SourceAmbientUniformBuilder Class Reference
Last update: 17.07.2025Represents the builder for an Ambient Source with Uniform type. More...
Properties | |
| Luminance = property(fget = __GetLuminance, fset = __SetLuminance) | |
| Gets or sets the luminance. | |
| MirroredExtent = property(fget = __GetMirroredExtent, fset = __SetMirroredExtent) | |
| Gets or sets the property to enable mirrored extent. | |
| 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. | |
| Sun = property(fget = __GetSun, fset = __SetSun) | |
| Gets or sets the property to enable the Sun. | |
| SunDirection = property(fget = __GetSunDirection, fset = __SetSunDirection) | |
| Gets or sets the Sun direction. | |
| SunDirectionReverse = property(fget = __GetSunDirectionReverse, fset = __SetSunDirectionReverse) | |
| Gets or sets the reverse Sun direction. | |
| 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 Uniform type.
The Ambient Uniform Source Builder is used to create and edit Ambient Uniform Source features.
To create a new instance of this class, use FeatureCollection::CreateSourceAmbientUniformBuilder
Property Documentation
◆ 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.
◆ MirroredExtent
|
static |
Gets or sets the property to enable mirrored extent.
True: Gets an ambient light from all the space.
False: Gets an ambient light only in the upper half space.
Value type: Boolean.
The default value is False.
◆ 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 Kdeg.
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.
◆ Sun
|
static |
Gets or sets the property to enable the Sun.
True : Uses the Sun.
False : Does not use the Sun.
Value type: Boolean.
The default value is False.
◆ SunDirection
|
static |
Gets or sets the Sun direction.
Prerequisite: The UseSun property must be True.
The Sun direction property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ SunDirectionReverse
|
static |
Gets or sets the reverse Sun direction.
Prerequisite: The UseSun property must be True.
True: Reverses the Sun direction.
False: Does not reverse the Sun directio.n
Value type: Boolean.
The default value is False.
◆ Temperature
|
static |
Gets or sets the temperature.
Prerequisite: The SpectrumType property must be 0.
Value type: String.
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: Does 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
