SourceAmbientEnvironmentBuilder Class Reference
Last update: 17.07.2025Represents the builder for an ambient environment source. More...
Static Public Attributes | |
| str | BlueSpectrumFile = property(fget=__GetBlueSpectrumFile, fset=__SetBlueSpectrumFile) |
| Gets or sets the blue spectrum file. | |
| str | ColorSpace = property(fget=__GetColorSpace, fset=__SetColorSpace) |
| Gets or sets the color space model type. | |
| str | GreenSpectrumFile = property(fget=__GetGreenSpectrumFile, fset=__SetGreenSpectrumFile) |
| Gets or sets the green spectrum file. | |
| str | GroundOrigin = property(fget=__GetGroundOrigin, fset=__SetGroundOrigin) |
| Gets or sets the ground origin. | |
| str | Height = property(fget=__GetHeight, fset=__SetHeight) |
| Gets or sets the height. | |
| str | ImageFilePath = property(fget=__GetImageFilePath, fset=__SetImageFilePath) |
| Gets or sets the image file. | |
| str | Luminance = property(fget=__GetLuminance, fset=__SetLuminance) |
| Gets or sets the luminance. | |
| str | PreviewSize = property(fget=__GetPreviewSize, fset=__SetPreviewSize) |
| Gets or sets the preview arrows size. | |
| str | RedSpectrumFile = property(fget=__GetRedSpectrumFile, fset=__SetRedSpectrumFile) |
| Gets or sets the red spectrum file. | |
| str | WhitePointType = property(fget=__GetWhitePointType, fset=__SetWhitePointType) |
| Gets or sets the white point type of the standard illuminant. | |
| str | WhitePointX = property(fget=__GetWhitePointX, fset=__SetWhitePointX) |
| Gets or sets the X coordinate of the white point. | |
| str | WhitePointY = property(fget=__GetWhitePointY, fset=__SetWhitePointY) |
| Gets or sets the Y coordinate of the white point. | |
| str | ZenithNorthSystem = property(fget=__GetZenithNorthSystem) |
| Gets the zenith north axis system. | |
 Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
| 'None' | 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 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 FeatureCollection::CreateSourceAmbientEnvironmentBuilder
Member Data Documentation
◆ BlueSpectrumFile
|
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.
◆ ColorSpace
|
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.
◆ GreenSpectrumFile
|
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.
◆ GroundOrigin
|
static |
Gets or sets the ground origin.
The GroundOrigin property takes a feature tag.
Value type: Integer.
The default value is 0.
◆ Height
|
static |
Gets or sets the height.
Value type: Double (in mm).
The default value is 0.0 mm.
◆ ImageFilePath
|
static |
Gets or sets the image file.
Value type: String.
The default value is an empty string.
◆ Luminance
|
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.
◆ PreviewSize
|
static |
Gets or sets the preview arrows size.
Value type: Double (in mm).
The default value is 100.0 mm.
◆ RedSpectrumFile
|
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.
◆ WhitePointType
|
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.
◆ WhitePointX
|
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.
◆ WhitePointY
|
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.
◆ ZenithNorthSystem
|
static |
Gets the zenith north axis system.
Value type: ZenithNorthSystem object.
The documentation for this class was generated from the following file:
- SpeosNX.py
