Interface ZOSAPI::Editors::NCE::IVMPS_DLLDefinedScattering

Definition:

Volume Physics Model - DLL Defined Scatering. This interface can be accessed via the INCEVolumePhysicsData interface.

Inherits from:

• ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings

Members

• _S_AngleScattering
• _S_DLLDefinedScattering
• _S_None
• _S_PhotoluminescenceModel
• Angle
• AngleRequired
• DLL
• GetAvailableDLLs
• GetParameterName
• GetParameterValue
• IsValid
• MeanPath
• MeanPathRequired
• NumberOfParameters
• SetParameterValue
• Type

Properties

Property DLL

Definition:

string ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.DLL

Return type: string

Property MeanPath

Definition:

double ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.MeanPath

Return type: double

Property MeanPathRequired

Definition:

bool ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.MeanPathRequired

Return type: bool

Property Angle

Definition:

double ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.Angle

Return type: double

Property AngleRequired

Definition:

bool ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.AngleRequired

Return type: bool

Property NumberOfParameters

Definition:

int ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.NumberOfParameters

Return type: int

Public functions

Function GetAvailableDLLs

string[] ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.GetAvailableDLLs()

Return type: string[]

Function GetParameterName

string ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.GetParameterName(int paramIdx)

Gets the name of the specified parameter (0 to NumberOfParameters).

Parameters:

• paramIdx: Index of the parameter.

Returns:

The name of the parameter if the index is valid; otherwise, an empty string.

Parameters:

• int paramIdx

Return type: string

Function GetParameterValue

double ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.GetParameterValue(int paramIdx)

Gets the value of the specified parameter (0 to NumberOfParameters).

Parameters:

• paramIdx: Index of the parameter.

Returns:

The value of the parameter if the index is valid; otherwise,

0.0

.

Parameters:

• int paramIdx

Return type: double

Function SetParameterValue

bool ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.SetParameterValue(int paramIdx, double Value)

Gets the value of the specified parameter.

Parameters:

• paramIdx: Index of the parameter (0-based).
• Value: The new parameter value.

Returns:

true

if the index is valid; otherwise,

false

.

Parameters:

• int paramIdx
• double Value

Return type: bool