ZOSAPI.Tools.IShadedModelVisualizationExport Interface Reference
Last update: 17.07.2025Interfaces and methods for getting a set of triangles for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface. More...
Public Member Functions | |
| IShadedModelTriangleList | GetResults () |
| Gets the triangles for the specified surfaces/objects, if available. | |
 Public Member Functions inherited from ZOSAPI.Tools.ISystemTool | |
| bool | Run () |
| Start the tool. Note that for synchronous tools (see IsAsynchronous), this call will block until completion. If it is asynchronous it will start running but return immediately. | |
| bool | RunAndWaitForCompletion () |
| Sames as calling Run followed by WaitForCompletion. | |
| bool | WaitForCompletion () |
| Waits for the asynchronous tool to complete. | |
| bool | Cancel () |
| Cancels the currently running asynchronous tool. | |
| bool | Close () |
| Closes this tool and frees up and associated resources. | |
| RunStatus | WaitWithTimeout (double timeOutSeconds) |
| Waits for the currently running tool to complete, with a specified time out value. Note that if the timeout is exceeded this method will return, however the tool will continue to run. Also note that this method will not start the tool running if it is not already. | |
| RunStatus | RunAndWaitWithTimeout (double timeOutSeconds) |
| Starts the tool running, and waits for it to complete with the specified timeout value. Note that if the timeout is exceeded this method will return, however the tool will continue to run. | |
Properties | |
| int | StartSurface [get, set] |
| The first surface which will be available in the output triangles. If set to -1, every surface from the beginning to the EndSurface will be available. | |
| int | EndSurface [get, set] |
| The last surface which will be available in the output triangles. If set to -1, every surface after the StartSurface will be available. | |
| int | Object [get, set] |
| The Object index from a non-sequential surface which will be available in the output triangles. If specified as -1, all objects will be available. | |
| Properties inherited from ZOSAPI.Tools.ISystemTool | |
| int | Progress [get] |
| Gets the progress of the current tool, if supported. | |
| string | Status [get] |
| Gets the status of the current tool, if supporoted. | |
| bool | IsRunning [get] |
| Gets a value indicating whether the tool is currently running asynchronously. | |
| bool | CanCancel [get] |
| Gets a value indicating whether the tool can be cancelled. | |
| bool | IsAsynchronous [get] |
| Gets a value indicating whether the tool runs asynchronously (i.e. on a thread). | |
| bool | IsFiniteDuration [get] |
| Gets a value indicating whether this tool will complete on its own. | |
| bool | IsValid [get] |
| Gets a value indicating whether the input settings are valid. | |
| bool | Succeeded [get] |
| Gets a value indicating whether the tool execution succeeded. | |
| string | ErrorMessage [get] |
If Succeeded is false, get the error messages; otherwise, null. | |
Detailed Description
Interfaces and methods for getting a set of triangles for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface.
Member Function Documentation
◆ GetResults()
| IShadedModelTriangleList ZOSAPI.Tools.IShadedModelVisualizationExport.GetResults | ( | ) |
Gets the triangles for the specified surfaces/objects, if available.
- Returns
- IShadedModelTriangleList
Property Documentation
◆ EndSurface
|
getset |
The last surface which will be available in the output triangles. If set to -1, every surface after the StartSurface will be available.
◆ Object
|
getset |
The Object index from a non-sequential surface which will be available in the output triangles. If specified as -1, all objects will be available.
◆ StartSurface
|
getset |
The first surface which will be available in the output triangles. If set to -1, every surface from the beginning to the EndSurface will be available.
