SourceLightFieldBuilder Class Reference
Last update: 16.07.2025Represents a light field source builder. More...
Static Public Attributes | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the Axis System of the source. | |
| str | CustomAxisSystem = property(fget=__GetCustomAxisSystem, fset=__SetCustomAxisSystem) |
| Gets or sets the custom axis system property. | |
| str | LightFieldFilePath = property(fget=__GetLightFieldFilePath, fset=__SetLightFieldFilePath) |
| Gets or sets the light field file path. | |
| str | NumberOfRays = property(fget=__GetNumberOfRays, fset=__SetNumberOfRays) |
| Gets or sets the number of rays. | |
| str | PreviewMode = property(fget=__GetPreviewMode, fset=__SetPreviewMode) |
| Gets or sets the preview mode. | |
| str | RayLength = property(fget=__GetRayLength, fset=__SetRayLength) |
| Gets or sets the ray length. | |
| str | SpectrumFilePath = property(fget=__GetSpectrumFilePath, fset=__SetSpectrumFilePath) |
| Gets or sets the spectrum file path. | |
 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 source builder.
The light field source builder creates or edits light field source features.
To create a new instance of this class, use FeatureCollection::CreateSourceLightFieldBuilder.
Member Data Documentation
◆ AxisSystem
|
static |
Gets the Axis System of the source.
Prerequisite: The CustomAxisSystem property must be True.
Value type: AxisSystem object.
◆ 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.
◆ LightFieldFilePath
|
static |
Gets or sets the light field file path.
Value type: String.
The default value is an empty string.
◆ NumberOfRays
|
static |
Gets or sets the number of rays.
Value type: Integer.
Range: The value must be superior or equal to 0.
The default value is 100.
◆ PreviewMode
|
static |
Gets or sets the preview mode.
The values are:
0 - Meshing.
1 - BoundingBox.
Value type: Integer.
The default value is 0.
◆ RayLength
|
static |
Gets or sets the ray length.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 75.0 mm.
◆ SpectrumFilePath
|
static |
Gets or sets the spectrum file path.
Prerequisite: The Light Field file must contain radiometric or photometric data.
Value type: String.
The default value is an empty string.
The documentation for this class was generated from the following file:
- SpeosNX_2412.py
