ZOS-API interface 2024 R1

ZOSAPI.Editors.NCE.INCERow Interface Reference

Last update: 17.07.2025

All data for a Non-Sequential Component Editor object. This interface can be accessed via the INonSeqEditor interface. More...

Inheritance diagram for ZOSAPI.Editors.NCE.INCERow:
Inheritance graph
[legend]

Public Member Functions

IEditorCell GetObjectCell (ObjectColumn Col)
 Gets the specified object cell data.
 
ObjectType[] AvailableObjectTypes ()
 Gets all object types that are available for use.
 
string[] AvailableParameters ()
 Retrieve the headers for all cells used by this object.
 
IObjectTypeSettings GetObjectTypeSettings (ObjectType type)
 Create the settings for the specified type. Use this method to specify any extra data required to change to the appropriate object type (i.e. external files).
 
bool ChangeType (IObjectTypeSettings settings)
 Changes the current object to the specified type. Use GetObjectTypeSettings to get the relevant settings.
 
IFaceData GetFacetedObjectData ()
 Retrieve the facet data for any object marked with INCETypeData.ObjectIsADetector = true.
 
IMetadata GetMetadata ()
 
string FindMaterialCatalog ()
 Find the material catalog containing the material for this row.
 
INCECoatingPerformanceData GetCoatingPerformanceData ()
 Gets the object Coating Performance data.
 
- Public Member Functions inherited from ZOSAPI.Editors.IEditorRow
IEditorCell GetCellAt (int pos)
 Gets the cell at the specified index (IEditor.MinColumn to IEditor.MaxColumn).
 

Properties

bool IsActive [get]
 Gets a value indicating whether this instance is active (i.e. refers to a valid object in the system).
 
int ObjectNumber [get]
 Gets the object number for this row.
 
string TypeName [get]
 
ObjectType Type [get]
 
IObjectTypeSettings CurrentTypeSettings [get]
 Gets settings for the current type (i.e. external files). Note that the current type can only be changed via the ChangeType method.
 
IObject ObjectData [get]
 
INCETypeData TypeData [get]
 Gets the object Type data.
 
INCEDrawData DrawData [get]
 Gets the object Draw data.
 
INCESourcesData SourcesData [get]
 Gets the object Sources data.
 
INCECoatScatterData CoatScatterData [get]
 Gets the object Coat/Scatter data.
 
INCEScatterToData ScatterToData [get]
 Gets the object Type data.
 
INCEVolumePhysicsData VolumePhysicsData [get]
 Gets the object Volume Physics data.
 
INCEIndexData IndexData [get]
 Gets the object Index data.
 
INCEDiffractionData DiffractionData [get]
 Gets the object Diffraction data.
 
INCECADData CADData [get]
 Gets the object CAD data.
 
string Comment [get, set]
 
IEditorCell CommentCell [get]
 
int RefObject [get, set]
 
IEditorCell RefObjectCell [get]
 
int InsideOf [get, set]
 
IEditorCell InsideOfCell [get]
 
double XPosition [get, set]
 
IEditorCell XPositionCell [get]
 
double YPosition [get, set]
 
IEditorCell YPositionCell [get]
 
double ZPosition [get, set]
 
IEditorCell ZPositionCell [get]
 
double TiltAboutX [get, set]
 
IEditorCell TiltAboutXCell [get]
 
double TiltAboutY [get, set]
 
IEditorCell TiltAboutYCell [get]
 
double TiltAboutZ [get, set]
 
IEditorCell TiltAboutZCell [get]
 
string Material [get, set]
 
IEditorCell MaterialCell [get]
 
long ObjectId [get]
 
- Properties inherited from ZOSAPI.Editors.IEditorRow
IEditor Editor [get]
 Gets the editor this row was retrieved from.
 
bool IsValidRow [get]
 Gets a value indicating whether this instance is currently valid. Note that the RowIndex for this object is fixed, so removing one or more rows from the editor may cause it to be invalid.
 
int RowIndex [get]
 Gets the index of this row in the editor.
 
string RowTypeName [get]
 Gets the type of this row; this can be a surface for the LDE, object for the NCE, etc.
 
string Bookmark [get, set]
 

Detailed Description

All data for a Non-Sequential Component Editor object. This interface can be accessed via the INonSeqEditor interface.

Examples
CSharpStandalone_06_nsc_phase.cs, CSharpStandalone_08_NSCEDetectorData.cs, CSharpStandalone_09_NSC_CAD.cs, CSharpStandalone_17_NSC_BulkScatter.cs, CSharpStandalone_21_White_LED_Phosphor.cs, CSharpStandalone_24_nsc_detectors.cs, and CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

Member Function Documentation

◆ AvailableObjectTypes()

ObjectType[] ZOSAPI.Editors.NCE.INCERow.AvailableObjectTypes ( )

Gets all object types that are available for use.

Returns

◆ AvailableParameters()

string[] ZOSAPI.Editors.NCE.INCERow.AvailableParameters ( )

Retrieve the headers for all cells used by this object.

Usage (see Example 09 for a full sample)

C#

// Access the CAD settings for object 1
INCECADData Obj1_CAD = Obj1.CADData; // Retrieve CAD data
// Determine if the surface-to-face mappint is available for this object.
// If available, update the mapping based on the total number of surfaces in the system
if (Obj1_CAD.HasFaceData)
{
if (Obj1_CAD.NumberOfSurfaces > 1)
{
// Assign the last face to surface 0. Now, the first and last surfaces will be defined with the same scatter and coating properties
Obj1_CAD.SetSurfaceFace(0, Obj1_CAD.NumberOfSurfaces - 1);
}
}
ZOSAPI.Editors.NCE.INCECADData
Object properties CAD tab. This interface can be accessed via the INCERow interface.
Definition: InterfacesNCE.cs:6972
ZOSAPI.Editors.NCE.INCECADData.NumberOfSurfaces
int NumberOfSurfaces
Definition: InterfacesNCE.cs:7010
ZOSAPI.Editors.NCE.INCECADData.HasFaceData
bool HasFaceData
Definition: InterfacesNCE.cs:7009
ZOSAPI.Editors.NCE.INCECADData.SetSurfaceFace
bool SetSurfaceFace(int surfaceIdx, int face)
Sets the face assigned to the specified surface.

C++

// Access the CAD settings for object 1
INCECADDataPtr Obj1_CAD = Obj1->CADData; // Retrieve CAD data
// Determine if surface-to-face mapping is available for this object. If yes, update the mapping.
if (Obj1_CAD->HasFaceData)
{
if (Obj1_CAD->NumberOfSurfaces > 1)
{
// Assign last face to surface 0. Now, the first and last surfaces will be defined with the same scatter and coating properties
Obj1_CAD->SetSurfaceFace(0, Obj1_CAD->NumberOfSurfaces - 1);
}
}

Matlab

% Access the CAD settings for object 1
Obj1_CAD = Obj1.CADData; % Retrieve CAD data
% Determine if the surface-to-face mapping is available for this
% object. If yes, update the mapping
if Obj1_CAD.HasFaceData
if Obj1_CAD.NumberOfSurfaces > 1
% Assign last face to surface 0. Now the first and last surface
% will be defined with the same scatter and coating properties.
Obj1_CAD.SetSurfaceFace(0, Obj1_CAD.NumberOfSurfaces-1);
end
end

Python

# Access the CAD settings for object 1
Obj1_CAD = Obj1.CADData
# Determine if the surface-to-face mapping is available for this object. If yes, update the mapping
if Obj1_CAD.HasFaceData:
if Obj1_CAD.NumberOfSurfaces > 1:
# Assign the last face to surface 0. Now, the first and last surfaces will be defined with the same scatter and coating properties.
Obj1_CAD.SetSurfaceFace(0, Obj1_CAD.NumberOfSurfaces-1)
Returns

◆ ChangeType()

bool ZOSAPI.Editors.NCE.INCERow.ChangeType ( IObjectTypeSettings  settings)

Changes the current object to the specified type. Use GetObjectTypeSettings to get the relevant settings.

Usage (see Example 17 for a full sample)

C#

//Source point
IObjectTypeSettings oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourcePoint);
Object_1.ChangeType(oType_1);
IObjectSourcePoint Source1_data = Object_1.ObjectData as IObjectSourcePoint;
Source1_data.NumberOfLayoutRays = 3;
Source1_data.NumberOfAnalysisRays = 1000000;
ZOSAPI.Editors.NCE.IObjectSourcePoint
Definition: InterfacesNCE.cs:4937
ZOSAPI.Editors.NCE.IObjectTypeSettings
This interface is used for selecting any files required by a object, and for changing object types....
Definition: InterfacesNCE.cs:1110
ZOSAPI.Editors.NCE
Definition: InterfacesNCE.cs:19
ZOSAPI.Editors
Definition: InterfacesEditors.cs:12
ZOSAPI
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

C++

//Source point
IObjectTypeSettingsPtr oType_1 = Object_1->GetObjectTypeSettings(ObjectType_SourcePoint);
Object_1->ChangeType(oType_1);
IObjectSourcePointPtr Source1_data = Object_1->ObjectData;
// Proterties NumberOfLayoutRays and NumberOfAnalysisRays belong to base interface IObjectSources. To use these properties, cast to IObjectSources first.
IObjectSourcesPtr caseIObjSources = Source1_data;
caseIObjSources->NumberOfLayoutRays = 3;
caseIObjSources->NumberOfAnalysisRays = 1000000;

Matlab

