SourceSurfaceBuilder Class Reference
Last update: 17.07.2025Represents a Surface Source Builder. More...
Properties | |
| AssociatedGeometries = property(fget = __GetAssociatedGeometries, fset = __SetAssociatedGeometries) | |
| Gets or sets associated geometries. | |
| ExitGeometries = property(fget = __GetExitGeometries, fset = __SetExitGeometries) | |
| Gets or sets the exit geometries. | |
| Exitance = property(fget = __GetExitance, fset = __SetExitance) | |
| Gets or sets the exitance type. | |
| ExitanceDistributionDirectionReverse = property(fget = __GetExitanceDistributionDirectionReverse, fset = __SetExitanceDistributionDirectionReverse) | |
| Gets or sets the property to reverse the exitance distribution. | |
| ExitanceDistributionFilePath = property(fget = __GetExitanceDistributionFilePath, fset = __SetExitanceDistributionFilePath) | |
| Gets or sets the exitance distribution file. | |
| ExitanceOriginPoint = property(fget = __GetExitanceOriginPoint, fset = __SetExitanceOriginPoint) | |
| Gets or sets the exitance origin Point. | |
| ExitanceXDirection = property(fget = __GetExitanceXDirection, fset = __SetExitanceXDirection) | |
| Gets or sets the exitance X direction. | |
| ExitanceXDirectionReversed = property(fget = __GetExitanceXDirectionReversed, fset = __SetExitanceXDirectionReversed) | |
| Gets or sets the property to reverse the exitance of X direction. | |
| ExitanceYDirection = property(fget = __GetExitanceYDirection, fset = __SetExitanceYDirection) | |
| Gets or sets the exitance Y direction. | |
| ExitanceYDirectionReversed = property(fget = __GetExitanceYDirectionReversed, fset = __SetExitanceYDirectionReversed) | |
| Gets or sets the property to reverse the exitance of Y direction. | |
| Flux = property(fget = __GetFlux, fset = __SetFlux) | |
| Gets or sets the flux. | |
| FluxUnit = property(fget = __GetFluxUnit, fset = __SetFluxUnit) | |
| Gets or sets the flux unit type. | |
| IntensityDistributionFilePath = property(fget = __GetIntensityDistributionFilePath, fset = __SetIntensityDistributionFilePath) | |
| Gets or sets the distribution file. | |
| IntensityFWHMAngle = property(fget = __GetIntensityFWHMAngle, fset = __SetIntensityFWHMAngle) | |
| Gets or sets the Full Width At Half Maximum (FWHM) angle. | |
| IntensityFWHMAngleX = property(fget = __GetIntensityFWHMAngleX, fset = __SetIntensityFWHMAngleX) | |
| Gets or sets the Full Width At Half Maximum (FWHM) X angle. | |
| IntensityFWHMAngleY = property(fget = __GetIntensityFWHMAngleY, fset = __SetIntensityFWHMAngleY) | |
| Gets or sets the Full Width At Half Maximum (FWHM) Y angle. | |
| IntensityN = property(fget = __GetIntensityN, fset = __SetIntensityN) | |
| Gets or sets the N. | |
| IntensityOrientation = property(fget = __GetIntensityOrientation, fset = __SetIntensityOrientation) | |
| Gets or sets the orientation type. | |
| IntensityTotalAngle = property(fget = __GetIntensityTotalAngle, fset = __SetIntensityTotalAngle) | |
| Gets or sets the intensity total angle. | |
| IntensityType = property(fget = __GetIntensityType, fset = __SetIntensityType) | |
| Gets or sets the intensity type of the light source. | |
| IntensityXDirection = property(fget = __GetIntensityXDirection, fset = __SetIntensityXDirection) | |
| Gets or sets the intensity X Direction. | |
| IntensityXDirectionReversed = property(fget = __GetIntensityXDirectionReversed, fset = __SetIntensityXDirectionReversed) | |
| Gets or sets the property to reverse the intensity X direction. | |
| IntensityYDirection = property(fget = __GetIntensityYDirection, fset = __SetIntensityYDirection) | |
| Gets or sets the intensity Y Direction. | |
| IntensityYDirectionReversed = property(fget = __GetIntensityYDirectionReversed, fset = __SetIntensityYDirectionReversed) | |
| Gets or sets the property to reverse the intensity Y direction. | |
| NumberOfRays = property(fget = __GetNumberOfRays, fset = __SetNumberOfRays) | |
| Gets or sets the number of rays. | |
| RayLength = property(fget = __GetRayLength, fset = __SetRayLength) | |
| Gets or sets the ray length. | |
| ShowIntensityDistribution = property(fget = __GetShowIntensityDistribution, fset = __SetShowIntensityDistribution) | |
| Gets or sets the property to show the intensity distribution. | |
| SourceSurfaceEmissiveFaces = property(fget = __GetSourceSurfaceEmissiveFaces) | |
| Returns the interface to edit the emissive faces of the source. | |
| Spectrum = property(fget = __GetSpectrum, fset = __SetSpectrum) | |
| Gets or sets the spectrum type. | |
| SpectrumFilePath = property(fget = __GetSpectrumFilePath, fset = __SetSpectrumFilePath) | |
| Gets or sets the spectrum file. | |
| Temperature = property(fget = __GetTemperature, fset = __SetTemperature) | |
| Gets or sets the temperature. | |
| UseFluxFromFile = property(fget = __GetUseFluxFromFile, fset = __SetUseFluxFromFile) | |
| Gets or sets the property to use the flux from file. | |
| Wavelength = property(fget = __GetWavelength, fset = __SetWavelength) | |
| Gets or sets the wavelength. | |
 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 a Surface Source Builder.
The Surface Source Builder creates or edits Surface Source features.
To create a new instance of this class, use FeatureCollection.CreateSourceSurfaceBuilder.
With a surface source, you can model the light emission of a source taking into account its physical properties as the flux, the spectrum, the exitance and the intensity. A surface source can be defined with any face in a geometry which emits rays.
Property Documentation
◆ AssociatedGeometries
|
static |
Gets or sets associated geometries.
The AssociatedGeometries property takes a list of feature tag and returns a list of feature tag.
Value type: List of integer.
The default value is an empty list.
◆ Exitance
|
static |
Gets or sets the exitance type.
Exitance of a source describes how each point of a surface emits rays.
The values are:
0 - Constant, ray energy is constant over surface source face.
1 - Variable, ray energy depends on xmp energy distribution.
Value type: Integer.
The default value is 0.
◆ ExitanceDistributionDirectionReverse
|
static |
Gets or sets the property to reverse the exitance distribution.
Prerequisite: The ExitanteType property must be 0.
True: Reverses the exitance distribution direction.
False: Does not reverse the exitance distribution direction.
Value type: Boolean.
The default value is False.
◆ ExitanceDistributionFilePath
|
static |
Gets or sets the exitance distribution file.
Prerequisite: The ExitanteType property must be 1.
Value type: String.
The default value is an empty string.
◆ ExitanceOriginPoint
|
static |
Gets or sets the exitance origin Point.
Prerequisite: The ExitanceType property must be 1.
The ExitanceOriginPoint property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ ExitanceXDirection
|
static |
Gets or sets the exitance X direction.
Prerequisite: The ExitanteType property must be 1.
The ExitanceXDirection property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ ExitanceXDirectionReversed
|
static |
Gets or sets the property to reverse the exitance of X direction.
Prerequisite: The ExitanceType property must be 1.
True: Reverses the exitance direction X.
False: Does not reverse the exitance direction X.
Value type: Boolean.
The default value is False.
◆ ExitanceYDirection
|
static |
Gets or sets the exitance Y direction.
Prerequisite: The ExitanteType property must be 1.
The ExitanceYDirection property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ ExitanceYDirectionReversed
|
static |
Gets or sets the property to reverse the exitance of Y direction.
Prerequisite: The ExitanceType property must be 1.
True: Reverses the exitance direction Y.
False: Does not reverse the exitance direction Y.
Value type: Boolean.
The default value is False.
◆ ExitGeometries
|
static |
Gets or sets the exit geometries.
The ExitGeometries property takes a list of feature tag and returns a list of feature tag.
Value type: List of integer.
The default value is an empty list.
◆ Flux
|
static |
Gets or sets the flux.
The unit depends on the FluxUnitType.
Value type: Double (in lm, W or cd).
Range: The value must be superior to 0.0.
The default value is 683.0 lm for FluxUnitType = 0, 1.0 W for FluxUnitType = 1 and 5.0 cd for FluxUnitType = 2.
◆ FluxUnit
|
static |
Gets or sets the flux unit type.
The values are:
0 - Lumen.
1 - Watt.
2 - Candela.
Value type: Integer.
The default value is 0.
◆ IntensityDistributionFilePath
|
static |
Gets or sets the distribution file.
Prerequisite: The EnumIntensityType property must be 4.
Value type: String.
The default value is an empty string.
◆ IntensityFWHMAngle
|
static |
Gets or sets the Full Width At Half Maximum (FWHM) angle.
Prerequisite: The EnumIntensityType property must be 2.
Value type: Double (in degrees).
Range: [0, 180].
The default value is 30.0 degrees.
◆ IntensityFWHMAngleX
|
static |
Gets or sets the Full Width At Half Maximum (FWHM) X angle.
Prerequisite: The EnumIntensityType property must be 3.
Value type: Double (in degrees).
Range: [0, 180].
The default value is 30.0 degrees.
◆ IntensityFWHMAngleY
|
static |
Gets or sets the Full Width At Half Maximum (FWHM) Y angle.
Prerequisite: The EnumIntensityType property must be 3.
Value type: Double (in degrees).
Range: [0, 180].
The default value is 30.0 degrees.
◆ IntensityN
|
static |
Gets or sets the N.
Prerequisite: The EnumIntensityType property must be 1.
Value type: Double.
Range: The value must be superior to -1.0.
The default value is 3.0.
◆ IntensityOrientation
|
static |
Gets or sets the orientation type.
The values are:
0 - AxisSystem.
1 - NormalToSurface.
2 - NormalToUVMap.
Value type: Integer.
The default value is 0.
◆ IntensityTotalAngle
|
static |
Gets or sets the intensity total angle.
Prerequisite: The EnumIntensityType property must be 0, 1, 2 or 3.
Value type: Double (in degrees).
Range: [0, 180].
The default value is 180.0 degrees.
◆ IntensityType
|
static |
Gets or sets the intensity type of the light source.
The values are:
0 - Lambertian.
1 - Cos.
2 - Symmetric Gaussian.
3 - Asymmetric Gaussian.
4 - Library.
Value type: Integer.
The default value is 0.
◆ IntensityXDirection
|
static |
Gets or sets the intensity X Direction.
Prerequisite: The EnumIntensityType property must be 3.
The property IntensityXDirection takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ IntensityXDirectionReversed
|
static |
Gets or sets the property to reverse the intensity X direction.
Prerequisite: The EnumIntensityType property must be 3.
True: Reverses the intensity X direction.
False: Does not reverse the intensity X direction.
Value type: Boolean.
The default value is False.
◆ IntensityYDirection
|
static |
Gets or sets the intensity Y Direction.
Prerequisite: The EnumIntensityType property must be 3.
The property IntensityYDirection takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ IntensityYDirectionReversed
|
static |
Gets or sets the property to reverse the intensity Y direction.
Prerequisite: The EnumIntensityType property must be 3 or The IntensityOrientationType must be 0.
True: Reverses the intensity Y direction.
False: Does not reverse the intensity Y direction.
Value type: Boolean.
The default value is False.
◆ NumberOfRays
|
static |
Gets or sets the number of rays.
Edits the value to set the number of rays displayed in the preview.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 100.
◆ RayLength
|
static |
Gets or sets the ray length.
Edits the value to set the length of the rays preview in the 3D view.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 75.0 mm.
◆ ShowIntensityDistribution
|
static |
Gets or sets the property to show the intensity distribution.
True: Shows the intensity distribution in the preview.
False: Does not show the intensity distribution in the preview.
Value type: Boolean.
The default value is False.
◆ SourceSurfaceEmissiveFaces
|
static |
Returns the interface to edit the emissive faces of the source.
Prerequisite: The ExitanteType property must be 0.
Value type: SourceSurfaceEmissiveFaces object.
◆ Spectrum
|
static |
Gets or sets the spectrum type.
The values are:
0 - Monochromatic, you can edit the wavelength value.
1 - Blackbody, you can edit the temperature value.
2 - Library, you can browse a .spectrum file.
Value type: Integer.
The default value is 0.
◆ SpectrumFilePath
|
static |
Gets or sets the spectrum file.
Prerequisite: The SpectrumType property must be 2.
Value type: String.
The default value is an empty string.
◆ Temperature
|
static |
Gets or sets the temperature.
Prerequisite: The SpectrumType property must be 1.
Value type: Double (in Kelvin).
Range: The value must be superior to 0.0.
The default value is 2856.0 Kelvin.
◆ UseFluxFromFile
|
static |
Gets or sets the property to use the flux from file.
True: Uses the flux from a file.
False: Does not use the flux from a file.
Value type: Boolean.
The default value is False.
◆ Wavelength
|
static |
Gets or sets the wavelength.
Prerequisite: The SpectrumType property must be 0.
Value type: Double (in nm).
Range: The value must be superior to 0.0.
The default value is 555.0 nm.
The documentation for this class was generated from the following file:
- SpeosNX.py
