GetRayWhyFailed Function

Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayWhyFailed

GetRayWhyFailed

Description

Returns a string that identifies the reason why a ray stopped tracing. 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

reason = GetRayWhyFailed ( id )

Parameters

reason (String)

The string that explains why the ray was stopped.

id As Long (or Huge_)

The identifier of the ray.

Remarks

This function returns a string that identifies the reason why a ray stopped tracing. The possible reasons for failure are:

Error	Meaning
no failure	ray traced successfully
too many total intersections	ray was stopped because the max intersection limit has been exceeded.
too many consecutive intersections	ray was stopped because the max consecutive intersection limit has been exceeded.
bad position
bad direction
below absolute transmitted power cutoff
below absolute reflected power cutoff
below relative transmitted power cutoff
below relative reflected power cutoff
unresolved material	the material the ray was supposed to be in could not be determined
exceeded specular ancestry cutoff
exceeded scatter ancestry cutoff
forbidden evanescent
forbidden total internal reflection (TIR)
surface interface specification stops ray
too many steps in material
secondary ray intersection failure
secondary ray refraction error
glue intersection failure in transmission
glue intersection failure in reflection
Unknown error