Speos NX library 2025 R2

FeatureCollection Class Reference

Last update: 16.07.2025

Represents 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.
 
'SourceInteractiveBuilder' CreateSourceInteractiveBuilder (self, featureToEdit)
 Creates a builder for an interactive 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.
 
'SimulationLiDARBuilder' CreateSimulationLiDARBuilder (self, featureToEdit)
 Creates a builder for a LiDAR 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.
 
'ComponentAmbientMaterialBuilder' CreateComponentAmbientMaterialBuilder (self, featureToEdit)
 Creates a builder for a Ambient Material 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.
 
'ComponentPolarizationPlateBuilder' CreateComponentPolarizationPlateBuilder (self, featureToEdit)
 Creates a builder for a Polarization Plate Component.
 
'Component3DTextureBuilder' CreateComponent3DTextureBuilder (self, featureToEdit)
 Creates a builder for a 3D Texture Component.
 
'CopyPasteBuilder' CreateCopyPasteBuilder (self, featureToCopy)
 Creates a builder to copy/paste a feature.
 
'SensorLiDARBuilder' CreateSensorLiDARBuilder (self, featureToEdit)
 Creates a builder for a LiDAR sensor.
 
'LightExpertSensorGroupBuilder' CreateLightExpertSensorGroupBuilder (self, featureToEdit)
 Creates a builder for a Light Expert Sensor Group.
 
'ExportAsGeometryBuilder' CreateExportAsGeometryBuilder (self)
 Creates a builder for exporting features as geometry.
 
'ResultLXPBuilder' CreateResultLXPBuilder (self, featureToEdit)
 Creates a builder for light expert analysis.
 

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.
 
str SourceFeatures = property(fget=__GetSourceFeatures)
 Returns all sources belonging to the part.
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 

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

◆ CreateComponent3DTextureBuilder()

'Component3DTextureBuilder' CreateComponent3DTextureBuilder ( self,
featureToEdit )

Creates a builder for a 3D Texture Component.

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

◆ CreateComponentAmbientMaterialBuilder()

'ComponentAmbientMaterialBuilder' CreateComponentAmbientMaterialBuilder ( self,
featureToEdit )

Creates a builder for a Ambient Material component.

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

◆ CreateComponentLightBoxExportBuilder()

'ComponentLightBoxExportBuilder' CreateComponentLightBoxExportBuilder ( self,
featureToEdit )

Creates a builder for an export light box component.

Parameters
[in]featureToEditthe 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]featureToEditthe feature to be edited or None to create a new feature.
Returns
CComponentLightBoxImpportBuilder object.

◆ CreateComponentPolarizationPlateBuilder()

'ComponentPolarizationPlateBuilder' CreateComponentPolarizationPlateBuilder ( self,
featureToEdit )

Creates a builder for a Polarization Plate Component.

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

◆ CreateCopyPasteBuilder()

'CopyPasteBuilder' CreateCopyPasteBuilder ( self,
featureToCopy )

Creates a builder to copy/paste a feature.

Parameters
[in]featureToCopythe feature to be copied.
Returns
CopyPasteBuilder object.

◆ CreateExportAsGeometryBuilder()

'ExportAsGeometryBuilder' CreateExportAsGeometryBuilder ( self)

Creates a builder for exporting features as geometry.

Returns
ExportAsGeometryBuilder object.

◆ CreateFolderBuilder()

'FolderBuilder' CreateFolderBuilder ( self,
featureToEdit )

Creates a builder for a Folder.

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

◆ CreateLightExpertSensorGroupBuilder()

'LightExpertSensorGroupBuilder' CreateLightExpertSensorGroupBuilder ( self,
featureToEdit )

Creates a builder for a Light Expert Sensor Group.

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

◆ CreateOpticalPropertiesBuilder()

'OpticalPropertiesBuilder' CreateOpticalPropertiesBuilder ( self,
featureToEdit )

Creates a builder for an optical property.

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

◆ CreateResultLXPBuilder()

'ResultLXPBuilder' CreateResultLXPBuilder ( self,
featureToEdit )

Creates a builder for light expert analysis.

Returns
ResultLXPBuilder object.

◆ CreateSensor3DEnergyDensityBuilder()

'Sensor3DEnergyDensityBuilder' 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.
Returns
Sensor3DEnergyDensityBuilder object.

◆ CreateSensor3DIrradianceBuilder()

'Sensor3DIrradianceBuilder' 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.
Returns
Sensor3DIrradianceBuilder object.

◆ CreateSensorCameraBuilder()

'SensorCameraBuilder' CreateSensorCameraBuilder ( self,
featureToEdit )

Creates a builder for a camera sensor.

Parameters
[in]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe feature to be edited or None to create a new feature.
Returns
SensorIrradianceBuilder object.

◆ CreateSensorLiDARBuilder()

'SensorLiDARBuilder' CreateSensorLiDARBuilder ( self,
featureToEdit )

Creates a builder for a LiDAR sensor.

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

◆ CreateSensorLightFieldBuilder()

'SensorLightFieldBuilder' CreateSensorLightFieldBuilder ( self,
featureToEdit )

Creates a builder for a light field sensor.

Parameters
[in]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe feature to be edited or None to create a new feature.
Returns
SimulationInverseBuilder object.

◆ CreateSimulationLiDARBuilder()

'SimulationLiDARBuilder' CreateSimulationLiDARBuilder ( self,
featureToEdit )

Creates a builder for a LiDAR simulation.

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

◆ CreateSourceAmbientEnvironmentBuilder()

'SourceAmbientEnvironmentBuilder' 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.
Returns
SourceAmbientEnvironmentBuilder object.

◆ CreateSourceAmbientGeneralSkyBuilder()

'SourceAmbientGeneralSkyBuilder' 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.
Returns
SourceAmbientGeneralSkyBuilder object.

◆ CreateSourceAmbientNaturalLightBuilder()

'SourceAmbientNaturalLightBuilder' 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.
Returns
SourceAmbientNaturalLightBuilder object.

◆ CreateSourceAmbientOvercastSkyBuilder()

'SourceAmbientOvercastSkyBuilder' 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.
Returns
SourceAmbientOvercastSkyBuilder object.

◆ CreateSourceAmbientUniformBuilder()

'SourceAmbientUniformBuilder' 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.
Returns
SourceAmbientUniformBuilder object.

◆ CreateSourceAmbientUS1976Builder()

'SourceAmbientUS1976Builder' 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.
Returns
SourceAmbientUS1976SkyBuilder object.

◆ CreateSourceDisplayBuilder()

'SourceDisplayBuilder' CreateSourceDisplayBuilder ( self,
featureToEdit )

Creates a builder for a display source.

Parameters
[in]featureToEditthe 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]featureToEditthe feature to be edited or None to create a new feature.
Returns
SourceGroup object.

◆ CreateSourceInteractiveBuilder()

'SourceInteractiveBuilder' CreateSourceInteractiveBuilder ( self,
featureToEdit )

Creates a builder for an interactive source.

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

◆ CreateSourceLightFieldBuilder()

'SourceLightFieldBuilder' CreateSourceLightFieldBuilder ( self,
featureToEdit )

Creates a builder for a light field source.

Parameters
[in]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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]featureToEditthe 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

str 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.

◆ SensorFeatures

str 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.

◆ SimulationFeatures

str 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.

◆ SourceFeatures

str 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_2412.py

Connect with Ansys