## On this page

  

 

 # SourceLuminaireBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for a luminaire source. [More...](#details)

Inheritance diagram for SourceLuminaireBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_source_luminaire_builder.png)



## <a id="properties" name="properties"></a>Properties

 [AxisSystem](#a4c4b8fa4fecce1d2737f605f77e7320a) = property(fget = \_\_GetAxisSystem) Gets the axis system.   
  [Flux](#ad1e0e7fa3b1f2579a8f2bfc57e140398) = property(fget = \_\_GetFlux, fset = \_\_SetFlux) Gets or sets the flux.   
  [FluxFromFile](#add4ddfbd9d13272896d3f0bd760721fb) = property(fget = \_\_GetFluxFromFile, fset = \_\_SetFluxFromFile) Gets or sets the property to enable or disable getting the flux from file.   
  [FluxUnit](#a7923861a00fbf8f6f36b062ecab43370) = property(fget = \_\_GetFluxUnit, fset = \_\_SetFluxUnit) Gets or sets the flux unit.   
  [IntensityFilePath](#ae441c07f8c1c874ed6918b174f8fb1d3) = property(fget = \_\_GetIntensityFilePath, fset = \_\_SetIntensityFilePath) Gets or set the intensity distribution file path.   
  [NumberOfRays](#a622dc1d3ba1038d63b443881726aac17) = property(fget = \_\_GetNumberOfRays, fset = \_\_SetNumberOfRays) Gets or sets the number of rays.   
  [RayLength](#ac34ed0a90a26560cbc5671f5f0243421) = property(fget = \_\_GetRayLength, fset = \_\_SetRayLength) Gets or sets the ray length.   
  [ShowIntensityDistribution](#a988eaa701eb99af6e535e4d8ce8d22c4) = property(fget = \_\_GetShowIntensityDistribution, fset = \_\_SetShowIntensityDistribution) Gets or sets the property to show the intensity distribution in the 3D view.   
  [Spectrum](#a1c58086357a2035379972e873865a4a8) = property(fget = \_\_GetSpectrum, fset = \_\_SetSpectrum) Gets or sets the spectrum type.   
  [SpectrumFilePath](#a1cca2d58b30206743ddcb68d2a673380) = property(fget = \_\_GetSpectrumFilePath, fset = \_\_SetSpectrumFilePath) Gets or set the spectrum file path.   
  [Temperature](#a22805146ddc4f17f31d72c5b46ece079) = property(fget = \_\_GetTemperature, fset = \_\_SetTemperature) Gets or sets the spectrum temperature.   
 ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Feature](class_speos_n_x_1_1_feature_builder.xhtml#a94ea57aab7fe0356cbfbd048b1ad971e) = property(fget = \_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
  [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a0b7259da2de11c688aa435d1f0509134) = property(fget = \_\_GetFullName) Gets the full name of the feature being edited.   
  [Name](class_speos_n_x_1_1_feature_builder.xhtml#aa5998168cabfb2b2e41151349077812c) = property(fget = \_\_GetName, fset = \_\_SetName) Gets or sets the name of the feature being edited.   
  [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a99e8764720550e4ed0eba629a625b2e3) = property(fget = \_\_GetNameWithContext) Gets the name with context of the feature being edited.   
  [Status](class_speos_n_x_1_1_feature_builder.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b) = property(fget = \_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a2b74e1b440341a82332053432b52b42c) (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.   
 <a id="details" name="details"></a>## 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 <a class="el" href="">FeatureCollection::CreateSourceLuminaireBuilder</a>



## Property Documentation

<a id="a4c4b8fa4fecce1d2737f605f77e7320a" name="a4c4b8fa4fecce1d2737f605f77e7320a"></a>## [◆ ](#a4c4b8fa4fecce1d2737f605f77e7320a)AxisSystem

 [AxisSystem](class_speos_n_x_1_1_axis_system.xhtml) = property(fget = \_\_GetAxisSystem)  static 

Gets the axis system.

**Value type**: AxisSystem object.





<a id="ad1e0e7fa3b1f2579a8f2bfc57e140398" name="ad1e0e7fa3b1f2579a8f2bfc57e140398"></a>## [◆ ](#ad1e0e7fa3b1f2579a8f2bfc57e140398)Flux

 Flux = property(fget = \_\_GetFlux, fset = \_\_SetFlux)  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.





<a id="add4ddfbd9d13272896d3f0bd760721fb" name="add4ddfbd9d13272896d3f0bd760721fb"></a>## [◆ ](#add4ddfbd9d13272896d3f0bd760721fb)FluxFromFile

 FluxFromFile = property(fget = \_\_GetFluxFromFile, fset = \_\_SetFluxFromFile)  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.





<a id="a7923861a00fbf8f6f36b062ecab43370" name="a7923861a00fbf8f6f36b062ecab43370"></a>## [◆ ](#a7923861a00fbf8f6f36b062ecab43370)FluxUnit

 FluxUnit = property(fget = \_\_GetFluxUnit, fset = \_\_SetFluxUnit)  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.





<a id="ae441c07f8c1c874ed6918b174f8fb1d3" name="ae441c07f8c1c874ed6918b174f8fb1d3"></a>## [◆ ](#ae441c07f8c1c874ed6918b174f8fb1d3)IntensityFilePath

 IntensityFilePath = property(fget = \_\_GetIntensityFilePath, fset = \_\_SetIntensityFilePath)  static 

Gets or set the intensity distribution file path.

**Value type**: String.

The default value is an empty string.





<a id="a622dc1d3ba1038d63b443881726aac17" name="a622dc1d3ba1038d63b443881726aac17"></a>## [◆ ](#a622dc1d3ba1038d63b443881726aac17)NumberOfRays

 NumberOfRays = property(fget = \_\_GetNumberOfRays, fset = \_\_SetNumberOfRays)  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.





<a id="ac34ed0a90a26560cbc5671f5f0243421" name="ac34ed0a90a26560cbc5671f5f0243421"></a>## [◆ ](#ac34ed0a90a26560cbc5671f5f0243421)RayLength

 RayLength = property(fget = \_\_GetRayLength, fset = \_\_SetRayLength)  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.





<a id="a988eaa701eb99af6e535e4d8ce8d22c4" name="a988eaa701eb99af6e535e4d8ce8d22c4"></a>## [◆ ](#a988eaa701eb99af6e535e4d8ce8d22c4)ShowIntensityDistribution

 ShowIntensityDistribution = property(fget = \_\_GetShowIntensityDistribution, fset = \_\_SetShowIntensityDistribution)  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.





<a id="a1c58086357a2035379972e873865a4a8" name="a1c58086357a2035379972e873865a4a8"></a>## [◆ ](#a1c58086357a2035379972e873865a4a8)Spectrum

 Spectrum = property(fget = \_\_GetSpectrum, fset = \_\_SetSpectrum)  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.





<a id="a1cca2d58b30206743ddcb68d2a673380" name="a1cca2d58b30206743ddcb68d2a673380"></a>## [◆ ](#a1cca2d58b30206743ddcb68d2a673380)SpectrumFilePath

 SpectrumFilePath = property(fget = \_\_GetSpectrumFilePath, fset = \_\_SetSpectrumFilePath)  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.





<a id="a22805146ddc4f17f31d72c5b46ece079" name="a22805146ddc4f17f31d72c5b46ece079"></a>## [◆ ](#a22805146ddc4f17f31d72c5b46ece079)Temperature

 Temperature = property(fget = \_\_GetTemperature, fset = \_\_SetTemperature)  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**