ZOSAPI.Preferences.IPreferencesGeneral Interface Reference
Last update: 17.07.2025Allows 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. More...
Public Member Functions | |
| bool | GetIsGPUEnabled () |
| Check if GPU calculates are enabled. | |
| bool | SetIsGPUEnabled (bool isEnabled) |
| Set whether or not to enable use of the GPU in calculations. | |
| bool | GetUseACIS () |
| bool | SetUseACIS (bool use) |
| bool | GetUseParasolid () |
| bool | SetUseParasolid (bool use) |
Properties | |
| DateTimeType | DateTimeFormat [get, set] |
| LanguageType | Language [get, set] |
| EncodingType | ZMXFileEncoding [get, set] |
| EncodingType | TXTFileEncoding [get, set] |
| bool | UseSessionFiles [get, set] |
| bool | IncludeCalculatedDataInSession [get, set] |
| bool | IncludeToleranceDataInSession [get, set] |
| bool | UpdateMostRecentlyUsedList [get, set] |
| This setting can be used to turn updating of the most recently used lens files in File > Open on or off. | |
| string | UserPreferences [get, set] |
| This is a single string in which you can store anything you want. It is saved in your Preferences configuration file together with all of the regular settings. As an example, this can be used to store a flag for you to keep track whether you have configured all of the Preferences you want or not. | |
Detailed Description
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.
Note - every time a setting is changed the Preference file in use will be automatically saved, but only if a valid file name is defined for IZOSAPI_Connection.PreferencesFile prior to connecting to the ZOS-API.
Member Function Documentation
◆ GetIsGPUEnabled()
| bool ZOSAPI.Preferences.IPreferencesGeneral.GetIsGPUEnabled | ( | ) |
Check if GPU calculates are enabled.
- Returns
◆ GetUseACIS()
| bool ZOSAPI.Preferences.IPreferencesGeneral.GetUseACIS | ( | ) |
◆ GetUseParasolid()
| bool ZOSAPI.Preferences.IPreferencesGeneral.GetUseParasolid | ( | ) |
◆ SetIsGPUEnabled()
| bool ZOSAPI.Preferences.IPreferencesGeneral.SetIsGPUEnabled | ( | bool | isEnabled | ) |
Set whether or not to enable use of the GPU in calculations.
- Parameters
-
isEnabled
- Returns
trueif the setting was successfully updated; otherwisefalse.
◆ SetUseACIS()
| bool ZOSAPI.Preferences.IPreferencesGeneral.SetUseACIS | ( | bool | use | ) |
◆ SetUseParasolid()
| bool ZOSAPI.Preferences.IPreferencesGeneral.SetUseParasolid | ( | bool | use | ) |
Property Documentation
◆ DateTimeFormat
|
getset |
◆ IncludeCalculatedDataInSession
|
getset |
◆ IncludeToleranceDataInSession
|
getset |
◆ Language
|
getset |
◆ TXTFileEncoding
|
getset |
◆ UpdateMostRecentlyUsedList
|
getset |
This setting can be used to turn updating of the most recently used lens files in File > Open on or off.
◆ UserPreferences
|
getset |
This is a single string in which you can store anything you want. It is saved in your Preferences configuration file together with all of the regular settings. As an example, this can be used to store a flag for you to keep track whether you have configured all of the Preferences you want or not.
◆ UseSessionFiles
|
getset |
◆ ZMXFileEncoding
|
getset |
