Interface ZOSAPI::Editors::NCE::IObjectTypeSettings
Last update: 13.03.2026
Definition:
This interface is used for selecting any files required by a object, and for changing object types. This interface can be accessed via the INCERow interface.
Members
Properties
Property Type
Definition:
ObjectType ZOSAPI.Editors.NCE.IObjectTypeSettings.Type
Gets the object type for this interface.
Usage (see Example 24 for a full sample)
C#
// Changes Object Type
TheNCE.GetObjectAt(1).ChangeType(o1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourceEllipse));
o2.ChangeType(o2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.AsphericSurface2));
o3.ChangeType(o3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.StandardLens));
o4.ChangeType(o4.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorColor));
o5.ChangeType(o5.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle));
C++
// Changes Object Type
IObjectTypeSettingsPtr oType_1 = o1->GetObjectTypeSettings(ObjectType_SourceEllipse);
o1->ChangeType(oType_1);
o2->ChangeType((IObjectTypeSettingsPtr)o2->GetObjectTypeSettings(ObjectType_AsphericSurface2));
o3->ChangeType((IObjectTypeSettingsPtr)o3->GetObjectTypeSettings(ObjectType_StandardLens));
o4->ChangeType((IObjectTypeSettingsPtr)o4->GetObjectTypeSettings(ObjectType_DetectorColor));
o5->ChangeType((IObjectTypeSettingsPtr)o5->GetObjectTypeSettings(ObjectType_DetectorRectangle));
Matlab
% Changes Object Type
TheNCE.GetObjectAt(1).ChangeType(o1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourceEllipse));
o2.ChangeType(o2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.AsphericSurface2));
o3.ChangeType(o3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.StandardLens));
o4.ChangeType(o4.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorColor));
o5.ChangeType(o5.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle));
Python
# Changes Object Type
TheNCE.GetObjectAt(1).ChangeType(o1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourceEllipse))
o2.ChangeType(o2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.AsphericSurface2))
o3.ChangeType(o3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.StandardLens))
o4.ChangeType(o4.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorColor))
o5.ChangeType(o5.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle))
The type.
Return type: ObjectType
Property IsValid
Definition:
bool ZOSAPI.Editors.NCE.IObjectTypeSettings.IsValid
Gets a value indicating whether all settings are valid.
true if this instance is valid; otherwise, false.
Return type: bool
Property RequiresFile1
Definition:
bool ZOSAPI.Editors.NCE.IObjectTypeSettings.RequiresFile1
Gets a value indicating whether this object type requires an external file to function.
true if a file is required; otherwise, false.
Return type: bool
Property FileName1
Definition:
string ZOSAPI.Editors.NCE.IObjectTypeSettings.FileName1
Gets or sets the currently selected file name.
Usage (see Example 21 for a full sample)
C#
// Set 1st object as a Source File
INCERow Object_1 = TheNCE.GetObjectAt(1);
IObjectTypeSettings Typeset_SourceFile = Object_1.GetObjectTypeSettings(ObjectType.SourceFile);
Typeset_SourceFile.FileName1 = "RAYFILE_LB_T67C_100K_190608_ZEMAX.DAT";
Object_1.ChangeType(Typeset_SourceFile);
Object_1.GetObjectCell(ObjectColumn.Par1).IntegerValue = 5;
Object_1.GetObjectCell(ObjectColumn.Par2).IntegerValue = 1000;
Object_1.GetObjectCell(ObjectColumn.Par3).DoubleValue = 2.485572;
Object_1.GetObjectCell(ObjectColumn.Par8).DoubleValue = 0.47;
Object_1.GetObjectCell(ObjectColumn.Par9).DoubleValue = 0.47;
C++
// Set 1st object as a Source File
INCERowPtr Object_1 = TheNCE->GetObjectAt(1);
IObjectTypeSettingsPtr Typeset_SourceFile = Object_1->GetObjectTypeSettings(ObjectType_SourceFile);
Typeset_SourceFile->FileName1 = "RAYFILE_LB_T67C_100K_190608_ZEMAX.DAT";
Object_1->ChangeType(Typeset_SourceFile);
Object_1->GetObjectCell(ObjectColumn_Par1)->IntegerValue = 5;
Object_1->GetObjectCell(ObjectColumn_Par2)->IntegerValue = 1000;
Object_1->GetObjectCell(ObjectColumn_Par3)->DoubleValue = 2.485572;
Object_1->GetObjectCell(ObjectColumn_Par8)->DoubleValue = 0.47;
Object_1->GetObjectCell(ObjectColumn_Par9)->DoubleValue = 0.47;
Matlab
% Set 1st object as a Source File
Object_1 = TheNCE.GetObjectAt(1);
Typeset_SourceFile = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourceFile);
Typeset_SourceFile.FileName1 = 'RAYFILE_LB_T67C_100K_190608_ZEMAX.DAT';
Object_1.ChangeType(Typeset_SourceFile);
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par1).IntegerValue = 5;
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par2).IntegerValue = 1000;
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par3).DoubleValue = 2.485572;
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par8).DoubleValue = 0.47;
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par9).DoubleValue = 0.47;
Python
# Set 1st object as a Source File
Object_1 = TheNCE.GetObjectAt(1)
Typeset_SourceFile = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourceFile)
Typeset_SourceFile.FileName1 = 'RAYFILE_LB_T67C_100K_190608_ZEMAX.DAT'
Object_1.ChangeType(Typeset_SourceFile)
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par1).IntegerValue = 5
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par2).IntegerValue = 1000
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par3).DoubleValue = 2.485572
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par8).DoubleValue = 0.47
Object_1.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par9).DoubleValue = 0.47
The name of the file. Note that only files returned by GetFileNames1 are allowed.
Return type: string
Property RequiresFile2
Definition:
bool ZOSAPI.Editors.NCE.IObjectTypeSettings.RequiresFile2
Gets a value indicating whether this object type requires an secondary external file to function (such as ObjectType.GridSagFrontBack).
true if a file is required; otherwise, false.
Return type: bool
Property FileName2
Definition:
string ZOSAPI.Editors.NCE.IObjectTypeSettings.FileName2
Gets or sets the currently selected secondary file name.
The name of the file. Note that only files returned by GetFileNames2 are allowed.
Return type: string
Public functions
Function GetFileNames1
string[] ZOSAPI.Editors.NCE.IObjectTypeSettings.GetFileNames1()
Gets all available files for this type.
Returns:
Return type: string[]
Function GetFileNames2
string[] ZOSAPI.Editors.NCE.IObjectTypeSettings.GetFileNames2()
Gets all available secondary files for this type.
Returns:
Return type: string[]
