Navigation: Scripting Reference Manual > Data Structures > T_SOURCEPROPSPEC

 

T_SOURCEPROPSPEC

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure used to characterize the pre-propagation data for a source.  This structure serves as a definition of how rays are moved immediately after they have been created, but before they have been raytraced.

 

Definition

Type T_SOURCEPROPSPEC

x As Double
y As Double
z As Double
r As Double
kind As String

End Type

 

Members

x

The x value, see table below.

 

y

The y value, see table below.

 

z

The z value, see table below.

 

r

The r value, see table below.

 

kind

Describes the kind of propagation. Can be one of "byx", "byy", "byz", "tox", "toy", "toz", "opl", "point", "sphere+", "sphere-", or "none". All other values are treated as "none". Specifies how the x, y, z, and r values are treated, according to the table below

 

If you select this Kind

You mean this

The x value is

the y value is

the z value is

the r value is

byx

Propagate by x

propagation distance in the x direction

ignored

ignored

ignored

byy

Propagate by y

ignored

propagation distance in the y direction

ignored

ignored

byz

Propagate by z

ignored

ignored

propagation distance in the z direction

ignored

tox

Propagate to x

propagate to the plane at the x value

ignored

ignored

ignored

toy

Propagate to y

ignored

propagate to the plane at the y value

ignored

ignored

toz

Propagate to z

ignored

ignored

propagate to the plane at the z value

ignored

opl

Propagate by optical path length

ignored

ignored

ignored

propagate by the given opl

point

Propagate to the closest approach to the given point

the x coordinate of the propagation point

the y coordinate of the propagation point

the z coordinate of the propagation point

ignored

sphere+

Propagate to the most positive intersection with the  sphere

the x coordinate of the sphere's center

the y coordinate of the sphere's center

the z coordinate of the sphere's center

the radius of the sphere

sphere-

Propagate to the most negative intersection with the sphere

the x coordinate of the sphere's center

the y coordinate of the sphere's center

the z coordinate of the sphere's center

the radius of the sphere

none

No Extra Propagation

ignored

ignored

ignored

ignored

 

 

Used as Parameter in

GetSourcePropagationSpec

SetSourcePropagationSpec

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC