Navigation: Scripting Reference Manual > Functions & Subroutines > GetTrimVolMinMax

 

GetTrimVolMinMax

 

Contact Us: fredsupport@photonengr.com

 

Description

Provides a shorthand method of retrieving trimming volume outer boundary minimum and maximum values.

 

Syntax

GetTrimVolMinMax n, xmin, xmax, ymin, ymax, zmin, zmax, shape

 

Parameters

n as Long

Node number of entity.

 

xmin As Double

Return value for minimum x coordinate of trimming volume outer boundary.

 

xmax As Double

Return value for maximum x coordinate of trimming volume outer boundary.

 

ymin As Double

Return value for minimum y coordinate of trimming volume outer boundary.

 

ymax As Double

Return value for maximum y coordinate of trimming volume outer boundary.

 

zmin As Double

Return value for minimum z coordinate of trimming volume outer boundary.

 

zmax As Double

Return value for maximum z coordinate of trimming volume outer boundary.

 

shape As String

Return value for trimming volume outer boundary shape. Possible values are "Box", "Cylinder" or "Ellipsoid".

 

 

Remarks

GetTrimVolMinMax is a shorthand method of retrieving trimming volume outer boundary minimum and maximum values. This command does not require the use of T_TRIMVOLUME. If there is a problem, the subroutine generates an error and does not return trimming volume outer boundary minimum and maximum values.

 

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 xMin As Double, xMax As Double, yMin As Double, yMax As Double, zMin As Double, zMax As Double, shape As String

 

ClearOutputWindow

 

For ii = 0 To GetEntityCount()-1

          If IsSurface( ii ) Then

                    GetTrimVolMinMax ii, xMin, xMax, yMin, yMax, zMin, zMax, shape

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

          End If

Next ii

 

See Also

SetTrimVolMinMax

SetTrimVolHole

GetTrimVolHole

GetTrimVol

SetTrimVol

 

 

 

 

 

Copyright © Photon Engineering, LLC