% Source point
oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourcePoint);
Object_1.ChangeType(oType_1);
Source1_data = Object_1.ObjectData;
Source1_data.NumberOfLayoutRays = 3;
Source1_data.NumberOfAnalysisRays = 1000000;

Python

# Source point
oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourcePoint)
Object_1.ChangeType(oType_1)
Source1_data = Object_1.ObjectData
Source1_data.NumberOfLayoutRays = 3
Source1_data.NumberOfAnalysisRays = 1000000
Parameters
settingsThe settings.
Returns
true if the change was successful.
Examples
CSharpStandalone_06_nsc_phase.cs, CSharpStandalone_08_NSCEDetectorData.cs, CSharpStandalone_09_NSC_CAD.cs, CSharpStandalone_17_NSC_BulkScatter.cs, CSharpStandalone_21_White_LED_Phosphor.cs, CSharpStandalone_24_nsc_detectors.cs, and CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

◆ FindMaterialCatalog()

string ZOSAPI.Editors.NCE.INCERow.FindMaterialCatalog ( )

Find the material catalog containing the material for this row.

Returns

◆ GetCoatingPerformanceData()

INCECoatingPerformanceData ZOSAPI.Editors.NCE.INCERow.GetCoatingPerformanceData ( )

Gets the object Coating Performance data.

The Coating Performance data interface.

◆ GetFacetedObjectData()

IFaceData ZOSAPI.Editors.NCE.INCERow.GetFacetedObjectData ( )

Retrieve the facet data for any object marked with INCETypeData.ObjectIsADetector = true.

Returns
The IFaceData interface with the triangle and intensity data for all facets.

◆ GetMetadata()

IMetadata ZOSAPI.Editors.NCE.INCERow.GetMetadata ( )

◆ GetObjectCell()

IEditorCell ZOSAPI.Editors.NCE.INCERow.GetObjectCell ( ObjectColumn  Col)

Gets the specified object cell data.

Usage (see Example 24 for a full sample)

C#

// Sets layout rays based on parameter number
TheNCE.GetObjectAt(1).GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par1).IntegerValue = 100;
// Sets analysis rays based on object data column
ZOSAPI.Editors.NCE.IObjectSourceEllipse sourcedata = o1.ObjectData as ZOSAPI.Editors.NCE.IObjectSourceEllipse;
sourcedata.NumberOfAnalysisRays = (int)1E6;
ZOSAPI.Editors.NCE.IObjectSourceEllipse
Definition: InterfacesNCE.cs:4809

C++

// Sets layout rays based on parameter number
TheNCE->GetObjectAt(1)->GetObjectCell(ObjectColumn_Par1)->IntegerValue = 100;
// Sets analysis rays based on object data column
IObjectSourcesPtr sourcedata = o1->ObjectData;
sourcedata->NumberOfAnalysisRays = (int)1E6;

Matlab

% Sets layout rays based on parameter number
TheNCE.GetObjectAt(1).GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par1).IntegerValue = 100;
% Sets analysis rays based on object data column
TheNCE.GetObjectAt(1).ObjectData.NumberOfAnalysisRays = 1E6;

Python

# Sets layout rays based on parameter number
TheNCE.GetObjectAt(1).GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par1).IntegerValue = 100
# Sets analysis rays based on object data column
o1.ObjectData.NumberOfAnalysisRays = 1E6
Parameters
ColThe column.
Returns
Examples
CSharpStandalone_21_White_LED_Phosphor.cs, CSharpStandalone_24_nsc_detectors.cs, and CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

◆ GetObjectTypeSettings()

IObjectTypeSettings ZOSAPI.Editors.NCE.INCERow.GetObjectTypeSettings ( ObjectType  type)

Create the settings for the specified type. Use this method to specify any extra data required to change to the appropriate object type (i.e. external files).

Usage (see Example 17 for a full sample)

C#

//Source point
IObjectTypeSettings oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourcePoint);
Object_1.ChangeType(oType_1);
IObjectSourcePoint Source1_data = Object_1.ObjectData as IObjectSourcePoint;
Source1_data.NumberOfLayoutRays = 3;
Source1_data.NumberOfAnalysisRays = 1000000;

C++

//Source point
IObjectTypeSettingsPtr oType_1 = Object_1->GetObjectTypeSettings(ObjectType_SourcePoint);
Object_1->ChangeType(oType_1);
IObjectSourcePointPtr Source1_data = Object_1->ObjectData;
// Proterties NumberOfLayoutRays and NumberOfAnalysisRays belong to base interface IObjectSources. To use these properties, cast to IObjectSources first.
IObjectSourcesPtr caseIObjSources = Source1_data;
caseIObjSources->NumberOfLayoutRays = 3;
caseIObjSources->NumberOfAnalysisRays = 1000000;

Matlab

% Source point
oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourcePoint);
Object_1.ChangeType(oType_1);
Source1_data = Object_1.ObjectData;
Source1_data.NumberOfLayoutRays = 3;
Source1_data.NumberOfAnalysisRays = 1000000;

