Description Retrieves all the event information for a specific path in the ray buffer. This subroutine is different from PathEvent in that PathEvent2 can identify whether a path event is a diffraction event through the return value of its evtclass argument. The PathEvent command can only distinguish whether an event is specular or scatter.
Syntax PathEvent2 path, event, id, type, evtclass, child, nonSeq, pause, order
Parameters path As Long The identifier of the path in the ray buffer.
event As Long The identifier of the event in the path. 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.
id As Long Returns the entity identifier for the specific event in the path.
type As Long Returns the type of ray/surface interaction. Set to 1 for ray transmission, 0 for absorption, and -1 for reflection.
evtclass As Long Returns the class of ray/surface interaction. Possible return values are: 1 = Specular 0 = Scatter -1 = Diffract
child As Boolean Returns the ray child state of the event. Set to True if the event generates a child ray, False if it does not.
nonSeq As Boolean Returns the sequential state of the event. Set to True if it's non-sequential, False if it's sequential.
pause As Boolean Returns the pause state of the event. Set to True if there is a pause, False if there is no pause.
order As Long Returns the diffraction order of the ray when it interacts with the surface.
See Also
Examples
|