Skip to main content

ZOS-API interface 2024 R2

ZOSAPI.Editors.LDE.ILDEScatteringData Interface Reference

Last update: 17.07.2025

Surface properties scattering tab. This interface can be accessed via the ILDERow interface. More...

Public Member Functions

ISurfaceScatteringType CreateScatteringTypeSettings (SurfaceScatteringTypes type)
 Gets settings for the specified scatter type. Note that no changes will be made until you call ChangeScatteringTypeSettings.
 
bool ChangeScatteringTypeSettings (ISurfaceScatteringType settings)
 Updates the current scattering type settings. Use CurrentTypeSettings or CreateScatteringTypeSettings to retrieve the relevant settings.
 

Properties

SurfaceScatteringTypes CurrentType [get]
 Gets the current scattering type.
 
ISurfaceScatteringType CurrentTypeSettings [get]
 Gets the settings specific to the current scattering type. Use CreateScatteringTypeSettings to get settings for a specific scattering type.
 

Detailed Description

Surface properties scattering tab. This interface can be accessed via the ILDERow interface.

Member Function Documentation

◆ ChangeScatteringTypeSettings()

bool ZOSAPI.Editors.LDE.ILDEScatteringData.ChangeScatteringTypeSettings ( ISurfaceScatteringType  settings)

Updates the current scattering type settings. Use CurrentTypeSettings or CreateScatteringTypeSettings to retrieve the relevant settings.

Parameters
settingsThe settings.
Returns

◆ CreateScatteringTypeSettings()

ISurfaceScatteringType ZOSAPI.Editors.LDE.ILDEScatteringData.CreateScatteringTypeSettings ( SurfaceScatteringTypes  type)

Gets settings for the specified scatter type. Note that no changes will be made until you call ChangeScatteringTypeSettings.

Parameters
typeThe type.
Returns

Property Documentation

◆ CurrentType

SurfaceScatteringTypes ZOSAPI.Editors.LDE.ILDEScatteringData.CurrentType
get

Gets the current scattering type.

The scattering type.

◆ CurrentTypeSettings

ISurfaceScatteringType ZOSAPI.Editors.LDE.ILDEScatteringData.CurrentTypeSettings
get

Gets the settings specific to the current scattering type. Use CreateScatteringTypeSettings to get settings for a specific scattering type.

The current type settings.

Connect with Ansys