FeatureCollection Class Reference
Last update: 17.07.2025Represents the collection of Speos features in a Part. More...
Public Member Functions | |
| FindFromTag (self, tag) | |
| Finds the feature with the given Tag. | |
| FindFromName (self, name) | |
| Finds the feature with the given name. | |
| CreateSourceDisplayBuilder (self, featureToEdit) | |
| Creates a builder for a display source. | |
| CreateSourceAmbientGeneralSkyBuilder (self, featureToEdit) | |
| Creates a builder for an ambient source with CIE General Sky type. | |
| CreateSourceAmbientNaturalLightBuilder (self, featureToEdit) | |
| Creates a builder for an ambient source with Natural Light type. | |
| CreateSourceAmbientOvercastSkyBuilder (self, featureToEdit) | |
| Creates a builder for an ambient source with Overcast Sky type. | |
| CreateSourceAmbientUniformBuilder (self, featureToEdit) | |
| Creates a builder for an ambient source with Uniform type. | |
| CreateSourceAmbientUS1976Builder (self, featureToEdit) | |
| Creates a builder for an U.S. | |
| CreateSourceLuminaireBuilder (self, featureToEdit) | |
| Creates a builder for a luminaire source. | |
| CreateSourceAmbientEnvironmentBuilder (self, featureToEdit) | |
| Creates a builder for an ambient environment source. | |
| CreateSourceSurfaceBuilder (self, featureToEdit) | |
| Creates a builder for a surface source. | |
| CreateSourceRayFileBuilder (self, featureToEdit) | |
| Creates a builder for a ray file source. | |
| CreateSensorRadianceBuilder (self, featureToEdit) | |
| Creates a builder for a radiance sensor. | |
| CreateSensorIrradianceBuilder (self, featureToEdit) | |
| Creates a builder for an irradiance sensor. | |
| CreateSensorIntensityBuilder (self, featureToEdit) | |
| Creates a builder for an intensity sensor. | |
| CreateSensor3DEnergyDensityBuilder (self, featureToEdit) | |
| Creates a builder for a 3D energy density sensor. | |
| CreateSensorVRImmersiveBuilder (self, featureToEdit) | |
| Creates a builder for a VR immersive sensor. | |
| CreateSensor3DIrradianceBuilder (self, featureToEdit) | |
| Creates a builder for a 3D irradiance sensor. | |
| CreateSensorObserverBuilder (self, featureToEdit) | |
| Creates a builder for an observer sensor. | |
| CreateSimulationInteractiveBuilder (self, featureToEdit) | |
| Creates a builder for an interactive simulation. | |
| CreateSimulationDirectBuilder (self, featureToEdit) | |
| Creates a builder for a direct simulation. | |
| CreateSimulationInverseBuilder (self, featureToEdit) | |
| Creates a builder for an inverse simulation. | |
| CreateOpticalPropertiesBuilder (self, featureToEdit) | |
| Creates a builder for an optical property. | |
| CreateSpeosPatternBuilder (self, featureToEdit) | |
| Creates a builder for a Speos pattern. | |
| CreateFolderBuilder (self, featureToEdit) | |
| Creates a builder for a Folder. | |
Properties | |
| OpticalPropertyFeatures = property(fget = __GetOpticalPropertyFeatures) | |
| Returns all optical properties belonging to the part. | |
| SensorFeatures = property(fget = __GetSensorFeatures) | |
| Returns all sensors belonging to the part. | |
| SimulationFeatures = property(fget = __GetSimulationFeatures) | |
| Returns all simulations belonging to the part. | |
| SourceFeatures = property(fget = __GetSourceFeatures) | |
| Returns all sources 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
◆ CreateFolderBuilder()
| 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()
| 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()
| 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()
| 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.
◆ CreateSensorIntensityBuilder()
| 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()
| 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.
◆ CreateSensorObserverBuilder()
| 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.
◆ CreateSensorRadianceBuilder()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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()
| 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.
◆ CreateSourceLuminaireBuilder()
| 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()
| 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()
| 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.
◆ CreateSpeosPatternBuilder()
| 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()
| FindFromName | ( | self, | |
| name ) |
Finds the feature with the given name.
This function only accepts full a feature name (e.g., "Direct Simulation (0)").
- Parameters
-
[in] name : String.
- Returns
- The feature with the given name.
◆ FindFromTag()
| 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.
Property 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.
◆ SourceFeatures
|
static |
Returns all sources belonging to the part.
Returns a list containing all sources, 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
