Navigation: Scripting Reference Manual > Data Structures > T_RAY

 

T_RAY

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure used to store basic ray data. Note that ray position coordinates are always given in the Global Coordinate System.  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.

 

Definition

Type T_RAY

x As Double

y As Double

z As Double

a As Double

b As Double

c As Double

k As Double

l As Double

m As Double

consecIntersects As Long

diffractdepth As Long

power As Double

pathlength As Double

wavelength As Double

material As Long

indexref As Double

indexrefimag As Double

entity As Long

parent As Long  (or Huge_)

source As Long

sourceRayNbr As Long  (or Huge_)

scatterdepth As Long

speculardepth As Long

intersects As Long

active As Boolean

colorR As Long

colorG As Long

colorB As Long

End Type

 

Members

x

The ray X position component given in global coordinates.

 

y

The ray Y position component given in global coordinates.

 

z

The ray Z position component given in global coordinates.

 

a

The ray X direction cosine given in global coordinates.

 

b

The ray Y direction cosine given in global coordinates.

 

c

The ray Z direction cosine given in global coordinates.

 

k

The X direction component of the surface normal at the ray's intersection location in global coordinates.  This is a read-only member variable and cannot be changed.

 

l

The Y direction component of the surface normal at the ray's intersection location in global coordinates.  This is a read-only member variable and cannot be changed.

 

m

The Z direction component of the surface normal at the ray's intersection location in global coordinates.  This is a read-only member variable and cannot be changed.

 

consecIntersects

The number of consecutive intersections that the ray has had with the current entity it is associated with.  This is a read-only member variable and cannot be changed.

 

diffractdepth

Indicates the number of times a ray has interacted with a diffraction grating.

 

power

The ray power.

 

pathlength

The optical path length of the ray.

 

wavelength

The wavelength of the ray. (microns)

 

material

Identifier of the material the ray is immersed in.

 

indexref

Refractive index of the ray's immersion material evaluated at the ray's wavelength.

 

indexrefimag

Imaginary refractive index of the ray's immersion material evaluated at the ray's wavelength.

 

entity

Node number of the last FRED entity the ray intersected.

 

parent

Identifier of this ray's parent ray.

 

source

Identifier of the Optical Source that generated the ray.

 

sourceRayNbr

Indicates that the ray is (or is a descendant of) the i'th ray that was created in the source given by the "source" member variable.  This is a read-only member variable and cannot be changed.

 

scatterdepth

The scatter ancestry depth of the ray.

 

speculardepth

The specular ancestry depth of the ray.

 

intersects

The total intersect count of the ray.

 

active

Set to True if the ray is active, False if it is not.

 

colorR

The red component of the ray color.

 

colorG

The green component of the ray color.

 

colorB

The blue component of the ray color.

 

Used as Parameter in

AddRay

GetRay

SetRay

 

Examples

Raytrace Controls

 

 

 

 

 

Copyright © Photon Engineering, LLC