Navigation:  C/C++ Scripting Engine > Classes > dbAperture

Stores information describing an Aperture.

 

Member Functions:

==============

 

int        getType()

Get the aperture Shape type.  For available Aperture shape types see: dbApertureTypeEnum

 

float        getWidth()

Get the aperture width.

 

float        getHeight()

Get the aperture height.

 

float        getOD()

Get the aperture od.

 

float        getID()

Get the aperture id.

 

float        getBase()

Get the aperture base.

 

float        getTop()

Get the aperture top.

 

float        getDelta()

Get the aperture delta.

 

char*        getCustomName()

Get the aperture custom name.

 

float        getRotation()

Get the aperture rotate.

 

float        getScale()

Get the aperture scale.

 

float        getCompensation()

Get the aperture compensation.

 

int        isMirror()

Get the aperture mirror flag. Returns 1 for mirror (horizontal), 2 for mirror (vertical), and 0 for no mirror.

 

int        getCrosshairCount()

Get the aperture crosshair count.

 

float        getCrosshairThick()

Get the aperture crosshair thickness.

 

float        getCrosshairLength()

Get the aperture crosshair length.

 

float        getRectRadius()

Get the aperture rect radius.

 

int        getRectCorner_ur()

Get the aperture rect upper-right corner flag.

 

int        getRectCorner_ul()

Get the aperture rect upper-left corner flag.

 

int        getRectCorner_ll()

Get the aperture rect lower-left corner flag.

 

int        getRectCorner_lr()

Get the aperture rect lower-right corner flag.

 

float        getSpokeAngle()

Get the aperture spoke angle.

 

int        getThermalOpenEnds()

Get the aperture thermal open ends.

 

float        getThermalAirGap()

Get the aperture thermal air gap.

 

float        getMoireRingWidth()

Get the aperture moire ring width.

 

float        getMoireRingGap()

Get the aperture moire ring gap.

 

int        getMoireRingCount()

Get the aperture moire ring count.

 

float        getMoireLineWidth()

Get the aperture moire line width.

 

float        getMoireLineLength()

Get the aperture moire line length.

 

void        setType( int val )

Set Aperture Shape Type.  For available Aperture shape types see: dbApertureTypeEnum

 

void        setWidth( float val )

Set the Aperture width.

 

void        setHeight( float val )

Set the Aperture height.

 

void        setOD( float val )

Set the Aperture od.

 

void        setID( float val )

Set the Aperture id.

 

void        setBase( float val )

Set the Aperture base.

 

void        setTop( float val )

Set the Aperture top.

 

void        setDelta( float val )

Set the Aperture delta.

 

void        setCustomName( char* val )

Set the Aperture custom name.

 

void        setRotation( float val )

Set the Aperture rotate.

 

void        setScale( float val )

Set the Aperture scale.

 

void        setCompensation( float val )

Set the Aperture compensation.

 

void        setMirror( int val )

Set the Aperture mirror.

 

void        setCrosshairCount( int val )

Set the Aperture crosshair count.

 

void        setCrosshairThick( float val )

Set the Aperture crosshair thickness.

 

void        setCrosshairLength( float val )

Set the Aperture crosshair length.

 

void        setRectRadius( float val )

Set the Aperture rectangle radius.

 

void        setRectCorner_ur( int val )

Set the Aperture rect upper-right corner flag.

 

void        setRectCorner_ul( int val )

Set the Aperture rect upper-left corner flag.

 

void        setRectCorner_ll( int val )

Set the Aperture rect lower-left corner flag.

 

void        setRectCorner_lr( int val )

Set the Aperture rect lower-right corner flag.

 

void        setSpokeAngle( float val )

Set the Aperture spoke angle.

 

void        setThermalOpenEnds( int val )

Set the Aperture thermal open ends.

 

void        setThermalAirGap( float val )

Set the Aperture thermal airgap.

 

void        setMoireRingWidth( float val )

Set the Aperture moire ring width.

 

void        setMoireRingGap( float val )

Set the Aperture moire ring gap.

 

void        setMoireRingCount( int val )

Set the Aperture moire ring count.

 

void        setMoireLineWidth( float val )

Set the Aperture moire line width.

 

void        setMoireLineLength( float val )

Set the Aperture moire line length.

 

 

===============================================================

 

Note:  Different parameters are required to define each unique Aperture Shape Type.  See below for a description of the required parameters for each shape type.  Note:  When writing scripts, you only need to define values to the required parameters per Aperture Shape Type.

 

Width:

dbApertureTypeCircle

dbApertureTypePoex

dbApertureTypePoin

dbApertureTypeTarget

dbApertureTypeButterfly

dbApertureTypeSquareButterfly

dbApertureTypeHexagon

 

 

Width, Height:

dbApertureTypeDiamond

dbApertureTypeOblong

dbApertureTypeRect

dbApertureTypeEllipse

dbApertureTypeOctagon

dbApertureTypeBullet

 

 

Width, Height, RectRadius:

dbApertureTypeRectRounded

dbApertureTypeRectChamfered

dbApertureTypeHexagonHorizontal

dbApertureTypeHexagonVertical

 

 

OD, ID:

dbApertureTypeDonut

dbApertureTypeDonutSquare

 

 

Base, Height:

dbApertureTypeTriangle

 

 

OD, ID, SpokeAngle, CrosshairCount, CrosshairThick:

dbApertureTypeThermal

dbApertureTypeThermalSquare

dbApertureTypeThermalSquareRound

 

 

Width, Height, SpokeAngle, CrosshairCount, CrosshairThick, ThermalAirgap:

dbApertureTypeThermalRectangle

 

 

Base, Height, Top, Delta:

dbApertureTypeTrapezoid

 

 

MoireRingWidth, MoireRingGap, MoireRingCount, MoireLineWidth, MoireLineLength:

dbApertureTypeMoire

 

 

CustomName:

dbApertureTypeCustom