Skip to main content

ZOS-API interface 2025 R2

ZOSAPI.Editors.NCE.INCEScatterToData Interface Reference

Last update: 16.07.2025

Object properties Scatter To tab. This interface can be accessed via the INCERow interface. More...

Public Member Functions

IImportanceSamplingSettings GetRayData (int rayIndex)
 Gets the importance sampling ray data for the specified ray (1 to NumberOfRayData).
 
bool SetRayData (int rayIndex, IImportanceSamplingSettings Data)
 Sets the importance sampling ray data for the specified ray.
 

Properties

bool IsScatterToAvailable [get]
 
ScatterToType ScatterToMethod [get, set]
 
string ScatterToList [get, set]
 
int NumberOfRayData [get]
 

Detailed Description

Object properties Scatter To tab. This interface can be accessed via the INCERow interface.

Member Function Documentation

◆ GetRayData()

IImportanceSamplingSettings ZOSAPI.Editors.NCE.INCEScatterToData.GetRayData ( int  rayIndex)

Gets the importance sampling ray data for the specified ray (1 to NumberOfRayData).

Parameters
rayIndexIndex of the ray data.
Returns
IImportanceSamplingSettings if the specified ray is valid; otherwise,
false
.

◆ SetRayData()

bool ZOSAPI.Editors.NCE.INCEScatterToData.SetRayData ( int  rayIndex,
IImportanceSamplingSettings  Data 
)

Sets the importance sampling ray data for the specified ray.

Parameters
rayIndexIndex of the ray.
DataThe new ray data settings.
Returns
true
if the specified index and data are valid; otherwise,
false
.

Property Documentation

◆ IsScatterToAvailable

bool ZOSAPI.Editors.NCE.INCEScatterToData.IsScatterToAvailable
get

◆ NumberOfRayData

int ZOSAPI.Editors.NCE.INCEScatterToData.NumberOfRayData
get

◆ ScatterToList

string ZOSAPI.Editors.NCE.INCEScatterToData.ScatterToList
getset

◆ ScatterToMethod

ScatterToType ZOSAPI.Editors.NCE.INCEScatterToData.ScatterToMethod
getset

Connect with Ansys