## On this page

  

 

 # SourceSurfaceBuilder Class Reference

 Last update: 16.07.2025 

Represents a Surface Source Builder. [More...](#details)

Inheritance diagram for SourceSurfaceBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_source_surface_builder.png)



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [AssociatedGeometries](#a0f6ec375196a93387bab461eb95bb4b5) = property(fget=\_\_GetAssociatedGeometries, fset=\_\_SetAssociatedGeometries) Gets or sets associated geometries.   
 str [ExitGeometries](#abcc911cc5f0fad6600039e4e396ff73d) = property(fget=\_\_GetExitGeometries, fset=\_\_SetExitGeometries) Gets or sets the exit geometries.   
 str [Exitance](#a26479c9bd04d81afface4fcdeb4bd527) = property(fget=\_\_GetExitance, fset=\_\_SetExitance) Gets or sets the exitance type.   
 str [ExitanceDistributionDirectionReverse](#aeecdfd8ba2ec6b1031f76189cd4ea25b) = property(fget=\_\_GetExitanceDistributionDirectionReverse, fset=\_\_SetExitanceDistributionDirectionReverse) Gets or sets the property to reverse the exitance distribution.   
 str [ExitanceDistributionFilePath](#a28861b39ef9df6d91a4fb73dd887e9d2) = property(fget=\_\_GetExitanceDistributionFilePath, fset=\_\_SetExitanceDistributionFilePath) Gets or sets the exitance distribution file.   
 str [ExitanceOriginPoint](#a5df88d93be628c2f957df458aada7985) = property(fget=\_\_GetExitanceOriginPoint, fset=\_\_SetExitanceOriginPoint) Gets or sets the exitance origin Point.   
 str [ExitanceXDirection](#ad28609daeb1f50804ca907c737d88baa) = property(fget=\_\_GetExitanceXDirection, fset=\_\_SetExitanceXDirection) Gets or sets the exitance X direction.   
 str [ExitanceXDirectionReversed](#aaa4d296fc032ef8a0162dc674a6dadee) = property(fget=\_\_GetExitanceXDirectionReversed, fset=\_\_SetExitanceXDirectionReversed) Gets or sets the property to reverse the exitance of X direction.   
 str [ExitanceYDirection](#a7c8f16e8139883d739ed82b41e8aad4c) = property(fget=\_\_GetExitanceYDirection, fset=\_\_SetExitanceYDirection) Gets or sets the exitance Y direction.   
 str [ExitanceYDirectionReversed](#aac062c688a040beb6fd5c435d8c010bf) = property(fget=\_\_GetExitanceYDirectionReversed, fset=\_\_SetExitanceYDirectionReversed) Gets or sets the property to reverse the exitance of Y direction.   
 str [Flux](#a493e918b625a1c115dbe4962fa41d2f9) = property(fget=\_\_GetFlux, fset=\_\_SetFlux) Gets or sets the flux.   
 str [FluxUnit](#af43355cfe1d66fcc1fe101275c2f23a3) = property(fget=\_\_GetFluxUnit, fset=\_\_SetFluxUnit) Gets or sets the flux unit type.   
 str [IntensityDistributionFilePath](#adb58c5fcb2e954375a892280c7ed3c4e) = property(fget=\_\_GetIntensityDistributionFilePath, fset=\_\_SetIntensityDistributionFilePath) Gets or sets the distribution file.   
 str [IntensityFWHMAngle](#a14516f44de572a9cbab2be4746f50205) = property(fget=\_\_GetIntensityFWHMAngle, fset=\_\_SetIntensityFWHMAngle) Gets or sets the Full Width At Half Maximum (FWHM) angle.   
 str [IntensityFWHMAngleX](#aa7a54f7548e5ffacefdbc13a3bf9c754) = property(fget=\_\_GetIntensityFWHMAngleX, fset=\_\_SetIntensityFWHMAngleX) Gets or sets the Full Width At Half Maximum (FWHM) X angle.   
 str [IntensityFWHMAngleY](#a6381e9fe7f2ac3ec3959f9689d2196ca) = property(fget=\_\_GetIntensityFWHMAngleY, fset=\_\_SetIntensityFWHMAngleY) Gets or sets the Full Width At Half Maximum (FWHM) Y angle.   
 str [IntensityN](#a7a99cd7f6baa1050f81522a976029082) = property(fget=\_\_GetIntensityN, fset=\_\_SetIntensityN) Gets or sets the N.   
 str [IntensityOrientation](#a2029810dfedeb2fae5a3d661db2026a5) = property(fget=\_\_GetIntensityOrientation, fset=\_\_SetIntensityOrientation) Gets or sets the orientation type.   
 str [IntensityTotalAngle](#a456a030f2836a64e93dca54ae049a681) = property(fget=\_\_GetIntensityTotalAngle, fset=\_\_SetIntensityTotalAngle) Gets or sets the intensity total angle.   
 str [IntensityType](#afaead7b0002acb1a44c356673d626e33) = property(fget=\_\_GetIntensityType, fset=\_\_SetIntensityType) Gets or sets the intensity type of the light source.   
 str [IntensityXDirection](#a48a94ee4ee8d1abdd88b1b22bde32fa1) = property(fget=\_\_GetIntensityXDirection, fset=\_\_SetIntensityXDirection) Gets or sets the intensity X Direction.   
 str [IntensityXDirectionReversed](#a57e3ceddd48f477cda5c50f380aed40a) = property(fget=\_\_GetIntensityXDirectionReversed, fset=\_\_SetIntensityXDirectionReversed) Gets or sets the property to reverse the intensity X direction.   
 str [IntensityYDirection](#a600179cd8d21cf81178ec2fe4e95da91) = property(fget=\_\_GetIntensityYDirection, fset=\_\_SetIntensityYDirection) Gets or sets the intensity Y Direction.   
 str [IntensityYDirectionReversed](#a1dd8c3bc1205168c69fe7b6b194dae3e) = property(fget=\_\_GetIntensityYDirectionReversed, fset=\_\_SetIntensityYDirectionReversed) Gets or sets the property to reverse the intensity Y direction.   
 str [NumberOfRays](#aaa149f4084199f582574fb95a19750ec) = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays) Gets or sets the number of rays.   
 str [RayLength](#a24786b401f788b91236f7c5238005822) = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength) Gets or sets the ray length.   
 str [ShowIntensityDistribution](#a71ae77d862335a54710f601e220d1d77) = property(fget=\_\_GetShowIntensityDistribution, fset=\_\_SetShowIntensityDistribution) Gets or sets the property to show the intensity distribution.   
 str [SourceSurfaceEmissiveFaces](#a9f0fad65bda12415362d81b5d336bed9) = property(fget=\_\_GetSourceSurfaceEmissiveFaces) Returns the interface to edit the emissive faces of the source.   
 str [Spectrum](#a16de2f6d720c95018e6e4894a84a1878) = property(fget=\_\_GetSpectrum, fset=\_\_SetSpectrum) Gets or sets the spectrum type.   
 str [SpectrumFilePath](#a92b012ddaebe46fb4504668c118ac6ab) = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath) Gets or sets the spectrum file.   
 str [Temperature](#a7339eaf2d641a7dac51923a3dd0b40c9) = property(fget=\_\_GetTemperature, fset=\_\_SetTemperature) Gets or sets the temperature.   
 str [UseFluxFromFile](#af2bd35bbd0a74c227e3a34782028025b) = property(fget=\_\_GetUseFluxFromFile, fset=\_\_SetUseFluxFromFile) Gets or sets the property to use the flux from file.   
 str [Wavelength](#ae546bb3e1d15eb5e3d84527989f7edae) = property(fget=\_\_GetWavelength, fset=\_\_SetWavelength) Gets or sets the wavelength.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 <a id="details" name="details"></a>## 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.



## Member Data Documentation

<a id="a0f6ec375196a93387bab461eb95bb4b5" name="a0f6ec375196a93387bab461eb95bb4b5"></a>## [◆ ](#a0f6ec375196a93387bab461eb95bb4b5)AssociatedGeometries

 str AssociatedGeometries = property(fget=\_\_GetAssociatedGeometries, fset=\_\_SetAssociatedGeometries)  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.





<a id="a26479c9bd04d81afface4fcdeb4bd527" name="a26479c9bd04d81afface4fcdeb4bd527"></a>## [◆ ](#a26479c9bd04d81afface4fcdeb4bd527)Exitance

 str Exitance = property(fget=\_\_GetExitance, fset=\_\_SetExitance)  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.





<a id="aeecdfd8ba2ec6b1031f76189cd4ea25b" name="aeecdfd8ba2ec6b1031f76189cd4ea25b"></a>## [◆ ](#aeecdfd8ba2ec6b1031f76189cd4ea25b)ExitanceDistributionDirectionReverse

 str ExitanceDistributionDirectionReverse = property(fget=\_\_GetExitanceDistributionDirectionReverse, fset=\_\_SetExitanceDistributionDirectionReverse)  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.





<a id="a28861b39ef9df6d91a4fb73dd887e9d2" name="a28861b39ef9df6d91a4fb73dd887e9d2"></a>## [◆ ](#a28861b39ef9df6d91a4fb73dd887e9d2)ExitanceDistributionFilePath

 str ExitanceDistributionFilePath = property(fget=\_\_GetExitanceDistributionFilePath, fset=\_\_SetExitanceDistributionFilePath)  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.





<a id="a5df88d93be628c2f957df458aada7985" name="a5df88d93be628c2f957df458aada7985"></a>## [◆ ](#a5df88d93be628c2f957df458aada7985)ExitanceOriginPoint

 str ExitanceOriginPoint = property(fget=\_\_GetExitanceOriginPoint, fset=\_\_SetExitanceOriginPoint)  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.





<a id="ad28609daeb1f50804ca907c737d88baa" name="ad28609daeb1f50804ca907c737d88baa"></a>## [◆ ](#ad28609daeb1f50804ca907c737d88baa)ExitanceXDirection

 str ExitanceXDirection = property(fget=\_\_GetExitanceXDirection, fset=\_\_SetExitanceXDirection)  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.





<a id="aaa4d296fc032ef8a0162dc674a6dadee" name="aaa4d296fc032ef8a0162dc674a6dadee"></a>## [◆ ](#aaa4d296fc032ef8a0162dc674a6dadee)ExitanceXDirectionReversed

 str ExitanceXDirectionReversed = property(fget=\_\_GetExitanceXDirectionReversed, fset=\_\_SetExitanceXDirectionReversed)  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.





<a id="a7c8f16e8139883d739ed82b41e8aad4c" name="a7c8f16e8139883d739ed82b41e8aad4c"></a>## [◆ ](#a7c8f16e8139883d739ed82b41e8aad4c)ExitanceYDirection

 str ExitanceYDirection = property(fget=\_\_GetExitanceYDirection, fset=\_\_SetExitanceYDirection)  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.





<a id="aac062c688a040beb6fd5c435d8c010bf" name="aac062c688a040beb6fd5c435d8c010bf"></a>## [◆ ](#aac062c688a040beb6fd5c435d8c010bf)ExitanceYDirectionReversed

 str ExitanceYDirectionReversed = property(fget=\_\_GetExitanceYDirectionReversed, fset=\_\_SetExitanceYDirectionReversed)  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.





<a id="abcc911cc5f0fad6600039e4e396ff73d" name="abcc911cc5f0fad6600039e4e396ff73d"></a>## [◆ ](#abcc911cc5f0fad6600039e4e396ff73d)ExitGeometries

 str ExitGeometries = property(fget=\_\_GetExitGeometries, fset=\_\_SetExitGeometries)  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.





<a id="a493e918b625a1c115dbe4962fa41d2f9" name="a493e918b625a1c115dbe4962fa41d2f9"></a>## [◆ ](#a493e918b625a1c115dbe4962fa41d2f9)Flux

 str Flux = property(fget=\_\_GetFlux, fset=\_\_SetFlux)  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.





<a id="af43355cfe1d66fcc1fe101275c2f23a3" name="af43355cfe1d66fcc1fe101275c2f23a3"></a>## [◆ ](#af43355cfe1d66fcc1fe101275c2f23a3)FluxUnit

 str FluxUnit = property(fget=\_\_GetFluxUnit, fset=\_\_SetFluxUnit)  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.**





<a id="adb58c5fcb2e954375a892280c7ed3c4e" name="adb58c5fcb2e954375a892280c7ed3c4e"></a>## [◆ ](#adb58c5fcb2e954375a892280c7ed3c4e)IntensityDistributionFilePath

 str IntensityDistributionFilePath = property(fget=\_\_GetIntensityDistributionFilePath, fset=\_\_SetIntensityDistributionFilePath)  static 

Gets or sets the distribution file.

**Prerequisite**: The EnumIntensityType property must be 4.

**Value type**: String.

The default value is an empty string.





<a id="a14516f44de572a9cbab2be4746f50205" name="a14516f44de572a9cbab2be4746f50205"></a>## [◆ ](#a14516f44de572a9cbab2be4746f50205)IntensityFWHMAngle

 str IntensityFWHMAngle = property(fget=\_\_GetIntensityFWHMAngle, fset=\_\_SetIntensityFWHMAngle)  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.





<a id="aa7a54f7548e5ffacefdbc13a3bf9c754" name="aa7a54f7548e5ffacefdbc13a3bf9c754"></a>## [◆ ](#aa7a54f7548e5ffacefdbc13a3bf9c754)IntensityFWHMAngleX

 str IntensityFWHMAngleX = property(fget=\_\_GetIntensityFWHMAngleX, fset=\_\_SetIntensityFWHMAngleX)  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.





<a id="a6381e9fe7f2ac3ec3959f9689d2196ca" name="a6381e9fe7f2ac3ec3959f9689d2196ca"></a>## [◆ ](#a6381e9fe7f2ac3ec3959f9689d2196ca)IntensityFWHMAngleY

 str IntensityFWHMAngleY = property(fget=\_\_GetIntensityFWHMAngleY, fset=\_\_SetIntensityFWHMAngleY)  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.





<a id="a7a99cd7f6baa1050f81522a976029082" name="a7a99cd7f6baa1050f81522a976029082"></a>## [◆ ](#a7a99cd7f6baa1050f81522a976029082)IntensityN

 str IntensityN = property(fget=\_\_GetIntensityN, fset=\_\_SetIntensityN)  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.





<a id="a2029810dfedeb2fae5a3d661db2026a5" name="a2029810dfedeb2fae5a3d661db2026a5"></a>## [◆ ](#a2029810dfedeb2fae5a3d661db2026a5)IntensityOrientation

 str IntensityOrientation = property(fget=\_\_GetIntensityOrientation, fset=\_\_SetIntensityOrientation)  static 

Gets or sets the orientation type.

The values are:  
 0 - AxisSystem.  
 1 - NormalToSurface.  
 2 - NormalToUVMap.

**Value type**: Integer.

The default value is 0.





<a id="a456a030f2836a64e93dca54ae049a681" name="a456a030f2836a64e93dca54ae049a681"></a>## [◆ ](#a456a030f2836a64e93dca54ae049a681)IntensityTotalAngle

 str IntensityTotalAngle = property(fget=\_\_GetIntensityTotalAngle, fset=\_\_SetIntensityTotalAngle)  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.





<a id="afaead7b0002acb1a44c356673d626e33" name="afaead7b0002acb1a44c356673d626e33"></a>## [◆ ](#afaead7b0002acb1a44c356673d626e33)IntensityType

 str IntensityType = property(fget=\_\_GetIntensityType, fset=\_\_SetIntensityType)  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.





<a id="a48a94ee4ee8d1abdd88b1b22bde32fa1" name="a48a94ee4ee8d1abdd88b1b22bde32fa1"></a>## [◆ ](#a48a94ee4ee8d1abdd88b1b22bde32fa1)IntensityXDirection

 str IntensityXDirection = property(fget=\_\_GetIntensityXDirection, fset=\_\_SetIntensityXDirection)  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.





<a id="a57e3ceddd48f477cda5c50f380aed40a" name="a57e3ceddd48f477cda5c50f380aed40a"></a>## [◆ ](#a57e3ceddd48f477cda5c50f380aed40a)IntensityXDirectionReversed

 str IntensityXDirectionReversed = property(fget=\_\_GetIntensityXDirectionReversed, fset=\_\_SetIntensityXDirectionReversed)  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.





<a id="a600179cd8d21cf81178ec2fe4e95da91" name="a600179cd8d21cf81178ec2fe4e95da91"></a>## [◆ ](#a600179cd8d21cf81178ec2fe4e95da91)IntensityYDirection

 str IntensityYDirection = property(fget=\_\_GetIntensityYDirection, fset=\_\_SetIntensityYDirection)  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.





<a id="a1dd8c3bc1205168c69fe7b6b194dae3e" name="a1dd8c3bc1205168c69fe7b6b194dae3e"></a>## [◆ ](#a1dd8c3bc1205168c69fe7b6b194dae3e)IntensityYDirectionReversed

 str IntensityYDirectionReversed = property(fget=\_\_GetIntensityYDirectionReversed, fset=\_\_SetIntensityYDirectionReversed)  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.





<a id="aaa149f4084199f582574fb95a19750ec" name="aaa149f4084199f582574fb95a19750ec"></a>## [◆ ](#aaa149f4084199f582574fb95a19750ec)NumberOfRays

 str NumberOfRays = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays)  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.





<a id="a24786b401f788b91236f7c5238005822" name="a24786b401f788b91236f7c5238005822"></a>## [◆ ](#a24786b401f788b91236f7c5238005822)RayLength

 str RayLength = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength)  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.





<a id="a71ae77d862335a54710f601e220d1d77" name="a71ae77d862335a54710f601e220d1d77"></a>## [◆ ](#a71ae77d862335a54710f601e220d1d77)ShowIntensityDistribution

 str ShowIntensityDistribution = property(fget=\_\_GetShowIntensityDistribution, fset=\_\_SetShowIntensityDistribution)  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.





<a id="a9f0fad65bda12415362d81b5d336bed9" name="a9f0fad65bda12415362d81b5d336bed9"></a>## [◆ ](#a9f0fad65bda12415362d81b5d336bed9)SourceSurfaceEmissiveFaces

 str [SourceSurfaceEmissiveFaces](class_speos_n_x__2412_1_1_source_surface_emissive_faces.xhtml) = property(fget=\_\_GetSourceSurfaceEmissiveFaces)  static 

Returns the interface to edit the emissive faces of the source.

**Prerequisite**: The ExitanteType property must be 0.

**Value type**: SourceSurfaceEmissiveFaces object.





<a id="a16de2f6d720c95018e6e4894a84a1878" name="a16de2f6d720c95018e6e4894a84a1878"></a>## [◆ ](#a16de2f6d720c95018e6e4894a84a1878)Spectrum

 str Spectrum = property(fget=\_\_GetSpectrum, fset=\_\_SetSpectrum)  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.





<a id="a92b012ddaebe46fb4504668c118ac6ab" name="a92b012ddaebe46fb4504668c118ac6ab"></a>## [◆ ](#a92b012ddaebe46fb4504668c118ac6ab)SpectrumFilePath

 str SpectrumFilePath = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath)  static 

Gets or sets the spectrum file.

**Prerequisite**: The SpectrumType property must be 2.

**Value type**: String.

The default value is an empty string.





<a id="a7339eaf2d641a7dac51923a3dd0b40c9" name="a7339eaf2d641a7dac51923a3dd0b40c9"></a>## [◆ ](#a7339eaf2d641a7dac51923a3dd0b40c9)Temperature

 str Temperature = property(fget=\_\_GetTemperature, fset=\_\_SetTemperature)  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.





<a id="af2bd35bbd0a74c227e3a34782028025b" name="af2bd35bbd0a74c227e3a34782028025b"></a>## [◆ ](#af2bd35bbd0a74c227e3a34782028025b)UseFluxFromFile

 str UseFluxFromFile = property(fget=\_\_GetUseFluxFromFile, fset=\_\_SetUseFluxFromFile)  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.





<a id="ae546bb3e1d15eb5e3d84527989f7edae" name="ae546bb3e1d15eb5e3d84527989f7edae"></a>## [◆ ](#ae546bb3e1d15eb5e3d84527989f7edae)Wavelength

 str Wavelength = property(fget=\_\_GetWavelength, fset=\_\_SetWavelength)  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\_2412.py**