Description Retrieves the scatter ancestry depth for 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 sdepth = GetRayScatterDepth ( id )
Parameters sdepth (Long) The scatter ancestry depth for the specified ray
id As Long (or Huge_) Identifier for the ray.
Remarks This function retrieves the scatter ancestry depth for a specified ray. If there is a problem, the function toggles an error and returns a value of -1.
The scatter ancestry depth is the number of generations of scatter splitting for the ray. For example, if the ray has scattered once from a specular ray, then its scatter ancestry depth is 1. If the ray has scattered from a ray that has scattered once, then the ancestry depth is 2. And so on.
See Also Examples
|