Skip to main content

ZOS-API interface 2024 R2

ZOSAPI.Editors.LDE.ISurfaceScatteringUser Interface Reference

Last update: 17.07.2025

Surface Scattering - User. This interface can be retrieved from the ILDEScatteringData interface. More...

Inheritance diagram for ZOSAPI.Editors.LDE.ISurfaceScatteringUser:

Public Member Functions

string[] GetAvailableDLLNames ()
 
string GetParameterName (int paramIdx)
 Gets the name of the specified parameter.
 
double GetParameterValue (int paramIdx)
 Gets the value of the specified parameter.
 
bool SetParameterValue (int paramIdx, double Value)
 Sets the value of the specified parameter.
 

Properties

string DLLName [get, set]
 
int NumberOfParameters [get]
 Gets the number of parameters used by the specified dll.
 
- Properties inherited from ZOSAPI.Editors.LDE.ISurfaceScatteringType
SurfaceScatteringTypes Type [get]
 Gets the scattering type for this instance.
 
ISurfaceScatteringNone _S_None [get]
 
ISurfaceScatteringLambertian _S_Lambertian [get]
 
ISurfaceScatteringGaussian _S_Gaussian [get]
 
ISurfaceScatteringABg _S_ABg [get]
 
ISurfaceScatteringABgFile _S_ABgFile [get]
 
ISurfaceScatteringBSDF _S_BSDF [get]
 
ISurfaceScatteringUser _S_User [get]
 
ISurfaceScatteringCatalog _S_Catalog [get]
 

Detailed Description

Surface Scattering - User. This interface can be retrieved from the ILDEScatteringData interface.

Member Function Documentation

◆ GetAvailableDLLNames()

string[] ZOSAPI.Editors.LDE.ISurfaceScatteringUser.GetAvailableDLLNames ( )

◆ GetParameterName()

string ZOSAPI.Editors.LDE.ISurfaceScatteringUser.GetParameterName ( int  paramIdx)

Gets the name of the specified parameter.

Parameters
paramIdxIndex of the parameter (0 to NumberOfParameters-1).
Returns

◆ GetParameterValue()

double ZOSAPI.Editors.LDE.ISurfaceScatteringUser.GetParameterValue ( int  paramIdx)

Gets the value of the specified parameter.

Parameters
paramIdxIndex of the parameter (0 to NumberOfParameters-1).
Returns

◆ SetParameterValue()

bool ZOSAPI.Editors.LDE.ISurfaceScatteringUser.SetParameterValue ( int  paramIdx,
double  Value 
)

Sets the value of the specified parameter.

Parameters
paramIdxIndex of the parameter (0 to NumberOfParameters-1).
ValueThe value.
Returns

Property Documentation

◆ DLLName

string ZOSAPI.Editors.LDE.ISurfaceScatteringUser.DLLName
getset

◆ NumberOfParameters

int ZOSAPI.Editors.LDE.ISurfaceScatteringUser.NumberOfParameters
get

Gets the number of parameters used by the specified dll.

The number of parameters.

Connect with Ansys