## On this page

  

 

 # SourceAmbientUniformBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for an Ambient Source with Uniform type. [More...](#details)

Inheritance diagram for SourceAmbientUniformBuilder:

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



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

 [Luminance](#a83cdcfa372358021030f5a7095bf2456) = property(fget = \_\_GetLuminance, fset = \_\_SetLuminance) Gets or sets the luminance.   
  [MirroredExtent](#a9c2563234d4332baefdae9dcb2940138) = property(fget = \_\_GetMirroredExtent, fset = \_\_SetMirroredExtent) Gets or sets the property to enable mirrored extent.   
  [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.   
  [Sun](#a8fde8a88e3416e7a669f903482471cd5) = property(fget = \_\_GetSun, fset = \_\_SetSun) Gets or sets the property to enable the Sun.   
  [SunDirection](#a103506e79863ea37b4d97c5611ab9f2a) = property(fget = \_\_GetSunDirection, fset = \_\_SetSunDirection) Gets or sets the Sun direction.   
  [SunDirectionReverse](#a3d9a8dec036bbab4ce5c9c43f72e4f34) = property(fget = \_\_GetSunDirectionReverse, fset = \_\_SetSunDirectionReverse) Gets or sets the reverse Sun direction.   
  [Temperature](#a22805146ddc4f17f31d72c5b46ece079) = property(fget = \_\_GetTemperature, fset = \_\_SetTemperature) Gets or sets the temperature.   
  [ZenithDirection](#ab57dae72b50188317d046d07aced528c) = property(fget = \_\_GetZenithDirection, fset = \_\_SetZenithDirection) Gets or sets the zenith direction.   
  [ZenithDirectionReversed](#ac2166e733c6dca82a5da69251dfad7fd) = property(fget = \_\_GetZenithDirectionReversed, fset = \_\_SetZenithDirectionReversed) Gets or sets the reverse zenith direction.   
 ![-](/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 an Ambient Source with Uniform type.

The Ambient Uniform Source Builder is used to create and edit Ambient Uniform Source features.

To create a new instance of this class, use <a class="el" href="">FeatureCollection::CreateSourceAmbientUniformBuilder</a>



## Property Documentation

<a id="a83cdcfa372358021030f5a7095bf2456" name="a83cdcfa372358021030f5a7095bf2456"></a>## [◆ ](#a83cdcfa372358021030f5a7095bf2456)Luminance

 Luminance = property(fget = \_\_GetLuminance, fset = \_\_SetLuminance)  static 

Gets or sets the luminance.

**Value type**: Double (in cd/m2).  
**Range**: The value must be superior to 0.

The default value is 1000.0 cd/m2.





<a id="a9c2563234d4332baefdae9dcb2940138" name="a9c2563234d4332baefdae9dcb2940138"></a>## [◆ ](#a9c2563234d4332baefdae9dcb2940138)MirroredExtent

 MirroredExtent = property(fget = \_\_GetMirroredExtent, fset = \_\_SetMirroredExtent)  static 

Gets or sets the property to enable mirrored extent.

True: Gets an ambient light from all the space.   
 False: Gets an ambient light only in the upper half space.

**Value type**: Boolean.

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, then in the Temperature property, set the blackbody temperature of the source spectrum in Kdeg.   
 1: Library, then in the File property, browse a .spectrum file.

**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 SpectrumType property must be 1.

**Value type**: String.

The default value is an empty string.





<a id="a8fde8a88e3416e7a669f903482471cd5" name="a8fde8a88e3416e7a669f903482471cd5"></a>## [◆ ](#a8fde8a88e3416e7a669f903482471cd5)Sun

 Sun = property(fget = \_\_GetSun, fset = \_\_SetSun)  static 

Gets or sets the property to enable the Sun.

True : Uses the Sun.  
 False : Does not use the Sun.

**Value type**: Boolean.

The default value is False.





<a id="a103506e79863ea37b4d97c5611ab9f2a" name="a103506e79863ea37b4d97c5611ab9f2a"></a>## [◆ ](#a103506e79863ea37b4d97c5611ab9f2a)SunDirection

 SunDirection = property(fget = \_\_GetSunDirection, fset = \_\_SetSunDirection)  static 

Gets or sets the Sun direction.

**Prerequisite**: The UseSun property must be True.

The Sun direction property takes a feature tag and returns a feature tag.

**Value type**: Integer.

The default value is 0.





<a id="a3d9a8dec036bbab4ce5c9c43f72e4f34" name="a3d9a8dec036bbab4ce5c9c43f72e4f34"></a>## [◆ ](#a3d9a8dec036bbab4ce5c9c43f72e4f34)SunDirectionReverse

 SunDirectionReverse = property(fget = \_\_GetSunDirectionReverse, fset = \_\_SetSunDirectionReverse)  static 

Gets or sets the reverse Sun direction.

**Prerequisite**: The UseSun property must be True.

True: Reverses the Sun direction.  
 False: Does not reverse the Sun directio.n

**Value type**: Boolean.

The default value is False.





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

 Temperature = property(fget = \_\_GetTemperature, fset = \_\_SetTemperature)  static 

Gets or sets the temperature.

**Prerequisite**: The SpectrumType property must be 0.

**Value type**: String.  
**Range**: The value must be superior to 0.0.

The default value is 8000.0 Kelvin.





<a id="ab57dae72b50188317d046d07aced528c" name="ab57dae72b50188317d046d07aced528c"></a>## [◆ ](#ab57dae72b50188317d046d07aced528c)ZenithDirection

 ZenithDirection = property(fget = \_\_GetZenithDirection, fset = \_\_SetZenithDirection)  static 

Gets or sets the zenith direction.

The zenith direction property takes a feature tag and returns a feature tag.

**Value type**: Integer.

The default value is 0.





<a id="ac2166e733c6dca82a5da69251dfad7fd" name="ac2166e733c6dca82a5da69251dfad7fd"></a>## [◆ ](#ac2166e733c6dca82a5da69251dfad7fd)ZenithDirectionReversed

 ZenithDirectionReversed = property(fget = \_\_GetZenithDirectionReversed, fset = \_\_SetZenithDirectionReversed)  static 

Gets or sets the reverse zenith direction.

True: Reverses the zenith direction.  
 False: Does not reverse the zenith direction

**Value type**: Boolean.

The default value is False.





---

The documentation for this class was generated from the following file:- **SpeosNX.py**