Navigation: Scripting Reference Manual > Data Structures > T_SOURCEPRIMRAYFAN

 

T_SOURCEPRIMRAYFAN

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure used for retrieving or specifying the configuration parameters of a Ray Fan type Source Primitive.

 

 

Definition

T_SOURCEPRIMRAYFAN

AxisY As Long

numRays As Huge_

PowerWatts As Double

RaySpec As Long

ReverseDir As Long

semi As Double

Vec As String

 

 

Members

AxisY

Specifies the orientation of the ray fan as aligned along either the X or Y axis.  A value of 0 specifies a ray fan oriented along the X axis.  A value of 1 specifies a ray fan oriented along the Y axis.

 

numRays

The number of rays across the the diameter of the source aperture.

 

PowerWatts

Total power emitted by the source in units of Watts.

 

RaySpec

Specifies how the Vec parameter is interpreted when setting the ray directions.  A value of 0 corresponds to the "Along direction" option in the GUI.  A value of 1 corresponds to the "From position" option in the GUI.  See the Ray Fan type Source Primitive help topic for more information.

 

ReverseDir

Specifies whether the ray directions are reversed (i.e. instead of "Along direction", the rays would be traveling "From direction" and instead of "From position" the rays would be traveling "Toward position").  A value of 0 means the rays are not reversed. A value of 1 means the ray directions are reversed.

 

semi

Sets the semi-aperture of the ray fan.

 

Vec

The (v1,v2,v3) vector whose interpretation is set by the RayFromDir parameter.  The vector is supplied as a string of delimited values (ex. "0, 1.0, 1.0" ).

 

 

Used as a parameter in

SourcePrimGetParmRayFan

SourcePrimSetParmRayFan

 

 

 

 

 

Copyright © Photon Engineering, LLC