SimulationSettings Class Reference
Last update: 17.07.2025Represents the interface for editing custom simulation settings. More...
Public Member Functions | |
| 'bool' | SaveAsPreset (self, name) |
| Save the simulation settings as preset. | |
Static Public Attributes | |
| m_pImpl = _swig_property(_SpeosNX.SimulationSettings_m_pImpl_get, _SpeosNX.SimulationSettings_m_pImpl_set) | |
| str | AmbientSampling = property(fget=__GetAmbientSampling, fset=__SetAmbientSampling) |
| Gets or sets the ambient sampling. | |
| str | AntiAliasing = property(fget=__GetAntiAliasing, fset=__SetAntiAliasing) |
| Gets or sets the anti-aliasing property. | |
| str | ColorimetricStandardMode = property(fget=__GetColorimetricStandardMode, fset=__SetColorimetricStandardMode) |
| Gets or sets the colorimetric standard type. | |
| str | DirectMaxImpact = property(fget=__GetDirectMaxImpact, fset=__SetDirectMaxImpact) |
| Gets or sets the specular approximation angle. | |
| str | DirectPhotonNumber = property(fget=__GetDirectPhotonNumber, fset=__SetDirectPhotonNumber) |
| Gets or sets the specular approximation angle. | |
| str | Dispersion = property(fget=__GetDispersion, fset=__SetDispersion) |
| Gets or sets the property to use dispersion. | |
| str | DrawImpacts = property(fget=__GetDrawImpacts, fset=__SetDrawImpacts) |
| Gets or sets the property to draw impacts. | |
| str | DrawRays = property(fget=__GetDrawRays, fset=__SetDrawRays) |
| Gets or sets the property to draw rays. | |
| str | FastTransmissionGathering = property(fget=__GetFastTransmissionGathering, fset=__SetFastTransmissionGathering) |
| Gets or sets the fast transmission gathering property. | |
| str | FinalGathering = property(fget=__GetFinalGathering, fset=__SetFinalGathering) |
| Gets or sets the final gathering property. | |
| str | FinalGatheringNeighbors = property(fget=__GetFinalGatheringNeighbors, fset=__SetFinalGatheringNeighbors) |
| Gets or sets the final gathering neighbors. | |
| str | GatheringSourceNumber = property(fget=__GetGatheringSourceNumber, fset=__SetGatheringSourceNumber) |
| Gets or sets the gathering source number. | |
| str | GeometricalDistanceTolerance = property(fget=__GetGeometricalDistanceTolerance, fset=__SetGeometricalDistanceTolerance) |
| Gets or sets the geometrical distance tolerance. | |
| str | InteractiveSimulationReport = property(fget=__GetInteractiveSimulationReport, fset=__SetInteractiveSimulationReport) |
| Gets or sets the property to report impact. | |
| str | IntermediateSaveFrequency = property(fget=__GetIntermediateSaveFrequency, fset=__SetIntermediateSaveFrequency) |
| Gets or sets the intermediate save frequency. | |
| str | MaxGatheringError = property(fget=__GetMaxGatheringError, fset=__SetMaxGatheringError) |
| Gets or sets the maximum gathering error. | |
| str | MaxNeighbors = property(fget=__GetMaxNeighbors, fset=__SetMaxNeighbors) |
| Gets or sets the maximum neighbors. | |
| str | MaxSearchRadius = property(fget=__GetMaxSearchRadius, fset=__SetMaxSearchRadius) |
| Gets or sets the maximum search radius. | |
| str | MaximumImpactNumber = property(fget=__GetMaximumImpactNumber, fset=__SetMaximumImpactNumber) |
| Gets or sets the maximum number of surface interaction. | |
| str | MeshingAngle = property(fget=__GetMeshingAngle, fset=__SetMeshingAngle) |
| Gets or sets the meshing angle. | |
| str | MeshingEdgeAngle = property(fget=__GetMeshingEdgeAngle, fset=__SetMeshingEdgeAngle) |
| Gets or sets the meshing edge angle. | |
| str | MeshingEdgeSag = property(fget=__GetMeshingEdgeSag, fset=__SetMeshingEdgeSag) |
| Gets or sets the meshing edge sag value. | |
| str | MeshingSagMode = property(fget=__GetMeshingSagMode, fset=__SetMeshingSagMode) |
| Gets or sets the meshing sag mode. | |
| str | MeshingSagValue = property(fget=__GetMeshingSagValue, fset=__SetMeshingSagValue) |
| Gets or sets the meshing sag value. | |
| str | MeshingStepMode = property(fget=__GetMeshingStepMode, fset=__SetMeshingStepMode) |
| Gets or sets the meshing step mode. | |
| str | MeshingStepValue = property(fget=__GetMeshingStepValue, fset=__SetMeshingStepValue) |
| Gets or sets the meshing step fixed value. | |
| str | MinimumEnergy = property(fget=__GetMinimumEnergy, fset=__SetMinimumEnergy) |
| Gets or sets the maximum number of surface interaction. | |
| str | MonteCarloAlgorithm = property(fget=__GetMonteCarloAlgorithm, fset=__SetMonteCarloAlgorithm) |
| Gets or sets the Monte Carlo algorithm property. | |
| str | NumberStandardPasses = property(fget=__GetNumberStandardPasses, fset=__SetNumberStandardPasses) |
| Gets or sets the number of standard passes before optimized passes. | |
| str | OptimizedPropagation = property(fget=__GetOptimizedPropagation, fset=__SetOptimizedPropagation) |
| Gets or sets optimized propagation type. | |
| str | PhotonMapMode = property(fget=__GetPhotonMapMode, fset=__SetPhotonMapMode) |
| Gets or sets the photon map mode. | |
| str | RayTracerPrecisionMode = property(fget=__GetRayTracerPrecisionMode, fset=__SetRayTracerPrecisionMode) |
| Gets or sets ray tracer precision mode. | |
| str | RenderingAsOptical = property(fget=__GetRenderingAsOptical, fset=__SetRenderingAsOptical) |
| Gets or sets the property to use rendering as optical properties. | |
| str | SaveIntermediateMaps = property(fget=__GetSaveIntermediateMaps, fset=__SetSaveIntermediateMaps) |
| Gets or sets the intermediate save frequency. | |
| str | SmartEngine = property(fget=__GetSmartEngine, fset=__SetSmartEngine) |
| Gets or sets the smart engine value. | |
| str | SpecificFacetEdgesParameters = property(fget=__GetSpecificFacetEdgesParameters, fset=__SetSpecificFacetEdgesParameters) |
| Gets or sets the specific parameters property for facet edges. | |
| str | SpecularApproxAngle = property(fget=__GetSpecularApproxAngle, fset=__SetSpecularApproxAngle) |
| Gets or sets the specular approximation angle. | |
| str | SpecularMaxImpact = property(fget=__GetSpecularMaxImpact, fset=__SetSpecularMaxImpact) |
| Gets or sets the specular maximum impact number. | |
| str | Splitting = property(fget=__GetSplitting, fset=__SetSplitting) |
| Gets or sets the property to use splitting for inverse simulation. | |
| str | SplittingNumber = property(fget=__GetSplittingNumber, fset=__SetSplittingNumber) |
| Gets or sets the splitting number. | |
| str | Texture = property(fget=__GetTexture, fset=__SetTexture) |
| Gets or sets the property to use texture mapping. | |
| str | TextureNormalizationMode = property(fget=__GetTextureNormalizationMode, fset=__SetTextureNormalizationMode) |
| Gets or sets texture normalization mode. | |
Detailed Description
Represents the interface for editing custom simulation settings.
To create a new instance of this class, use SimulationCommonBuilder::GetSettings
Member Function Documentation
◆ SaveAsPreset()
| 'bool' SaveAsPreset | ( | self, | |
| name ) |
Save the simulation settings as preset.
- Parameters
-
[in] name : name of the preset.
- Returns
- True: Success.
False: Error.
Member Data Documentation
◆ AmbientSampling
|
static |
Gets or sets the ambient sampling.
Prerequisite: The UseMonteCarlo property must be False.
Value type: Integer.
Range: [1, 1000000].
The default value is 100.
◆ AntiAliasing
|
static |
Gets or sets the anti-aliasing property.
Prerequisite: The UseMonteCarlo property must be False.
True: Uses anti-aliasing.
False: Does not use anti-aliasing.
Reduces artifacts as jagged profiles and fine details but increasing the simulation time.
Value type: Boolean.
The default value is True.
◆ ColorimetricStandardMode
|
static |
Gets or sets the colorimetric standard type.
The values are:
0 - CIE 1931.
1 - CIE 1936.
Value type: Integer.
The default value is 0.
◆ DirectMaxImpact
|
static |
Gets or sets the specular approximation angle.
Prerequisite: The PhotonMapMode property must be 1 or 3.
Represents the max impact of rays in the direct phase.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 100.
◆ DirectPhotonNumber
|
static |
Gets or sets the specular approximation angle.
Prerequisite: The PhotonMapMode property must be 1 or 3.
Represents the number of rays sent in the direct phase.
Value type: Integer.
Range: (0, 200000].
The default value is 10000.
◆ Dispersion
|
static |
Gets or sets the property to use dispersion.
Prerequisite: The UseMonteCarlo property must be True.
True: Activates dispersion.
False: Deactivates dispersion.
Value type: Boolean.
The default value is False.
◆ DrawImpacts
|
static |
Gets or sets the property to draw impacts.
Displays the impacts in the 3D view.
True: Draws impacts.
False: Does not draw impacts.
Value type: Boolean.
The default value is False.
◆ DrawRays
|
static |
Gets or sets the property to draw rays.
Displays the ray trajectories in the 3D view.
True: Draws rays.
False: Does not draw rays.
Value type: Boolean.
The default value is True.
◆ FastTransmissionGathering
|
static |
Gets or sets the fast transmission gathering property.
Prerequisite: The UseMonteCarlo property must be True.
True: Uses fast transmission gathering.
False: Does not use fast transmission gathering.
Value type: Boolean.
The default value is False.
◆ FinalGathering
|
static |
Gets or sets the final gathering property.
Prerequisite: The PhotonMapMode property must be 1, 2 or 3.
True: Uses final gathering.
False: Does not use final gathering.
Value type: Boolean.
The default value is False.
◆ FinalGatheringNeighbors
|
static |
Gets or sets the final gathering neighbors.
Prerequisite: The UseFinalGathering property must be True.
Pilots the number of neighbors after the secondary rays. They are used to compute the luminance for each split ray.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 10.
◆ GatheringSourceNumber
|
static |
Gets or sets the gathering source number.
Prerequisite: The UseMonteCarlo property must be True.
The gathering source number parameter pilots the number of shadow rays to target at each source.
Value type: Integer.
Range: The value must be superior or equal to 0.
The default value is 1.
◆ GeometricalDistanceTolerance
|
static |
Gets or sets the geometrical distance tolerance.
The Geometrical distance tolerance defines the maximum distance to consider two faces as tangent.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 0.05 mm.
◆ InteractiveSimulationReport
|
static |
Gets or sets the property to report impact.
Activates the addition of information to the HTML simulation report.
True: Reports impacts.
False: Does not report impacts.
Value type: Boolean.
The default value is False.
◆ IntermediateSaveFrequency
|
static |
Gets or sets the intermediate save frequency.
Value type: Integer (in seconds).
Range: The value must be superior or equal to 300.
The default value is 1800 s.
◆ MaxGatheringError
|
static |
Gets or sets the maximum gathering error.
Prerequisite: The UseMonteCarlo property must be True.
Defines the level below which a source can be neglected.
Value type: Double.
Range: [0.0, 100.0].
The default value is 0.0.
◆ MaximumImpactNumber
|
static |
Gets or sets the maximum number of surface interaction.
The maximum number of surface interactions value defines the maximum number of ray impacts during propagation.
Value type: Integer.
Range: The value must be superior to 0
The default value is 100.
◆ MaxNeighbors
|
static |
Gets or sets the maximum neighbors.
Prerequisite: The PhotonMapMode property must be 1, 2 or 3.
Represents the number of photons from the photon map taken into account to calculate the luminance.
Value type: Integer.
Range: (0, 10000].
The default value is 100.
◆ MaxSearchRadius
|
static |
Gets or sets the maximum search radius.
Prerequisite: The PhotonMapMode property must be 1, 2 or 3.
Represents the maximum distance from the luminance calculation's point to search for neighbors contribution.
Value type: Double (in mm).
Range:The value must be superior to 0.
The default value is 100000000.0 mm.
◆ MeshingAngle
|
static |
Gets or sets the meshing angle.
Value type: Double (in degrees).
Range: (0.0, 90.0).
The default value is 15.0 degrees.
◆ MeshingEdgeAngle
|
static |
Gets or sets the meshing edge angle.
Prerequisite The SpecificFacetEdgesParameters property must be True.
Defines the maximum angular variation in degrees between successive tangents for all points along a solid edge.
Value type: Double (in degrees).
Range: (0.0, 90.0).
The default value is 10.0 degrees.
◆ MeshingEdgeSag
|
static |
Gets or sets the meshing edge sag value.
Prerequisite The SpecificFacetEdgesParameters property must be True.
Defines the maximum distance between the geometry and the meshing on the edges. The Meshing edge sag value always uses the Fixed mode.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 0.1 mm.
◆ MeshingSagMode
|
static |
Gets or sets the meshing sag mode.
The values are:
0 - Proportional, the value adapts and adjusts to the size of each face of the object.
1 - Fixed, the value will remain unchanged no matter the size or shape of the object.
Value type: Integer.
The default value is 0.
◆ MeshingSagValue
|
static |
Gets or sets the meshing sag value.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 0.5 mm.
◆ MeshingStepMode
|
static |
Gets or sets the meshing step mode.
The values are:
0 - Proportional, the value adapts and adjusts to the size of each face of the object.
1 - Fixed, the value will remain unchanged no matter the size or shape of the object.
Value type: Integer.
The default value is 0.
◆ MeshingStepValue
|
static |
Gets or sets the meshing step fixed value.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 1.0 mm.
◆ MinimumEnergy
|
static |
Gets or sets the maximum number of surface interaction.
Prerequisite The UseWeight property must be True.
The Minimum energy percentage value defines the minimum energy ratio to continue to propagate a ray with weight.
Value type: Double.
Range: [0.0, 10000.0]
The default value is 0.5.
◆ MonteCarloAlgorithm
|
static |
Gets or sets the Monte Carlo algorithm property.
True: Uses Monte Carlo algorithm.
False: Uses deterministic algorithm.
Value type: Boolean.
The default value is True.
◆ NumberStandardPasses
|
static |
Gets or sets the number of standard passes before optimized passes.
Prerequisite: The OptimizedMode property must be 1 or 2.
Corresponds to the minimum number of passes without pass optimization.
Value type: Integer.
The default value is 0.
◆ OptimizedPropagation
|
static |
Gets or sets optimized propagation type.
Prerequisite: The UseMonteCarlo property must be True.
The values are:
0 - None, the same number of passes is used for each pixel of the image.
1 - Relative, the algorithm adapts the number of passes per pixel to send the optimal number of rays according to the signal each pixel needs.
2 - Absolute, same as relative, however the method of calculation is slightly different.
Value type: Integer.
The default value is 0.
◆ PhotonMapMode
|
static |
Gets or sets the photon map mode.
Prerequisite: The UseMonteCarlo property must be False.
The values are:
0 - No photon map.
1 - Build photon map.
2 - Load photon map.
3 - Build and save photon map.
Value type: Integer.
The default value is 0.
◆ RayTracerPrecisionMode
|
static |
Gets or sets ray tracer precision mode.
The values are:
0 - Automatic.
1 - Double.
2 - Single.
Value type: Integer.
The default value is 0.
◆ RenderingAsOptical
|
static |
Gets or sets the property to use rendering as optical properties.
True: Uses rendering as optical properties.
False: Does not use rendering as optical properties.
Value type: Boolean.
The default value is False.
◆ SaveIntermediateMaps
|
static |
Gets or sets the intermediate save frequency.
Value type: Integer.
Range: The value must be superior or equal to 300.
The default value is 1800.
◆ SmartEngine
|
static |
Gets or sets the smart engine value.
Prerequisite: The RayTracerPrecisionMode property must be 1.
The Smart Engine value defines a balance between the speed and the memory. The higher the value, the more subdivided the scene becomes.
Value type: Integer.
Range: [1, 15].
The default value is 11.
◆ SpecificFacetEdgesParameters
|
static |
Gets or sets the specific parameters property for facet edges.
Allows to control the precision of the meshing on the edges of the faces.
True: Enables specific parameters for facet edges.
False: Disables specific parameters for facet edges.
Value type: Boolean.
The default value is False.
◆ SpecularApproxAngle
|
static |
Gets or sets the specular approximation angle.
Prerequisite: The UseMonteCarlo property must be False.
Reduces artifacts as jagged profiles and fine details but increasing the simulation time.
Value type: Double (in degrees).
Range: The value must be superior or equal to 0.0.
The default value is 0.0 degrees.
◆ SpecularMaxImpact
|
static |
Gets or sets the specular maximum impact number.
Prerequisite: The UseMonteCarlo property must be False.
Value type: Integer.
Range: [0, 15].
The default value is 10.
◆ Splitting
|
static |
Gets or sets the property to use splitting for inverse simulation.
Prerequisite: The UseMonteCarlo property must be True.
If you do so, the path of each reverse propagated ray is split in more paths at the first impact after leaving the observer point.
True: Activates splitting.
False: Deactivates splitting.
Value type: Boolean.
The default value is False.
◆ SplittingNumber
|
static |
Gets or sets the splitting number.
Prerequisite: The UseFinalGathering property must be True.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 15.
◆ Texture
|
static |
Gets or sets the property to use texture mapping.
True: Uses texture as optical properties.
False: Does not use texture as optical properties.
Value type: Boolean.
The default value is True.
◆ TextureNormalizationMode
|
static |
Gets or sets texture normalization mode.
Prerequisite: The UseTexture property must be True.
The values are:
0 - None. The simulation results uses both the Image Texture and the Texture Mapping Optical Properties.
1 - Color from BRDF. The simulation result uses the BRDF information of the Texture Mapping Optical Properties.
2 - Color from texture. The simulation result uses the color and the color lightness of the Image Texture.
Value type: Integer.
The default value is 0.
The documentation for this class was generated from the following file:
- SpeosNX.py