Python

# Source point
oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourcePoint)
Object_1.ChangeType(oType_1)
Source1_data = Object_1.ObjectData
Source1_data.NumberOfLayoutRays = 3
Source1_data.NumberOfAnalysisRays = 1000000
Parameters
typeThe desired type.
Returns
Examples
CSharpStandalone_06_nsc_phase.cs, CSharpStandalone_08_NSCEDetectorData.cs, CSharpStandalone_09_NSC_CAD.cs, CSharpStandalone_17_NSC_BulkScatter.cs, CSharpStandalone_21_White_LED_Phosphor.cs, CSharpStandalone_24_nsc_detectors.cs, and CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

Property Documentation

◆ CADData

INCECADData ZOSAPI.Editors.NCE.INCERow.CADData
get

Gets the object CAD data.

Usage (see Example 09 for a full sample)

C#

// Access the CAD settings for object 1
INCECADData Obj1_CAD = Obj1.CADData; // Retrieve CAD data
// Determine if the surface-to-face mappint is available for this object.
// If available, update the mapping based on the total number of surfaces in the system
if (Obj1_CAD.HasFaceData)
{
if (Obj1_CAD.NumberOfSurfaces > 1)
{
// Assign the last face to surface 0. Now, the first and last surfaces will be defined with the same scatter and coating properties
Obj1_CAD.SetSurfaceFace(0, Obj1_CAD.NumberOfSurfaces - 1);
}
}

C++

// Access the CAD settings for object 1
INCECADDataPtr Obj1_CAD = Obj1->CADData; // Retrieve CAD data
// Determine if surface-to-face mapping is available for this object. If yes, update the mapping.
if (Obj1_CAD->HasFaceData)
{
if (Obj1_CAD->NumberOfSurfaces > 1)
{
// Assign last face to surface 0. Now, the first and last surfaces will be defined with the same scatter and coating properties
Obj1_CAD->SetSurfaceFace(0, Obj1_CAD->NumberOfSurfaces - 1);
}
}

Matlab

% Access the CAD settings for object 1
Obj1_CAD = Obj1.CADData; % Retrieve CAD data
% Determine if the surface-to-face mapping is available for this
% object. If yes, update the mapping
if Obj1_CAD.HasFaceData
if Obj1_CAD.NumberOfSurfaces > 1
% Assign last face to surface 0. Now the first and last surface
% will be defined with the same scatter and coating properties.
Obj1_CAD.SetSurfaceFace(0, Obj1_CAD.NumberOfSurfaces-1);
end
end

Python

# Access the CAD settings for object 1
Obj1_CAD = Obj1.CADData
# Determine if the surface-to-face mapping is available for this object. If yes, update the mapping
if Obj1_CAD.HasFaceData:
if Obj1_CAD.NumberOfSurfaces > 1:
# Assign the last face to surface 0. Now, the first and last surfaces will be defined with the same scatter and coating properties.
Obj1_CAD.SetSurfaceFace(0, Obj1_CAD.NumberOfSurfaces-1)

The CAD data interface.

Examples
CSharpStandalone_09_NSC_CAD.cs.

◆ CoatScatterData

INCECoatScatterData ZOSAPI.Editors.NCE.INCERow.CoatScatterData
get

Gets the object Coat/Scatter data.

The Coat/Scatter data interface.

Examples
CSharpStandalone_21_White_LED_Phosphor.cs, and CSharpStandalone_24_nsc_detectors.cs.

◆ Comment

string ZOSAPI.Editors.NCE.INCERow.Comment
getset

◆ CommentCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.CommentCell
get

◆ CurrentTypeSettings

IObjectTypeSettings ZOSAPI.Editors.NCE.INCERow.CurrentTypeSettings
get

Gets settings for the current type (i.e. external files). Note that the current type can only be changed via the ChangeType method.

The current type settings.

◆ DiffractionData

INCEDiffractionData ZOSAPI.Editors.NCE.INCERow.DiffractionData
get

Gets the object Diffraction data.

The Diffraction data interface.

◆ DrawData

INCEDrawData ZOSAPI.Editors.NCE.INCERow.DrawData
get

Gets the object Draw data.

Usage (see Example 17 for a full sample)

C#

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettings oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = "N-BK7";
IObjectRectangularVolume RectVolume2_data = Object_2.ObjectData as IObjectRectangularVolume;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
INCEVolumePhysicsData RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30;
INCEDrawData RectVolume2_Drawdata = Object_2.DrawData;
RectVolume2_Drawdata.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;
ZOSAPI.Editors.NCE.INCEDrawData
Object properties Draw tab. This interface can be accessed via the INCERow interface.
Definition: InterfacesNCE.cs:5789
ZOSAPI.Editors.NCE.INCEVolumePhysicsData
Object properties Volume Physics tab. This interface can be accessed via the INCERow interface.
Definition: InterfacesNCE.cs:6551
ZOSAPI.Editors.NCE.IObjectRectangularVolume
Definition: InterfacesNCE.cs:4582
ZOSAPI.Common
Definition: InterfacesCommon.cs:9
ZOSAPI.Editors.NCE.VolumePhysicsModelType
VolumePhysicsModelType
Definition: InterfacesNCE.cs:6537

