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
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:
This interface defines all properties and methods needed to interact with the Lens Data Editor. This interface can be accessed via the IOpticalSystem interface
This interface defines all properties and methods needed to interact with the Multiple Configuration Editor. This interface can be accessed via the IOpticalSystem interface
This interface defines all properties and methods needed to interact with the MRit Function Editor. This interface can be accessed via the IOpticalSystem interface
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
This interface defines all properties and methods needed to interact with the Tolerance Data Editor. This interface can be accessed via the IOpticalSystem interface
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:
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
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
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
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
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
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
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.)
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
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
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
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
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
Interfaces and methods for converting the sequential surfaces to a non-sequential group. This interface can be accessed via the IOpticalSystemTools interface
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
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
Interfaces and methods for getting a set of triangles for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface
Interfaces and methods for saving an output image for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface
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
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
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
Interface for the Merit Function, Nonsequential Component Roadway Lighting Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface
Interface for the Merit Function, Nonsequential Component Bitmap Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface
Interface for the Merit Function, Nonsequential Component Optimization Wizard.
These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface
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
Interface for the Tolerance Editor, Nonsequential Component Wizard These settings can be retrieved from the ZOSAPI.Editors.TDE.IToleranceDataEditor interface
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
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
