Navigation: Scripting Reference Manual > Functions & Subroutines > GetTrimVol

 

GetTrimVol

 

Contact Us: fredsupport@photonengr.com

 

Description

Provides a shorthand method of retrieving trimming volume specifications.

 

Syntax

GetTrimVol n, xsemi, ysemi, zsemi, xcen, ycen, zcen, shape

 

Parameters

n as Long

Node number of entity.

 

xsemi As Double

Return value for x-semiwidth of trimming volume.

 

ysemi As Double

Return value for y-semiwidth of trimming volume.

 

zsemi As Double

Return value for z-semiwidth of trimming volume.

 

xcen As Double

Return value for x-coordinate of trimming volume center.

 

ycen As Double

Return value for y-coordinate of trimming volume center.

 

zcen As Double

Return value for z-coordinate of trimming volume center.

 

shape As String

Return value for trimming volume shape. Possible values are "Box", "Zcylinder" or "Ellipsoid".

 

Remarks

GetTrimVol is a shorthand method of retrieving trimming volume specifications. This command does not require the use of T_TRIMVOLUME. Note, however, that this command does not return trimming hole specifications. If there is a problem, the subroutine generates an error and does not return trimming volume specifications.

 

Example

The following example loops over all entities on the object tree, checks to see if the entity is a surface, retrieves the surface's trimming volume specification and prints a message to the output window.

 

Dim ii As Long

Dim xSemi As Double, ySemi As Double, zSemi As Double, xCen As Double, yCen As Double, zCen As Double, shape As String

 

ClearOutputWindow

 

For ii = 0 To GetEntityCount()-1

          If IsSurface( ii ) Then

                    GetTrimVol ii, xSemi, ySemi, zSemi, xCen, yCen, zCen, shape

                    Print "Surface " & GetFullName( ii ) & " has trimming volume: " & shape

          End If

Next ii

 

See Also

SetTrimVol

SetTrimVolMinMax

GetTrimVolMinMax

GetTrimVolHole

SetTrimVolHole

GetTrimVolume

SetTrimVolume

 

 

 

 

 

Copyright © Photon Engineering, LLC