## On this page # SimulationInverseBuilder Class Reference Last update: 17.07.2025 Represents an Inverse Simulation Builder. [More...](#details) Inheritance diagram for SimulationInverseBuilder: ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_simulation_inverse_builder.png) ## Public Member Functions [AddSourceFaceFilteringReferences](#a7598bf83dc06bc58ec855cf4a061ebf0) (self, tags) Adds sources faces filtering into the simulation. [DeleteSourceFaceFilteringReferences](#a15bf9da521ec1b18da49f156d3971ae8) (self, tags) Deletes sources faces filtering from the simulation. ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [SimulationCommonBuilder](class_speos_n_x_1_1_simulation_common_builder.xhtml) [AddSources](class_speos_n_x_1_1_simulation_common_builder.xhtml#a99f17a25fe9e579fc3504b17728ca2da) (self, sources) Adds sources into the simulation. [RemoveSources](class_speos_n_x_1_1_simulation_common_builder.xhtml#ac10a0c4124712e65cb3a6c55fc1350f3) (self, sources) Deletes sources from the simulation. [AddGeometries](class_speos_n_x_1_1_simulation_common_builder.xhtml#a0ec813b00b8afd7a9702b5cf2f1525b2) (self, tags) Adds geometries into the simulation. [RemoveGeometries](class_speos_n_x_1_1_simulation_common_builder.xhtml#a30e21d1cd47e7d87d547daede1cb45e4) (self, tags) Deletes geometries from the simulation. [AddSensors](class_speos_n_x_1_1_simulation_common_builder.xhtml#a2823ee2dcd595a45c1870bcaf47205e2) (self, sensors) Adds sensors into the simulation. [RemoveSensors](class_speos_n_x_1_1_simulation_common_builder.xhtml#a2cdb6d650a57ad372cff24bcf8e6ad10) (self, sensors) Deletes sensors from the simulation. ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a2b74e1b440341a82332053432b52b42c) (self) Commits any edits that have been applied to the builder. **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. ## Properties [Duration](#a8318f4a102968ced04ab2b96b7ddc91f) = property(fget = \_\_GetDuration, fset = \_\_SetDuration) toto [FamilySelection](#a0ab03e771c58adbf47c04e62524ab0c1) = property(fget = \_\_GetFamilySelection, fset = \_\_SetFamilySelection) Gets or sets the family selection list. [MaximumNumberOfPaths](#a9d9cca5ae67ecb673e2877455968f317) = property(fget = \_\_GetMaximumNumberOfPaths, fset = \_\_SetMaximumNumberOfPaths) Gets or sets the maximum number of paths. [PassNumber](#a10832b2898ffe8ea310497a8b7142e3e) = property(fget = \_\_GetPassNumber, fset = \_\_SetPassNumber) Gets or sets the pass number. [SourcesFacesFilteringReferences](#a722877941e7a90874709a30cf8e52fb0) = property(fget = \_\_GetSourcesFacesFilteringReferences) Gets the sources faces filtering. [StopOnDuration](#a62c95807266af389ad43a421001a9593) = property(fget = \_\_GetStopOnDuration, fset = \_\_SetStopOnDuration) Gets or sets the duration. [StopOnPassNumber](#a7563f5d6fd445811eac8fa58cf15fac1) = property(fget = \_\_GetStopOnPassNumber, fset = \_\_SetStopOnPassNumber) Gets or sets the property to enable stop on pass number. [UsePartFamilies](#ad4452745fc2dfed208ac920492795371) = property(fget = \_\_GetUsePartFamilies, fset = \_\_SetUsePartFamilies) Gets or sets the property to use family tables. ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [SimulationCommonBuilder](class_speos_n_x_1_1_simulation_common_builder.xhtml) [AllPreset](class_speos_n_x_1_1_simulation_common_builder.xhtml#a2d38741fb47265ebdb84e60609c7d2d8) = property(fget = \_\_GetAllPreset) Gets all Preset. [AmbientMaterial](class_speos_n_x_1_1_simulation_common_builder.xhtml#a641797a3dee312fe1b16f7802892cbd7) = property(fget = \_\_GetAmbientMaterial, fset = \_\_SetAmbientMaterial) Gets or sets the property to enable ambient material. [EstimatedRam](class_speos_n_x_1_1_simulation_common_builder.xhtml#a01394f4c9bed5f61748a591f2b4ce881) = property(fget = \_\_GetEstimatedRam) Gets the estimated RAM usage. [FeatureSimulation](class_speos_n_x_1_1_simulation_common_builder.xhtml#aea2ecab47bbbf24fd10319127c9d8015) = property(fget = \_\_GetFeatureSimulation) Gets the simulation feature object. [Geometries](class_speos_n_x_1_1_simulation_common_builder.xhtml#a98788fbe263fc2e12068ecc7ddbadbc7) = property(fget = \_\_GetGeometries) Gets geometries tag. [LightExpert](class_speos_n_x_1_1_simulation_common_builder.xhtml#a661765be07a8c635f5abb0dab4c3927d) = property(fget = \_\_GetLightExpert, fset = \_\_SetLightExpert) Gets or sets the property to enable Light Expert. [Preset](class_speos_n_x_1_1_simulation_common_builder.xhtml#ad9b61b7f2b7dbe4c6816a994778e318f) = property(fget = \_\_GetPreset, fset = \_\_SetPreset) Gets or sets the Preset object. [SelectAmbientMaterial](class_speos_n_x_1_1_simulation_common_builder.xhtml#a648a4416c8d3b6af5b24abc08ed5290a) = property(fget = \_\_GetSelectAmbientMaterial, fset = \_\_SetSelectAmbientMaterial) Gets or set the ambient material. [Sensors](class_speos_n_x_1_1_simulation_common_builder.xhtml#aa98b6524756441f584e32369e01c056e) = property(fget = \_\_GetSensors) Gets sensor features. [Settings](class_speos_n_x_1_1_simulation_common_builder.xhtml#add3c793dad9f47bc87861b43af7038d1) = property(fget = \_\_GetSettings, fset = \_\_SetSettings) Gets or sets the simulation settings. [Sources](class_speos_n_x_1_1_simulation_common_builder.xhtml#a4dd596ec01d5279a29972479e475fc16) = property(fget = \_\_GetSources) Gets source features. **StandardDeviation** = property(fget = \_\_GetStandardDeviation, fset = \_\_SetStandardDeviation) [UsePresetSettings](class_speos_n_x_1_1_simulation_common_builder.xhtml#a1fc3778f8d488ad1316a09023625ea3b) = property(fget = \_\_GetUsePresetSettings, fset = \_\_SetUsePresetSettings) Gets or sets the property to enable preset settings. ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Feature](class_speos_n_x_1_1_feature_builder.xhtml#a94ea57aab7fe0356cbfbd048b1ad971e) = property(fget = \_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode. [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a0b7259da2de11c688aa435d1f0509134) = property(fget = \_\_GetFullName) Gets the full name of the feature being edited. [Name](class_speos_n_x_1_1_feature_builder.xhtml#aa5998168cabfb2b2e41151349077812c) = property(fget = \_\_GetName, fset = \_\_SetName) Gets or sets the name of the feature being edited. [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a99e8764720550e4ed0eba629a625b2e3) = property(fget = \_\_GetNameWithContext) Gets the name with context of the feature being edited. [Status](class_speos_n_x_1_1_feature_builder.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b) = property(fget = \_\_GetStatus) Returns the status of the feature being edited. ## Detailed Description Represents an Inverse Simulation Builder. The Inverse Simulation Builder is used to create and edit Inverse Simulation features. To create a new instance of this class, use FeatureCollection::CreateSimulationInverseBuilder ## Member Function Documentation ## [◆ ](#a7598bf83dc06bc58ec855cf4a061ebf0)AddSourceFaceFilteringReferences() AddSourceFaceFilteringReferences ( *self*, *tags* ) Adds sources faces filtering into the simulation. The AddSourceFaceFilteringRefs function takes a list of feature tag as parameter. Parameters \[in\]tags: List of integer. Returnsvoid. ## [◆ ](#a15bf9da521ec1b18da49f156d3971ae8)DeleteSourceFaceFilteringReferences() DeleteSourceFaceFilteringReferences ( *self*, *tags* ) Deletes sources faces filtering from the simulation. The DeleteSourceFaceFilteringRefs function takes a list of feature tag as parameter. Parameters \[in\]tags: List of integer. Returnsvoid. ## Property Documentation ## [◆ ](#a8318f4a102968ced04ab2b96b7ddc91f)Duration Duration = property(fget = \_\_GetDuration, fset = \_\_SetDuration) static toto toto Returnstoto ## [◆ ](#a0ab03e771c58adbf47c04e62524ab0c1)FamilySelection FamilySelection = property(fget = \_\_GetFamilySelection, fset = \_\_SetFamilySelection) static Gets or sets the family selection list. **Prerequisite**: The UseFamilyTables property must be True. Selects the configurations to run with the simulation. **Value type**: List of string. The default value is an empty list. ## [◆ ](#a9d9cca5ae67ecb673e2877455968f317)MaximumNumberOfPaths MaximumNumberOfPaths = property(fget = \_\_GetMaximumNumberOfPaths, fset = \_\_SetMaximumNumberOfPaths) static Gets or sets the maximum number of paths. **Prerequisite**: The EnableLightExpert property must be True. The Maximum paths corresponds to the maximum number of rays the Light Path Finder file (\*.lpf or \*.lp3) can contain. **Value type**: Integer. **Range**: The value must be superior to 0. The default value is 100,000. ## [◆ ](#a10832b2898ffe8ea310497a8b7142e3e)PassNumber PassNumber = property(fget = \_\_GetPassNumber, fset = \_\_SetPassNumber) static Gets or sets the pass number. **Prerequisite**: The StopOnPassNumber property must be True. **Value type**: Integer. **Range**: the value must be superior to 0. The default value is 5. ## [◆ ](#a722877941e7a90874709a30cf8e52fb0)SourcesFacesFilteringReferences SourcesFacesFilteringReferences = property(fget = \_\_GetSourcesFacesFilteringReferences) static Gets the sources faces filtering. The SourcesFacesFilteringRef property returns a list of feature tag. **Value type**: List of integer. ## [◆ ](#a62c95807266af389ad43a421001a9593)StopOnDuration StopOnDuration = property(fget = \_\_GetStopOnDuration, fset = \_\_SetStopOnDuration) static Gets or sets the duration. **Prerequisite**: The StopOnDuration property must be True. Time necessary to reach for the simulation to end. **Value type**: Double (in second). **Range**: The value must be superior to 0.0. The default value is 1800.0 s. ## [◆ ](#a7563f5d6fd445811eac8fa58cf15fac1)StopOnPassNumber StopOnPassNumber = property(fget = \_\_GetStopOnPassNumber, fset = \_\_SetStopOnPassNumber) static Gets or sets the property to enable stop on pass number. True: Enables stop on PassNumber property False: Disables stop on PassNumber property **Value type**: Boolean. The default value is True. ## [◆ ](#ad4452745fc2dfed208ac920492795371)UsePartFamilies UsePartFamilies = property(fget = \_\_GetUsePartFamilies, fset = \_\_SetUsePartFamilies) static Gets or sets the property to use family tables. True: Enables multi-configuration to run in the simulation. False: Disables multi-configuration to run in the simulation. **Value type**: Boolean. The default value is False. --- The documentation for this class was generated from the following file:- **SpeosNX.py**