Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceIthUserRay

 

GetSourceIthUserRay

 

Contact Us: fredsupport@photonengr.com

 

Description

Gets the data for a particular user ray in a specific source.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

GetSourceIthUserRay n, indx, userRay

 

Parameters

n As Long

Node number of the source.

 

indx As Long (or Huge_)

The index (zero based) of the ray.

 

userRay As T_SOURCEUSERRAY

Structure containing the new data for a particular user ray.

 

Remarks

This subroutine gets the data for a particular user ray in a specific source. If there is a problem the subroutine sets an error and operation is halted.  If the source is not of the user-defined ray type, no error message is returned and operation continues.

 

See Also

T_SOURCEUSERRAY

AddSourceUserRay

AddSourceUserRays

DeleteSourceIthUserRay

DeleteSourceUserRays

GetSourceUserRayCount

SetSourceIthUserRay

Examples

 

 

 

 

 

Copyright © Photon Engineering, LLC