SensorLightFieldBuilder Class Reference
Last update: 16.07.2025Represents a light field sensor builder. More...
Static Public Attributes | |
| str | ArrowLength = property(fget=__GetArrowLength, fset=__SetArrowLength) |
| Gets or sets the length of the arrow preview. | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the Axis System of the source. | |
| str | AzimuthEnd = property(fget=__GetAzimuthEnd) |
| Gets the azimuth end. | |
| str | AzimuthResolution = property(fget=__GetAzimuthResolution, fset=__SetAzimuthResolution) |
| Gets or sets the azimuth resolution. | |
| str | AzimuthSampling = property(fget=__GetAzimuthSampling, fset=__SetAzimuthSampling) |
| Gets or sets the azimuth sampling. | |
| str | AzimuthStart = property(fget=__GetAzimuthStart) |
| Gets the azimuth start. | |
| str | CustomAxisSystem = property(fget=__GetCustomAxisSystem, fset=__SetCustomAxisSystem) |
| Gets or sets the custom axis system property. | |
| str | IncidentEnd = property(fget=__GetIncidentEnd) |
| Gets the incident angle end. | |
| str | IncidentResolution = property(fget=__GetIncidentResolution, fset=__SetIncidentResolution) |
| Gets or sets the incident resolution. | |
| str | IncidentSampling = property(fget=__GetIncidentSampling, fset=__SetIncidentSampling) |
| Gets or sets the incident sampling. | |
| str | IncidentStart = property(fget=__GetIncidentStart) |
| Gets the incident angle start. | |
| str | Selections = property(fget=__GetSelections) |
| Returns the interface to select the oriented faces and bodies on which to measure the light distribution. | |
| str | Type = property(fget=__GetType, fset=__SetType) |
| Gets or sets the sensor type. | |
| str | WavelengthEnd = property(fget=__GetWavelengthEnd, fset=__SetWavelengthEnd) |
| Gets the wavelength end. | |
| str | WavelengthResolution = property(fget=__GetWavelengthResolution, fset=__SetWavelengthResolution) |
| Gets or sets the wavelength resolution. | |
| str | WavelengthSampling = property(fget=__GetWavelengthSampling, fset=__SetWavelengthSampling) |
| Gets or sets the wavelength sampling. | |
| str | WavelengthStart = property(fget=__GetWavelengthStart, fset=__SetWavelengthStart) |
| Gets the wavelength start. | |
 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 a light field sensor builder.
The light field sensor builder creates or edits light field sensor features.
To create a new instance of this class, use FeatureCollection::CreateSensorLightFieldBuilder.
Member Data Documentation
◆ ArrowLength
|
static |
Gets or sets the length of the arrow preview.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 10 mm.
◆ AxisSystem
|
static |
Gets the Axis System of the source.
Prerequisite: The CustomAxisSystem property must be True.
Value type: AxisSystem object.
◆ AzimuthEnd
|
static |
Gets the azimuth end.
Value type: Double (in degree).
The default value is 360 deg.
◆ AzimuthResolution
|
static |
Gets or sets the azimuth resolution.
Value type: Double (in degree).
Range: The value must be superior to 0.0.
The default value is 36 deg.
◆ AzimuthSampling
|
static |
Gets or sets the azimuth sampling.
Value type: Integer.
Range: The value must be superior or equal to 2.
The default value is 10.
◆ AzimuthStart
|
static |
Gets the azimuth start.
Value type: Double (in degree).
The default value is 0 deg.
◆ CustomAxisSystem
|
static |
Gets or sets the custom axis system property.
True: Enables custom axis system.
False: Disables custom axis system.
Value type: Boolean.
The default value is False.
◆ IncidentEnd
|
static |
Gets the incident angle end.
Value type: Double (in degree).
The default value is 90 deg.
◆ IncidentResolution
|
static |
Gets or sets the incident resolution.
Value type: Double (in degree).
Range: The value must be superior to 0.0.
The default value is 9 deg.
◆ IncidentSampling
|
static |
Gets or sets the incident sampling.
Value type: Integer.
Range: The value must be superior or equal to 2.
The default value is 10.
◆ IncidentStart
|
static |
Gets the incident angle start.
Value type: Double (in degree).
The default value is 0 deg.
◆ Selections
|
static |
Returns the interface to select the oriented faces and bodies on which to measure the light distribution.
Value type: SensorLightFieldSelections object.
◆ Type
|
static |
Gets or sets the sensor type.
The values are:
0 - Photometric.
1 - Radiometric.
2 - Spectral.
Value type: Integer.
The default value is 1.
◆ WavelengthEnd
|
static |
Gets the wavelength end.
Value type: Double (in nm).
Range: The value must be superior to 0.0 and more than start value.
The default value is 700 nm.
◆ WavelengthResolution
|
static |
Gets or sets the wavelength resolution.
Value type: Double (in nm).
Range: The value must be superior to 0.0.
The default value is 25 nm.
◆ WavelengthSampling
|
static |
Gets or sets the wavelength sampling.
Value type: Integer.
Range: The value must be superior or equal to 2.
The default value is 13.
◆ WavelengthStart
|
static |
Gets the wavelength start.
Value type: Double (in nm).
Range: The value must be superior to 0.0 and less than end value.
The default value is 400 nm.
The documentation for this class was generated from the following file:
- SpeosNX_2412.py
