Navigation: Scripting Reference Manual > Functions & Subroutines > PathAddEvent

 

PathAddEvent

 

Contact Us: fredsupport@photonengr.com

 

Description

Appends a single event to an existing user-defined path.  User-defined path mode is entered using SetUserDefinedRayPathMode.

 

Syntax

event = PathAddEvent( path, itemID, type, specular, child, nonsequential, pause, order )

 

Parameters

event (Long)

Event identifier.

 

path As Long

Path number of the path being modified.  This value is also returned by the PathAdd command.

 

itemID As Long

Node number of the entity on which the path event occurs.

 

type As Long

Sets event type: +1=transmit, -1=reflect, 0=absorb.

 

specular As Boolean

True sets path event as specular. False sets path as a scatter path.

 

child As Boolean

True indicates event involves a child (split). False denotes a parent.

 

nonsequential As Boolean

True sets event as a non-sequential event. False sets event as sequential.

 

pause As Boolean

True causes rays to stop at this event. False allows rays to continue.

 

order As Long

Sets the diffraction order of the event.

 

See Also

SetUserDefinedRayPathMode

Path Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC