Speos NX library 2025 R2

Preferences Class Reference

Last update: 16.07.2025

Represents Speos for NX Preferences. More...

Inheritance diagram for Preferences:

Public Member Functions

'None' ResetDefaultValues (self)
 Initializes Speos for NX Preferences to their default values.
 
'None' Load (self)
 Loads Speos for NX Preferences.
 
'None' Save (self)
 Saves Speos for NX Preferences.
 

Static Public Attributes

str AutoFeatureUpdateOutsideSpeos = property(fget=__GetAutoFeatureUpdateOutsideSpeos, fset=__SetAutoFeatureUpdateOutsideSpeos)
 Gets or sets the property to enable the automatic update of Speos feature outside Speos application.
 
str CreateSimulationSubFolder = property(fget=__GetCreateSimulationSubFolder, fset=__SetCreateSimulationSubFolder)
 Gets or sets the property to enable a sub folder for simulation results.
 
str DefaultColorimetricStandard = property(fget=__GetDefaultColorimetricStandard, fset=__SetDefaultColorimetricStandard)
 Gets or sets the CIE used by default in all simulations.
 
str DefaultDirectPreset = property(fget=__GetDefaultDirectPreset, fset=__SetDefaultDirectPreset)
 Gets or sets the default preset to apply to new direct simulations.
 
str DefaultHOAPreset = property(fget=__GetDefaultHOAPreset, fset=__SetDefaultHOAPreset)
 Gets or sets the default preset to be applied to new HOA simulations.
 
str DefaultIntensityViewingDirection = property(fget=__GetDefaultIntensityViewingDirection, fset=__SetDefaultIntensityViewingDirection)
 Gets or sets the default intensity sensor viewing direction.
 
str DefaultInteractivePreset = property(fget=__GetDefaultInteractivePreset, fset=__SetDefaultInteractivePreset)
 Gets or sets the default preset to be applied to new interactive simulations.
 
str DefaultInversePreset = property(fget=__GetDefaultInversePreset, fset=__SetDefaultInversePreset)
 Gets or sets the default preset to be applied to new inverse simulations.
 
str DefaultLidarPreset = property(fget=__GetDefaultLidarPreset, fset=__SetDefaultLidarPreset)
 Gets or sets the default preset to be applied to new Lidar simulations.
 
str DefaultRayFileFormat = property(fget=__GetDefaultRayFileFormat, fset=__SetDefaultRayFileFormat)
 Gets or sets the default ray file format used in sensors and in direct simulations.
 
str DefaultVbbPreset = property(fget=__GetDefaultVbbPreset, fset=__SetDefaultVbbPreset)
 Gets or sets the default preset to be applied to new Virtual BSDF Bench simulations.
 
str DefaultXMPViewer = property(fget=__GetDefaultXMPViewer, fset=__SetDefaultXMPViewer)
 Gets or sets the default lab to display XMP files.
 
str EnableBetaFeatures = property(fget=__GetEnableBetaFeatures, fset=__SetEnableBetaFeatures)
 Gets or sets the property to enable beta features.
 
str EnableDisplayOutsideSpeos = property(fget=__GetEnableDisplayOutsideSpeos, fset=__SetEnableDisplayOutsideSpeos)
 Gets or sets the property to enable the display of Speos feature outside Speos application.
 
str EnableGPUExplore = property(fget=__GetEnableGPUExplore, fset=__SetEnableGPUExplore)
 Gets or sets the property to enable GPU-Explore in simulation preview.
 
str IncrementSimulationResults = property(fget=__GetIncrementSimulationResults, fset=__SetIncrementSimulationResults)
 Gets or sets the property to enable the increment of simulation results.
 
str InteractiveSimulationAutoUpdate = property(fget=__GetInteractiveSimulationAutoUpdate, fset=__SetInteractiveSimulationAutoUpdate)
 Gets or sets the property to enable the automatic update of interactive simulations.
 
str LightBoxMeshingPreviewLimit = property(fget=__GetLightBoxMeshingPreviewLimit, fset=__SetLightBoxMeshingPreviewLimit)
 Gets or sets the maximum number of triangles displayed in the lightbox mesh.
 
str NumberOfThreads = property(fget=__GetNumberOfThreads, fset=__SetNumberOfThreads)
 Gets or sets the simulation number of threads.
 
str ReferenceSet = property(fget=__GetReferenceSet, fset=__SetReferenceSet)
 Gets or sets the Reference Set name.
 
str ReferenceSetMode = property(fget=__GetReferenceSetMode, fset=__SetReferenceSetMode)
 Gets or sets the content to load and display from a project.
 
str UpdateFeaturesOnLoad = property(fget=__GetUpdateFeaturesOnLoad, fset=__SetUpdateFeaturesOnLoad)
 Gets or sets the property to enable the automatic update of Speos feature when loading the document.
 
str UseUserInputFolder = property(fget=__GetUseUserInputFolder, fset=__SetUseUserInputFolder)
 Gets or sets the property to enable the use of a user input folder.
 
str UseUserIsolatedFolder = property(fget=__GetUseUserIsolatedFolder, fset=__SetUseUserIsolatedFolder)
 Gets or sets the property to enable the use of a user isolated folder.
 
str UseUserOutputFolder = property(fget=__GetUseUserOutputFolder, fset=__SetUseUserOutputFolder)
 Gets or sets the property to enable the use of a user output folder.
 
str UserInputFolder = property(fget=__GetUserInputFolder, fset=__SetUserInputFolder)
 Gets or sets the path to the user input folder.
 
str UserIsolatedFolder = property(fget=__GetUserIsolatedFolder, fset=__SetUserIsolatedFolder)
 Gets or sets the path to the user isolated folder.
 
str UserOutputFolder = property(fget=__GetUserOutputFolder, fset=__SetUserOutputFolder)
 Gets or sets the path to the user output folder.
 
str VRSensorMemoryManagement = property(fget=__GetVRSensorMemoryManagement, fset=__SetVRSensorMemoryManagement)
 Gets or sets the property to enable the VR memory management to limit memory usage.
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 

Detailed Description

Represents Speos for NX Preferences.

To obtain an instance of this class, refer to Session::Preferences().

Member Data Documentation

◆ AutoFeatureUpdateOutsideSpeos

str AutoFeatureUpdateOutsideSpeos = property(fget=__GetAutoFeatureUpdateOutsideSpeos, fset=__SetAutoFeatureUpdateOutsideSpeos)
static

Gets or sets the property to enable the automatic update of Speos feature outside Speos application.


True: Enables automatic update of Speos feature outside Speos application.
False: Disables automatic update of Speos feature outside Speos application.

Value type: Boolean.

The default value is True.

◆ CreateSimulationSubFolder

str CreateSimulationSubFolder = property(fget=__GetCreateSimulationSubFolder, fset=__SetCreateSimulationSubFolder)
static

Gets or sets the property to enable a sub folder for simulation results.


True: Enables simulation sub folder.
False: Disables simulation sub folder.

Value type: Boolean.

The default value is True.

◆ DefaultColorimetricStandard

str DefaultColorimetricStandard = property(fget=__GetDefaultColorimetricStandard, fset=__SetDefaultColorimetricStandard)
static

Gets or sets the CIE used by default in all simulations.

The values are:
0 - CIE 1931 Standard.
1 - CIE 1964 Standard.

Value type: Integer.

The default value is 0.

◆ DefaultDirectPreset

str DefaultDirectPreset = property(fget=__GetDefaultDirectPreset, fset=__SetDefaultDirectPreset)
static

Gets or sets the default preset to apply to new direct simulations.


Preset is identified by an internal GUID Value type: String.

The default value is empty.

◆ DefaultHOAPreset

str DefaultHOAPreset = property(fget=__GetDefaultHOAPreset, fset=__SetDefaultHOAPreset)
static

Gets or sets the default preset to be applied to new HOA simulations.


Preset is identified by an internal GUID Value type: String.

The default value is empty.

◆ DefaultIntensityViewingDirection

str DefaultIntensityViewingDirection = property(fget=__GetDefaultIntensityViewingDirection, fset=__SetDefaultIntensityViewingDirection)
static

Gets or sets the default intensity sensor viewing direction.

The values are:
0 - From Source looking at Sensor, the viewing direction of the observer is the same as the light direction emitted.
1 - From Sensor looking at Source, the viewing direction of the observer is in the opposite of the light direction.

Value type: Integer.

The default value is 0.

◆ DefaultInteractivePreset

str DefaultInteractivePreset = property(fget=__GetDefaultInteractivePreset, fset=__SetDefaultInteractivePreset)
static

Gets or sets the default preset to be applied to new interactive simulations.


Preset is identified by an internal GUID Value type: String.

The default value is empty.

◆ DefaultInversePreset

str DefaultInversePreset = property(fget=__GetDefaultInversePreset, fset=__SetDefaultInversePreset)
static

Gets or sets the default preset to be applied to new inverse simulations.


Preset is identified by an internal GUID Value type: String.

The default value is empty.

◆ DefaultLidarPreset

str DefaultLidarPreset = property(fget=__GetDefaultLidarPreset, fset=__SetDefaultLidarPreset)
static

Gets or sets the default preset to be applied to new Lidar simulations.


Preset is identified by an internal GUID Value type: String.

The default value is empty.

◆ DefaultRayFileFormat

str DefaultRayFileFormat = property(fget=__GetDefaultRayFileFormat, fset=__SetDefaultRayFileFormat)
static

Gets or sets the default ray file format used in sensors and in direct simulations.

The values are:
0 - Classic, format without polarization *.ray.
1 - Polarization, format with polarization *.ray.
2 - TM25, IESNA TM25 format *.tm25ray with polarization.
3 - TM25NoPolarization, IESNA TM25 format *.tm25ray without polarization.

Value type: Integer.

The default value is 0.

◆ DefaultVbbPreset

str DefaultVbbPreset = property(fget=__GetDefaultVbbPreset, fset=__SetDefaultVbbPreset)
static

Gets or sets the default preset to be applied to new Virtual BSDF Bench simulations.


Preset is identified by an internal GUID Value type: String.

The default value is empty.

◆ DefaultXMPViewer

str DefaultXMPViewer = property(fget=__GetDefaultXMPViewer, fset=__SetDefaultXMPViewer)
static

Gets or sets the default lab to display XMP files.

The values are:
0 - Virtual Photometric Lab.
1 - Human Vision Lab.

Value type: Integer.

The default value is 0.

◆ EnableBetaFeatures

str EnableBetaFeatures = property(fget=__GetEnableBetaFeatures, fset=__SetEnableBetaFeatures)
static

Gets or sets the property to enable beta features.


True: Enables beta features.
False: Disables beta features.

Value type: Boolean.

The default value is False.

◆ EnableDisplayOutsideSpeos

str EnableDisplayOutsideSpeos = property(fget=__GetEnableDisplayOutsideSpeos, fset=__SetEnableDisplayOutsideSpeos)
static

Gets or sets the property to enable the display of Speos feature outside Speos application.


True: Enables display of Speos feature outside Speos application.
False: Disables display of Speos feature outside Speos application.

Value type: Boolean.

The default value is True.

◆ EnableGPUExplore

str EnableGPUExplore = property(fget=__GetEnableGPUExplore, fset=__SetEnableGPUExplore)
static

Gets or sets the property to enable GPU-Explore in simulation preview.


True: Enables GPU-Explore.
False: Disables GPU-Explore.

Value type: Boolean.

The default value is True.

◆ IncrementSimulationResults

str IncrementSimulationResults = property(fget=__GetIncrementSimulationResults, fset=__SetIncrementSimulationResults)
static

Gets or sets the property to enable the increment of simulation results.


True: Enables increment of simulation results.
False: Disables increment of simulation results.

Value type: Boolean.

The default value is False.

◆ InteractiveSimulationAutoUpdate

str InteractiveSimulationAutoUpdate = property(fget=__GetInteractiveSimulationAutoUpdate, fset=__SetInteractiveSimulationAutoUpdate)
static

Gets or sets the property to enable the automatic update of interactive simulations.


True: Enables automatic update of interactive simulations.
False: Disables automatic update of interactive simulations.

Value type: Boolean.

The default value is True.

◆ LightBoxMeshingPreviewLimit

str LightBoxMeshingPreviewLimit = property(fget=__GetLightBoxMeshingPreviewLimit, fset=__SetLightBoxMeshingPreviewLimit)
static

Gets or sets the maximum number of triangles displayed in the lightbox mesh.

If there are more triangles, a bounding box is displayed instead.

Value type: Integer.
Range: The value must be superior to 0.

The default value is 10000000.

◆ NumberOfThreads

str NumberOfThreads = property(fget=__GetNumberOfThreads, fset=__SetNumberOfThreads)
static

Gets or sets the simulation number of threads.

Value type: Integer.
Range: The value must be superior to 0.

The default value is the number of physical processor of the computer.

◆ ReferenceSet

str ReferenceSet = property(fget=__GetReferenceSet, fset=__SetReferenceSet)
static

Gets or sets the Reference Set name.

Prerequisite: The ReferenceSetMode property must be 1.

Value type: String.

The default value is empty.

◆ ReferenceSetMode

str ReferenceSetMode = property(fget=__GetReferenceSetMode, fset=__SetReferenceSetMode)
static

Gets or sets the content to load and display from a project.

The values are:
0 - Model, add automatically to Model Reference Set.
1 - User, add automatically to specified Reference Set.

Value type: Integer.

The default value is 0.

◆ UpdateFeaturesOnLoad

str UpdateFeaturesOnLoad = property(fget=__GetUpdateFeaturesOnLoad, fset=__SetUpdateFeaturesOnLoad)
static

Gets or sets the property to enable the automatic update of Speos feature when loading the document.


True: Enables automatic update of Speos feature when loading the document.
False: Disables automatic update of Speos feature when loading the document.

Value type: Boolean.

The default value is False.

◆ UserInputFolder

str UserInputFolder = property(fget=__GetUserInputFolder, fset=__SetUserInputFolder)
static

Gets or sets the path to the user input folder.


Prerequisite: The UseUserInputFolder property must be True.

Value type: Boolean.

The default value is empty.

◆ UserIsolatedFolder

str UserIsolatedFolder = property(fget=__GetUserIsolatedFolder, fset=__SetUserIsolatedFolder)
static

Gets or sets the path to the user isolated folder.


Prerequisite: The UseUserIsolatedFolder property must be True.

Value type: Boolean.

The default value is empty.

◆ UserOutputFolder

str UserOutputFolder = property(fget=__GetUserOutputFolder, fset=__SetUserOutputFolder)
static

Gets or sets the path to the user output folder.


Prerequisite: The UseUserOutputFolder property must be True.

Value type: Boolean.

The default value is empty.

◆ UseUserInputFolder

str UseUserInputFolder = property(fget=__GetUseUserInputFolder, fset=__SetUseUserInputFolder)
static

Gets or sets the property to enable the use of a user input folder.


True: Enables user input folder.
False: Disables user input folder.

Value type: Boolean.

The default value is False.

◆ UseUserIsolatedFolder

str UseUserIsolatedFolder = property(fget=__GetUseUserIsolatedFolder, fset=__SetUseUserIsolatedFolder)
static

Gets or sets the property to enable the use of a user isolated folder.


True: Enables user isolated folder.
False: Disables user isolated folder.

Value type: Boolean.

The default value is False.

◆ UseUserOutputFolder

str UseUserOutputFolder = property(fget=__GetUseUserOutputFolder, fset=__SetUseUserOutputFolder)
static

Gets or sets the property to enable the use of a user output folder.


True: Enables user output folder.
False: Disables user output folder.

Value type: Boolean.

The default value is False.

◆ VRSensorMemoryManagement

str VRSensorMemoryManagement = property(fget=__GetVRSensorMemoryManagement, fset=__SetVRSensorMemoryManagement)
static

Gets or sets the property to enable the VR memory management to limit memory usage.


True: Enables VR memory management.
False: Disables VR memory management.

Value type: Boolean.

The default value is False.

The documentation for this class was generated from the following file:
  • SpeosNX_2412.py

Connect with Ansys