Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayParent

 

GetRayParent

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the identifier for the parent ray of a specified ray.  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

parent = GetRayParent ( id )

 

Parameters

parent (Long or Huge_)

The identifier of the parent ray.

 

id As Long (or Huge_)

Identifier for the ray.

 

Remarks

This function returns the identifier for the parent ray of a specified ray.  If the ray index is out-of-bounds, then the function returns -1 and generates an error. If the ray has no parent (generation 0), then the function returns -1 but does not generate an error.

 

See Also

AddRay

GetRay

SetRay

GetRayPathLength

GetRayEntity

GetRayIntersects

IsRayOnEntityArray

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC