SourceAmbientOvercastSkyBuilder Class Reference
Last update: 17.07.2025Represents the builder for an Ambient Source with CIE Standard Overcast Sky type. More...
Properties | |
| Luminance = property(fget = __GetLuminance, fset = __SetLuminance) | |
| Gets or sets the luminance. | |
| Spectrum = property(fget = __GetSpectrum, fset = __SetSpectrum) | |
| Gets or sets the spectrum type. | |
| SpectrumFilePath = property(fget = __GetSpectrumFilePath, fset = __SetSpectrumFilePath) | |
| Gets or set the spectrum file path. | |
| Temperature = property(fget = __GetTemperature, fset = __SetTemperature) | |
| Gets or sets the temperature. | |
| ZenithDirection = property(fget = __GetZenithDirection, fset = __SetZenithDirection) | |
| Gets or sets the zenith direction. | |
| ZenithDirectionReversed = property(fget = __GetZenithDirectionReversed, fset = __SetZenithDirectionReversed) | |
| Gets or sets the reverse zenith direction. | |
 Properties inherited from FeatureBuilder | |
| Feature = property(fget = __GetFeature) | |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| FullName = property(fget = __GetFullName) | |
| Gets the full name of the feature being edited. | |
| Name = property(fget = __GetName, fset = __SetName) | |
| Gets or sets the name of the feature being edited. | |
| NameWithContext = property(fget = __GetNameWithContext) | |
| Gets the name with context of the feature being edited. | |
| Status = property(fget = __GetStatus) | |
| Returns the status of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| Commit (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. | |
Detailed Description
Represents the builder for an Ambient Source with CIE Standard Overcast Sky type.
The Ambient Overcast Sky Source Builder is used to create and edit Ambient Overcast Sky Source features.
This sky model is based on the publication of the CIE: ISO 15469:2004/CIE S 011:2003: Spatial distribution of daylight - CIE standard general sky.
To create a new instance of this class, use FeatureCollection::CreateSourceAmbientOvercastSkyBuilder
Property Documentation
◆ Luminance
|
static |
Gets or sets the luminance.
Value type: Double (cd/m2).
Range: The value must be superior to 0.
The default value is 1000.0 cd/m2.
◆ Spectrum
|
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 Kelvin.
1 - Library, then in the File property, browse a .spectrum file.
Value type: Integer.
The default value is 0.
◆ SpectrumFilePath
|
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.
◆ Temperature
|
static |
Gets or sets the temperature.
Prerequisite: The SpectrumType property must be 0.
Value type: Double (in Kelvin).
Range: The value must be superior to 0.0.
The default value is 8000.0 Kelvin.
◆ ZenithDirection
|
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.
◆ ZenithDirectionReversed
|
static |
Gets or sets the reverse zenith direction.
True: Reverses the zenith direction.
False: 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
