## On this page

  

 

 # FeatureCollection Class Reference

 Last update: 17.07.2025 

Represents the collection of Speos features in a Part. [More...](#details)

Inheritance diagram for FeatureCollection:

 ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_feature_collection.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [FindFromTag](#a081b01090a58981bf1a844f173c8d054) (self, tag) Finds the feature with the given Tag.   
  [FindFromName](#a90bc7a74a7ab1d63cb1b87a781d8ae6f) (self, name) Finds the feature with the given name.   
  [CreateSourceDisplayBuilder](#a1182d0e17d4dc5ee31d2af4d8dd7b74b) (self, featureToEdit) Creates a builder for a display source.   
  [CreateSourceAmbientGeneralSkyBuilder](#ac58971722d01ea96f5e08596da4a75e1) (self, featureToEdit) Creates a builder for an ambient source with CIE General Sky type.   
  [CreateSourceAmbientNaturalLightBuilder](#ad0c64198783cb6eab19ba2473d1c23d8) (self, featureToEdit) Creates a builder for an ambient source with Natural Light type.   
  [CreateSourceAmbientOvercastSkyBuilder](#a18c99fe82d3fb7ecb9b4fc31de2e62ef) (self, featureToEdit) Creates a builder for an ambient source with Overcast Sky type.   
  [CreateSourceAmbientUniformBuilder](#adac89372480fe2f00b7b52b145bcbf8c) (self, featureToEdit) Creates a builder for an ambient source with Uniform type.   
  [CreateSourceAmbientUS1976Builder](#ac0d306ab44d9df027ae269b7c4d706f0) (self, featureToEdit) Creates a builder for an U.S.   
  [CreateSourceLuminaireBuilder](#a8f6268617be48c2d37fa52659288a04d) (self, featureToEdit) Creates a builder for a luminaire source.   
  [CreateSourceAmbientEnvironmentBuilder](#a4db8f31e03e4d41a00285fd7fce63c08) (self, featureToEdit) Creates a builder for an ambient environment source.   
  [CreateSourceSurfaceBuilder](#a2f318ab919d0fd7c1aeeed7ea1ba8af6) (self, featureToEdit) Creates a builder for a surface source.   
  [CreateSourceRayFileBuilder](#ade3ee95cd6be148e2de4f526f39a9249) (self, featureToEdit) Creates a builder for a ray file source.   
  [CreateSensorRadianceBuilder](#aae2c582f021e388d8eaec79a15cbcb43) (self, featureToEdit) Creates a builder for a radiance sensor.   
  [CreateSensorIrradianceBuilder](#ac128a25e173bf3a4945fcc44b1f02644) (self, featureToEdit) Creates a builder for an irradiance sensor.   
  [CreateSensorIntensityBuilder](#a96cade1ade86e20b6f73da07177acc66) (self, featureToEdit) Creates a builder for an intensity sensor.   
  [CreateSensor3DEnergyDensityBuilder](#af37796b14a583a7dc1d2fa7f28f23dac) (self, featureToEdit) Creates a builder for a 3D energy density sensor.   
  [CreateSensorVRImmersiveBuilder](#a8b3516625f21fa27171b9ba5c90be93d) (self, featureToEdit) Creates a builder for a VR immersive sensor.   
  [CreateSensor3DIrradianceBuilder](#ad51428b784e4478fde3c76b58027bfea) (self, featureToEdit) Creates a builder for a 3D irradiance sensor.   
  [CreateSensorObserverBuilder](#a4583f5f94eaf23ea63b322990fe63879) (self, featureToEdit) Creates a builder for an observer sensor.   
  [CreateSimulationInteractiveBuilder](#a747753f32f4fd1f4d2f026e6cfc4eeb0) (self, featureToEdit) Creates a builder for an interactive simulation.   
  [CreateSimulationDirectBuilder](#a1c2b287759854a49605512a0b239e7a7) (self, featureToEdit) Creates a builder for a direct simulation.   
  [CreateSimulationInverseBuilder](#a1f1eed3a668bc99cfb3c9c52db17d16a) (self, featureToEdit) Creates a builder for an inverse simulation.   
  [CreateOpticalPropertiesBuilder](#ae62fa27759e77b2d7da29e2a47cf22c5) (self, featureToEdit) Creates a builder for an optical property.   
  [CreateSpeosPatternBuilder](#a9f53f31b42a28656931295ef21f37289) (self, featureToEdit) Creates a builder for a Speos pattern.   
  [CreateFolderBuilder](#a1f379dd13891227e8ef6137f4c8490b3) (self, featureToEdit) Creates a builder for a Folder.   
 ## <a id="properties" name="properties"></a>Properties

 [OpticalPropertyFeatures](#a6f54729dd58815afbf7d9b845a6fffb6) = property(fget = \_\_GetOpticalPropertyFeatures) Returns all optical properties belonging to the part.   
  [SensorFeatures](#a721c879757d63cdc7c9be9d5e3313519) = property(fget = \_\_GetSensorFeatures) Returns all sensors belonging to the part.   
  [SimulationFeatures](#ae48a053ad0f4ef01adbb7f75004f8d12) = property(fget = \_\_GetSimulationFeatures) Returns all simulations belonging to the part.   
  [SourceFeatures](#ae17396cf6159fbf3a797b06ef7b58490) = property(fget = \_\_GetSourceFeatures) Returns all sources belonging to the part.   
 <a id="details" name="details"></a>## 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

<a id="a1f379dd13891227e8ef6137f4c8490b3" name="a1f379dd13891227e8ef6137f4c8490b3"></a>## [◆ ](#a1f379dd13891227e8ef6137f4c8490b3)CreateFolderBuilder()

 CreateFolderBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a Folder.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsFolderBuilder object. 



<a id="ae62fa27759e77b2d7da29e2a47cf22c5" name="ae62fa27759e77b2d7da29e2a47cf22c5"></a>## [◆ ](#ae62fa27759e77b2d7da29e2a47cf22c5)CreateOpticalPropertiesBuilder()

 CreateOpticalPropertiesBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an optical property.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsOpticalPropertiesBuilder object. 



<a id="af37796b14a583a7dc1d2fa7f28f23dac" name="af37796b14a583a7dc1d2fa7f28f23dac"></a>## [◆ ](#af37796b14a583a7dc1d2fa7f28f23dac)CreateSensor3DEnergyDensityBuilder()

 CreateSensor3DEnergyDensityBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a 3D energy density sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensor3DEnergyDensityBuilder object. 



<a id="ad51428b784e4478fde3c76b58027bfea" name="ad51428b784e4478fde3c76b58027bfea"></a>## [◆ ](#ad51428b784e4478fde3c76b58027bfea)CreateSensor3DIrradianceBuilder()

 CreateSensor3DIrradianceBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a 3D irradiance sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensor3DIrradianceBuilder object. 



<a id="a96cade1ade86e20b6f73da07177acc66" name="a96cade1ade86e20b6f73da07177acc66"></a>## [◆ ](#a96cade1ade86e20b6f73da07177acc66)CreateSensorIntensityBuilder()

 CreateSensorIntensityBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an intensity sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensorIntensityBuilder object. 



<a id="ac128a25e173bf3a4945fcc44b1f02644" name="ac128a25e173bf3a4945fcc44b1f02644"></a>## [◆ ](#ac128a25e173bf3a4945fcc44b1f02644)CreateSensorIrradianceBuilder()

 CreateSensorIrradianceBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an irradiance sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensorIrradianceBuilder object. 



<a id="a4583f5f94eaf23ea63b322990fe63879" name="a4583f5f94eaf23ea63b322990fe63879"></a>## [◆ ](#a4583f5f94eaf23ea63b322990fe63879)CreateSensorObserverBuilder()

 CreateSensorObserverBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an observer sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensorObserverBuilder object. 



<a id="aae2c582f021e388d8eaec79a15cbcb43" name="aae2c582f021e388d8eaec79a15cbcb43"></a>## [◆ ](#aae2c582f021e388d8eaec79a15cbcb43)CreateSensorRadianceBuilder()

 CreateSensorRadianceBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a radiance sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensorRadianceBuilder object. 



<a id="a8b3516625f21fa27171b9ba5c90be93d" name="a8b3516625f21fa27171b9ba5c90be93d"></a>## [◆ ](#a8b3516625f21fa27171b9ba5c90be93d)CreateSensorVRImmersiveBuilder()

 CreateSensorVRImmersiveBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a VR immersive sensor.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSensorVRImmersiveBuilder object. 



<a id="a1c2b287759854a49605512a0b239e7a7" name="a1c2b287759854a49605512a0b239e7a7"></a>## [◆ ](#a1c2b287759854a49605512a0b239e7a7)CreateSimulationDirectBuilder()

 CreateSimulationDirectBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a direct simulation.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSimulationDirectBuilder object. 



<a id="a747753f32f4fd1f4d2f026e6cfc4eeb0" name="a747753f32f4fd1f4d2f026e6cfc4eeb0"></a>## [◆ ](#a747753f32f4fd1f4d2f026e6cfc4eeb0)CreateSimulationInteractiveBuilder()

 CreateSimulationInteractiveBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an interactive simulation.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSimulationInteractiveBuilder object. 



<a id="a1f1eed3a668bc99cfb3c9c52db17d16a" name="a1f1eed3a668bc99cfb3c9c52db17d16a"></a>## [◆ ](#a1f1eed3a668bc99cfb3c9c52db17d16a)CreateSimulationInverseBuilder()

 CreateSimulationInverseBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an inverse simulation.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSimulationInverseBuilder object. 



<a id="a4db8f31e03e4d41a00285fd7fce63c08" name="a4db8f31e03e4d41a00285fd7fce63c08"></a>## [◆ ](#a4db8f31e03e4d41a00285fd7fce63c08)CreateSourceAmbientEnvironmentBuilder()

 CreateSourceAmbientEnvironmentBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an ambient environment source.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceAmbientEnvironmentBuilder object. 



<a id="ac58971722d01ea96f5e08596da4a75e1" name="ac58971722d01ea96f5e08596da4a75e1"></a>## [◆ ](#ac58971722d01ea96f5e08596da4a75e1)CreateSourceAmbientGeneralSkyBuilder()

 CreateSourceAmbientGeneralSkyBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an ambient source with CIE General Sky type.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceAmbientGeneralSkyBuilder object. 



<a id="ad0c64198783cb6eab19ba2473d1c23d8" name="ad0c64198783cb6eab19ba2473d1c23d8"></a>## [◆ ](#ad0c64198783cb6eab19ba2473d1c23d8)CreateSourceAmbientNaturalLightBuilder()

 CreateSourceAmbientNaturalLightBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an ambient source with Natural Light type.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceAmbientNaturalLightBuilder object. 



<a id="a18c99fe82d3fb7ecb9b4fc31de2e62ef" name="a18c99fe82d3fb7ecb9b4fc31de2e62ef"></a>## [◆ ](#a18c99fe82d3fb7ecb9b4fc31de2e62ef)CreateSourceAmbientOvercastSkyBuilder()

 CreateSourceAmbientOvercastSkyBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an ambient source with Overcast Sky type.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceAmbientOvercastSkyBuilder object. 



<a id="adac89372480fe2f00b7b52b145bcbf8c" name="adac89372480fe2f00b7b52b145bcbf8c"></a>## [◆ ](#adac89372480fe2f00b7b52b145bcbf8c)CreateSourceAmbientUniformBuilder()

 CreateSourceAmbientUniformBuilder  (  *self*,     *featureToEdit* )

Creates a builder for an ambient source with Uniform type.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceAmbientUniformBuilder object. 



<a id="ac0d306ab44d9df027ae269b7c4d706f0" name="ac0d306ab44d9df027ae269b7c4d706f0"></a>## [◆ ](#ac0d306ab44d9df027ae269b7c4d706f0)CreateSourceAmbientUS1976Builder()

 CreateSourceAmbientUS1976Builder  (  *self*,     *featureToEdit* )

Creates a builder for an U.S.

Standard Atmosphere 1976 source.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceAmbientUS1976SkyBuilder object. 



<a id="a1182d0e17d4dc5ee31d2af4d8dd7b74b" name="a1182d0e17d4dc5ee31d2af4d8dd7b74b"></a>## [◆ ](#a1182d0e17d4dc5ee31d2af4d8dd7b74b)CreateSourceDisplayBuilder()

 CreateSourceDisplayBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a display source.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceDisplayBuilder object. 



<a id="a8f6268617be48c2d37fa52659288a04d" name="a8f6268617be48c2d37fa52659288a04d"></a>## [◆ ](#a8f6268617be48c2d37fa52659288a04d)CreateSourceLuminaireBuilder()

 CreateSourceLuminaireBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a luminaire source.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceLuminaireBuilder object. 



<a id="ade3ee95cd6be148e2de4f526f39a9249" name="ade3ee95cd6be148e2de4f526f39a9249"></a>## [◆ ](#ade3ee95cd6be148e2de4f526f39a9249)CreateSourceRayFileBuilder()

 CreateSourceRayFileBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a ray file source.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceRayFileBuilder object. 



<a id="a2f318ab919d0fd7c1aeeed7ea1ba8af6" name="a2f318ab919d0fd7c1aeeed7ea1ba8af6"></a>## [◆ ](#a2f318ab919d0fd7c1aeeed7ea1ba8af6)CreateSourceSurfaceBuilder()

 CreateSourceSurfaceBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a surface source.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSourceSurfaceBuilder object. 



<a id="a9f53f31b42a28656931295ef21f37289" name="a9f53f31b42a28656931295ef21f37289"></a>## [◆ ](#a9f53f31b42a28656931295ef21f37289)CreateSpeosPatternBuilder()

 CreateSpeosPatternBuilder  (  *self*,     *featureToEdit* )

Creates a builder for a Speos pattern.

Parameters \[in\]featureToEditthe feature to be edited or None to create a new feature. ReturnsSpeosPatternBuilder object. 



<a id="a90bc7a74a7ab1d63cb1b87a781d8ae6f" name="a90bc7a74a7ab1d63cb1b87a781d8ae6f"></a>## [◆ ](#a90bc7a74a7ab1d63cb1b87a781d8ae6f)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. ReturnsThe feature with the given name. 



<a id="a081b01090a58981bf1a844f173c8d054" name="a081b01090a58981bf1a844f173c8d054"></a>## [◆ ](#a081b01090a58981bf1a844f173c8d054)FindFromTag()

 FindFromTag  (  *self*,     *tag* )

Finds the feature with the given Tag.

This function takes as parameter a feature tag.

Parameters \[in\]Tag: Integer. ReturnsThe feature with the given Tag. 



## Property Documentation

<a id="a6f54729dd58815afbf7d9b845a6fffb6" name="a6f54729dd58815afbf7d9b845a6fffb6"></a>## [◆ ](#a6f54729dd58815afbf7d9b845a6fffb6)OpticalPropertyFeatures

 OpticalPropertyFeatures = property(fget = \_\_GetOpticalPropertyFeatures)  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.





<a id="a721c879757d63cdc7c9be9d5e3313519" name="a721c879757d63cdc7c9be9d5e3313519"></a>## [◆ ](#a721c879757d63cdc7c9be9d5e3313519)SensorFeatures

 SensorFeatures = property(fget = \_\_GetSensorFeatures)  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.





<a id="ae48a053ad0f4ef01adbb7f75004f8d12" name="ae48a053ad0f4ef01adbb7f75004f8d12"></a>## [◆ ](#ae48a053ad0f4ef01adbb7f75004f8d12)SimulationFeatures

 SimulationFeatures = property(fget = \_\_GetSimulationFeatures)  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.





<a id="ae17396cf6159fbf3a797b06ef7b58490" name="ae17396cf6159fbf3a797b06ef7b58490"></a>## [◆ ](#ae17396cf6159fbf3a797b06ef7b58490)SourceFeatures

 SourceFeatures = property(fget = \_\_GetSourceFeatures)  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**