C++

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettingsPtr oType_2 = Object_2->GetObjectTypeSettings(ObjectType_RectangularVolume);
Object_2->ChangeType(oType_2);
Object_2->ZPosition = 2;
Object_2->Material = "N-BK7";
IObjectRectangularVolumePtr RectVolume2_data = Object_2->ObjectData;
RectVolume2_data->X1HalfWidth = 12;
RectVolume2_data->Y1HalfWidth = 12;
RectVolume2_data->ZLength = 40;
RectVolume2_data->X2HalfWidth = 12;
RectVolume2_data->Y2HalfWidth = 12;
INCEVolumePhysicsDataPtr RectVolume2_volphysdata = Object_2->VolumePhysicsData;
RectVolume2_volphysdata->Model = VolumePhysicsModelType_AngleScattering;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->MeanPath = 5;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->Angle = 30;
INCEDrawDataPtr RectVolume2_Drawdata = Object_2->DrawData;
RectVolume2_Drawdata->Opacity = ZemaxOpacity_P50;

Matlabz

% Rectangular Volume
% Scattering Properties
% Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = 'N-BK7';
RectVolume2_data = Object_2.ObjectData;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.Angle = 30;
RectVolume2_DrawData = Object_2.DrawData;
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

Python

# Rectangular Volume
# Scattering Properties
# Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume)
Object_2.ChangeType(oType_2)
Object_2.ZPosition = 2
Object_2.Material = "N-BK7"
RectVolume2_data = Object_2.ObjectData
RectVolume2_data.X1HalfWidth = 12
RectVolume2_data.Y1HalfWidth = 12
RectVolume2_data.ZLength = 40
RectVolume2_data.X2HalfWidth = 12
RectVolume2_data.Y2HalfWidth = 12
RectVolume2_volphysdata = Object_2.VolumePhysicsData
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30
RectVolume2_DrawData = Object_2.DrawData
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50

The Draw data interface.

Examples
CSharpStandalone_17_NSC_BulkScatter.cs.

◆ IndexData

INCEIndexData ZOSAPI.Editors.NCE.INCERow.IndexData
get

Gets the object Index data.

The Index data interface.

◆ InsideOf

int ZOSAPI.Editors.NCE.INCERow.InsideOf
getset

◆ InsideOfCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.InsideOfCell
get

◆ IsActive

bool ZOSAPI.Editors.NCE.INCERow.IsActive
get

Gets a value indicating whether this instance is active (i.e. refers to a valid object in the system).

true if this instance is active; otherwise, false.

◆ Material

string ZOSAPI.Editors.NCE.INCERow.Material
getset

Usage (see Example 17 for a full sample)

C#

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettings oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = "N-BK7";
IObjectRectangularVolume RectVolume2_data = Object_2.ObjectData as IObjectRectangularVolume;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
INCEVolumePhysicsData RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30;
INCEDrawData RectVolume2_Drawdata = Object_2.DrawData;
RectVolume2_Drawdata.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

C++

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettingsPtr oType_2 = Object_2->GetObjectTypeSettings(ObjectType_RectangularVolume);
Object_2->ChangeType(oType_2);
Object_2->ZPosition = 2;
Object_2->Material = "N-BK7";
IObjectRectangularVolumePtr RectVolume2_data = Object_2->ObjectData;
RectVolume2_data->X1HalfWidth = 12;
RectVolume2_data->Y1HalfWidth = 12;
RectVolume2_data->ZLength = 40;
RectVolume2_data->X2HalfWidth = 12;
RectVolume2_data->Y2HalfWidth = 12;
INCEVolumePhysicsDataPtr RectVolume2_volphysdata = Object_2->VolumePhysicsData;
RectVolume2_volphysdata->Model = VolumePhysicsModelType_AngleScattering;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->MeanPath = 5;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->Angle = 30;
INCEDrawDataPtr RectVolume2_Drawdata = Object_2->DrawData;
RectVolume2_Drawdata->Opacity = ZemaxOpacity_P50;

Matlab

% Rectangular Volume
% Scattering Properties
% Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = 'N-BK7';
RectVolume2_data = Object_2.ObjectData;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.Angle = 30;
RectVolume2_DrawData = Object_2.DrawData;
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

Python

