Skip to main content

ZOS-API interface 2024 R2 SP02

ZOSAPI.Editors.NCE.INCETypeData Interface Reference

Last update: 17.07.2025

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

Public Member Functions

string[] GetAvailableUDAFiles ()
 
string GetUDAFileFullPath ()
 

Properties

bool AreUDASettingsAvailable [get]
 
bool UserDefinedAperture [get, set]
 
double UDAScale [get, set]
 
string UDAFile [get, set]
 
ZemaxColor RowColor [get, set]
 
bool UseGlobalXYZRotationOrder [get, set]
 
bool ConvertImportedFilesToZOF [get, set]
 
string ConsiderObjects [get, set]
 
string IgnoreObjects [get, set]
 
RaysIgnoreObjectType RaysIgnoreObject [get, set]
 
bool UseConsiderIgnoreWhenSplitting [get, set]
 
bool FastRayTrace [get, set]
 
bool UseFastApproximateRayTrace [get, set]
 
bool ObjectIsADetector [get, set]
 
DetectorShowAsType DetectorShowAs [get, set]
 
bool UsePixelInterpolation [get, set]
 
bool NormalizeCoherentPower [get, set]
 
bool RecordSpectralData [get, set]
 
int NumberOfSpectralData [get, set]
 
double SpectralDataMinWave [get, set]
 
double SpectralDataMaxWave [get, set]
 
bool RecordPixelSpectralData [get, set]
 

Detailed Description

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

Member Function Documentation

◆ GetAvailableUDAFiles()

string[] ZOSAPI.Editors.NCE.INCETypeData.GetAvailableUDAFiles ( )

◆ GetUDAFileFullPath()

string ZOSAPI.Editors.NCE.INCETypeData.GetUDAFileFullPath ( )

Property Documentation

◆ AreUDASettingsAvailable

bool ZOSAPI.Editors.NCE.INCETypeData.AreUDASettingsAvailable
get

◆ ConsiderObjects

string ZOSAPI.Editors.NCE.INCETypeData.ConsiderObjects
getset

◆ ConvertImportedFilesToZOF

bool ZOSAPI.Editors.NCE.INCETypeData.ConvertImportedFilesToZOF
getset

◆ DetectorShowAs

DetectorShowAsType ZOSAPI.Editors.NCE.INCETypeData.DetectorShowAs
getset

◆ FastRayTrace

bool ZOSAPI.Editors.NCE.INCETypeData.FastRayTrace
getset

◆ IgnoreObjects

string ZOSAPI.Editors.NCE.INCETypeData.IgnoreObjects
getset

◆ NormalizeCoherentPower

bool ZOSAPI.Editors.NCE.INCETypeData.NormalizeCoherentPower
getset

◆ NumberOfSpectralData

int ZOSAPI.Editors.NCE.INCETypeData.NumberOfSpectralData
getset

◆ ObjectIsADetector

bool ZOSAPI.Editors.NCE.INCETypeData.ObjectIsADetector
getset

◆ RaysIgnoreObject

RaysIgnoreObjectType ZOSAPI.Editors.NCE.INCETypeData.RaysIgnoreObject
getset

Usage (see Example 21 for a full sample)

C#

// Set Rays Ignore Object = Always for object 2
// TypeData includes all settings in Object Properties > Type
Object_2.TypeData.RaysIgnoreObject = RaysIgnoreObjectType.Always;
RaysIgnoreObjectType
Definition: InterfacesNCE.cs:5689

C++

// Set Rays Ignore Object = Always for object 2
// TypeData includes all settings in Object Properties > Type
Object_2->TypeData->RaysIgnoreObject = RaysIgnoreObjectType_Always;

Matlab

% Set Rays Ignore Object = Always for object 2
% TypeData includes all settings in Object Properties > Type
Object_2.TypeData.RaysIgnoreObject = ZOSAPI.Editors.NCE.RaysIgnoreObjectType.Always;
Definition: InterfacesNCE.cs:19
Definition: InterfacesEditors.cs:12
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

Python

# Set Rays Ignore Object = Always for object 2
# TypeData includes all settings in Object Properties > Type
Object_2.TypeData.RaysIgnoreObject = ZOSAPI.Editors.NCE.RaysIgnoreObjectType.Always

◆ RecordPixelSpectralData

bool ZOSAPI.Editors.NCE.INCETypeData.RecordPixelSpectralData
getset

◆ RecordSpectralData

bool ZOSAPI.Editors.NCE.INCETypeData.RecordSpectralData
getset

◆ RowColor

ZemaxColor ZOSAPI.Editors.NCE.INCETypeData.RowColor
getset

◆ SpectralDataMaxWave

double ZOSAPI.Editors.NCE.INCETypeData.SpectralDataMaxWave
getset

◆ SpectralDataMinWave

double ZOSAPI.Editors.NCE.INCETypeData.SpectralDataMinWave
getset

◆ UDAFile

string ZOSAPI.Editors.NCE.INCETypeData.UDAFile
getset

◆ UDAScale

double ZOSAPI.Editors.NCE.INCETypeData.UDAScale
getset

◆ UseConsiderIgnoreWhenSplitting

bool ZOSAPI.Editors.NCE.INCETypeData.UseConsiderIgnoreWhenSplitting
getset

◆ UseFastApproximateRayTrace

bool ZOSAPI.Editors.NCE.INCETypeData.UseFastApproximateRayTrace
getset

◆ UseGlobalXYZRotationOrder

bool ZOSAPI.Editors.NCE.INCETypeData.UseGlobalXYZRotationOrder
getset

◆ UsePixelInterpolation

bool ZOSAPI.Editors.NCE.INCETypeData.UsePixelInterpolation
getset

Usage (see Example 24 for a full sample)

C#

// Removes pixel interpolation for the detector
o4.TypeData.UsePixelInterpolation = false;

C++

// Removes pixel interpolation for the detector
o4->TypeData->UsePixelInterpolation = false;

Matlab

% removes pixel interpolation for the detector
o4.TypeData.UsePixelInterpolation = false;

Python

# removes pixel interpolation for the detector
o4.TypeData.UsePixelInterpolation = False

◆ UserDefinedAperture

bool ZOSAPI.Editors.NCE.INCETypeData.UserDefinedAperture
getset

Connect with Ansys