Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayPathLength

 

GetRayPathLength

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the optical path length (OPD) for a specified ray in the ray buffer.  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

opl = GetRayPathLength ( id )

 

Parameters

opl (Double)

Returns the optical path length (OPD) of the ray.

 

id As Long (or Huge_)

Identifier for the ray.

 

Remarks

This function retrieves the optical path length (OPD) for a specified ray in the ray buffer.  If there is a problem, an error is toggled and the function returns a value of 0.

 

See Also

AddRay

GetRay

SetRay

GetRayEntity

GetRayIntersects

GetRayParent

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC