Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

▼NZOSAPI	The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection, and IZOSAPI_Application for more information
►NAnalysis
►NData
CIAR_	Properties and methods for retrieving analysis window data. This interface can be accessed via the IA_ interface. Note that not all analysis types currently return detailed results via this interface, however all analyses that support text output should support the GetTextFile method. See the OpticStudio manual for more information
CIAR_CriticalRayData
CIAR_CriticalRayInfo
CIAR_DataGrid
CIAR_DataGridRgb
CIAR_DataGridVector
CIAR_DataScatterPoints
CIAR_DataScatterPointsRgb
CIAR_DataSeries
CIAR_DataSeriesRgb
CIAR_HeaderData
CIAR_MetaData
CIAR_NSCSingleRayTraceData
CIAR_PathAnalysisData
CIAR_PathAnalysisEntry
CIAR_RayData
CIAR_RayInfo
CIAR_Rgb
CIAR_ScatterPoint
CIAR_ScatterPointRgb
CIAR_SpotDataResult
CIAR_SpotDataResultMatrix
CIAR_Vector2D
CIAR_XYZ
►NPhysicalOptics
CIAS_PhysicalOpticsPropagation
►NRayTracing
CIAS_PathAnalysis
►NSettings
►NAberrations
CIAS_FieldCurvatureAndDistortion
CIAS_FocalShiftDiagram
CIAS_FullFieldAberration
CIAS_GridDistortion
CIAS_LateralColor
CIAS_LongitudinalAberration
CIAS_RayTrace
CIAS_SeidelCoefficients
CIAS_SeidelDiagram
CIAS_ZernikeAnnularCoefficients
CIAS_ZernikeCoefficientsVsField
CIAS_ZernikeFringeCoefficients
CIAS_ZernikeStandardCoefficients
►NCoatings
CIAS_RTA_Angle
CIAS_RTA_Wavelength
►NDiffractionEfficiency
CIAS_DiffEfficiency2D
CIAS_DiffEfficiencyAngular
CIAS_DiffEfficiencyChromatic
►NEncircledEnergy
CIAS_DiffractionEncircledEnergy
CIAS_ExtendedSourceEncircledEnergy
CIAS_GeometricEncircledEnergy
CIAS_GeometricLineEdgeSpread
►NExtendedScene
CIAS_GeometricImageAnalysis
CIAS_ImageSimulation
CIAS_RelativeIllumination
►NFans
CIAS_Fan
►NMaterials
CIAS_GrinProfile
CIAS_InternalTransmissionvsWavelength
►NMtf
CIAS_ContrastLossMap
CIAS_FftMtf
CIAS_FftMtfMap
CIAS_FftMtfvsField
CIAS_FftSurfaceMtf
CIAS_FftThroughFocusMtf
CIAS_GeometricMtf
CIAS_GeometricMtfMap
CIAS_GeometricMtfvsField
CIAS_GeometricThroughFocusMtf
CIAS_HuygensMtf
CIAS_HuygensMtfvsField
CIAS_HuygensSurfaceMtf
CIAS_HuygensThroughFocusMtf
CIAS_NSCGeometricMtf
►NNSCSurface
CIAS_NSCSurfaceSag
►NPsf
CIAS_FftPsf
CIAS_FftPsfCrossSection
CIAS_FftPsfLineEdgeSpread
CIAS_HuygensPsf
CIAS_HuygensPsfCrossSection
►NRayTracing
CIAS_DetectorViewer
CIAS_NSCSingleRayTrace
►NRMS
CIAS_RMSField
CIAS_RMSFieldMap
CIAS_RMSFocus
CIAS_RMSLambdaDiagram
►NSpot
CIAS_Spot
►NSurface
CIAS_SurfaceCurvature
CIAS_SurfaceCurvatureCross
CIAS_SurfacePhase
CIAS_SurfacePhaseCross
CIAS_SurfacePhaseSlope
CIAS_SurfacePhaseSlopeCross
CIAS_SurfaceSag
CIAS_SurfaceSagCross
CIAS_SurfaceSlope
CIAS_SurfaceSlopeCross
►NWavefront
CIAS_Foucault
CIAS_	Base class for all analysis settings interfaces. This class can be accessed via the IA_ interface
CIAS_CriticalRayTracer	Settings to control the Critical Ray Trace analysis
CIAS_Detector
CIAS_Field
CIAS_FileComparator	Settings to control the Critical Ray Trace analysis
CIAS_Interferogram
CIAS_Surface
CIAS_WavefrontMap
CIAS_Wavelength
CIAS_XXXTemplateXXX
►NTolerancing
►NQuickYield
CIAS_QYField	Provides methods for setting and inspecting the field configuration for a Quick Yield analysis
CIAS_ISOElementDrawing
CIAS_QuickYield
CIAS_TolerancingHistogram
CIAS_TolerancingYield
CITolerancingOperand
CITolerancingOperands
CI_Analyses	Methods and interfaces for opening, closing, and retrieving analyses. This interface can be accessed via the IOpticalSystem interface
CIA_	Base interface for all analysis windows. This interface can be accessed via the I_Analyses interface
CIColorTranslator
CIMessage
CIMessages
CIUser2DLineData	Properties and methods for configuring a 2D line User Analysis plot. This interface can be accessed via the IUserAnalysisData interface
CIUserAnalysisData	Properties and methods used to generate a User Analysis. This interface can be accessed via the IZOSAPI_Application interface. Note that this interface is only available when creating a User Analysis plugin application
CIUserGridData	Properties and methods for configuring a 2D grid User Analysis plot. This interface can be accessed via the IUserAnalysisData interface
CIUserGridRGBData	Properties and methods for configuring a 2D rgb grid User Analysis plot. This interface can be accessed via the IUserAnalysisData interface
CIUserTextData	Properties and methods for configuring a text User Analysis window. This interface can be accessed via the IUserAnalysisData interface
►NCommon
CICoordinateTransform
CIMatrixData	Methods and properties for retrieving and/or setting a 2D array of double precision data
CIMetadata
CISettingsData	Methods and interfaces for storing and retrieving user-defined settings. All settings are referenced via a user-defined string key, and has a specific type associated with it (e.g. a single integer, array of doubles, etc.)
CIVectorData	Methods and properties for retrieving and/or setting a 1D array of double precision data
►NEditors
►NLDE
CICoatingPerformanceData
CILDEApertureData	Surface properties aperture tab. This interface can be accessed via the ILDERow interface
CILDECoatingData	Surface properties coatings tab. This interface can be accessed via the ILDERow interface
CILDECoatingSettings	Coating settings for a specific layer. This interface can be accessed via the ILDECoatingData interface
CILDECompositeData	Surface properties composite tab. This interface can be accessed via the ILDERow interface
CILDEDrawData	Surface properties draw tab. This interface can be accessed via the ILDERow interface
CILDEImportData	Surface properties import tab. This interface can be accessed via the ILDERow interface
CILDEPhysicalOpticsData	Surface properties physical optics tab. This interface can be accessed via the ILDERow interface
CILDERow	All data for a Lens Data Editor surface. This interface can be accessed via the ILensDataEditor interface
CILDEScatteringData	Surface properties scattering tab. This interface can be accessed via the ILDERow interface
CILDETiltDecenterData	Surface properties tilt/decenter data. This interface can be accessed via the ILDERow interface
CILDETool_AddCoatingsToAllSurfaces
CILDETool_TiltDecenterElements
CILDETypeData	Surface properties type tab. This interface can be accessed via the ILDERow interface
CILensDataEditor	This interface defines all properties and methods needed to interact with the Lens Data Editor. This interface can be accessed via the IOpticalSystem interface
CISTAR_ComponentRBMs	All STAR component data for a Lens Data Editor surface
CISTAR_CoordinateTransform
CISTAR_Data	All STAR data for a Lens Data Editor surface. This interface can be accessed via the ILDERow interface
CISTAR_Decenters
CISTAR_Deformation
CISTAR_DeformationFits
CISTAR_Deformations	All STAR deformation data for a Lens Data Editor surface
CISTAR_DeformationsFEAData
CISTAR_DirectIndex	All STAR direct refractive index data for a Lens Data Editor surface
CISTAR_DirectIndexFEAData	Classes which implement this interface allow to handle refractive index FEA datasets
CISTAR_DirectIndexFits
CISTAR_FEAFitResults
CISTAR_FEAFitSettings
CISTAR_PointWithDeformation
CISTAR_PointWithDeformationAndWeight
CISTAR_PointWithIndex
CISTAR_PointWithIndexAndRetardance
CISTAR_PointWithRetardance
CISTAR_PointWithStress
CISTAR_PointWithTemperatureAndIndex
CISTAR_RBM_Centroid
CISTAR_RBM_ReferencePoint
CISTAR_RBMs
CISTAR_RotationAngles
CISTAR_Rotations
CISTAR_RotationValues
CISTAR_Stress	All STAR stress tensor data for a Lens Data Editor surface
CISTAR_StressFEAData	Classes which implement this interface allow to handle stress FEA datasets
CISTAR_StressFits	Classes which implement this interface allow to manipulate stress fits
CISTAR_Temperatures	All STAR temperature data for a Lens Data Editor surface
CISTAR_TemperaturesFEAData
CISTAR_TemperaturesFits
CISurface
CISurfaceABCD
CISurfaceAlternateEven
CISurfaceAlternateOdd
CISurfaceAnnularZernikeSag
CISurfaceAPBC
CISurfaceApertureCircular	Aperture Type - Circular Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface
CISurfaceApertureElliptical	Aperture Type - Elliptical Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface
CISurfaceApertureFloating	Aperture Type - Floating Aperture. This interface can be retrieved from a ILDEApertureData interface
CISurfaceApertureNone	Aperture Type - None. This interface can be retrieved from a ILDEApertureData interface
CISurfaceApertureRectangular	Aperture Type - Rectangular Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface
CISurfaceApertureSpider	Aperture Type - Spider. This interface can be retrieved from a ILDEApertureData interface
CISurfaceApertureType	Base interface for settings specific to a SurfaceApertureTypes. This interface can be retrieved from a ILDEApertureData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the appropriate aperture type settings
CISurfaceApertureUser	Aperture Type - User Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface
CISurfaceAtmospheric
CISurfaceBiconic
CISurfaceBiconicZernike
CISurfaceBinary1
CISurfaceBinary2
CISurfaceBinary3
CISurfaceBinary4
CISurfaceBirefringentIn
CISurfaceBirefringentOut
CISurfaceBlackBoxLens
CISurfaceChebyShv
CISurfaceCoeff_P_NthEvenPower
CISurfaceCoeff_P_NthPower
CISurfaceCoeff_R_NthEvenPower
CISurfaceCoeff_R_NthPower
CISurfaceCoeff_X1P1X2P2_NthEvenPower
CISurfaceCoeff_X_NthEvenPower
CISurfaceCoeff_X_NthEvenPower_8
CISurfaceCoeff_Y_NthEvenPower
CISurfaceCoeff_Y_NthEvenPower_8
CISurfaceConjugate
CISurfaceCoordinateBreak
CISurfaceCubicSpline
CISurfaceCylinderFrensel
CISurfaceCylinderFresnel
CISurfaceData
CISurfaceDiffractionGrating
CISurfaceEllipticalGrating1
CISurfaceEllipticalGrating2
CISurfaceEvenAspheric
CISurfaceExtendedAsphere
CISurfaceExtendedCubicSpline
CISurfaceExtendedFresnel
CISurfaceExtendedOddAsphere
CISurfaceExtendedPolynomial
CISurfaceExtendedToroidalGrating
CISurfaceFreeformNthZernike
CISurfaceFreeformXYPolynomial
CISurfaceFresnel
CISurfaceGeneralizedFresnel
CISurfaceGradient1
CISurfaceGradient10
CISurfaceGradient12
CISurfaceGradient2
CISurfaceGradient3
CISurfaceGradient4
CISurfaceGradient5
CISurfaceGradient6
CISurfaceGradient7
CISurfaceGradient9
CISurfaceGradium
CISurfaceGridGradient
CISurfaceGridPhase
CISurfaceGridSag
CISurfaceHologram1
CISurfaceHologram2
CISurfaceIrregular
CISurfaceJonesMatrix
CISurfaceNonSequential
CISurfaceNthEvenOrderTerms
CISurfaceNthOrderTerms
CISurfaceNthThickness
CISurfaceNthZernike
CISurfaceOddAsphere
CISurfaceOddCosine
CISurfaceOffAxisConicFreeform
CISurfaceOpticallyFabricatedHologram
CISurfaceParaxial
CISurfaceParaxialXY
CISurfacePeriodic
CISurfacePolynomial
CISurfaceQTypeAsphere
CISurfaceQTypeFreeform
CISurfaceRadialGrating
CISurfaceRadialNurbs
CISurfaceRetroReflect
CISurfaceScatteringABg	Surface Scattering - ABg. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringABgFile	Surface Scattering - ABg File. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringBSDF	Surface Scattering - BSDF. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringCatalog	Surface Scattering - IS Scatter Catalog. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringGaussian	Surface Scattering - Gaussian. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringLambertian	Surface Scattering - Lambertian. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringNone	Surface Scattering - None. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceScatteringType	Base interface for all surface scattering types. This interface can be retrieved from the ILDEScatteringData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the appropriate scattering type settings
CISurfaceScatteringUser	Surface Scattering - User. This interface can be retrieved from the ILDEScatteringData interface
CISurfaceSlide
CISurfaceStandard
CISurfaceSuperconic
CISurfaceTilted
CISurfaceToroidal
CISurfaceToroidalGrat
CISurfaceToroidalHologram
CISurfaceToroidalNurbs
CISurfaceTrueFreeform
CISurfaceTypeSettings	This interface is used for selecting any files required by a surface, and for changing surface types. This interface can be accessed via the ILDERow interface
CISurfaceVariableLineSpaceGrating
CISurfaceXYPolynomial
CISurfaceZernikeAnnularPhase
CISurfaceZernikeFringePhase
CISurfaceZernikeFringeSag
CISurfaceZernikeStandardPhase
CISurfaceZernikeStandardSag
CISurfaceZonePlate
►NMCE
CIMCERow	All data for a Multiple Configuration Editor operand. This interface can be accessed via the IMultiConfigEditor interface
CIMultiConfigEditor	This interface defines all properties and methods needed to interact with the Multiple Configuration Editor. This interface can be accessed via the IOpticalSystem interface
►NMFE
CIMeritFunctionEditor	This interface defines all properties and methods needed to interact with the MRit Function Editor. This interface can be accessed via the IOpticalSystem interface
CIMFERow	All data for a Merit Function Editor operand. This interface can be accessed via the IMeritFunctionEditor interface
►NNCE
CIFaceData	Contains face vertex, normal, intensity, and power data for all facets of detector objects
CIImportanceSamplingSettings
CIIMS_Birefringent	Index Model - Birefringent. This interface can be accessed via the INCEIndexData interface
CIIMS_GRIN	Index Model - Gradient Index. This interface can be accessed via the INCEIndexData interface
CIIMS_Isotropic	Index Model - Isotropic. This interface can be accessed via the INCEIndexData interface
CIIndexModelSettings	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
CINCECADData	Object properties CAD tab. This interface can be accessed via the INCERow interface
CINCECoatingPerformanceData
CINCECoatingPerformanceFaceData
CINCECoatScatterData	Object properties Coat/Scatter tab. This interface can be accessed via the INCERow interface
CINCECoatScatterFaceData	Coat/Scatter settings for a specific face. This interface can be accessed via the INCECoatScatterData interface
CINCEDiffractionData	Object properties Diffraction tab. This interface can be accessed via the INCERow interface
CINCEDrawData	Object properties Draw tab. This interface can be accessed via the INCERow interface
CINCEIndexData	Object properties Index tab. This interface can be accessed via the INCERow interface
CINCERow	All data for a Non-Sequential Component Editor object. This interface can be accessed via the INonSeqEditor interface
CINCEScatterToData	Object properties Scatter To tab. This interface can be accessed via the INCERow interface
CINCESourcesData	Object properties Sources tab. This interface can be accessed via the INCERow interface
CINCETypeData	Object properties Type tab. This interface can be accessed via the INCERow interface
CINCEVolumePhysicsData	Object properties Volume Physics tab. This interface can be accessed via the INCERow interface
CINonSeqEditor	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
CIObject
CIObjectAnnularAsphericLens
CIObjectAnnularAxialLens
CIObjectAnnularVolume
CIObjectAnnulus
CIObjectArray
CIObjectArrayRing
CIObjectAsphericSurface
CIObjectAsphericSurface2
CIObjectAxiconSurface
CIObjectBiconicLens
CIObjectBiconicSurface
CIObjectBiconicZernike
CIObjectBiconicZernikeSurface
CIObjectBinary1
CIObjectBinary2
CIObjectBinary2A
CIObjectBoolean
CIObjectBooleanNative
CIObjectCADAssemblyAutodeskInventor
CIObjectCADAssemblyCreoParametric
CIObjectCADAssemblySolidWorks
CIObjectCADPartAutodeskInventor
CIObjectCADPartCreoParametric
CIObjectCADPartSolidWorks
CIObjectCADPartSTEPIGESSAT
CIObjectCADPartSTL
CIObjectCADPartZPD
CIObjectCompoundLens
CIObjectCone
CIObjectCPC
CIObjectCPCRectangular
CIObjectCylinder2Pipe
CIObjectCylinder2Volume
CIObjectCylinderPipe
CIObjectCylinderVolume
CIObjectDetector
CIObjectDetectorColor
CIObjectDetectorPolar
CIObjectDetectorRectangle
CIObjectDetectorSurface
CIObjectDetectorVolume
CIObjectDiffractionGrating
CIObjectDualBEFSurface
CIObjectEllipse
CIObjectEllipticalVolume
CIObjectEvenAsphereLens
CIObjectExtendedOddAsphereLens
CIObjectExtendedPolynomialLens
CIObjectExtendedPolynomialSurface
CIObjectExtruded
CIObjectFacetedSurface
CIObjectFreeformZ
CIObjectFresnel1
CIObjectFresnel2
CIObjectGridSagFrontBack
CIObjectGridSagLens
CIObjectGridSagSurface
CIObjectHexagonalLensletArray
CIObjectHologramLens
CIObjectHologramSurface
CIObjectJonesMatrix
CIObjectLensletArray1
CIObjectLensletArray2
CIObjectMEMS
CIObjectNullObject
CIObjectOddAsphereLens
CIObjectOffAxisMirror
CIObjectParaxialLens
CIObjectPolygon
CIObjectQTypeAsphereSurface
CIObjectRayRotator
CIObjectRectangle
CIObjectRectangularCorner
CIObjectRectangularPipe
CIObjectRectangularPipeGrating
CIObjectRectangularRoof
CIObjectRectangularTorusSurface
CIObjectRectangularTorusVolume
CIObjectRectangularVolume
CIObjectRectangularVolumeGrating
CIObjectReverseRadianceDetector
CIObjectReverseRadianceTarget
CIObjectScatteringSettings	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
CIObjectSlide
CIObjectSourceDiffractive
CIObjectSourceDiode
CIObjectSourceDLL
CIObjectSourceEllipse
CIObjectSourceEULUMDATFile
CIObjectSourceFilament
CIObjectSourceFile
CIObjectSourceGaussian
CIObjectSourceIESNAFile
CIObjectSourceImported
CIObjectSourceObject
CIObjectSourcePoint
CIObjectSourceRadial
CIObjectSourceRay
CIObjectSourceRectangle
CIObjectSources
CIObjectSourceTube
CIObjectSourceTwoAngle
CIObjectSourceVolumeCylindrical
CIObjectSourceVolumeElliptical
CIObjectSourceVolumeRectangular
CIObjectSphere
CIObjectStandardLens
CIObjectStandardSurface
CIObjectSwept
CIObjectTabulatedFactedRadial
CIObjectTabulatedFactedToroid
CIObjectTabulatedFrenselRadial
CIObjectToroidalHologram
CIObjectToroidalLens
CIObjectToroidalSurface
CIObjectToroidalSurfaceOddASphere
CIObjectTorusSurface
CIObjectTorusVolume
CIObjectTriangle
CIObjectTriangularCorner
CIObjectTypeSettings	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
CIObjectUserDefinedObject
CIObjectWolterSurface
CIObjectXYPolynomial
CIObjectZernikeSurface
CIOSS_ABg	Object Scattering Settings - ABg. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_ABgFile	Object Scattering Settings - ABg File. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_BSDF	Object Scattering Settings - BSDF. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_Gaussian	Object Scattering Settings - Gaussian. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_ISScatterCatalog	Object Scattering Settings - IS Scatter Catalog. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_Lambertian	Object Scattering Settings - Lambertian. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_None	Object Scattering Settings - None. This interface can be accessed via the INCECoatScatterFaceData interface
CIOSS_User	Object Scattering Settings - User. This interface can be accessed via the INCECoatScatterFaceData interface
CISCS_BlackBodySpectrum	Source Color Mode - Black Body Spectrum. This interface can be accessed via the INCESourcesData interface
CISCS_CIE1931Chromaticity	Source Color Mode - CIE 1931 Chromaticity xy. This interface can be accessed via the INCESourcesData interface
CISCS_CIE1931RGB	Source Color Mode - CIE 1931 RGB (Saturated). This interface can be accessed via the INCESourcesData interface
CISCS_CIE1931Tristimulus	Source Color Mode - CIE 1931 Tristimulus XYZ. This interface can be accessed via the INCESourcesData interface
CISCS_CIE1976	Source Color Mode - CIE 1976 Chromaticity u' v'. This interface can be accessed via the INCESourcesData interface
CISCS_ColorTemperature	Source Color Mode - Color Temperature. This interface can be accessed via the INCESourcesData interface
CISCS_D65White	Source Color Mode - D65 White. This interface can be accessed via the INCESourcesData interface
CISCS_SpectrumFile	Source Color Mode - Spectrum File. This interface can be accessed via the INCESourcesData interface
CISCS_SystemWavelengths	Source Color Mode - System Wavelengths. This interface can be accessed via the INCESourcesData interface
CISCS_UniformPowerSpectrum	Source Color Mode - Uniform Power Spectrum. This interface can be accessed via the INCESourcesData interface
CISourceColorSettings	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
CIVMPS_AngleScattering	Volume Physics Model - Angle Scattering. This interface can be accessed via the INCEVolumePhysicsData interface
CIVMPS_DLLDefinedScattering	Volume Physics Model - DLL Defined Scatering. This interface can be accessed via the INCEVolumePhysicsData interface
CIVMPS_PhotoluminscenceModel	Volume Physics Model - Phosphors and Fluorescence. This interface can be accessed via the INCEVolumePhysicsData interface
CIVolumePhysicsModelSettings	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
CIVPMS_None	Volume Physics Model - None. This interface can be accessed via the INCEVolumePhysicsData interface
►NTDE
CITDERow	All data for a Tolerance Data Editor operand. This interface can be accessed via the IToleranceDataEditor interface
CIToleranceDataEditor	This interface defines all properties and methods needed to interact with the Tolerance Data Editor. This interface can be accessed via the IOpticalSystem interface
CICoatingParameter
CIEditor	Base interface for all five editor types. All editors can be accessed via the IOpticalSystem interface. Note that this interface can be used to retrieve basic editor information only. For more detailed data, you should use one of the editor-specific interfaces:
CIEditorCell	Interface used to get and set data for a specific cell in an editor. This interface can be accessed via:
CIEditorRow	Base interface for all five editor row types. General row information can be accessed via the IEditor interface. Note that this interface can be used to retrieve basic editor information only. For more detailed data, you should use one of the editor-specific interfaces:
CISolveAplanatic
CISolveAutomatic
CISolveCenterOfCurvature
CISolveChiefRayAngle
CISolveChiefRayHeight
CISolveChiefRayNormal
CISolveCocentricRadius
CISolveCocentricSurface
CISolveCompensator
CISolveConfigPickup
CISolveData	Base interface for all solve types. This interface can be accesed via the IEditorCell interface. Note that the S properties are for convenience only and merely cast this interface to the appropriate derived interface. See the OpticStudio documentation for details on the various solve types
CISolveDuplicateSag
CISolveEdgeThickness
CISolveElementPower
CISolveFieldPickup
CISolveFixed
CISolveFNumber
CISolveInvertSag
CISolveMarginalRayAngle
CISolveMarginalRayHeight
CISolveMarginalRayNormal
CISolveMaterialModel
CISolveMaterialOffset
CISolveMaterialSubstitute
CISolveMaximum
CISolveNone	This solve type is only used for cells that do not support any type of solve. For most cells, use ISolveFixed instead
CISolveObjectPickup
CISolveOpticalPathDifference
CISolvePickupChiefRay
CISolvePosition
CISolvePupilPosition
CISolveSurfacePickup
CISolveThermalPickup
CISolveVariable
CISolveZPLMacro
►NPreferences
CIPreferencesEditor	Allows configuration of settings from the OpticStudio Preferences -> Editor tab in OpticStudio.
CIPreferencesFolders	Allows configuration of settings from the OpticStudio Preferences -> Folders tab in OpticStudio.
CIPreferencesGeneral	Allows configuration of settings from the OpticStudio Preferences -> General tab in OpticStudio. Only a subset of preferences can be configured via the ZOS-API as most settings do not have any effect
►NSystemData
CIField	System field data. This interface can be accessed via the IFields interface
CIFields	System Explorer - Fields Data. This interface can be accessed via the ISystemData interface
CISDAdvancedData	System Explorer - Advanced Data. This interface can be accessed via the ISystemData interface
CISDApertureData	System Explorer - Aperture Data. This interface can be accessed via the ISystemData interface
CISDEnvironmentData	System Explorer - Environment Data. This interface can be accessed via the ISystemData interface
CISDFiles	System Explorer - Files Data. This interface can be accessed via the ISystemData interface
CISDMaterialCatalogData	System Explorer - Material Catalogs Data. This interface can be accessed via the ISystemData interface
CISDNamedFilters	System Explorer - Named Filters Data. This interface can be accessed via the ISystemData interface
CISDNonSeqData	System Explorer - Non-Sequential Data. This interface can be accessed via the ISystemData interface
CISDPolarizationData	System Explorer - Polarization Data. This interface can be accessed via the ISystemData interface
CISDRayAimingData	System Explorer - Ray Aiming Data. This interface can be accessed via the ISystemData interface
CISDTitleNotes	System Explorer - Notes Data. This interface can be accessed via the ISystemData interface
CISDUnitsData	System Explorer - Units Data. This interface can be accessed via the ISystemData interface
CISurfaceSelection
CISystemData	Interfaces and methods for changing all System Explorer data. This interface can be accessed via the IOpticalSystem interface
CIWavelength	System wavelength data. This interface can be accessed via the IWavelengths interface
CIWavelengths	System Explorer - Wavelengths Data. This interface can be accessed via the ISystemData interface
►NTools
►NFileManager
CIConvertProjectToFileTool	Tool for converting a Lens Project to a Lens File. This tool can be accessed via the IOpticalSystemTools interface, itself accessible via IOpticalSystem.Tools
CIFile
►NGeneral
CIComputeRMSSpotSize
CICovarianceData
CICreateArchive	Interfaces and methods for creating a ZAR file. This interface can be accessed via the IOpticalSystemTools interface
CICreateProject
CIDataDictionary
CIDataEntry
CIExportCAD	Interfaces and methods for exporting the current system to various CAD formats. This interface can be accessed via the IOpticalSystemTools interface
CIHullTools
CILensCatalogLens
CILensCatalogs	Interfaces and methods for searching the available Lens Catalogs. This interface can be accessed via the IOpticalSystemTools interface
CIPoint3D
CIPointList3D
CIPointTools
CIQuickAdjust	Interfaces and methods for running the Quick Adjust tool. This interface can be accessed via the IOpticalSystemTools interface
CIQuickFocus	Interfaces and methods for running the Quick Focus tool. This interface can be accessed via the IOpticalSystemTools interface
CIRayAimingWizard
CIRestoreArchive	Interfaces and methods for restoring a ZAR file. This interface can be accessed via the IOpticalSystemTools interface
CIRestoreProject
CIScale	Interfaces and methods for Scaling the Currently active Lens System. This interface can be accessed via the IOpticalSystemTools interface
►NLayouts
CI3DViewerExport
CICrossSectionExport	Interfaces and methods for saving an output image for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface
CIImageExportData
CIImagePixel
CINSC3DLayoutExport
CINSCShadedModelExport
CIShadedModelExport
►NOptimization
CIGlobalOptimization	Interfaces and methods for running a Global Optimization. This interface can be accessed via the IOpticalSystemTools interface
CIHammerOptimization	Interfaces and methods for running a Hammer Optimization. This interface can be accessed via the IOpticalSystemTools interface
CILocalOptimization	Interfaces and methods for running a Local Optimization. This interface can be accessed via the IOpticalSystemTools interface
►NOptimizationTools
CIConvertAsphereType
CIFindBestAsphere
►NRayTrace
CIBatchRayTrace	Interfaces and methods for running a ray trace on multiple rays at a time. This interface can be accessed via the IOpticalSystemTools interface
CILightningTrace	Interfaces and methods for running the LightningTrace tool. This interface can be accessed via the IOpticalSystemTools interface
CINSCRayTrace	Interfaces and methods for running a non-sequential ray trace. This interface can be accessed via the IOpticalSystemTools interface. NOTE - due to architectural limitations, currently only one INSCRayTrace instance can be used at a time, across all IOpticalSystem instances. The first call to IOpticalSystemTools.OpenNSCRayTrace will succeed, while all further calls will return `null` until the the single INSCRayTrace instance is closed. It is anticipated that this limiation will be removed in future versions of the API
CIRayTraceDirectPolData
CIRayTraceDirectUnpolData
CIRayTraceNormPolData
CIRayTraceNormUnpolData
CIRayTraceNSCData
CIRayTraceNSCSourceData
CIZRDReader
CIZRDReaderResults
►NTolerancing
CIMonteCarloData
CIQuickSensitivity
CISensitivityCompensator
CISensitivityCriterionMetadata
CISensitivityData
CISensitivityOperandEffect
CISensitivityOperandMetadata
CITeziData
CIToleranceDataViewer
CITolerancing	Interfaces and methods for running Tolerancing. This interface can be accessed via the IOpticalSystemTools interface
CITolerancingColumnMetadata
CITolerancingHistogram
CITolerancingOperandMetadata
CITolerancingParameter
CITolerancingSummaryStatistics
CIAPIUtilities
CIConvertToNSCGroup	Interfaces and methods for converting the sequential surfaces to a non-sequential group. This interface can be accessed via the IOpticalSystemTools interface
CICriticalRaysetGenerator	Interfaces and methods for generating a 'critical rayset'; these rays can be used after converting to non-sequential in order to verify that the conversion did not fundamentally alter the geometries. This interface can be accessed via the IOpticalSystemTools interface
CIDesignLockdown	Interfaces and methods for validating a sequential design, prior to manufacturing or conversion to non-sequential. This interface can be accessed via the IOpticalSystemTools interface
CIExportToSpeosLensSystem	Interface to access the "Export to Speos Lens System" tool. This interface can be accessed via the IOpticalSystemTools interface
CIExportToSpeosWhitebox
CIFileManager
CIHPCSettings
CIInternalBirefringenceData
CIInternalBirefringenceParameter
CIInternalTransmissionData
CIInternalTransmissionParameter
CILayouts
CIMaterialsCatalog
CIMFCalculator	Interfaces and methods for calculating the current Merit Function value. This interface can be accessed via the IOpticalSystemTools interface
CIOpticalSystemTools	Methods to run various system-wide tools. This interface can be accessed via the IOpticalSystem interface. Note that only one ISystemTool can be open at a time; the previous tool must be closed using ISystemTool.Close before a new one can be opened
CIShadedModelTriangleList
CIShadedModelVisualizationExport	Interfaces and methods for getting a set of triangles for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface
CISystemTool	Base interface for all system tools. See IOpticalSystemTools for access to specific tools
►NWizards
CIImageData
CINSCBitmapWizard	Interface for the Merit Function, Nonsequential Component Bitmap Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface
CINSCOptimizationWizard	Interface for the Merit Function, Nonsequential Component Optimization Wizard. These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface
CINSCRoadwayLightingWizard	Interface for the Merit Function, Nonsequential Component Roadway Lighting Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface
CINSCToleranceWizard	Interface for the Tolerance Editor, Nonsequential Component Wizard These settings can be retrieved from the ZOSAPI.Editors.TDE.IToleranceDataEditor interface
CINSCWizard	Interface for the Common data for the Merit Function, Nonsequential Component Optimization and Bitmap Wizards
CISEQOptimizationWizard	Interface for the Merit Function, Sequential Optimization Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface. Note that this wizard is obsolete and you should use ISEQOptimizationWizard2 instead
CISEQOptimizationWizard2
CISEQToleranceWizard	Interface for the Tolerance Editor, Sequential Wizard These settings can be retrieved from the ZOSAPI.Editors.TDE.IToleranceDataEditor interface
CIToleranceWizard	Interface for the Tolerance Wizard
CIWizard	Base interface for all the Wizards
CAPINetCallback
CIOpticalSystem	Represent a complete optical system. A IOpticalSystem corresponds to a single .ZMX file. See IZOSAPI_Application for information on how to get or create a IOpticalSystem
CIPreferences
CISTARMaterials	Top-level access to material properties for STAR module
CISTARSubsystem	Controls the STAR module at the optical system level
CIZAPI_BaseObject
CIZOSAPI_Application	This interface contains all information about the current ZOS-API connection, as well as methods for accessing an Optical System. This interface can only be retrieved from a connection interface - ZOSAPI.IZOSAPI_Connection for more information
CIZOSAPI_Callback
CIZOSAPI_Connection	This is the initial interface to Optic Studio. All applications that wish to use the ZOS-API must first establish a connection, using the T:ZOSAPI.ZOSAPI_Connection class
CIZOSAPI_Events	COM classes can inherit from this interface if they wish to receive status changed notifications. See also ZOSAPI_Connection.SystemStatusChangedEvent
CZOSAPI_Connection

ZOS-API interface 2025 R1

Connect with Ansys