SourceAmbientNaturalLightBuilder Class Reference
Last update: 17.07.2025Represents the builder for an Ambient Source with Natural Light type. More...
Properties | |
| SunDirection = property(fget = __GetSunDirection, fset = __SetSunDirection) | |
| Gets or sets the Sun direction. | |
| SunDirectionReversed = property(fget = __GetSunDirectionReversed, fset = __SetSunDirectionReversed) | |
| Gets or sets the reverse Sun direction. | |
| SunType = property(fget = __GetSunType, fset = __SetSunType) | |
| Gets or sets the Sun type. | |
| Timezone = property(fget = __GetTimezone) | |
| Gets the Timezone and Location object. | |
| Turbidity = property(fget = __GetTurbidity, fset = __SetTurbidity) | |
| Gets or sets the turbidity. | |
| WithSky = property(fget = __GetWithSky, fset = __SetWithSky) | |
| Gets or sets the property to enable the sky. | |
| ZenithNorthSystem = property(fget = __GetZenithNorthSystem) | |
| Gets the orientation object of the source. | |
 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 Natural Light type.
The Ambient Natural Light Source Builder is used to create and edit Ambient Natural Light Source features.
To create a new instance of this class, use FeatureCollection::CreateSourceAmbientNaturalLightBuilder
Property Documentation
◆ 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 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.
◆ Turbidity
|
static |
Gets or sets the turbidity.
Turbidity is a measure of the fraction of scattering due to haze as opposed to molecules.
Value type: Double.
Range: [2.0, 9.0]
The default value is 3.0.
◆ WithSky
|
static |
Gets or sets the property to enable the sky.
True: Uses the sun and Sky in simulations.
False: Uses sun only in simulations.
Value type: Boolean.
The default value is True.
◆ 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
