SourceAmbientGeneralSkyBuilder Class Reference
Last update: 17.07.2025Represents the builder for an Ambient Source with CIE Standard General Sky type. More...
Static Public Attributes | |
| str | CIEType = property(fget=__GetCIEType, fset=__SetCIEType) |
| Gets or sets the CIE type. | |
| str | Luminance = property(fget=__GetLuminance, fset=__SetLuminance) |
| Gets or sets the luminance. | |
| str | SunDirection = property(fget=__GetSunDirection, fset=__SetSunDirection) |
| Gets or sets the Sun direction. | |
| str | SunDirectionReversed = property(fget=__GetSunDirectionReversed, fset=__SetSunDirectionReversed) |
| Gets or sets the reverse Sun direction. | |
| str | SunType = property(fget=__GetSunType, fset=__SetSunType) |
| Gets or sets the Sun type. | |
| str | Timezone = property(fget=__GetTimezone) |
| Gets the Timezone and Location object. | |
| str | ZenithNorthSystem = property(fget=__GetZenithNorthSystem) |
| Gets the orientation object of the source. | |
 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 Source with CIE Standard General Sky type.
The Ambient General Sky Source Builder is used to create and edit Ambient General 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::CreateSourceAmbientGeneralSkyBuilder
Member Data Documentation
◆ CIEType
|
static |
Gets or sets the CIE type.
The values are:
0 - CIE standard overcast sky.
1 - Overcast with steep luminance gradation and slight brightening towards the sun.
2 - Overcast, moderately graded with azimuthal uniformity.
3 - Overcast, moderately graded and slight brightening towards the sun.
4 - Sky of uniform luminance.
5 - Partly cloudy sky, no gradation towards zenith, slight brightnening.
6 - Partly cloudy sky, no gradation towards zenith, brighter circumsolar region.
7 - Partly cloudy sky, no gradation towards zenith, distinct solar corona.
8 - Partly cloudy sky, with the obscured sun.
9 - Partly cloudy sky, with brighter circumsolar region.
10 - White blue sky with distinct solar corona.
11 - CIE standard clear sky, low luminance turbidity.
12 - CIE standard clear sky, polluted atmosphere.
13 - Cloudless turbid sky with broad solar corona.
14 - White blue turbid sky with broad solar corona.
Value type: Integer.
The default value is 5.
◆ Luminance
|
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.
◆ SunDirection
|
static |
Gets or sets the Sun direction.
Prerequisite: The SunType property must be 1.
The Sun direction property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ SunDirectionReversed
|
static |
Gets or sets the reverse Sun direction.
Prerequisite: The SunType property must be 1.
True: Reverses the Sun direction.
False: Does not reverse the Sun direction.
Value type: Boolean.
The default value is False.
◆ SunType
|
static |
Gets or sets the Sun type.
The values are:
0 - Automatic, you must set the values in the Timezone and Location object.
1 - Direction, you must to set the sun direction property.
Value type: Integer.
The default value is 0.
◆ Timezone
|
static |
Gets the Timezone and Location object.
Prerequisite: The SunType property must be 0.
Value type: Timezone object.
◆ ZenithNorthSystem
|
static |
Gets the orientation object of the source.
Value type: ZenithNorthSystem object.
The documentation for this class was generated from the following file:
- SpeosNX.py
