## On this page

  

 

 # SourceSurfaceThermicBuilder Class Reference

 Last update: 16.07.2025 

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

Inheritance diagram for SourceSurfaceThermicBuilder:

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



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

str [CosN](#ab6af473ac0abd6943d5eac98e2fb5140) = property(fget=\_\_GetCosN, fset=\_\_SetCosN) Gets or sets the N value for Cos distribution.   
 str [EmittanceFilePath](#a5f3af49b047d4a02c47e95e821579873) = property(fget=\_\_GetEmittanceFilePath, fset=\_\_SetEmittanceFilePath) Gets or sets the emittance file.   
 str [EmittanceOrigin](#a0d2e840225ed1561b885865edaa695a2) = property(fget=\_\_GetEmittanceOrigin, fset=\_\_SetEmittanceOrigin) Gets or sets the emittance origin Point.   
 str [EmittanceType](#a5c508ae31407e7d56cbda2e644a6445f) = property(fget=\_\_GetEmittanceType, fset=\_\_SetEmittanceType) Gets or sets the emittance type.   
 str [EmittanceXDirection](#a19dad9aa500910e24bebd800fad756c1) = property(fget=\_\_GetEmittanceXDirection, fset=\_\_SetEmittanceXDirection) Gets or sets the emittance X direction.   
 str [EmittanceXDirectionReversed](#afc1f007282bb1ede565aa8e1acbb8d84) = property(fget=\_\_GetEmittanceXDirectionReversed, fset=\_\_SetEmittanceXDirectionReversed) Gets or sets the property to reverse the emittance of X direction.   
 str [EmittanceYDirection](#a7b60842e4bcc71b71e7434ad001f2dc3) = property(fget=\_\_GetEmittanceYDirection, fset=\_\_SetEmittanceYDirection) Gets or sets the emittance Y direction.   
 str [EmittanceYDirectionReversed](#a6f15b75d71150574e1ed4feab3f5b86b) = property(fget=\_\_GetEmittanceYDirectionReversed, fset=\_\_SetEmittanceYDirectionReversed) Gets or sets the property to reverse the emittance of Y direction.   
 str [EnableAutomaticUpdate](#ad88556ebaeb426c95b29f5c2854f3133) = property(fget=\_\_GetEnableAutomaticUpdate, fset=\_\_SetEnableAutomaticUpdate) Gets or sets the property to enable/disable the automatic update.   
 str [Flux](#a493e918b625a1c115dbe4962fa41d2f9) = property(fget=\_\_GetFlux) Gets the flux.   
 str [FluxUnit](#af43355cfe1d66fcc1fe101275c2f23a3) = property(fget=\_\_GetFluxUnit, fset=\_\_SetFluxUnit) Gets or sets the flux unit.   
 str [IntensityType](#afaead7b0002acb1a44c356673d626e33) = property(fget=\_\_GetIntensityType, fset=\_\_SetIntensityType) Gets or sets the intensity diagram.   
 str [NumberOfRays](#aaa149f4084199f582574fb95a19750ec) = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays) Gets or sets the number of rays.   
 str [PreviewMode](#af000d33c17bc2049aded27ce88b25ec9) = property(fget=\_\_GetPreviewMode, fset=\_\_SetPreviewMode) Gets or sets the preview mode.   
 str [RayLength](#a24786b401f788b91236f7c5238005822) = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength) Gets or sets the ray length.   
 str [SOPLibraryFilePath](#a651afa088ab1fd3a34396a5fefd49551) = property(fget=\_\_GetSOPLibraryFilePath, fset=\_\_SetSOPLibraryFilePath) Gets or sets the surface optical properties library file.   
 str [SOPParametersFilePath](#a8d15bbb04e1306901e50aac252451c4a) = property(fget=\_\_GetSOPParametersFilePath, fset=\_\_SetSOPParametersFilePath) Gets or sets the surface optical properties parameters file.   
 str [SOPPluginFilePath](#a8fc3568684d47c04ef7e3116307a52ff) = property(fget=\_\_GetSOPPluginFilePath, fset=\_\_SetSOPPluginFilePath) Gets or sets the surface optical properties plug-in file.   
 str [SOPReflectance](#ae5d38106ddbad20f6eb7b46014eaebdc) = property(fget=\_\_GetSOPReflectance, fset=\_\_SetSOPReflectance) Gets or sets the surface optical properties reflectance.   
 str [SOPType](#a247b53ec63e2053c4ea0b47face746ab) = property(fget=\_\_GetSOPType, fset=\_\_SetSOPType) Gets or sets the surface optical properties.   
 str [SourceSurfaceEmissiveFaces](#a9f0fad65bda12415362d81b5d336bed9) = property(fget=\_\_GetSourceSurfaceEmissiveFaces) Returns the interface to edit the emissive faces of the source.   
 str [Temperature](#a7339eaf2d641a7dac51923a3dd0b40c9) = property(fget=\_\_GetTemperature, fset=\_\_SetTemperature) Gets or sets the temperature.   
 ![-](/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 Thermic Surface Source Builder.

The Thermic Surface Source Builder creates or edits Thermic Surface Source features.

To create a new instance of this class, use FeatureCollection.CreateSourceSurfaceThermicBuilder.

A thermic surface can define a source for which the total flux and the spectrum are defined by the source's temperature and the optical properties of the support geometry. You can define a thermic source on any face of the geometry.



## Member Data Documentation

<a id="ab6af473ac0abd6943d5eac98e2fb5140" name="ab6af473ac0abd6943d5eac98e2fb5140"></a>## [◆ ](#ab6af473ac0abd6943d5eac98e2fb5140)CosN

 str CosN = property(fget=\_\_GetCosN, fset=\_\_SetCosN)  static 

Gets or sets the N value for Cos distribution.

Prerequisite: The IntensityType property must be 1.

**Value type**: Double.

The default value is 3.0.





<a id="a5f3af49b047d4a02c47e95e821579873" name="a5f3af49b047d4a02c47e95e821579873"></a>## [◆ ](#a5f3af49b047d4a02c47e95e821579873)EmittanceFilePath

 str EmittanceFilePath = property(fget=\_\_GetEmittanceFilePath, fset=\_\_SetEmittanceFilePath)  static 

Gets or sets the emittance file.

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

**Value type**: String.

The default value is an empty string.





<a id="a0d2e840225ed1561b885865edaa695a2" name="a0d2e840225ed1561b885865edaa695a2"></a>## [◆ ](#a0d2e840225ed1561b885865edaa695a2)EmittanceOrigin

 str EmittanceOrigin = property(fget=\_\_GetEmittanceOrigin, fset=\_\_SetEmittanceOrigin)  static 

Gets or sets the emittance origin Point.

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

The EmittanceOrigin property takes and returns a feature tag.

**Value type**: Integer.

The default value is 0.





<a id="a5c508ae31407e7d56cbda2e644a6445f" name="a5c508ae31407e7d56cbda2e644a6445f"></a>## [◆ ](#a5c508ae31407e7d56cbda2e644a6445f)EmittanceType

 str EmittanceType = property(fget=\_\_GetEmittanceType, fset=\_\_SetEmittanceType)  static 

Gets or sets the emittance type.

The values are:  
 0 - Temperature Field.  
 1 - Emissive Faces.

**Value type**: Integer.

The default value is 1.





<a id="a19dad9aa500910e24bebd800fad756c1" name="a19dad9aa500910e24bebd800fad756c1"></a>## [◆ ](#a19dad9aa500910e24bebd800fad756c1)EmittanceXDirection

 str EmittanceXDirection = property(fget=\_\_GetEmittanceXDirection, fset=\_\_SetEmittanceXDirection)  static 

Gets or sets the emittance X direction.

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

The EmittanceXDirection property takes and returns a feature tag.

**Value type**: Integer.

The default value is 0.





<a id="afc1f007282bb1ede565aa8e1acbb8d84" name="afc1f007282bb1ede565aa8e1acbb8d84"></a>## [◆ ](#afc1f007282bb1ede565aa8e1acbb8d84)EmittanceXDirectionReversed

 str EmittanceXDirectionReversed = property(fget=\_\_GetEmittanceXDirectionReversed, fset=\_\_SetEmittanceXDirectionReversed)  static 

Gets or sets the property to reverse the emittance of X direction.

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

True: Reverses the emittance direction X.  
 False: Does not reverse the emittance direction X.

**Value type**: Boolean.

The default value is False.





<a id="a7b60842e4bcc71b71e7434ad001f2dc3" name="a7b60842e4bcc71b71e7434ad001f2dc3"></a>## [◆ ](#a7b60842e4bcc71b71e7434ad001f2dc3)EmittanceYDirection

 str EmittanceYDirection = property(fget=\_\_GetEmittanceYDirection, fset=\_\_SetEmittanceYDirection)  static 

Gets or sets the emittance Y direction.

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

The EmittanceXDirection property takes and returns a feature tag.

**Value type**: Integer.

The default value is 0.





<a id="a6f15b75d71150574e1ed4feab3f5b86b" name="a6f15b75d71150574e1ed4feab3f5b86b"></a>## [◆ ](#a6f15b75d71150574e1ed4feab3f5b86b)EmittanceYDirectionReversed

 str EmittanceYDirectionReversed = property(fget=\_\_GetEmittanceYDirectionReversed, fset=\_\_SetEmittanceYDirectionReversed)  static 

Gets or sets the property to reverse the emittance of Y direction.

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

True: Reverses the emittance direction Y.  
 False: Does not reverse the emittance direction Y.

**Value type**: Boolean.

The default value is False.





<a id="ad88556ebaeb426c95b29f5c2854f3133" name="ad88556ebaeb426c95b29f5c2854f3133"></a>## [◆ ](#ad88556ebaeb426c95b29f5c2854f3133)EnableAutomaticUpdate

 str EnableAutomaticUpdate = property(fget=\_\_GetEnableAutomaticUpdate, fset=\_\_SetEnableAutomaticUpdate)  static 

Gets or sets the property to enable/disable the automatic update.

True: Enables the automatic update.  
 False: Disables the automatic update.

**Value type**: Boolean.

The default value is False.





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

 str Flux = property(fget=\_\_GetFlux)  static 

Gets the flux.

**Value type**: Double.

The default value is 0.





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

 str FluxUnit = property(fget=\_\_GetFluxUnit, fset=\_\_SetFluxUnit)  static 

Gets or sets the flux unit.

The values are:  
 0 - lumen (lm).  
 1 - watt (W).

**Value type**: Integer.

The default value is 0.





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

 str IntensityType = property(fget=\_\_GetIntensityType, fset=\_\_SetIntensityType)  static 

Gets or sets the intensity diagram.

The intensity diagram of a source describes in which directions is made the emission.

The values are:  
 0 - Lambertian.  
 1 - Cos.

**Value type**: Integer.

The default value is 0.





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

 str NumberOfRays = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays)  static 

Gets or sets the number of rays.

**Value type**: Integer.  
**Range**: The value must be superior or equal to 0.

The default value is 100.





<a id="af000d33c17bc2049aded27ce88b25ec9" name="af000d33c17bc2049aded27ce88b25ec9"></a>## [◆ ](#af000d33c17bc2049aded27ce88b25ec9)PreviewMode

 str PreviewMode = property(fget=\_\_GetPreviewMode, fset=\_\_SetPreviewMode)  static 

Gets or sets the preview mode.

The values are:  
 0 - Meshing.  
 1 - BoundingBox.

**Value type**: Integer.

The default value is Meshing (0).





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

 str RayLength = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength)  static 

Gets or sets the ray length.

**Value type**: Double (in mm).  
**Range**: The value must be superior to 0.0.

The default value is 75.0 mm.





<a id="a651afa088ab1fd3a34396a5fefd49551" name="a651afa088ab1fd3a34396a5fefd49551"></a>## [◆ ](#a651afa088ab1fd3a34396a5fefd49551)SOPLibraryFilePath

 str SOPLibraryFilePath = property(fget=\_\_GetSOPLibraryFilePath, fset=\_\_SetSOPLibraryFilePath)  static 

Gets or sets the surface optical properties library file.

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

**Value type**: String.

The default value is an empty string.





<a id="a8d15bbb04e1306901e50aac252451c4a" name="a8d15bbb04e1306901e50aac252451c4a"></a>## [◆ ](#a8d15bbb04e1306901e50aac252451c4a)SOPParametersFilePath

 str SOPParametersFilePath = property(fget=\_\_GetSOPParametersFilePath, fset=\_\_SetSOPParametersFilePath)  static 

Gets or sets the surface optical properties parameters file.

**Prerequisite**: The SOPType property must be 3.

**Value type**: String.

The default value is an empty string.





<a id="a8fc3568684d47c04ef7e3116307a52ff" name="a8fc3568684d47c04ef7e3116307a52ff"></a>## [◆ ](#a8fc3568684d47c04ef7e3116307a52ff)SOPPluginFilePath

 str SOPPluginFilePath = property(fget=\_\_GetSOPPluginFilePath, fset=\_\_SetSOPPluginFilePath)  static 

Gets or sets the surface optical properties plug-in file.

**Prerequisite**: The SOPType property must be 3.

**Value type**: String.

The default value is an empty string.





<a id="ae5d38106ddbad20f6eb7b46014eaebdc" name="ae5d38106ddbad20f6eb7b46014eaebdc"></a>## [◆ ](#ae5d38106ddbad20f6eb7b46014eaebdc)SOPReflectance

 str SOPReflectance = property(fget=\_\_GetSOPReflectance, fset=\_\_SetSOPReflectance)  static 

Gets or sets the surface optical properties reflectance.

**Prerequisite**: The SOPType property must be 1.

**Value type**: Double (in percentage).  
**Range**: \[0.0, 100.0\].

The default value is 100.0 percent.





<a id="a247b53ec63e2053c4ea0b47face746ab" name="a247b53ec63e2053c4ea0b47face746ab"></a>## [◆ ](#a247b53ec63e2053c4ea0b47face746ab)SOPType

 str SOPType = property(fget=\_\_GetSOPType, fset=\_\_SetSOPType)  static 

Gets or sets the surface optical properties.

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

The values are:  
 1 - Mirror, uses a perfect specular surface and edits the Reflectance value if needed.  
 2 - Library, with this value the SOPLibraryFile property is available and must be defined.  
 3 - Plug-in, selects a custom made \*.sop plug-in as File and the Parameters file for the plug-in.

**Value type**: Integer.

The default value is 1.





<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="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 0.

**Value type**: Double (in Kelvin).  
**Range**: The value must be superior to 0.0.

The default value is 8000.0 Kelvin.





---

The documentation for this class was generated from the following file:- **SpeosNX\_2412.py**