# Rectangular Volume
# Scattering Properties
# Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume)
Object_2.ChangeType(oType_2)
Object_2.ZPosition = 2
Object_2.Material = "N-BK7"
RectVolume2_data = Object_2.ObjectData
RectVolume2_data.X1HalfWidth = 12
RectVolume2_data.Y1HalfWidth = 12
RectVolume2_data.ZLength = 40
RectVolume2_data.X2HalfWidth = 12
RectVolume2_data.Y2HalfWidth = 12
RectVolume2_volphysdata = Object_2.VolumePhysicsData
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30
RectVolume2_DrawData = Object_2.DrawData
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50
Examples
CSharpStandalone_24_nsc_detectors.cs.

◆ MaterialCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.MaterialCell
get

◆ ObjectData

IObject ZOSAPI.Editors.NCE.INCERow.ObjectData
get

Usage (see Example 17 for a full sample)

C#

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettings oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = "N-BK7";
IObjectRectangularVolume RectVolume2_data = Object_2.ObjectData as IObjectRectangularVolume;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
INCEVolumePhysicsData RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30;
INCEDrawData RectVolume2_Drawdata = Object_2.DrawData;
RectVolume2_Drawdata.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

C++

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettingsPtr oType_2 = Object_2->GetObjectTypeSettings(ObjectType_RectangularVolume);
Object_2->ChangeType(oType_2);
Object_2->ZPosition = 2;
Object_2->Material = "N-BK7";
IObjectRectangularVolumePtr RectVolume2_data = Object_2->ObjectData;
RectVolume2_data->X1HalfWidth = 12;
RectVolume2_data->Y1HalfWidth = 12;
RectVolume2_data->ZLength = 40;
RectVolume2_data->X2HalfWidth = 12;
RectVolume2_data->Y2HalfWidth = 12;
INCEVolumePhysicsDataPtr RectVolume2_volphysdata = Object_2->VolumePhysicsData;
RectVolume2_volphysdata->Model = VolumePhysicsModelType_AngleScattering;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->MeanPath = 5;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->Angle = 30;
INCEDrawDataPtr RectVolume2_Drawdata = Object_2->DrawData;
RectVolume2_Drawdata->Opacity = ZemaxOpacity_P50;

Matlab

% Rectangular Volume
% Scattering Properties
% Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = 'N-BK7';
RectVolume2_data = Object_2.ObjectData;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.Angle = 30;
RectVolume2_DrawData = Object_2.DrawData;
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

Python

# Rectangular Volume
# Scattering Properties
# Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume)
Object_2.ChangeType(oType_2)
Object_2.ZPosition = 2
Object_2.Material = "N-BK7"
RectVolume2_data = Object_2.ObjectData
RectVolume2_data.X1HalfWidth = 12
RectVolume2_data.Y1HalfWidth = 12
RectVolume2_data.ZLength = 40
RectVolume2_data.X2HalfWidth = 12
RectVolume2_data.Y2HalfWidth = 12
RectVolume2_volphysdata = Object_2.VolumePhysicsData
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30
RectVolume2_DrawData = Object_2.DrawData
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50

i

Examples
CSharpStandalone_06_nsc_phase.cs.

◆ ObjectId

long ZOSAPI.Editors.NCE.INCERow.ObjectId
get

◆ ObjectNumber

int ZOSAPI.Editors.NCE.INCERow.ObjectNumber
get

Gets the object number for this row.

The object number.

◆ RefObject

int ZOSAPI.Editors.NCE.INCERow.RefObject
getset

Usage (see Example 17 for a full sample)

C#

//Detector Rectangle
IObjectTypeSettings oType_3 = Object_3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle);
Object_3.RefObject = 2;
Object_3.ZPosition = 42;
Object_3.Material = "ABSORB";
Object_3.ChangeType(oType_3);
IObjectDetectorRectangle DetRect3_data = Object_3.ObjectData as IObjectDetectorRectangle;
DetRect3_data.XHalfWidth = 15;
DetRect3_data.YHalfWidth = 15;
DetRect3_data.NumberXPixels = 25;
DetRect3_data.NumberYPixels = 25;
DetRect3_data.DataType = 0;
DetRect3_data.Color = 2;
DetRect3_data.Smoothing = 1;
ZOSAPI.Editors.NCE.IObjectDetectorRectangle
Definition: InterfacesNCE.cs:3274

C++

//Detector Rectangle
IObjectTypeSettingsPtr oType_3 = Object_3->GetObjectTypeSettings(ObjectType_DetectorRectangle);
Object_3->RefObject = 2;
Object_3->ZPosition = 42;
Object_3->Material = "ABSORB";
Object_3->ChangeType(oType_3);
IObjectDetectorRectanglePtr DetRect3_data = Object_3->ObjectData;
DetRect3_data->XHalfWidth = 15;
DetRect3_data->YHalfWidth = 15;
DetRect3_data->NumberXPixels = 25;
DetRect3_data->NumberYPixels = 25;
DetRect3_data->DataType = 0;
DetRect3_data->Color = 2;
DetRect3_data->Smoothing = 1;

