Navigation: Scripting Reference Manual > Functions & Subroutines > GetSurfRayPathNode

 

GetSurfRayPathNode

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the ray path node number assignment for a given surface.    The surface being queried reports itself as the assigned node number for ray path purposes.

 

 

Syntax

pathNode = GetSurfRayPathNode( surfNode )

 

 

Parameters

pathNode ( Long )

Node number being reported by the surface for ray path purposes.

 

surfNode As Long

Node number of the surface being queried for its ray path node number assignment information.  This node ID must be a surface or the function will halt with error, "A referenced entity is not of the correct type".

 

 

Example

The following example code queries a surface named "Surf 1" for its ray path node number assignment and prints the information to the output window.

 

Dim surfNode As Long, pathNode As Long

 

'surface node being queried

surfNode = FindFullName( "Geometry.Subassembly 1.Elem 1.Surf 1" )

 

'get and print ray path node number specification

pathNode = GetSurfRayPathNode( surfNode )

 

Print Chr(34) & GetFullName( surfNode ) & Chr(34)  & " reports as node " & Chr(34) & GetFullName( pathNode ) & Chr(34) & " for ray path purposes."

 

 

See Also

Ray Path Node Number(s)

SetSurfRayPathNode

 

 

 

 

 

Copyright © Photon Engineering, LLC