Sensor3DIrradianceBuilder Class Reference
Last update: 16.07.2025Represents the builder for a 3D irradiance sensor. More...
Static Public Attributes | |
| str | Absorption = property(fget=__GetAbsorption, fset=__SetAbsorption) |
| Gets or sets the absorption property. | |
| str | IntegrationType = property(fget=__GetIntegrationType, fset=__SetIntegrationType) |
| Gets or sets the integration type. | |
| str | Layer = property(fget=__GetLayer, fset=__SetLayer) |
| Gets or sets the layer mode. | |
| str | MeasureType = property(fget=__GetMeasureType, fset=__SetMeasureType) |
| Gets or sets the measure type. | |
| str | RayFileFormat = property(fget=__GetRayFileFormat, fset=__SetRayFileFormat) |
| Gets or sets the ray file format. | |
| str | Reflection = property(fget=__GetReflection, fset=__SetReflection) |
| Gets or sets the reflection property. | |
| str | Selections = property(fget=__GetSelections, fset=__SetSelections) |
| Gets or sets the selected faces or bodies. | |
| str | TemplateFilePath = property(fget=__GetTemplateFilePath, fset=__SetTemplateFilePath) |
| Gets or sets the XM3 template file. | |
| str | Transmission = property(fget=__GetTransmission, fset=__SetTransmission) |
| Gets or sets the transmission property. | |
| str | UseRayFile = property(fget=__GetUseRayFile, fset=__SetUseRayFile) |
| Gets or sets the property to enable or disable use of ray file. | |
| str | UseTemplateFile = property(fget=__GetUseTemplateFile, fset=__SetUseTemplateFile) |
| Gets or sets the property to enable or disable use of XM3 template file. | |
| str | WavelengthEnd = property(fget=__GetWavelengthEnd, fset=__SetWavelengthEnd) |
| Gets or sets the higher value of the wavelength range to be considered by the sensor. | |
| str | WavelengthStart = property(fget=__GetWavelengthStart, fset=__SetWavelengthStart) |
| Gets or sets the lower value of the wavelength range to be considered by the sensor. | |
 Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
| str | Status = property(fget=__GetStatus) |
| Returns the status of the feature being edited. | |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from FeatureBuilder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from Builder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | ShowResult (self) |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
| Public Member Functions inherited from Builder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
Detailed Description
Represents the builder for a 3D irradiance sensor.
The 3D irradiance sensor builder is used to create and edit 3D irradiance sensor features.
To create a new instance of this class, use FeatureCollection::CreateSensor3DIrradianceBuilder
Member Data Documentation
◆ Absorption
|
static |
Gets or sets the absorption property.
Prerequisite: The property MeasureType must be 0 or 2, and IntegrationType must be 0.
Value type: Boolean.
The default value is True.
◆ IntegrationType
|
static |
Gets or sets the integration type.
The values are:
0 - Planar. Integration that is made orthogonally with the sensor plan.
1 - Radial. Follows specific street lighting illumination regulations.
Value type: Integer.
The default value is 0.
◆ Layer
|
static |
Gets or sets the layer mode.
The values are:
0 - None.
1 - Source.
Value type: Integer.
The default value is 0.
◆ MeasureType
|
static |
Gets or sets the measure type.
The values are:
0 - Photometric to compute the luminous intensity and generate an extended map for Virtual 3D Photometric Lab.
1 - Colorimetric to compute the radiant intensity and generate an extended map for Virtual 3D Photometric Lab.
2 - Radiometric to compute the color results without any spectral layer separation and generate a spectral map for Virtual 3D Photometric Lab.
Value type: Integer.
The default value is 0.
◆ RayFileFormat
|
static |
Gets or sets the ray file format.
Prerequisite: The UseRayFile property must be True.
Defines the type of ray file. The simulation creates the ray file.
The values are:
0 - Speos without Polarization.
1 - Speos with Polarization.
2 - IES TM-25 without Polarization.
3 - IES TM-25 with Polarization.
Value type: Integer.
The default value is 0.
◆ Reflection
|
static |
Gets or sets the reflection property.
Prerequisite: The property MeasureType must be 0 or 2, and IntegrationType must be 0.
Value type: Boolean.
The default value is True.
◆ Selections
|
static |
Gets or sets the selected faces or bodies.
The Selections property takes and returns a list of feature tags.
Value type: List of integer.
The default value is an empty list.
◆ TemplateFilePath
|
static |
Gets or sets the XM3 template file.
Prerequisite: The property TemplateFile must be True.
Value type: String.
The default value is an empty string.
◆ Transmission
|
static |
Gets or sets the transmission property.
Prerequisite: The property MeasureType must be 0 or 2, and IntegrationType must be 0.
Value type: Boolean.
The default value is True.
◆ UseRayFile
|
static |
Gets or sets the property to enable or disable use of ray file.
True: Uses ray file.
False: Does not use ray file.
Value type: Boolean.
The default value is False.
◆ UseTemplateFile
|
static |
Gets or sets the property to enable or disable use of XM3 template file.
True: Uses XM3 template file.
False: Does not use XM3 template file.
Value type: Boolean.
The default value is False.
◆ WavelengthEnd
|
static |
Gets or sets the higher value of the wavelength range to be considered by the sensor.
Prerequisite: The property MeasureType must be 1.
The sensor does not take into account wavelengths beyond the borders that you define.
Value type: Double (in nm).
The default value is 700.0 nm.
◆ WavelengthStart
|
static |
Gets or sets the lower value of the wavelength range to be considered by the sensor.
Prerequisite: The property MeasureType must be 1.
The sensor does not take into account wavelengths beyond the borders that you define.
Value type: Double (in nm).
The default value is 400.0 nm.
The documentation for this class was generated from the following file:
- SpeosNX_2412.py
