SourceLuminaireBuilder Class Reference
Last update: 17.07.2025Represents the builder for a luminaire source. More...
Properties | |
| AxisSystem = property(fget = __GetAxisSystem) | |
| Gets the axis system. | |
| Flux = property(fget = __GetFlux, fset = __SetFlux) | |
| Gets or sets the flux. | |
| FluxFromFile = property(fget = __GetFluxFromFile, fset = __SetFluxFromFile) | |
| Gets or sets the property to enable or disable getting the flux from file. | |
| FluxUnit = property(fget = __GetFluxUnit, fset = __SetFluxUnit) | |
| Gets or sets the flux unit. | |
| IntensityFilePath = property(fget = __GetIntensityFilePath, fset = __SetIntensityFilePath) | |
| Gets or set the intensity distribution file path. | |
| NumberOfRays = property(fget = __GetNumberOfRays, fset = __SetNumberOfRays) | |
| Gets or sets the number of rays. | |
| RayLength = property(fget = __GetRayLength, fset = __SetRayLength) | |
| Gets or sets the ray length. | |
| ShowIntensityDistribution = property(fget = __GetShowIntensityDistribution, fset = __SetShowIntensityDistribution) | |
| Gets or sets the property to show the intensity distribution in the 3D view. | |
| Spectrum = property(fget = __GetSpectrum, fset = __SetSpectrum) | |
| Gets or sets the spectrum type. | |
| SpectrumFilePath = property(fget = __GetSpectrumFilePath, fset = __SetSpectrumFilePath) | |
| Gets or set the spectrum file path. | |
| Temperature = property(fget = __GetTemperature, fset = __SetTemperature) | |
| Gets or sets the spectrum temperature. | |
 Properties inherited from FeatureBuilder | |
| Feature = property(fget = __GetFeature) | |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| FullName = property(fget = __GetFullName) | |
| Gets the full name of the feature being edited. | |
| Name = property(fget = __GetName, fset = __SetName) | |
| Gets or sets the name of the feature being edited. | |
| NameWithContext = property(fget = __GetNameWithContext) | |
| Gets the name with context of the feature being edited. | |
| Status = property(fget = __GetStatus) | |
| Returns the status of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| Commit (self) | |
| Commits any edits that have been applied to the builder. | |
| ShowResult (self) | |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
Detailed Description
Represents the builder for a luminaire source.
The luminaire source builder is used to create and edit luminaire source features.
To create a new instance of this class, use FeatureCollection::CreateSourceLuminaireBuilder
Property Documentation
◆ AxisSystem
|
static |
Gets the axis system.
Value type: AxisSystem object.
◆ Flux
|
static |
Gets or sets the flux.
Prerequisite: The IsFluxFromFile property must be False.
Value type: Double (in lm or W).
Range: The value must be superior to 0.0.
The default value is 683.0.
◆ FluxFromFile
|
static |
Gets or sets the property to enable or disable getting the flux from file.
True: Enables getting the flux from file.
False: Disables getting the flux from file.
Value type: Boolean.
The default value is True.
◆ FluxUnit
|
static |
Gets or sets the flux unit.
Prerequisite: The IsFluxFromFile property must be False or The IntensityFile property must be set.
The values are:
0 - Lumen.
1 - Watt.
Value type: Integer.
The default value is 0.
◆ IntensityFilePath
|
static |
Gets or set the intensity distribution 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.
◆ 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.
◆ ShowIntensityDistribution
|
static |
Gets or sets the property to show the intensity distribution in the 3D view.
True: Shows the intensity distribution in the 3D view.
False: Does not show the intensity distribution in the 3D view.
The default value is False.
◆ Spectrum
|
static |
Gets or sets the spectrum type.
The values are:
0 - Blackbody, with this value the Temperature property is available.
1 - Library, with this value the File property is available.
2 - Incandescent.
3 - Warmwhite fluorescent.
4 - Daylight fluorescent.
5 - White LED.
6 - Halogen.
7 - Metal halide.
8 - High pressure sodium.
Value type: Integer.
The default value is 0.
◆ SpectrumFilePath
|
static |
Gets or set the spectrum file path.
Prerequisite: The spectrum type must be 1.
Value type: String.
The default value is an empty string.
◆ Temperature
|
static |
Gets or sets the spectrum temperature.
Prerequisite: The spectrum type must be 0.
Value type: Double (in Kelvin).
Range: The value must be superior to 0.0.
The default value is 2856.0 Kelvin.
The documentation for this class was generated from the following file:
- SpeosNX.py
