Skip to main content

ZOS-API interface 2024 R2

ZOSAPI.ISTARSubsystem Interface Reference

Last update: 17.07.2025

Controls the STAR module at the optical system level. More...

Public Member Functions

void DoManualUpdate ()
 Force a lens update to reflect the latest STAR configuration on all surfaces.
 

Properties

STARUpdateMode UpdateMode [get, set]
 Gets/sets the current STAR update mode. Suspended requires manual updates using the DoManualUpdate() function.
 
ISTARMaterials Materials [get]
 Access material properties used in STAR calculations.
 

Detailed Description

Controls the STAR module at the optical system level.

Member Function Documentation

◆ DoManualUpdate()

void ZOSAPI.ISTARSubsystem.DoManualUpdate ( )

Force a lens update to reflect the latest STAR configuration on all surfaces.

Returns

Property Documentation

◆ Materials

ISTARMaterials ZOSAPI.ISTARSubsystem.Materials
get

Access material properties used in STAR calculations.

◆ UpdateMode

STARUpdateMode ZOSAPI.ISTARSubsystem.UpdateMode
getset

Gets/sets the current STAR update mode. Suspended requires manual updates using the DoManualUpdate() function.

The STAR update mode. Normal means updates will happen automatically as the user changes the STAR configuration for a surface. Use Suspended to pause updates when making changes on multiple surfaces.

Connect with Ansys