Skip to main content

ZOS-API interface 2024 R1

ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog Interface Reference

Last update: 17.07.2025

Surface Scattering - IS Scatter Catalog. This interface can be retrieved from the ILDEScatteringData interface. More...

Inheritance diagram for ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog:

Public Member Functions

string GetFile ()
 Gets the selected transmission file.
 
ReflectTransmitCode SetFile (string File)
 Tries to change the selecting transmission file. Note that this will fail if the file only contains reflection data.
 
string[] GetAvailableFiles ()
 Gets all available isx files.
 
SampleSides[] GetSampleSides ()
 Gets the available sample sides from the selected file.
 

Properties

double Angle [get, set]
 
SampleSides SampleSide [get, set]
 Gets or sets the selected sample side.
 
Samplings Sampling [get, set]
 Gets or sets the sampling.
 
- 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 - IS Scatter Catalog. This interface can be retrieved from the ILDEScatteringData interface.

Member Function Documentation

◆ GetAvailableFiles()

string[] ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.GetAvailableFiles ( )

Gets all available isx files.

Returns

◆ GetFile()

string ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.GetFile ( )

Gets the selected transmission file.

Returns

◆ GetSampleSides()

SampleSides[] ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.GetSampleSides ( )

Gets the available sample sides from the selected file.

Returns

◆ SetFile()

ReflectTransmitCode ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.SetFile ( string  File)

Tries to change the selecting transmission file. Note that this will fail if the file only contains reflection data.

Parameters
FileThe file.
Returns

Property Documentation

◆ Angle

double ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.Angle
getset

◆ SampleSide

SampleSides ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.SampleSide
getset

Gets or sets the selected sample side.

The sample side.

◆ Sampling

Samplings ZOSAPI.Editors.LDE.ISurfaceScatteringCatalog.Sampling
getset

Gets or sets the sampling.

The sampling.

Connect with Ansys