## On this page

  

 

 # SourceAmbientEnvironmentBuilder Class Reference

 Last update: 16.07.2025 

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

Inheritance diagram for SourceAmbientEnvironmentBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_source_ambient_environment_builder.png)



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [BlueSpectrumFile](#a72eefcbc10b482e9b44bfae0c3a5d5cc) = property(fget=\_\_GetBlueSpectrumFile, fset=\_\_SetBlueSpectrumFile) Gets or sets the blue spectrum file.   
 str [ColorSpace](#aeaf08fe09b5dba864e9567b46973cc03) = property(fget=\_\_GetColorSpace, fset=\_\_SetColorSpace) Gets or sets the color space model type.   
 str [GreenSpectrumFile](#a71e30d101d726c8744a9b69efb178358) = property(fget=\_\_GetGreenSpectrumFile, fset=\_\_SetGreenSpectrumFile) Gets or sets the green spectrum file.   
 str [GroundOrigin](#aaeeb813ba4dc675ca6f27de6d612472a) = property(fget=\_\_GetGroundOrigin, fset=\_\_SetGroundOrigin) Gets or sets the ground origin.   
 str [Height](#a37eb7401ae5f6ba4e112d3909cae96f0) = property(fget=\_\_GetHeight, fset=\_\_SetHeight) Gets or sets the height.   
 str [ImageFilePath](#a123e0960e42f334da9b12d11d373ded4) = property(fget=\_\_GetImageFilePath, fset=\_\_SetImageFilePath) Gets or sets the image file.   
 str [Luminance](#ae0eaed72c741a4ee1dcf2fe53257db93) = property(fget=\_\_GetLuminance, fset=\_\_SetLuminance) Gets or sets the luminance.   
 str [PreviewSize](#a6aa632655e525d1b227f78dfa7b3ed4f) = property(fget=\_\_GetPreviewSize, fset=\_\_SetPreviewSize) Gets or sets the preview arrows size.   
 str [RedSpectrumFile](#a175a0605a0b9625b6156835b7eab1b89) = property(fget=\_\_GetRedSpectrumFile, fset=\_\_SetRedSpectrumFile) Gets or sets the red spectrum file.   
 str [WhitePointType](#a40dd8956fa2b807fc1ffc7805e7639c3) = property(fget=\_\_GetWhitePointType, fset=\_\_SetWhitePointType) Gets or sets the white point type of the standard illuminant.   
 str [WhitePointX](#aa3f27fb02d4752eb583a4b0773122e8f) = property(fget=\_\_GetWhitePointX, fset=\_\_SetWhitePointX) Gets or sets the X coordinate of the white point.   
 str [WhitePointY](#a27fa0aa58391796b4f86ffbe2e9a4a64) = property(fget=\_\_GetWhitePointY, fset=\_\_SetWhitePointY) Gets or sets the Y coordinate of the white point.   
 str [ZenithNorthSystem](#ad894fef939dd40da0f5ec4bf1205cb84) = property(fget=\_\_GetZenithNorthSystem) Gets the zenith north axis system.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 <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>



## Member Data Documentation

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

 str 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="aeaf08fe09b5dba864e9567b46973cc03" name="aeaf08fe09b5dba864e9567b46973cc03"></a>## [◆ ](#aeaf08fe09b5dba864e9567b46973cc03)ColorSpace

 str 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="a71e30d101d726c8744a9b69efb178358" name="a71e30d101d726c8744a9b69efb178358"></a>## [◆ ](#a71e30d101d726c8744a9b69efb178358)GreenSpectrumFile

 str 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="aaeeb813ba4dc675ca6f27de6d612472a" name="aaeeb813ba4dc675ca6f27de6d612472a"></a>## [◆ ](#aaeeb813ba4dc675ca6f27de6d612472a)GroundOrigin

 str 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="a37eb7401ae5f6ba4e112d3909cae96f0" name="a37eb7401ae5f6ba4e112d3909cae96f0"></a>## [◆ ](#a37eb7401ae5f6ba4e112d3909cae96f0)Height

 str 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="a123e0960e42f334da9b12d11d373ded4" name="a123e0960e42f334da9b12d11d373ded4"></a>## [◆ ](#a123e0960e42f334da9b12d11d373ded4)ImageFilePath

 str 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="ae0eaed72c741a4ee1dcf2fe53257db93" name="ae0eaed72c741a4ee1dcf2fe53257db93"></a>## [◆ ](#ae0eaed72c741a4ee1dcf2fe53257db93)Luminance

 str 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="a6aa632655e525d1b227f78dfa7b3ed4f" name="a6aa632655e525d1b227f78dfa7b3ed4f"></a>## [◆ ](#a6aa632655e525d1b227f78dfa7b3ed4f)PreviewSize

 str 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="a175a0605a0b9625b6156835b7eab1b89" name="a175a0605a0b9625b6156835b7eab1b89"></a>## [◆ ](#a175a0605a0b9625b6156835b7eab1b89)RedSpectrumFile

 str 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="a40dd8956fa2b807fc1ffc7805e7639c3" name="a40dd8956fa2b807fc1ffc7805e7639c3"></a>## [◆ ](#a40dd8956fa2b807fc1ffc7805e7639c3)WhitePointType

 str 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 - C. Uses an average daylight illuminant.  
 1 - D50. Uses a natural, horizon light.  
 2 - D65. Uses a standard daylight illuminant that provides accurate color perception and evaluation.  
 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="aa3f27fb02d4752eb583a4b0773122e8f" name="aa3f27fb02d4752eb583a4b0773122e8f"></a>## [◆ ](#aa3f27fb02d4752eb583a4b0773122e8f)WhitePointX

 str 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="a27fa0aa58391796b4f86ffbe2e9a4a64" name="a27fa0aa58391796b4f86ffbe2e9a4a64"></a>## [◆ ](#a27fa0aa58391796b4f86ffbe2e9a4a64)WhitePointY

 str 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="ad894fef939dd40da0f5ec4bf1205cb84" name="ad894fef939dd40da0f5ec4bf1205cb84"></a>## [◆ ](#ad894fef939dd40da0f5ec4bf1205cb84)ZenithNorthSystem

 str [ZenithNorthSystem](class_speos_n_x__2412_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\_2412.py**