Navigation: Scripting Reference Manual > Functions & Subroutines > PathEventIsChild

 

PathEventIsChild

 

Contact Us: fredsupport@photonengr.com

 

Description

Identifies if a given event is associated with the child ray.

 

Syntax

child = PathEventIsChild ( path, event )

 

Parameters

child (Boolean)

Set to True if the event generated a child ray, False otherwise.

 

path As Long

The identifier of the path.

 

event As Long

The identifier of the event.  Path events can be indexed forward or backwards.  For example, an event ID of 0 indicates the first event along the path, 1 indexes the second event, etc.  When using negative event indexing, -1 indicates the last event along the path, -2 is the second to last event, etc.

 

Remarks

This function identifies if a given event is associated with the child ray. If there is a problem the function sets an error and returns False.

 

See Also

Path Commands

 

Examples

RayPath Functions

 

 

 

 

 

Copyright © Photon Engineering, LLC