Matlab

% Detector Rectangle
oType_3 = Object_3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle);
Object_3.RefObject = 2;
Object_3.ZPosition = 42;
Object_3.Material = 'ABSORB';
Object_3.ChangeType(oType_3);
DetRect3_data = Object_3.ObjectData;
DetRect3_data.XHalfWidth = 15;
DetRect3_data.YHalfWidth = 15;
DetRect3_data.NumberXPixels = 25;
DetRect3_data.NumberYPixels = 25;
DetRect3_data.DataType = 0;
DetRect3_data.Color = 2;
DetRect3_data.Smoothing = 1;

Python

# Detector Rectangle
oType_3 = Object_3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle)
Object_3.RefObject = 2
Object_3.ZPosition = 42
Object_3.Material = "ABSORB"
Object_3.ChangeType(oType_3)
DetRect3_data = Object_3.ObjectData
DetRect3_data.XHalfWidth = 15
DetRect3_data.YHalfWidth = 15
DetRect3_data.NumberXPixels = 25
DetRect3_data.NumberYPixels = 25
DetRect3_data.DataType = 0
DetRect3_data.Color = 2
DetRect3_data.Smoothing = 1

◆ RefObjectCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.RefObjectCell
get

◆ ScatterToData

INCEScatterToData ZOSAPI.Editors.NCE.INCERow.ScatterToData
get

Gets the object Type data.

The Type data interface.

◆ SourcesData

INCESourcesData ZOSAPI.Editors.NCE.INCERow.SourcesData
get

Gets the object Sources data.

The Sources data interface.

◆ TiltAboutX

double ZOSAPI.Editors.NCE.INCERow.TiltAboutX
getset

◆ TiltAboutXCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.TiltAboutXCell
get

◆ TiltAboutY

double ZOSAPI.Editors.NCE.INCERow.TiltAboutY
getset

◆ TiltAboutYCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.TiltAboutYCell
get

◆ TiltAboutZ

double ZOSAPI.Editors.NCE.INCERow.TiltAboutZ
getset

◆ TiltAboutZCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.TiltAboutZCell
get

◆ Type

ObjectType ZOSAPI.Editors.NCE.INCERow.Type
get

◆ TypeData

INCETypeData ZOSAPI.Editors.NCE.INCERow.TypeData
get

Gets the object Type data.

The Type data interface.

◆ TypeName

string ZOSAPI.Editors.NCE.INCERow.TypeName
get

◆ VolumePhysicsData

INCEVolumePhysicsData ZOSAPI.Editors.NCE.INCERow.VolumePhysicsData
get

Gets the object Volume Physics data.

Usage (see Example 17 for a full sample)

C#

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettings oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = "N-BK7";
IObjectRectangularVolume RectVolume2_data = Object_2.ObjectData as IObjectRectangularVolume;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
INCEVolumePhysicsData RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30;
INCEDrawData RectVolume2_Drawdata = Object_2.DrawData;
RectVolume2_Drawdata.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

C++

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettingsPtr oType_2 = Object_2->GetObjectTypeSettings(ObjectType_RectangularVolume);
Object_2->ChangeType(oType_2);
Object_2->ZPosition = 2;
Object_2->Material = "N-BK7";
IObjectRectangularVolumePtr RectVolume2_data = Object_2->ObjectData;
RectVolume2_data->X1HalfWidth = 12;
RectVolume2_data->Y1HalfWidth = 12;
RectVolume2_data->ZLength = 40;
RectVolume2_data->X2HalfWidth = 12;
RectVolume2_data->Y2HalfWidth = 12;
INCEVolumePhysicsDataPtr RectVolume2_volphysdata = Object_2->VolumePhysicsData;
RectVolume2_volphysdata->Model = VolumePhysicsModelType_AngleScattering;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->MeanPath = 5;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->Angle = 30;
INCEDrawDataPtr RectVolume2_Drawdata = Object_2->DrawData;
RectVolume2_Drawdata->Opacity = ZemaxOpacity_P50;

Matlab

% Rectangular Volume
% Scattering Properties
% Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = 'N-BK7';
RectVolume2_data = Object_2.ObjectData;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.Angle = 30;
RectVolume2_DrawData = Object_2.DrawData;
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

Python

# Rectangular Volume
# Scattering Properties
# Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume)
Object_2.ChangeType(oType_2)
Object_2.ZPosition = 2
Object_2.Material = "N-BK7"
RectVolume2_data = Object_2.ObjectData
RectVolume2_data.X1HalfWidth = 12
RectVolume2_data.Y1HalfWidth = 12
RectVolume2_data.ZLength = 40
RectVolume2_data.X2HalfWidth = 12
RectVolume2_data.Y2HalfWidth = 12
RectVolume2_volphysdata = Object_2.VolumePhysicsData
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30
RectVolume2_DrawData = Object_2.DrawData
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50

The Volume Physics data interface.

Examples
CSharpStandalone_17_NSC_BulkScatter.cs, and CSharpStandalone_21_White_LED_Phosphor.cs.

◆ XPosition

double ZOSAPI.Editors.NCE.INCERow.XPosition
getset

Usage (see Example 24 for a full sample)

C#

// Sets positions & materials
TheNCE.GetObjectAt(2).XPosition = 1.5;
TheNCE.GetObjectAt(2).ZPosition = 9.99;
TheNCE.GetObjectAt(2).Material = "ABSORB";

C++

// Sets positions & materials
TheNCE->GetObjectAt(2)->XPosition = 1.5;
TheNCE->GetObjectAt(2)->ZPosition = 9.99;
TheNCE->GetObjectAt(2)->Material = "ABSORB";

Matlab

% Sets positions & materials
TheNCE.GetObjectAt(2).XPosition = 1.5;
TheNCE.GetObjectAt(2).ZPosition = 9.99;
TheNCE.GetObjectAt(2).Material = 'ABSORB';

Python

# Sets positions & materials
TheNCE.GetObjectAt(2).XPosition = 1.5
TheNCE.GetObjectAt(2).ZPosition = 9.99
TheNCE.GetObjectAt(2).Material = 'ABSORB'
Examples
CSharpStandalone_24_nsc_detectors.cs.

◆ XPositionCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.XPositionCell
get

◆ YPosition

double ZOSAPI.Editors.NCE.INCERow.YPosition
getset

◆ YPositionCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.YPositionCell
get

◆ ZPosition

double ZOSAPI.Editors.NCE.INCERow.ZPosition
getset

Usage (see Example 17 for a full sample)

C#

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettings oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = "N-BK7";
IObjectRectangularVolume RectVolume2_data = Object_2.ObjectData as IObjectRectangularVolume;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
INCEVolumePhysicsData RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30;
INCEDrawData RectVolume2_Drawdata = Object_2.DrawData;
RectVolume2_Drawdata.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

C++

//Rectangular Volume
//Scattering properties
//Draw:opacity set to 50%
IObjectTypeSettingsPtr oType_2 = Object_2->GetObjectTypeSettings(ObjectType_RectangularVolume);
Object_2->ChangeType(oType_2);
Object_2->ZPosition = 2;
Object_2->Material = "N-BK7";
IObjectRectangularVolumePtr RectVolume2_data = Object_2->ObjectData;
RectVolume2_data->X1HalfWidth = 12;
RectVolume2_data->Y1HalfWidth = 12;
RectVolume2_data->ZLength = 40;
RectVolume2_data->X2HalfWidth = 12;
RectVolume2_data->Y2HalfWidth = 12;
INCEVolumePhysicsDataPtr RectVolume2_volphysdata = Object_2->VolumePhysicsData;
RectVolume2_volphysdata->Model = VolumePhysicsModelType_AngleScattering;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->MeanPath = 5;
RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->Angle = 30;
INCEDrawDataPtr RectVolume2_Drawdata = Object_2->DrawData;
RectVolume2_Drawdata->Opacity = ZemaxOpacity_P50;

Matlab

% Rectangular Volume
% Scattering Properties
% Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
Object_2.ChangeType(oType_2);
Object_2.ZPosition = 2;
Object_2.Material = 'N-BK7';
RectVolume2_data = Object_2.ObjectData;
RectVolume2_data.X1HalfWidth = 12;
RectVolume2_data.Y1HalfWidth = 12;
RectVolume2_data.ZLength = 40;
RectVolume2_data.X2HalfWidth = 12;
RectVolume2_data.Y2HalfWidth = 12;
RectVolume2_volphysdata = Object_2.VolumePhysicsData;
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.MeanPath = 5;
RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.Angle = 30;
RectVolume2_DrawData = Object_2.DrawData;
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

Python

# Rectangular Volume
# Scattering Properties
# Draw:opacity set to 50%
oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume)
Object_2.ChangeType(oType_2)
Object_2.ZPosition = 2
Object_2.Material = "N-BK7"
RectVolume2_data = Object_2.ObjectData
RectVolume2_data.X1HalfWidth = 12
RectVolume2_data.Y1HalfWidth = 12
RectVolume2_data.ZLength = 40
RectVolume2_data.X2HalfWidth = 12
RectVolume2_data.Y2HalfWidth = 12
RectVolume2_volphysdata = Object_2.VolumePhysicsData
RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5
RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30
RectVolume2_DrawData = Object_2.DrawData
RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50
Examples
CSharpStandalone_24_nsc_detectors.cs.

◆ ZPositionCell

IEditorCell ZOSAPI.Editors.NCE.INCERow.ZPositionCell
get

Connect with Ansys