Navigation: Scripting Reference Manual > Functions & Subroutines > GetDotProdSurfTrim

 

GetDotProdSurfTrim

 

Contact Us: fredsupport@photonengr.com

 

Description

This subroutine retrieves the advanced dot-product surface trimming specification from a surface node (Faceted Surface excluded).

 

 

Syntax

GetDotProdSurfTrim surfNode, trimType, bSign, dX, dY, dZ

 

 

Parameters

surfNode As Long

Node number of the surface whose dot product trimming specification is being queried.

 

trimType As String

After the command has been executed, this variable contains the string specification of the trimming type.  Specifications are:

"No Test"

"Position Test"

"Direction Test"

"X Test"

"Y Test"

"Z Test"

 

bSign As Boolean

After the command has been executed, this variable stores the sign of the dot product specification.  True = Positive and False = Negative.

 

dX As Double

After the command has been executed, this variable stores the X-component of the reference vector.

 

dY As Double

After the command has been executed, this variable stores the Y-component of the reference vector.

 

dZ As Double

After the command has been executed, this variable stores the Z-component of the reference vector.

 

 

Example

The following example locates a surface node, retrieves the dot product trimming specification and then reports the specification settings to the output window.

 

Sub Main

 

    ClearOutputWindow

 

    Dim sNode As Long

    sNode = FindFullName( "Geometry.Plane.Surface" )

 

    Dim trimType As String

    Dim bSign As Boolean

    Dim dX As Double, dY As Double, dZ As Double

    GetDotProdSurfTrim( sNode, trimType, bSign, dX, dY, dZ )

 

    Print "Advanced dot product trimming specification"

    Print "-------------------------------------------"

    Print "Trimming type: " & trimType

    Print "Sign: " & bSign

    Print "Reference vector: " & dX & ", " & dY & ", " & dZ

 

 

End Sub

 

 

See Also

SetDotProdSurfTrim

 

 

 

 

 

Copyright © Photon Engineering, LLC