Navigation: Scripting Reference Manual > Functions & Subroutines > SetSourcePolarization

 

SetSourcePolarization

 

Contact Us: fredsupport@photonengr.com

 

Description

Sets the polarization state of a source.  If the source node being operated on is a Source Primitive, the "randomize" options in the T_SOURCEPOLARIZATION data structure cannot be applied.  Additionally, the polarization reference vector defined in the T_SOURCEPOLARIZATION data structure must be (1,0,0).  If either of these rules are violated, the SetSourcePolarization function will halt with an error if operating on a Source Primitive.  No restrictions apply when operating on a Detailed Source.

 

Syntax

SetSourcePolarization n, pspec

 

Parameters

n As Long

Node number of the source.

 

pspec As T_SOURCEPOLARIZATION

Structure containing the new polarization properties of the source.

 

Remarks

This subroutine gets the polarization state of a source. If there is a problem, the subroutine returns without modifying the source or setting an error.

 

See Also

T_SOURCEPOLARIZATION

GetSourcePolarization

 

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC