ZOS-API interface 2024 R2 SP02

ZOSAPI.Editors.NCE Namespace Reference

Last update: 17.07.2025

Classes

interface  IFaceData
 Contains face vertex, normal, intensity, and power data for all facets of detector objects. More...
 
interface  IImportanceSamplingSettings
 
interface  IIMS_Birefringent
 Index Model - Birefringent. This interface can be accessed via the INCEIndexData interface. More...
 
interface  IIMS_GRIN
 Index Model - Gradient Index. This interface can be accessed via the INCEIndexData interface. More...
 
interface  IIMS_Isotropic
 Index Model - Isotropic. This interface can be accessed via the INCEIndexData interface. More...
 
interface  IIndexModelSettings
 Base interface for all specific NCEIndexType settings. This interface can be accessed via the INCEIndexData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the specific index model settings. More...
 
interface  INCECADData
 Object properties CAD tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCECoatingPerformanceData
 
interface  INCECoatingPerformanceFaceData
 
interface  INCECoatScatterData
 Object properties Coat/Scatter tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCECoatScatterFaceData
 Coat/Scatter settings for a specific face. This interface can be accessed via the INCECoatScatterData interface. More...
 
interface  INCEDiffractionData
 Object properties Diffraction tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCEDrawData
 Object properties Draw tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCEIndexData
 Object properties Index tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCERow
 All data for a Non-Sequential Component Editor object. This interface can be accessed via the INonSeqEditor interface. More...
 
interface  INCEScatterToData
 Object properties Scatter To tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCESourcesData
 Object properties Sources tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCETypeData
 Object properties Type tab. This interface can be accessed via the INCERow interface. More...
 
interface  INCEVolumePhysicsData
 Object properties Volume Physics tab. This interface can be accessed via the INCERow interface. More...
 
interface  INonSeqEditor
 This interface defines all properties and methods needed to interact with the Non-Sequential Component Editor. This interface can be accessed via the IOpticalSystem interface. More...
 
interface  IObject
 
interface  IObjectAnnularAsphericLens
 
interface  IObjectAnnularAxialLens
 
interface  IObjectAnnularVolume
 
interface  IObjectAnnulus
 
interface  IObjectArray
 
interface  IObjectArrayRing
 
interface  IObjectAsphericSurface
 
interface  IObjectAsphericSurface2
 
interface  IObjectAxiconSurface
 
interface  IObjectBiconicLens
 
interface  IObjectBiconicSurface
 
interface  IObjectBiconicZernike
 
interface  IObjectBiconicZernikeSurface
 
interface  IObjectBinary1
 
interface  IObjectBinary2
 
interface  IObjectBinary2A
 
interface  IObjectBoolean
 
interface  IObjectBooleanNative
 
interface  IObjectCADAssemblyAutodeskInventor
 
interface  IObjectCADAssemblyCreoParametric
 
interface  IObjectCADAssemblySolidWorks
 
interface  IObjectCADPartAutodeskInventor
 
interface  IObjectCADPartCreoParametric
 
interface  IObjectCADPartSolidWorks
 
interface  IObjectCADPartSTEPIGESSAT
 
interface  IObjectCADPartSTL
 
interface  IObjectCADPartZPD
 
interface  IObjectCompoundLens
 
interface  IObjectCone
 
interface  IObjectCPC
 
interface  IObjectCPCRectangular
 
interface  IObjectCylinder2Pipe
 
interface  IObjectCylinder2Volume
 
interface  IObjectCylinderPipe
 
interface  IObjectCylinderVolume
 
interface  IObjectDetector
 
interface  IObjectDetectorColor
 
interface  IObjectDetectorPolar
 
interface  IObjectDetectorRectangle
 
interface  IObjectDetectorSurface
 
interface  IObjectDetectorVolume
 
interface  IObjectDiffractionGrating
 
interface  IObjectDualBEFSurface
 
interface  IObjectEllipse
 
interface  IObjectEllipticalVolume
 
interface  IObjectEvenAsphereLens
 
interface  IObjectExtendedOddAsphereLens
 
interface  IObjectExtendedPolynomialLens
 
interface  IObjectExtendedPolynomialSurface
 
interface  IObjectExtruded
 
interface  IObjectFacetedSurface
 
interface  IObjectFreeformZ
 
interface  IObjectFresnel1
 
interface  IObjectFresnel2
 
interface  IObjectGridSagFrontBack
 
interface  IObjectGridSagLens
 
interface  IObjectGridSagSurface
 
interface  IObjectHexagonalLensletArray
 
interface  IObjectHologramLens
 
interface  IObjectHologramSurface
 
interface  IObjectJonesMatrix
 
interface  IObjectLensletArray1
 
interface  IObjectLensletArray2
 
interface  IObjectMEMS
 
interface  IObjectNullObject
 
interface  IObjectOddAsphereLens
 
interface  IObjectOffAxisMirror
 
interface  IObjectParaxialLens
 
interface  IObjectPolygon
 
interface  IObjectQTypeAsphereSurface
 
interface  IObjectRayRotator
 
interface  IObjectRectangle
 
interface  IObjectRectangularCorner
 
interface  IObjectRectangularPipe
 
interface  IObjectRectangularPipeGrating
 
interface  IObjectRectangularRoof
 
interface  IObjectRectangularTorusSurface
 
interface  IObjectRectangularTorusVolume
 
interface  IObjectRectangularVolume
 
interface  IObjectRectangularVolumeGrating
 
interface  IObjectReverseRadianceDetector
 
interface  IObjectReverseRadianceTarget
 
interface  IObjectScatteringSettings
 Scatter model settings for a specific face. This interface can be accessed via the INCECoatScatterFaceData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the specific scattering type settings. More...
 
interface  IObjectSlide
 
interface  IObjectSourceDiffractive
 
interface  IObjectSourceDiode
 
interface  IObjectSourceDLL
 
interface  IObjectSourceEllipse
 
interface  IObjectSourceEULUMDATFile
 
interface  IObjectSourceFilament
 
interface  IObjectSourceFile
 
interface  IObjectSourceGaussian
 
interface  IObjectSourceIESNAFile
 
interface  IObjectSourceImported
 
interface  IObjectSourceObject
 
interface  IObjectSourcePoint
 
interface  IObjectSourceRadial
 
interface  IObjectSourceRay
 
interface  IObjectSourceRectangle
 
interface  IObjectSources
 
interface  IObjectSourceTube
 
interface  IObjectSourceTwoAngle
 
interface  IObjectSourceVolumeCylindrical
 
interface  IObjectSourceVolumeElliptical
 
interface  IObjectSourceVolumeRectangular
 
interface  IObjectSphere
 
interface  IObjectStandardLens
 
interface  IObjectStandardSurface
 
interface  IObjectSwept
 
interface  IObjectTabulatedFactedRadial
 
interface  IObjectTabulatedFactedToroid
 
interface  IObjectTabulatedFrenselRadial
 
interface  IObjectToroidalHologram
 
interface  IObjectToroidalLens
 
interface  IObjectToroidalSurface
 
interface  IObjectToroidalSurfaceOddASphere
 
interface  IObjectTorusSurface
 
interface  IObjectTorusVolume
 
interface  IObjectTriangle
 
interface  IObjectTriangularCorner
 
interface  IObjectTypeSettings
 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. More...
 
interface  IObjectUserDefinedObject
 
interface  IObjectWolterSurface
 
interface  IObjectXYPolynomial
 
interface  IObjectZernikeSurface
 
interface  IOSS_ABg
 Object Scattering Settings - ABg. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_ABgFile
 Object Scattering Settings - ABg File. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_BSDF
 Object Scattering Settings - BSDF. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_Gaussian
 Object Scattering Settings - Gaussian. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_ISScatterCatalog
 Object Scattering Settings - IS Scatter Catalog. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_Lambertian
 Object Scattering Settings - Lambertian. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_None
 Object Scattering Settings - None. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  IOSS_User
 Object Scattering Settings - User. This interface can be accessed via the INCECoatScatterFaceData interface. More...
 
interface  ISCS_BlackBodySpectrum
 Source Color Mode - Black Body Spectrum. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_CIE1931Chromaticity
 Source Color Mode - CIE 1931 Chromaticity xy. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_CIE1931RGB
 Source Color Mode - CIE 1931 RGB (Saturated). This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_CIE1931Tristimulus
 Source Color Mode - CIE 1931 Tristimulus XYZ. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_CIE1976
 Source Color Mode - CIE 1976 Chromaticity u' v'. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_ColorTemperature
 Source Color Mode - Color Temperature. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_D65White
 Source Color Mode - D65 White. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_SpectrumFile
 Source Color Mode - Spectrum File. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_SystemWavelengths
 Source Color Mode - System Wavelengths. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISCS_UniformPowerSpectrum
 Source Color Mode - Uniform Power Spectrum. This interface can be accessed via the INCESourcesData interface. More...
 
interface  ISourceColorSettings
 Base interface for all specific SourceColorMode settings. This interface can be accessed via the INCESourcesData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the specific source color settings. More...
 
interface  IVMPS_AngleScattering
 Volume Physics Model - Angle Scattering. This interface can be accessed via the INCEVolumePhysicsData interface. More...
 
interface  IVMPS_DLLDefinedScattering
 Volume Physics Model - DLL Defined Scatering. This interface can be accessed via the INCEVolumePhysicsData interface. More...
 
interface  IVMPS_PhotoluminscenceModel
 Volume Physics Model - Phosphors and Fluorescence. This interface can be accessed via the INCEVolumePhysicsData interface. More...
 
interface  IVolumePhysicsModelSettings
 Base interface for all specific VolumePhysicsModelType settings. This interface can be accessed via the INCEVolumePhysicsData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the specific volume physics model settings. More...
 
interface  IVPMS_None
 Volume Physics Model - None. This interface can be accessed via the INCEVolumePhysicsData interface. More...
 

Enumerations

enum  ObjectType {
  AnnularAsphericLens , AnnularAxialLens , AnnularVolume , Annulus ,
  Array , ArrayRing , AsphericSurface , AsphericSurface2 ,
  AxiconSurface , BiconicLens , BiconicSurface , BiconicZernike ,
  BiconicZernikeSurface , Binary1 , Binary2 , Binary2A ,
  Boolean , BooleanCAD = Boolean , CADAssemblyAutodeskInventor , CADAssemblyCreoParametric ,
  CADAssemblySolidWorks , CADPartAutodeskInventor , CADPartCreoParametric , CADPartSolidWorks ,
  CADPartSTEPIGESSAT , CADPartSTL , CADPartZPD , Cone ,
  CPC , CPCRectangular , CylinderPipe , CylinderVolume ,
  Cylinder2Pipe , Cylinder2Volume , DetectorColor , DetectorPolar ,
  DetectorRectangle , DetectorSurface , DetectorVolume , DiffractionGrating ,
  DualBEFSurface , Ellipse , EllipticalVolume , EvenAsphereLens ,
  ExtendedOddAsphereLens , ExtendedPolynomialLens , ExtendedPolynomialSurface , Extruded ,
  FacetedSurface , FreeformZ , Fresnel1 , Fresnel2 ,
  GridSagLens , GridSagSurface , GridSagFrontBack , HexagonalLensletArray ,
  HologramLens , HologramSurface , JonesMatrix , LensletArray1 ,
  LensletArray2 , MEMS , NullObject , OddAsphereLens ,
  ParaxialLens , PolygonObject , RayRotator , RectangularCorner ,
  Rectangle , RectangularPipe , RectangularPipeGrating , RectangularRoof ,
  RectangularTorusSurface , RectangularTorusVolume , RectangularVolume , RectangularVolumeGrating ,
  ReverseRadianceDetector , ReverseRadianceTarget , Slide , SourceDiffractive ,
  SourceDiode , SourceDLL , SourceEllipse , SourceEULUMDATFile ,
  SourceFilament , SourceFile , SourceGaussian , SourceIESNAFile ,
  SourceImported , SourceObject , SourcePoint , SourceRadial ,
  SourceRay , SourceRectangle , SourceTube , SourceTwoAngle ,
  SourceVolumeCylindrical , SourceVolumeElliptical , SourceVolumeRectangular , Sphere ,
  StandardLens , StandardSurface , Swept , TabulatedFactedRadial ,
  TabulatedFactedToroid , TabulatedFrenselRadial , ToroidalHologram , ToroidalLens ,
  ToroidalSurface , ToroidalSurfaceOddASphere , TorusSurface , TorusVolume ,
  TriangularCorner , Triangle , UserDefinedObject , WolterSurface ,
  ZernikeSurface , BooleanNative , CompoundLens , QTypeAsphereSurface ,
  OffAxisMirror
}
 All supported non-sequential object types. More...
 
enum  ObjectColumn {
  Comment = 1 , RefObject = 2 , InsideOf = 3 , XPosition = 4 ,
  YPosition = 5 , ZPosition = 6 , TiltX = 7 , TiltY = 8 ,
  TiltZ = 9 , Material = 10 , Par1 = 11 , Par2 = 12 ,
  Par3 = 13 , Par4 = 14 , Par5 = 15 , Par6 = 16 ,
  Par7 = 17 , Par8 = 18 , Par9 = 19 , Par10 = 20 ,
  Par11 = 21 , Par12 = 22 , Par13 = 23 , Par14 = 24 ,
  Par15 = 25 , Par16 = 26 , Par17 = 27 , Par18 = 28 ,
  Par19 = 29 , Par20 = 30 , Par21 = 31 , Par22 = 32 ,
  Par23 = 33 , Par24 = 34 , Par25 = 35 , Par26 = 36 ,
  Par27 = 37 , Par28 = 38 , Par29 = 39 , Par30 = 40 ,
  Par31 = 41 , Par32 = 42 , Par33 = 43 , Par34 = 44 ,
  Par35 = 45 , Par36 = 46 , Par37 = 47 , Par38 = 48 ,
  Par39 = 49 , Par40 = 50 , Par41 = 51 , Par42 = 52 ,
  Par43 = 53 , Par44 = 54 , Par45 = 55 , Par46 = 56 ,
  Par47 = 57 , Par48 = 58 , Par49 = 59 , Par50 = 60 ,
  Par51 = 61 , Par52 = 62 , Par53 = 63 , Par54 = 64 ,
  Par55 = 65 , Par56 = 66 , Par57 = 67 , Par58 = 68 ,
  Par59 = 69 , Par60 = 70 , Par61 = 71 , Par62 = 72 ,
  Par63 = 73 , Par64 = 74 , Par65 = 75 , Par66 = 76 ,
  Par67 = 77 , Par68 = 78 , Par69 = 79 , Par70 = 80 ,
  Par71 = 81 , Par72 = 82 , Par73 = 83 , Par74 = 84 ,
  Par75 = 85 , Par76 = 86 , Par77 = 87 , Par78 = 88 ,
  Par79 = 89 , Par80 = 90 , Par81 = 91 , Par82 = 92 ,
  Par83 = 93 , Par84 = 94 , Par85 = 95 , Par86 = 96 ,
  Par87 = 97 , Par88 = 98 , Par89 = 99 , Par90 = 100 ,
  Par91 = 101 , Par92 = 102 , Par93 = 103 , Par94 = 104 ,
  Par95 = 105 , Par96 = 106 , Par97 = 107 , Par98 = 108 ,
  Par99 = 109 , Par100 = 110 , Par101 = 111 , Par102 = 112 ,
  Par103 = 113 , Par104 = 114 , Par105 = 115 , Par106 = 116 ,
  Par107 = 117 , Par108 = 118 , Par109 = 119 , Par110 = 120 ,
  Par111 = 121 , Par112 = 122 , Par113 = 123 , Par114 = 124 ,
  Par115 = 125 , Par116 = 126 , Par117 = 127 , Par118 = 128 ,
  Par119 = 129 , Par120 = 130 , Par121 = 131 , Par122 = 132 ,
  Par123 = 133 , Par124 = 134 , Par125 = 135 , Par126 = 136 ,
  Par127 = 137 , Par128 = 138 , Par129 = 139 , Par130 = 140 ,
  Par131 = 141 , Par132 = 142 , Par133 = 143 , Par134 = 144 ,
  Par135 = 145 , Par136 = 146 , Par137 = 147 , Par138 = 148 ,
  Par139 = 149 , Par140 = 150 , Par141 = 151 , Par142 = 152 ,
  Par143 = 153 , Par144 = 154 , Par145 = 155 , Par146 = 156 ,
  Par147 = 157 , Par148 = 158 , Par149 = 159 , Par150 = 160 ,
  Par151 = 161 , Par152 = 162 , Par153 = 163 , Par154 = 164 ,
  Par155 = 165 , Par156 = 166 , Par157 = 167 , Par158 = 168 ,
  Par159 = 169 , Par160 = 170 , Par161 = 171 , Par162 = 172 ,
  Par163 = 173 , Par164 = 174 , Par165 = 175 , Par166 = 176 ,
  Par167 = 177 , Par168 = 178 , Par169 = 179 , Par170 = 180 ,
  Par171 = 181 , Par172 = 182 , Par173 = 183 , Par174 = 184 ,
  Par175 = 185 , Par176 = 186 , Par177 = 187 , Par178 = 188 ,
  Par179 = 189 , Par180 = 190 , Par181 = 191 , Par182 = 192 ,
  Par183 = 193 , Par184 = 194 , Par185 = 195 , Par186 = 196 ,
  Par187 = 197 , Par188 = 198 , Par189 = 199 , Par190 = 200 ,
  Par191 = 201 , Par192 = 202 , Par193 = 203 , Par194 = 204 ,
  Par195 = 205 , Par196 = 206 , Par197 = 207 , Par198 = 208 ,
  Par199 = 209 , Par200 = 210 , Par201 = 211 , Par202 = 212 ,
  Par203 = 213 , Par204 = 214 , Par205 = 215 , Par206 = 216 ,
  Par207 = 217 , Par208 = 218 , Par209 = 219 , Par210 = 220 ,
  Par211 = 221 , Par212 = 222 , Par213 = 223 , Par214 = 224 ,
  Par215 = 225 , Par216 = 226 , Par217 = 227 , Par218 = 228 ,
  Par219 = 229 , Par220 = 230 , Par221 = 231 , Par222 = 232 ,
  Par223 = 233 , Par224 = 234 , Par225 = 235 , Par226 = 236 ,
  Par227 = 237 , Par228 = 238 , Par229 = 239 , Par230 = 240 ,
  Par231 = 241 , Par232 = 242 , Par233 = 243 , Par234 = 244 ,
  Par235 = 245 , Par236 = 246 , Par237 = 247 , Par238 = 248 ,
  Par239 = 249 , Par240 = 250 , Par241 = 251 , Par242 = 252 ,
  Par243 = 253 , Par244 = 254 , Par245 = 255 , Par246 = 256 ,
  Par247 = 257 , Par248 = 258 , Par249 = 259 , Par250 = 260
}
 
enum  DetectorDataType { Real = 0 , Imaginary , Amplitude , Power }
 
enum  PolarDetectorDataType {
  Power = 1 , PowerSolidAngle , Lumens , LumensSolidAngle ,
  Cx , Cy , u_T , u_V ,
  TriX , TriY , TriZ
}
 
enum  InterpolateChoices { Bicubic = 0 , Linear }
 
enum  OrderChoices { Before = 0 , After }
 
enum  HologramTypes { Type_1 = 1 , Type_2 = 2 }
 
enum  DiffractiveFaceChoices { FrontFace = 1 , BackFace = 2 }
 
enum  PixelAddressing { ByRow = 0 , ByColumn = 1 , Individually = 2 }
 
enum  ShapeChoices { Rectangular = 0 , Elliptical = 1 }
 
enum  UniformAngleChoices { UniformIrradiance = 0 , UniformInAngleSpace = 1 }
 
enum  EndCapOptions { None = 0 , First = 1 , Second = 2 , Both = 3 }
 
enum  ApertureShapes { Annular = 0 , Elliptical = 1 , Rectangular = 2 , CyliderWithRectangular = 3 }
 Various Aperture shapes. More...
 
enum  RaysIgnoreObjectType { Never = 0 , Always = 1 , OnLaunch = 2 }
 
enum  DetectorShowAsType {
  GreyScaleFlux = 0 , InverseGreyScaleFlux = 1 , FalseColorFlux = 2 , InverseFalseColorFlux = 3 ,
  GreyScaleIrradiance = 4 , InverseGreyScaleIrradiance = 5 , FalseColorIrradiance = 6 , InverseFalseColorIrradiance = 7
}
 
enum  DrawingResolutionType {
  Standard = 0 , Medium = 1 , High = 2 , Presentation = 3 ,
  Custom = 4
}
 
enum  SourceBulkScatterMode { Many = 0 , Once = 1 , Never = 2 }
 
enum  SourceSamplingMethod { Random = 0 , Sobol = 1 }
 
enum  ArrayMode {
  None = 0 , Rectangular = 1 , Circular = 2 , Hexapolar = 3 ,
  Hexagonal = 4
}
 
enum  SourceColorMode {
  SystemWavelengths = 0 , CIE1931Tristimulus = 1 , CIE1931Chromaticity = 2 , CIE1931RGB = 3 ,
  UniformPowerSpectrum = 4 , D65White = 5 , ColorTemperature = 6 , BlackBodySpectrum = 7 ,
  SpectrumFile = 8 , CIE1976 = 9
}
 
enum  FaceIsType { ObjectDefault = 0 , Reflective = 1 , Absorbing = 2 }
 
enum  ObjectScatteringTypes {
  None = 0 , Lambertian = 1 , Gaussian = 2 , ABg = 3 ,
  ABgFile = 4 , BSDF = 5 , ISScatterCatalog = 6 , User = 7
}
 
enum  ScatterToType { ScatterToList = 0 , ImportanceSampling = 1 }
 
enum  VolumePhysicsModelType { None = 0 , AngleScattering = 1 , DLLDefinedScattering = 2 , PhotoluminescenceModel = 3 }
 
enum  EfficiencySpectrumType { QuantumYield = 0 , Excitation = 1 }
 
enum  NCEIndexType { Isotropic , Birefringent , GRIN }
 
enum  BirefringentMode { TraceOrdinayAndExtraordinary = 0 , TraceOrdinaryOnly = 1 , TraceExtraordinaryOnly = 2 , Waveplate = 3 }
 
enum  BirefringentReflections { TraceReflectedAndRefracted = 0 , TraceRefractedOnly = 1 , TraceReflectedOnly = 2 }
 
enum  DiffractionSplitType { DontSplitByOrder = 0 , SplitByTable = 1 , SplitByDLL = 2 }
 
enum  RayTraceModes { Standard = 0 , Flat = 1 , Shaded = 2 , Kernel = 3 }
 

Detailed Description

Usage (see Example 21 for a full sample)

C#

// Set 4th object as Standard Lens
INCERow Object_4 = TheNCE.GetObjectAt(4);
IObjectTypeSettings Typeset_StandardLens = Object_4.GetObjectTypeSettings(ObjectType.StandardLens);
Object_4.ChangeType(Typeset_StandardLens);
// Set positions
Object_4.GetObjectCell(ObjectColumn.ZPosition).DoubleValue = 0.9;
// To set solve for any cell, you need to first create a "ISolveData" by "CreateSolveType()" method.
// And then assign it to the cell.
ISolveData Solve_ObjPick = Object_4.GetObjectCell(ObjectColumn.Material).CreateSolveType(SolveType.ObjectPickup);
Solve_ObjPick._S_ObjectPickup.Object = 3;
// Set parameters
Object_4.GetObjectCell(ObjectColumn.Material).SetSolveData(Solve_ObjPick);
Object_4.GetObjectCell(ObjectColumn.Par3).DoubleValue = 1.2;
Object_4.GetObjectCell(ObjectColumn.Par4).DoubleValue = 1.2;
Object_4.GetObjectCell(ObjectColumn.Par5).DoubleValue = 1.2;
Object_4.GetObjectCell(ObjectColumn.Par6).DoubleValue = -1.2;
Object_4.GetObjectCell(ObjectColumn.Par8).DoubleValue = 1.2;
Object_4.GetObjectCell(ObjectColumn.Par9).DoubleValue = 1.2;
ZOSAPI.Editors.IEditorCell.DoubleValue
double DoubleValue
Gets or sets the double precision value of this cell. Note that if DataType is not CellDataType....
Definition: InterfacesEditors.cs:340
ZOSAPI.Editors.IEditorCell.SetSolveData
SolveStatus SetSolveData(ISolveData Data)
Updates the system with the new solve type settings (see also CreateSolveType and GetSolveData).
ZOSAPI.Editors.IEditorCell.CreateSolveType
ISolveData CreateSolveType(SolveType type)
Creates the solve type settings for the specified solve type. Note that SetSolveData must be used to ...
ZOSAPI.Editors.ISolveData
Base interface for all solve types. This interface can be accesed via the IEditorCell interface....
Definition: InterfacesEditors.cs:563
ZOSAPI.Editors.NCE.INCERow
All data for a Non-Sequential Component Editor object. This interface can be accessed via the INonSeq...
Definition: InterfacesNCE.cs:1198
ZOSAPI.Editors.NCE.INCERow.ChangeType
bool ChangeType(IObjectTypeSettings settings)
Changes the current object to the specified type. Use GetObjectTypeSettings to get the relevant setti...
ZOSAPI.Editors.NCE.INCERow.GetObjectCell
IEditorCell GetObjectCell(ObjectColumn Col)
Gets the specified object cell data.
ZOSAPI.Editors.NCE.INCERow.GetObjectTypeSettings
IObjectTypeSettings GetObjectTypeSettings(ObjectType type)
Create the settings for the specified type. Use this method to specify any extra data required to cha...
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.ObjectColumn
ObjectColumn
Definition: InterfacesNCE.cs:199
ZOSAPI.Editors.NCE.ObjectType
ObjectType
All supported non-sequential object types.
Definition: InterfacesNCE.cs:38
ZOSAPI.Editors.SolveType
SolveType
All solve types available. Note that only a portion of the types are available for any given IEditorC...
Definition: InterfacesEditors.cs:483

C++

// Set 4th object as Standard Lens
INCERowPtr Object_4 = TheNCE->GetObjectAt(4);
IObjectTypeSettingsPtr Typeset_StandardLens = Object_4->GetObjectTypeSettings(ObjectType_StandardLens);
Object_4->ChangeType(Typeset_StandardLens);
// Set positions
Object_4->GetObjectCell(ObjectColumn_ZPosition)->DoubleValue = 0.9;
// To set solve for any cell, you need to first create a "ISolveData" by "CreateSolveType()" method.
// And then assign it to the cell.
ISolveDataPtr Solve_ObjPick = Object_4->GetObjectCell(ObjectColumn_Material)->CreateSolveType(SolveType_ObjectPickup);
Solve_ObjPick->_S_ObjectPickup->Object = 3;
// Set parameters
Object_4->GetObjectCell(ObjectColumn_Material)->SetSolveData(Solve_ObjPick);
Object_4->GetObjectCell(ObjectColumn_Par3)->DoubleValue = 1.2;
Object_4->GetObjectCell(ObjectColumn_Par4)->DoubleValue = 1.2;
Object_4->GetObjectCell(ObjectColumn_Par5)->DoubleValue = 1.2;
Object_4->GetObjectCell(ObjectColumn_Par6)->DoubleValue = -1.2;
Object_4->GetObjectCell(ObjectColumn_Par8)->DoubleValue = 1.2;
Object_4->GetObjectCell(ObjectColumn_Par9)->DoubleValue = 1.2;

Matlab

% Set 4th object as Standard Lens
Object_4 = TheNCE.GetObjectAt(4);
Typeset_StandardLens = Object_4.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.StandardLens);
Object_4.ChangeType(Typeset_StandardLens);
% Set positions
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.ZPosition).DoubleValue = 0.9;
% To set solve for any cell, you need to first create a "ISolveData" by "CreateSolveType()" method.
% And then assign it to the cell.
Solve_ObjPick = Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Material).CreateSolveType(ZOSAPI.Editors.SolveType.ObjectPickup);
Solve_ObjPick.S_ObjectPickup_.Object = 3;
% Set parameters
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Material).SetSolveData(Solve_ObjPick);
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par3).DoubleValue = 1.2;
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par4).DoubleValue = 1.2;
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par5).DoubleValue = 1.2;
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par6).DoubleValue = -1.2;
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par8).DoubleValue = 1.2;
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par9).DoubleValue = 1.2;
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

Python

# Set 4th object as Standard Lens
Object_4 = TheNCE.GetObjectAt(4)
Typeset_StandardLens = Object_4.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.StandardLens)
Object_4.ChangeType(Typeset_StandardLens)
# Set positions
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.ZPosition).DoubleValue = 0.9
# To set solve for any cell, you need to first create a "ISolveData" by "CreateSolveType()" method.
# And then assign it to the cell.
Solve_ObjPick = Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Material).CreateSolveType(ZOSAPI.Editors.SolveType.ObjectPickup)
Solve_ObjPick._S_ObjectPickup.Object = 3
# Set parameters
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Material).SetSolveData(Solve_ObjPick)
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par3).DoubleValue = 1.2
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par4).DoubleValue = 1.2
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par5).DoubleValue = 1.2
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par6).DoubleValue = -1.2
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par8).DoubleValue = 1.2
Object_4.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par9).DoubleValue = 1.2

Enumeration Type Documentation

◆ ApertureShapes

enum ZOSAPI.Editors.NCE.ApertureShapes

Various Aperture shapes.

Enumerator
Annular 
Elliptical 
Rectangular 
CyliderWithRectangular 

◆ ArrayMode

enum ZOSAPI.Editors.NCE.ArrayMode
Enumerator
None 
Rectangular 
Circular 
Hexapolar 
Hexagonal 

◆ BirefringentMode

enum ZOSAPI.Editors.NCE.BirefringentMode
Enumerator
TraceOrdinayAndExtraordinary 
TraceOrdinaryOnly 
TraceExtraordinaryOnly 
Waveplate 

◆ BirefringentReflections

enum ZOSAPI.Editors.NCE.BirefringentReflections
Enumerator
TraceReflectedAndRefracted 
TraceRefractedOnly 
TraceReflectedOnly 

◆ DetectorDataType

enum ZOSAPI.Editors.NCE.DetectorDataType

Usage (see Example 24 for a full sample)

C#

// Saves current system in memory
TheSystem.SaveAs(TheApplication.SamplesDir + "\\API\\CS\\e24_nsc_detectors.zos");

C++

// saves current system in memory
TheSystem->SaveAs((_bstr_t)TheApplication->SamplesDir + "\\API\\CPP\\e24_nsc_detectors.zos");

Matlab

% saves current system in memory
TheSystem.Save();

Python

# saves current system in memory
TheSystem.Save()
Enumerator
Real 
Imaginary 
Amplitude 
Power 

◆ DetectorShowAsType

enum ZOSAPI.Editors.NCE.DetectorShowAsType
Enumerator
GreyScaleFlux 
InverseGreyScaleFlux 
FalseColorFlux 
InverseFalseColorFlux 
GreyScaleIrradiance 
InverseGreyScaleIrradiance 
FalseColorIrradiance 
InverseFalseColorIrradiance 

◆ DiffractionSplitType

enum ZOSAPI.Editors.NCE.DiffractionSplitType
Enumerator
DontSplitByOrder 
SplitByTable 
SplitByDLL 

◆ DiffractiveFaceChoices

enum ZOSAPI.Editors.NCE.DiffractiveFaceChoices
Enumerator
FrontFace 
BackFace 

◆ DrawingResolutionType

enum ZOSAPI.Editors.NCE.DrawingResolutionType
Enumerator
Standard 
Medium 
High 
Presentation 
Custom 

◆ EfficiencySpectrumType

enum ZOSAPI.Editors.NCE.EfficiencySpectrumType
Enumerator
QuantumYield 
Excitation 

◆ EndCapOptions

enum ZOSAPI.Editors.NCE.EndCapOptions
Enumerator
None 
First 
Second 
Both 

◆ FaceIsType

enum ZOSAPI.Editors.NCE.FaceIsType
Enumerator
ObjectDefault 
Reflective 
Absorbing 

◆ HologramTypes

enum ZOSAPI.Editors.NCE.HologramTypes
Enumerator
Type_1 
Type_2 

◆ InterpolateChoices

enum ZOSAPI.Editors.NCE.InterpolateChoices
Enumerator
Bicubic 
Linear 

◆ NCEIndexType

enum ZOSAPI.Editors.NCE.NCEIndexType
Enumerator
Isotropic 
Birefringent 
GRIN 

◆ ObjectColumn

enum ZOSAPI.Editors.NCE.ObjectColumn

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
Enumerator
Comment 
RefObject 
InsideOf 
XPosition 
YPosition 
ZPosition 
TiltX 
TiltY 
TiltZ 
Material 
Par1 
Par2 
Par3 
Par4 
Par5 
Par6 
Par7 
Par8 
Par9 
Par10 
Par11 
Par12 
Par13 
Par14 
Par15 
Par16 
Par17 
Par18 
Par19 
Par20 
Par21 
Par22 
Par23 
Par24 
Par25 
Par26 
Par27 
Par28 
Par29 
Par30 
Par31 
Par32 
Par33 
Par34 
Par35 
Par36 
Par37 
Par38 
Par39 
Par40 
Par41 
Par42 
Par43 
Par44 
Par45 
Par46 
Par47 
Par48 
Par49 
Par50 
Par51 
Par52 
Par53 
Par54 
Par55 
Par56 
Par57 
Par58 
Par59 
Par60 
Par61 
Par62 
Par63 
Par64 
Par65 
Par66 
Par67 
Par68 
Par69 
Par70 
Par71 
Par72 
Par73 
Par74 
Par75 
Par76 
Par77 
Par78 
Par79 
Par80 
Par81 
Par82 
Par83 
Par84 
Par85 
Par86 
Par87 
Par88 
Par89 
Par90 
Par91 
Par92 
Par93 
Par94 
Par95 
Par96 
Par97 
Par98 
Par99 
Par100 
Par101 
Par102 
Par103 
Par104 
Par105 
Par106 
Par107 
Par108 
Par109 
Par110 
Par111 
Par112 
Par113 
Par114 
Par115 
Par116 
Par117 
Par118 
Par119 
Par120 
Par121 
Par122 
Par123 
Par124 
Par125 
Par126 
Par127 
Par128 
Par129 
Par130 
Par131 
Par132 
Par133 
Par134 
Par135 
Par136 
Par137 
Par138 
Par139 
Par140 
Par141 
Par142 
Par143 
Par144 
Par145 
Par146 
Par147 
Par148 
Par149 
Par150 
Par151 
Par152 
Par153 
Par154 
Par155 
Par156 
Par157 
Par158 
Par159 
Par160 
Par161 
Par162 
Par163 
Par164 
Par165 
Par166 
Par167 
Par168 
Par169 
Par170 
Par171 
Par172 
Par173 
Par174 
Par175 
Par176 
Par177 
Par178 
Par179 
Par180 
Par181 
Par182 
Par183 
Par184 
Par185 
Par186 
Par187 
Par188 
Par189 
Par190 
Par191 
Par192 
Par193 
Par194 
Par195 
Par196 
Par197 
Par198 
Par199 
Par200 
Par201 
Par202 
Par203 
Par204 
Par205 
Par206 
Par207 
Par208 
Par209 
Par210 
Par211 
Par212 
Par213 
Par214 
Par215 
Par216 
Par217 
Par218 
Par219 
Par220 
Par221 
Par222 
Par223 
Par224 
Par225 
Par226 
Par227 
Par228 
Par229 
Par230 
Par231 
Par232 
Par233 
Par234 
Par235 
Par236 
Par237 
Par238 
Par239 
Par240 
Par241 
Par242 
Par243 
Par244 
Par245 
Par246 
Par247 
Par248 
Par249 
Par250 

◆ ObjectScatteringTypes

enum ZOSAPI.Editors.NCE.ObjectScatteringTypes

Usage (see Example 21 for a full sample)

C#

// Make Face 1 of object 3 has Lambertian scattering properties
// To set scatter properties, you need to first create "ScatteringSettings" by "CreateScatterModelSettings()" method.
// And then assign is to object 3 by ChangeScatterModelSettings().
IObjectScatteringSettings ScatType_Lam = Object_3.CoatScatterData.GetFaceData(1).CreateScatterModelSettings(ObjectScatteringTypes.Lambertian);
ScatType_Lam._S_Lambertian.ScatterFraction = 1;
Object_3.CoatScatterData.GetFaceData(1).ChangeScatterModelSettings(ScatType_Lam);
Object_3.CoatScatterData.GetFaceData(1).NumberOfRays = 1;
ZOSAPI.Editors.NCE.IObjectScatteringSettings
Scatter model settings for a specific face. This interface can be accessed via the INCECoatScatterFac...
Definition: InterfacesNCE.cs:6323
ZOSAPI.Editors.NCE.ObjectScatteringTypes
ObjectScatteringTypes
Definition: InterfacesNCE.cs:6200

C++

// Make Face 1 of object 3 has Lambertian scattering properties
// To set scatter properties, you need to first create "ScatteringSettings" by "CreateScatterModelSettings()" method.
// And then assign is to object 3 by ChangeScatterModelSettings().
IObjectScatteringSettingsPtr ScatType_Lam = Object_3->CoatScatterData->GetFaceData(1)->CreateScatterModelSettings(ObjectScatteringTypes_Lambertian);
ScatType_Lam->_S_Lambertian->ScatterFraction = 1;
Object_3->CoatScatterData->GetFaceData(1)->ChangeScatterModelSettings(ScatType_Lam);
Object_3->CoatScatterData->GetFaceData(1)->NumberOfRays = 1;

Matlab

% Make Face 1 of object 3 has Lambertian scattering properties
% To set scatter properties, you need to first create "ScatteringSettings" by "CreateScatterModelSettings()" method.
% And then assign is to object 3 by ChangeScatterModelSettings().
ScatType_Lam = Object_3.CoatScatterData.GetFaceData(1).CreateScatterModelSettings(ZOSAPI.Editors.NCE.ObjectScatteringTypes.Lambertian);
ScatType_Lam.S_Lambertian_.ScatterFraction = 1;
Object_3.CoatScatterData.GetFaceData(1).ChangeScatterModelSettings(ScatType_Lam);
Object_3.CoatScatterData.GetFaceData(1).NumberOfRays = 1;

Python

# Make Face 1 of object 3 has Lambertian scattering properties
# To set scatter properties, you need to first create "ScatteringSettings" by "CreateScatterModelSettings()" method.
# And then assign is to object 3 by ChangeScatterModelSettings().
ScatType_Lam = Object_3.CoatScatterData.GetFaceData(1).CreateScatterModelSettings(ZOSAPI.Editors.NCE.ObjectScatteringTypes.Lambertian)
ScatType_Lam._S_Lambertian.ScatterFraction = 1
Object_3.CoatScatterData.GetFaceData(1).ChangeScatterModelSettings(ScatType_Lam)
Object_3.CoatScatterData.GetFaceData(1).NumberOfRays = 1
Enumerator
None 
Lambertian 
Gaussian 
ABg 
ABgFile 
BSDF 
ISScatterCatalog 
User 

◆ ObjectType

enum ZOSAPI.Editors.NCE.ObjectType

All supported non-sequential object types.

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

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
Enumerator
AnnularAsphericLens 
AnnularAxialLens 
AnnularVolume 
Annulus 
Array 
ArrayRing 
AsphericSurface 
AsphericSurface2 
AxiconSurface 
BiconicLens 
BiconicSurface 
BiconicZernike 
BiconicZernikeSurface 
Binary1 
Binary2 
Binary2A 
Boolean 
BooleanCAD 
CADAssemblyAutodeskInventor 
CADAssemblyCreoParametric 
CADAssemblySolidWorks 
CADPartAutodeskInventor 
CADPartCreoParametric 
CADPartSolidWorks 
CADPartSTEPIGESSAT 
CADPartSTL 
CADPartZPD 
Cone 
CPC 
CPCRectangular 
CylinderPipe 
CylinderVolume 
Cylinder2Pipe 
Cylinder2Volume 
DetectorColor 
DetectorPolar 
DetectorRectangle 
DetectorSurface 
DetectorVolume 
DiffractionGrating 
DualBEFSurface 
Ellipse 
EllipticalVolume 
EvenAsphereLens 
ExtendedOddAsphereLens 
ExtendedPolynomialLens 
ExtendedPolynomialSurface 
Extruded 
FacetedSurface 
FreeformZ 
Fresnel1 
Fresnel2 
GridSagLens 
GridSagSurface 
GridSagFrontBack 
HexagonalLensletArray 
HologramLens 
HologramSurface 
JonesMatrix 
LensletArray1 
LensletArray2 
MEMS 
NullObject 
OddAsphereLens 
ParaxialLens 
PolygonObject 
RayRotator 
RectangularCorner 
Rectangle 
RectangularPipe 
RectangularPipeGrating 
RectangularRoof 
RectangularTorusSurface 
RectangularTorusVolume 
RectangularVolume 
RectangularVolumeGrating 
ReverseRadianceDetector 
ReverseRadianceTarget 
Slide 
SourceDiffractive 
SourceDiode 
SourceDLL 
SourceEllipse 
SourceEULUMDATFile 
SourceFilament 
SourceFile 
SourceGaussian 
SourceIESNAFile 
SourceImported 
SourceObject 
SourcePoint 
SourceRadial 
SourceRay 
SourceRectangle 
SourceTube 
SourceTwoAngle 
SourceVolumeCylindrical 
SourceVolumeElliptical 
SourceVolumeRectangular 
Sphere 
StandardLens 
StandardSurface 
Swept 
TabulatedFactedRadial 
TabulatedFactedToroid 
TabulatedFrenselRadial 
ToroidalHologram 
ToroidalLens 
ToroidalSurface 
ToroidalSurfaceOddASphere 
TorusSurface 
TorusVolume 
TriangularCorner 
Triangle 
UserDefinedObject 
WolterSurface 
ZernikeSurface 
BooleanNative 
CompoundLens 
QTypeAsphereSurface 
OffAxisMirror 

◆ OrderChoices

enum ZOSAPI.Editors.NCE.OrderChoices
Enumerator
Before 
After 

◆ PixelAddressing

enum ZOSAPI.Editors.NCE.PixelAddressing
Enumerator
ByRow 
ByColumn 
Individually 

◆ PolarDetectorDataType

enum ZOSAPI.Editors.NCE.PolarDetectorDataType
Enumerator
Power 
PowerSolidAngle 
Lumens 
LumensSolidAngle 
Cx 
Cy 
u_T 
u_V 
TriX 
TriY 
TriZ 

◆ RaysIgnoreObjectType

enum ZOSAPI.Editors.NCE.RaysIgnoreObjectType
Enumerator
Never 
Always 
OnLaunch 

◆ RayTraceModes

enum ZOSAPI.Editors.NCE.RayTraceModes
Enumerator
Standard 
Flat 
Shaded 
Kernel 

◆ ScatterToType

enum ZOSAPI.Editors.NCE.ScatterToType
Enumerator
ScatterToList 
ImportanceSampling 

◆ ShapeChoices

enum ZOSAPI.Editors.NCE.ShapeChoices
Enumerator
Rectangular 
Elliptical 

◆ SourceBulkScatterMode

enum ZOSAPI.Editors.NCE.SourceBulkScatterMode
Enumerator
Many 
Once 
Never 

◆ SourceColorMode

enum ZOSAPI.Editors.NCE.SourceColorMode
Enumerator
SystemWavelengths 
CIE1931Tristimulus 
CIE1931Chromaticity 
CIE1931RGB 
UniformPowerSpectrum 
D65White 
ColorTemperature 
BlackBodySpectrum 
SpectrumFile 
CIE1976 

◆ SourceSamplingMethod

enum ZOSAPI.Editors.NCE.SourceSamplingMethod
Enumerator
Random 
Sobol 

◆ UniformAngleChoices

enum ZOSAPI.Editors.NCE.UniformAngleChoices
Enumerator
UniformIrradiance 
UniformInAngleSpace 

◆ VolumePhysicsModelType

enum ZOSAPI.Editors.NCE.VolumePhysicsModelType

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;

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
Enumerator
None 
AngleScattering 
DLLDefinedScattering 
PhotoluminescenceModel 

Connect with Ansys