Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceDirIthMultiAngle

 

GetSourceDirIthMultiAngle

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves a particular angle from a multi-angle source.

 

Syntax

GetSourceDirIthMultiAngle n, indx, angX, angY, active

 

Parameters

n As Long

Node number of the multi-angle (plane waves) source.

 

indx As Long

The identifier of the angle entry to be retrieved.  Note: the script index is zero based and the GUI list is 1-based.  The 2 entry in the GUI therefore corresponds to a 1 index in script.

 

angX As Double

Returns the angle in the X direction.

 

angY As Double

Returns the angle in the Y direction.

 

active As Boolean

Returns the activity state of the angle.

 

Remarks

This subroutine retrieves a particular angle from a multi-angle source. If there is a problem the subroutine sets an error and returns without modifying the parameters.

 

See Also

IsSourceDirMultiAngle

SetSourceDirMultiAngle

SetSourceDirIthMultiAngle

SetSourceDirIthMultiAngleActive

AddSourceDirIthMultiAngle

GetSourceDirMultiAngleCount

GetSourceDirIthMultiAngleActive

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC