## On this page

  

 

 # SourceAmbientEnvironmentBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for an ambient environment source. [More...](#details)

Inheritance diagram for SourceAmbientEnvironmentBuilder:

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



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

 [BlueSpectrumFile](#a8765ef90ca522f488173fc6985f09d40) = property(fget = \_\_GetBlueSpectrumFile, fset = \_\_SetBlueSpectrumFile) Gets or sets the blue spectrum file.   
  [ColorSpace](#a20f8d042a293f7b8c87f2992d183ceb9) = property(fget = \_\_GetColorSpace, fset = \_\_SetColorSpace) Gets or sets the color space model type.   
  [GreenSpectrumFile](#ac58f22766bd30a897a5d5a1a365d07b7) = property(fget = \_\_GetGreenSpectrumFile, fset = \_\_SetGreenSpectrumFile) Gets or sets the green spectrum file.   
  [GroundOrigin](#a1a6f83cd4e831a9eaef9dee84d5110a7) = property(fget = \_\_GetGroundOrigin, fset = \_\_SetGroundOrigin) Gets or sets the ground origin.   
  [Height](#a27ba8679f9fd5b9572ecbf433894952c) = property(fget = \_\_GetHeight, fset = \_\_SetHeight) Gets or sets the height.   
  [ImageFilePath](#a41734f9d1ab445ca3f74efb480f7b1c2) = property(fget = \_\_GetImageFilePath, fset = \_\_SetImageFilePath) Gets or sets the image file.   
  [Luminance](#a83cdcfa372358021030f5a7095bf2456) = property(fget = \_\_GetLuminance, fset = \_\_SetLuminance) Gets or sets the luminance.   
  [PreviewSize](#aa10cc10c2acf6c3d1ca98afff67b96f1) = property(fget = \_\_GetPreviewSize, fset = \_\_SetPreviewSize) Gets or sets the preview arrows size.   
  [RedSpectrumFile](#ab3ec7aadd8cf0680d13f550136dd24d4) = property(fget = \_\_GetRedSpectrumFile, fset = \_\_SetRedSpectrumFile) Gets or sets the red spectrum file.   
  [WhitePointType](#aee30c02105b7e65855ee5976c11c2db6) = property(fget = \_\_GetWhitePointType, fset = \_\_SetWhitePointType) Gets or sets the white point type of the standard illuminant.   
  [WhitePointX](#a36c61aa2378a1d999086241732672114) = property(fget = \_\_GetWhitePointX, fset = \_\_SetWhitePointX) Gets or sets the X coordinate of the white point.   
  [WhitePointY](#ae9e202f90077d5edf159cd7aedf2423f) = property(fget = \_\_GetWhitePointY, fset = \_\_SetWhitePointY) Gets or sets the Y coordinate of the white point.   
  [ZenithNorthSystem](#a03f08fee1847dfcd8dc2f3aa2060a011) = property(fget = \_\_GetZenithNorthSystem) Gets the zenith north axis system.   
 ![-](/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 environment source.

The ambient environment source builder is used to create and edit ambient environment source features.

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



## Property Documentation

<a id="a8765ef90ca522f488173fc6985f09d40" name="a8765ef90ca522f488173fc6985f09d40"></a>## [◆ ](#a8765ef90ca522f488173fc6985f09d40)BlueSpectrumFile

 BlueSpectrumFile = property(fget = \_\_GetBlueSpectrumFile, fset = \_\_SetBlueSpectrumFile)  static 

Gets or sets the blue spectrum file.

Prerequisite: The ColorSpace property must be 2.

**Value type**: String.

The default value is an empty string.





<a id="a20f8d042a293f7b8c87f2992d183ceb9" name="a20f8d042a293f7b8c87f2992d183ceb9"></a>## [◆ ](#a20f8d042a293f7b8c87f2992d183ceb9)ColorSpace

 ColorSpace = property(fget = \_\_GetColorSpace, fset = \_\_SetColorSpace)  static 

Gets or sets the color space model type.

The values are:  
 0 - sRGB. Uses the standard and most commonly used RGB based model.  
 1 - Adobe RGB. Uses a larger gamut.  
 2 - User Defined RGB. Defines manually the white point of the standard illuminant.

**Value type**: Integer.

The default value is 0.





<a id="ac58f22766bd30a897a5d5a1a365d07b7" name="ac58f22766bd30a897a5d5a1a365d07b7"></a>## [◆ ](#ac58f22766bd30a897a5d5a1a365d07b7)GreenSpectrumFile

 GreenSpectrumFile = property(fget = \_\_GetGreenSpectrumFile, fset = \_\_SetGreenSpectrumFile)  static 

Gets or sets the green spectrum file.

Prerequisite: The ColorSpace property must be 2.

**Value type**: String.

The default value is an empty string.





<a id="a1a6f83cd4e831a9eaef9dee84d5110a7" name="a1a6f83cd4e831a9eaef9dee84d5110a7"></a>## [◆ ](#a1a6f83cd4e831a9eaef9dee84d5110a7)GroundOrigin

 GroundOrigin = property(fget = \_\_GetGroundOrigin, fset = \_\_SetGroundOrigin)  static 

Gets or sets the ground origin.

The GroundOrigin property takes a feature tag.

**Value type**: Integer.

The default value is 0.





<a id="a27ba8679f9fd5b9572ecbf433894952c" name="a27ba8679f9fd5b9572ecbf433894952c"></a>## [◆ ](#a27ba8679f9fd5b9572ecbf433894952c)Height

 Height = property(fget = \_\_GetHeight, fset = \_\_SetHeight)  static 

Gets or sets the height.

**Value type**: Double (in mm).

The default value is 0.0 mm.





<a id="a41734f9d1ab445ca3f74efb480f7b1c2" name="a41734f9d1ab445ca3f74efb480f7b1c2"></a>## [◆ ](#a41734f9d1ab445ca3f74efb480f7b1c2)ImageFilePath

 ImageFilePath = property(fget = \_\_GetImageFilePath, fset = \_\_SetImageFilePath)  static 

Gets or sets the image file.

**Value type**: String.

The default value is an empty string.





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

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

Gets or sets the luminance.

The luminance parameter is the source luminance for the white point in front direction of the source.

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

The default value is 1000.0 cd/m2.





<a id="aa10cc10c2acf6c3d1ca98afff67b96f1" name="aa10cc10c2acf6c3d1ca98afff67b96f1"></a>## [◆ ](#aa10cc10c2acf6c3d1ca98afff67b96f1)PreviewSize

 PreviewSize = property(fget = \_\_GetPreviewSize, fset = \_\_SetPreviewSize)  static 

Gets or sets the preview arrows size.

**Value type**: Double (in mm).

The default value is 100.0 mm.





<a id="ab3ec7aadd8cf0680d13f550136dd24d4" name="ab3ec7aadd8cf0680d13f550136dd24d4"></a>## [◆ ](#ab3ec7aadd8cf0680d13f550136dd24d4)RedSpectrumFile

 RedSpectrumFile = property(fget = \_\_GetRedSpectrumFile, fset = \_\_SetRedSpectrumFile)  static 

Gets or sets the red spectrum file.

Prerequisite: The WhitePoint property must be 4.

**Value type**: String.

The default value is an empty string.





<a id="aee30c02105b7e65855ee5976c11c2db6" name="aee30c02105b7e65855ee5976c11c2db6"></a>## [◆ ](#aee30c02105b7e65855ee5976c11c2db6)WhitePointType

 WhitePointType = property(fget = \_\_GetWhitePointType, fset = \_\_SetWhitePointType)  static 

Gets or sets the white point type of the standard illuminant.

Prerequisite: The ColorSpace property must be 2.

The values are:  
 0 - D65. Uses a standard daylight illuminant that provides accurate color perception and evaluation.  
 1 - D50. Uses a natural, horizon light.  
 2 - C. Uses an average daylight illuminant.  
 3 - E. Uses an illuminant that gives equal weight to all wavelengths.  
 4 - User defined. Allows to edit the Color Coordinates of the white point.

**Value type**: Integer.

The default value is 0.





<a id="a36c61aa2378a1d999086241732672114" name="a36c61aa2378a1d999086241732672114"></a>## [◆ ](#a36c61aa2378a1d999086241732672114)WhitePointX

 WhitePointX = property(fget = \_\_GetWhitePointX, fset = \_\_SetWhitePointX)  static 

Gets or sets the X coordinate of the white point.

Prerequisite: The WhitePoint property must be 4.

**Value type**: Double.

The default value is 0.31271.





<a id="ae9e202f90077d5edf159cd7aedf2423f" name="ae9e202f90077d5edf159cd7aedf2423f"></a>## [◆ ](#ae9e202f90077d5edf159cd7aedf2423f)WhitePointY

 WhitePointY = property(fget = \_\_GetWhitePointY, fset = \_\_SetWhitePointY)  static 

Gets or sets the Y coordinate of the white point.

Prerequisite: The WhitePoint property must be 4.

**Value type**: Double.

The default value is 0.32902.





<a id="a03f08fee1847dfcd8dc2f3aa2060a011" name="a03f08fee1847dfcd8dc2f3aa2060a011"></a>## [◆ ](#a03f08fee1847dfcd8dc2f3aa2060a011)ZenithNorthSystem

 [ZenithNorthSystem](class_speos_n_x_1_1_zenith_north_system.xhtml) = property(fget = \_\_GetZenithNorthSystem)  static 

Gets the zenith north axis system.

**Value type**: ZenithNorthSystem object.





---

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