Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayStatus

 

GetRayStatus

 

Contact Us: fredsupport@photonengr.com

 

Description

This function retrieves the status code for a given ray id number.  Photon Engineering considers this an advanced function and the ray status codes are subject to development changes.  The status codes are provided here for reference in special scripting applications and should be used with caution.  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

status = GetRayStatus ( id )

 

Parameters

status (Long)

Returns the decimal status code of the ray.

 

id As Long (or Huge_)

The identifier of the ray.

 

Status Codes

HEX

DECIMAL

MEANING

0000

0000

No more intersections found.  Ray is OK.

0100

0256

Exceeded allowed number of total intersections

0200

0512

Exceeded allowed number of consecutive intersections

0300

0768

Bad position

0400

1024

Bad direction

0500

1280

Below absolute transmitted power cutoff

0600

1536

Below absolute reflected power cutoff

0700

1792

Below relative transmitted power cutoff

0800

2048

Below relative reflected power cutoff

0900

2304

Bad material

0A00

2560

Exceeded specular ancestry cutoff

0B00

2816

Exceeded scatter ancestry cutoff

0C00

3072

Became evanescent

0D00

3328

TIR not allowed

0E00

3584

Surface interface specification stops ray (ray control)

0F00

3840

Exceeded allowed number of steps in inhomogeneous material

1000

4096

Parabasal ray intersection failure

1100

4352

Parabasal ray interface interaction failure

1200

4608

Transmitted ray failed glue intersection

1300

4864

Reflected ray failed glue intersection

1400

5120

Ray has been deleted but is still in the virtual ray buffer

1500

5376

Absorbed ray

 

 

See Also

AddRay

GetRay

GetRayCount

SetRay

SetRayStatus

 

 

 

 

 

Copyright © Photon Engineering, LLC