Navigation: Scripting Reference Manual > Functions & Subroutines > InsertSourceDirIthMultiAngle

 

InsertSourceDirIthMultiAngle

 

Contact Us: fredsupport@photonengr.com

 

Description

For a source node with ray direction type, "Multiple source angles (plane waves)", this subroutine inserts an angle specification at the specified index.  The index value is 0-based.

 

Syntax

InsertSourceDirIthMultiAngle( src, idx, xAng, yAng, bActive )

 

Parameters

src As Long

Node number of the source being modified.

 

idx As Long

The new angle specification will be inserted into the current angle list at the index value given by idx.  The index value is 0-based.

 

xAng As Double

X angle in degrees along which the rays will propagate.

 

yAng As Double

Y angle in degrees along which the rays will propagate

 

bActive As Boolean

Indicates whether this angle specification is active or inactive.  When inactive, no rays will be generated along the specified direction.

 

 

Example

The example below shows how to insert an angle specification into a source with ray direction type "Multiple source angles (plane waves)".

 

Sub Main

    'Source node being modified

    Dim src As Long

    src = FindFullName( "Optical Sources.Multi Angle Source" )

 

    'Insert a new angle specification

    Dim idx As Long

    idx = 5

    InsertSourceDirIthMultiAngle( src, idx, 15, -15, True )

 

    Update

 

End Sub

 

See Also

Source Script Commands

DeleteSourceDirIthMultiAngle

AddSourceDirIthMultiAngle

IsSourceDirMultiAngle

SetSourceDirMultiAngle

SetSourceDirIthMultiAngle

SetSourceDirIthMultiAngleActive

GetSourceDirMultiAngleCount

GetSourceDirIthMultiAngle

GetSourceDirIthMultiAngleActive

 

 

 

 

 

Copyright © Photon Engineering, LLC