Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceDirFocus

 

GetSourceDirFocus

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the ray direction data from a source with a Focus to/from a point ray direction.

 

Syntax

success = GetSourceDirFocus ( n, x, y, z, isTowardPoint )

 

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 point.

 

y As Double

Returns the Y component of the point.

 

z As Double

Returns the Z component of the point.

 

isTowardPoint As Boolean

Returns the ray direction type. Set to True if the rays are directed towards the point x, y, z and False if the rays are directed away from (x,y,z).

 

Remarks

This function retrieves the ray direction data from a source with a Focus to/from a point ray direction. If there is a problem the function returns False and does not set an error.

 

See Also

IsSourceDirFocus

SetSourceDirFocus

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC