Navigation: Scripting Reference Manual > Data Structures > T_SOURCEPOLARIZATION

 

T_SOURCEPOLARIZATION

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure whose members describe the polarization state of a source node.

 

Definition

Type T_SOURCEPOLARIZATION

ellipticity As Double
ellipseAngle As Double
localDirX As Double
localDirY As Double
localDirZ As Double
isPolarized As Boolean
isRightHanded As Boolean
randomizeEllipticity As Boolean
randomizeAngle As Boolean
randomizeHandedness As Boolean

End Type

 

Members

ellipticity

Holds the ratio of the minimum/maximum axes of the polarization ellipse. May be a value between 0 (linear) and 1 (circular), inclusive.

 

ellipseAngle

The angle, in degrees, of the major axis of the polarization ellipse with respect to the local X axis.

 

localDirX

The X component of the Local X axis direction vector. NOTE: must be 1 if operating on a Source Primitive node type.  No restrictions apply to Detailed Sources.

 

localDirY

The Y component of the Local X axis direction vector. NOTE: must be 0 if operating on a Source Primitive node type.  No restrictions apply to Detailed Sources.

 

localDirZ

The Z component of the Local X axis direction vector. NOTE: must be 0 if operating on a Source Primitive node type.  No restrictions apply to Detailed Sources.

 

isPolarized

When set to False, ignores the values in other member variables. Useful for turning off polarization for a given source (see SetSourcePolarization).

 

isRightHanded

When set to True, assigns a clockwise handedness as the ray propagates toward the observer.

 

randomizeEllipticity

When set to True, generates a random value for the ellipticity of the polarization ellipse. NOTE: must be False if operating on a Source Primitive node type.  No restrictions apply to Detailed Sources.

 

randomizeAngle

When set to True, generates a random value for the Polarization ellipse angle and ignores ellipseAngle. NOTE: must be False if operating on a Source Primitive node type.  No restrictions apply to Detailed Sources.

 

randomizeHandedness

When set to True, randomizes the handedness and ignores isRightHanded. NOTE: must be False if operating on a Source Primitive node type.  No restrictions apply to Detailed Sources.

 

 

Used as Parameter in

GetSourcePolarization

SetSourcePolarization

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC