Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceDirection

 

GetSourceDirection

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the ray direction data from a source with a single direction plane wave ray direction type.

 

Syntax

success = GetSourceDirection ( n, x, y, z )

 

Parameters

success (Boolean)

Indicates if the function succeeded (True) or failed (False).

 

n As Long

Node number of the source.

 

x As Double

Returns the X component of the direction vector.

 

y As Double

Returns the Y component of the direction vector.

 

z As Double

Returns the Z component of the direction vector.

 

Remarks

This function retrieves the ray direction data from a source with a single direction plane wave ray direction type. If there is a problem the function returns False and does not set an error.

 

See Also

IsSourceDirection

SetSourceDirection

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC