FeatureCollection Class Reference
Last update: 17.07.2025Represents the collection of Speos features in a Part. More...
Inheritance diagram for FeatureCollection:
Public Member Functions | |
| 'Feature' | FindFromTag (self, tag) |
| Finds the feature with the given Tag. | |
| 'Feature' | FindFromName (self, name) |
| Finds the feature with the given name. | |
| 'SourceDisplayBuilder' | CreateSourceDisplayBuilder (self, featureToEdit) |
| Creates a builder for a display source. | |
| 'SourceAmbientGeneralSkyBuilder' | CreateSourceAmbientGeneralSkyBuilder (self, featureToEdit) |
| Creates a builder for an ambient source with CIE General Sky type. | |
| 'SourceAmbientNaturalLightBuilder' | CreateSourceAmbientNaturalLightBuilder (self, featureToEdit) |
| Creates a builder for an ambient source with Natural Light type. | |
| 'SourceAmbientOvercastSkyBuilder' | CreateSourceAmbientOvercastSkyBuilder (self, featureToEdit) |
| Creates a builder for an ambient source with Overcast Sky type. | |
| 'SourceAmbientUniformBuilder' | CreateSourceAmbientUniformBuilder (self, featureToEdit) |
| Creates a builder for an ambient source with Uniform type. | |
| 'SourceAmbientUS1976Builder' | CreateSourceAmbientUS1976Builder (self, featureToEdit) |
| Creates a builder for an U.S. | |
| 'SourceLuminaireBuilder' | CreateSourceLuminaireBuilder (self, featureToEdit) |
| Creates a builder for a luminaire source. | |
| 'SourceAmbientEnvironmentBuilder' | CreateSourceAmbientEnvironmentBuilder (self, featureToEdit) |
| Creates a builder for an ambient environment source. | |
| 'SourceSurfaceBuilder' | CreateSourceSurfaceBuilder (self, featureToEdit) |
| Creates a builder for a surface source. | |
| 'SourceRayFileBuilder' | CreateSourceRayFileBuilder (self, featureToEdit) |
| Creates a builder for a ray file source. | |
| 'SourceSurfaceThermicBuilder' | CreateSourceSurfaceThermicBuilder (self, featureToEdit) |
| Creates a builder for a thermic surface source. | |
| 'SourceGroupBuilder' | CreateSourceGroupBuilder (self, featureToEdit) |
| Creates a builder for a source group. | |
| 'SourceLightFieldBuilder' | CreateSourceLightFieldBuilder (self, featureToEdit) |
| Creates a builder for a light field source. | |
| 'SensorLightFieldBuilder' | CreateSensorLightFieldBuilder (self, featureToEdit) |
| Creates a builder for a light field sensor. | |
| 'SensorRadianceBuilder' | CreateSensorRadianceBuilder (self, featureToEdit) |
| Creates a builder for a radiance sensor. | |
| 'SensorIrradianceBuilder' | CreateSensorIrradianceBuilder (self, featureToEdit) |
| Creates a builder for an irradiance sensor. | |
| 'SensorIntensityBuilder' | CreateSensorIntensityBuilder (self, featureToEdit) |
| Creates a builder for an intensity sensor. | |
| 'Sensor3DEnergyDensityBuilder' | CreateSensor3DEnergyDensityBuilder (self, featureToEdit) |
| Creates a builder for a 3D energy density sensor. | |
| 'SensorVRImmersiveBuilder' | CreateSensorVRImmersiveBuilder (self, featureToEdit) |
| Creates a builder for a VR immersive sensor. | |
| 'Sensor3DIrradianceBuilder' | CreateSensor3DIrradianceBuilder (self, featureToEdit) |
| Creates a builder for a 3D irradiance sensor. | |
| 'SensorObserverBuilder' | CreateSensorObserverBuilder (self, featureToEdit) |
| Creates a builder for an observer sensor. | |
| 'SensorCameraBuilder' | CreateSensorCameraBuilder (self, featureToEdit) |
| Creates a builder for a camera sensor. | |
| 'SensorHumanEyeBuilder' | CreateSensorHumanEyeBuilder (self, featureToEdit) |
| Creates a builder for a human eye sensor. | |
| 'SensorPhysicalCameraBuilder' | CreateSensorPhysicalCameraBuilder (self, featureToEdit) |
| Creates a builder for an Physical Camera sensor. | |
| 'SimulationInteractiveBuilder' | CreateSimulationInteractiveBuilder (self, featureToEdit) |
| Creates a builder for an interactive simulation. | |
| 'SimulationDirectBuilder' | CreateSimulationDirectBuilder (self, featureToEdit) |
| Creates a builder for a direct simulation. | |
| 'SimulationInverseBuilder' | CreateSimulationInverseBuilder (self, featureToEdit) |
| Creates a builder for an inverse simulation. | |
| 'ComponentLightBoxImportBuilder' | CreateComponentLightBoxImportBuilder (self, featureToEdit) |
| Creates a builder for a light box import component. | |
| 'ComponentLightBoxExportBuilder' | CreateComponentLightBoxExportBuilder (self, featureToEdit) |
| Creates a builder for an export light box component. | |
| 'OpticalPropertiesBuilder' | CreateOpticalPropertiesBuilder (self, featureToEdit) |
| Creates a builder for an optical property. | |
| 'SpeosPatternBuilder' | CreateSpeosPatternBuilder (self, featureToEdit) |
| Creates a builder for a Speos pattern. | |
| 'FolderBuilder' | CreateFolderBuilder (self, featureToEdit) |
| Creates a builder for a Folder. | |
Static Public Attributes | |
| str | OpticalPropertyFeatures = property(fget=__GetOpticalPropertyFeatures) |
| Returns all optical properties belonging to the part. | |
| str | SensorFeatures = property(fget=__GetSensorFeatures) |
| Returns all sensors belonging to the part. | |
| str | SimulationFeatures = property(fget=__GetSimulationFeatures) |
| Returns all simulations belonging to the part. | |
Detailed Description
Represents the collection of Speos features in a Part.
There is only one instance of FeatureCollection for each Part.
To obtain an instance of this class, refer to Part.
Member Function Documentation
◆ CreateComponentLightBoxExportBuilder()
| 'ComponentLightBoxExportBuilder' CreateComponentLightBoxExportBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an export light box component.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- CComponentLightBoxExportBuilder object.
◆ CreateComponentLightBoxImportBuilder()
| 'ComponentLightBoxImportBuilder' CreateComponentLightBoxImportBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a light box import component.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- CComponentLightBoxImpportBuilder object.
◆ CreateFolderBuilder()
| 'FolderBuilder' CreateFolderBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a Folder.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- FolderBuilder object.
◆ CreateOpticalPropertiesBuilder()
| 'OpticalPropertiesBuilder' CreateOpticalPropertiesBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an optical property.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- OpticalPropertiesBuilder object.
◆ CreateSensor3DEnergyDensityBuilder()
| 'Sensor3DEnergyDensityBuilder' CreateSensor3DEnergyDensityBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a 3D energy density sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- Sensor3DEnergyDensityBuilder object.
◆ CreateSensor3DIrradianceBuilder()
| 'Sensor3DIrradianceBuilder' CreateSensor3DIrradianceBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a 3D irradiance sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- Sensor3DIrradianceBuilder object.
◆ CreateSensorCameraBuilder()
| 'SensorCameraBuilder' CreateSensorCameraBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a camera sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorCamera object.
◆ CreateSensorHumanEyeBuilder()
| 'SensorHumanEyeBuilder' CreateSensorHumanEyeBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a human eye sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorHumanEye object.
◆ CreateSensorIntensityBuilder()
| 'SensorIntensityBuilder' CreateSensorIntensityBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an intensity sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorIntensityBuilder object.
◆ CreateSensorIrradianceBuilder()
| 'SensorIrradianceBuilder' CreateSensorIrradianceBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an irradiance sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorIrradianceBuilder object.
◆ CreateSensorLightFieldBuilder()
| 'SensorLightFieldBuilder' CreateSensorLightFieldBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a light field sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorLightFieldBuilder object.
◆ CreateSensorObserverBuilder()
| 'SensorObserverBuilder' CreateSensorObserverBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an observer sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorObserverBuilder object.
◆ CreateSensorPhysicalCameraBuilder()
| 'SensorPhysicalCameraBuilder' CreateSensorPhysicalCameraBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an Physical Camera sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorPhysicalCameraBuilder object.
◆ CreateSensorRadianceBuilder()
| 'SensorRadianceBuilder' CreateSensorRadianceBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a radiance sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorRadianceBuilder object.
◆ CreateSensorVRImmersiveBuilder()
| 'SensorVRImmersiveBuilder' CreateSensorVRImmersiveBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a VR immersive sensor.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SensorVRImmersiveBuilder object.
◆ CreateSimulationDirectBuilder()
| 'SimulationDirectBuilder' CreateSimulationDirectBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a direct simulation.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SimulationDirectBuilder object.
◆ CreateSimulationInteractiveBuilder()
| 'SimulationInteractiveBuilder' CreateSimulationInteractiveBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an interactive simulation.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SimulationInteractiveBuilder object.
◆ CreateSimulationInverseBuilder()
| 'SimulationInverseBuilder' CreateSimulationInverseBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an inverse simulation.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SimulationInverseBuilder object.
◆ CreateSourceAmbientEnvironmentBuilder()
| 'SourceAmbientEnvironmentBuilder' CreateSourceAmbientEnvironmentBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an ambient environment source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceAmbientEnvironmentBuilder object.
◆ CreateSourceAmbientGeneralSkyBuilder()
| 'SourceAmbientGeneralSkyBuilder' CreateSourceAmbientGeneralSkyBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an ambient source with CIE General Sky type.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceAmbientGeneralSkyBuilder object.
◆ CreateSourceAmbientNaturalLightBuilder()
| 'SourceAmbientNaturalLightBuilder' CreateSourceAmbientNaturalLightBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an ambient source with Natural Light type.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceAmbientNaturalLightBuilder object.
◆ CreateSourceAmbientOvercastSkyBuilder()
| 'SourceAmbientOvercastSkyBuilder' CreateSourceAmbientOvercastSkyBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an ambient source with Overcast Sky type.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceAmbientOvercastSkyBuilder object.
◆ CreateSourceAmbientUniformBuilder()
| 'SourceAmbientUniformBuilder' CreateSourceAmbientUniformBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for an ambient source with Uniform type.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceAmbientUniformBuilder object.
◆ CreateSourceAmbientUS1976Builder()
| 'SourceAmbientUS1976Builder' CreateSourceAmbientUS1976Builder | ( | self, | |
| featureToEdit ) |
Creates a builder for an U.S.
Standard Atmosphere 1976 source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceAmbientUS1976SkyBuilder object.
◆ CreateSourceDisplayBuilder()
| 'SourceDisplayBuilder' CreateSourceDisplayBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a display source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceDisplayBuilder object.
◆ CreateSourceGroupBuilder()
| 'SourceGroupBuilder' CreateSourceGroupBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a source group.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceGroup object.
◆ CreateSourceLightFieldBuilder()
| 'SourceLightFieldBuilder' CreateSourceLightFieldBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a light field source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceLightFieldBuilder object.
◆ CreateSourceLuminaireBuilder()
| 'SourceLuminaireBuilder' CreateSourceLuminaireBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a luminaire source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceLuminaireBuilder object.
◆ CreateSourceRayFileBuilder()
| 'SourceRayFileBuilder' CreateSourceRayFileBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a ray file source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceRayFileBuilder object.
◆ CreateSourceSurfaceBuilder()
| 'SourceSurfaceBuilder' CreateSourceSurfaceBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a surface source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceSurfaceBuilder object.
◆ CreateSourceSurfaceThermicBuilder()
| 'SourceSurfaceThermicBuilder' CreateSourceSurfaceThermicBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a thermic surface source.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SourceSurfaceThermicBuilder object.
◆ CreateSpeosPatternBuilder()
| 'SpeosPatternBuilder' CreateSpeosPatternBuilder | ( | self, | |
| featureToEdit ) |
Creates a builder for a Speos pattern.
- Parameters
-
[in] featureToEdit the feature to be edited or None to create a new feature.
- Returns
- SpeosPatternBuilder object.
◆ FindFromName()
| 'Feature' FindFromName | ( | self, | |
| name ) |
Finds the feature with the given name.
This function only accepts a full feature name (e.g., "Direct Simulation (0)").
- Parameters
-
[in] name : String.
- Returns
- The feature with the given name.
◆ FindFromTag()
| 'Feature' FindFromTag | ( | self, | |
| tag ) |
Finds the feature with the given Tag.
This function takes as parameter a feature tag.
- Parameters
-
[in] Tag : Integer.
- Returns
- The feature with the given Tag.
Member Data Documentation
◆ OpticalPropertyFeatures
|
static |
Returns all optical properties belonging to the part.
Returns a list containing all properties, including those for folders, but not the folder itself. Value type: List of Feature.
◆ SensorFeatures
|
static |
Returns all sensors belonging to the part.
Returns a list containing all sensors, including those for folders, but not the folder itself. Value type: List of Feature.
◆ SimulationFeatures
|
static |
Returns all simulations belonging to the part.
Returns a list containing all simulations, including those for folders, but not the folder itself. Value type: List of Feature.
The documentation for this class was generated from the following file:
- SpeosNX.py
