Navigation: Scripting Reference Manual > Functions & Subroutines > IsSourceDirSampledPolar

 

IsSourceDirSampledPolar

 

Contact Us: fredsupport@photonengr.com

 

Description

This function checks if a source node has ray direction specification "Randomly according to intensity distribution", which generates ray directions using weighting factors on a polar grid.

 

Syntax

dirCheck = IsSourceDirSampledPolar( srcNode )

 

Parameters

dirCheck (Boolean)

True if source ray directions are "Randomly according to intensity distribution".  False otherwise.

 

srcNode As Long

Node number of the source being queried.

 

Remarks

If the node number argument is not a source type, the following error message will be issued and operation is halted:

 

"Error: A referenced entity is not of the correct type"

 

If the node number argument does not exist in the FRED document, the following error message will be issued and operation is halted:

 

"Error: Invalid entity number or array index out of bounds"

 

Example

Sub Main

          Dim srcNode As Long, dirCheck As Boolean

          srcNode = FindFullName( "Optical Sources.My Source" )

          dirCheck =  IsSourceDirSampledPolar( srcNode )

          Print "Source ray direction check: " & dirCheck

End Sub

 

See Also

Source scripting commands

SetSourceDirSampledPolar

GetSourceDirSampledPolar

 

 

 

 

 

Copyright © Photon Engineering, LLC