Navigation: Scripting Reference Manual > Data Structures > T_TRIMVOLUME

 

T_TRIMVOLUME

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure for definition of a trimming volume applied to a FRED entity.  If xSemiApe, ySemiApe or zSemiApe are zero when SetTrimVolume is called, the corresponding semi aperture will be reset to 1% of the diagonal length of the box.

 

Definition

Type T_TRIMVOLUME

xSemiApe As Double

ySemiApe As Double

zSemiApe As Double

xCenter As Double

yCenter As Double

zCenter As Double

xSemiApeHole As Double

ySemiApeHole As Double

xCenterHole As Double

yCenterHole As Double

box As Boolean

boxHole As Boolean

End Type

 

Members

xSemiApe

Semi-aperture in the X direction.

 

ySemiApe

Semi-aperture in the Y direction.

 

zSemiApe

Semi-aperture in the Z direction.

 

xCenter

X coordinate of the location of the center.

 

yCenter

Y coordinate of the location of the center.

 

zCenter

Z coordinate of the location of the center.

 

xSemiApeHole

X Semi-aperture of the hole in the trimming volume.

 

ySemiApeHole

Y Semi-aperture of the hole in the trimming volume.

 

xCenterHole

X component of the central hole location.

 

yCenterHole

Y component of the central hole location.

 

box

Set to True if the Trimming Volume is a box, False if it is a Cylinder. Ellipsoid volumes are currently not allowed.

 

boxHole

Set to True if the hole in the Trimming Volume is a rectangular shape, False if it is a Z-Cylinder.

 

Used as Parameter in

GetTrimVolume

SetTrimVolume

 

See Also

T_ENTITY

Examples

 

 

 

 

 

 

Copyright © Photon Engineering, LLC