## On this page

  

 

 # SpeosPatternBuilder Class Reference

 Last update: 17.07.2025 

Represents a Speos pattern builder. [More...](#details)

Inheritance diagram for SpeosPatternBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_speos_pattern_builder.png)



## <a id="properties" name="properties"></a>Properties

 [NumberOfRay](#a451c243568b9c7aa0d2ec3b91b6e6681) = property(fget = \_\_GetNumberOfRay, fset = \_\_SetNumberOfRay) Gets or sets the number of rays.   
  [OneLayerPerInstance](#a99743376d4b0701f5b36a90eabc3a75f) = property(fget = \_\_GetOneLayerPerInstance, fset = \_\_SetOneLayerPerInstance) Gets or sets the property to enable/disable one layer per instance.   
  [OneLayerPerSource](#ac089f6f69a2d9628de4fe6f24c282449) = property(fget = \_\_GetOneLayerPerSource, fset = \_\_SetOneLayerPerSource) Gets or sets the property to enable/disable one layer per source.   
  [Origins](#ab3f29e6ff66d23cd0f68feaa2fe0c6cc) = property(fget = \_\_GetOrigins, fset = \_\_SetOrigins) Gets or sets the origin coordinate systems.   
  [PatternFilePassword](#a4424ebed4a779048c360c954208ec558) = property(fget = \_\_GetPatternFilePassword, fset = \_\_SetPatternFilePassword) Gets or sets the pattern file password.   
  [PatternFilePath](#ae8395e9ee2d44b39edceb12b1af88ace) = property(fget = \_\_GetPatternFilePath, fset = \_\_SetPatternFilePath) Gets or sets the property pattern file path.   
  [PreviewMode](#a6bc49932dce7e43d1b630ab8395e5c53) = property(fget = \_\_GetPreviewMode, fset = \_\_SetPreviewMode) Gets or sets the preview mode.   
  [RayFileData](#adb7a34add84aefc85395a71273ac9308) = property(fget = \_\_GetRayFileData) Returns the ray file data object.   
  [RayFileFlux](#a19388654fad9dbf9e77155a79c10e52e) = property(fget = \_\_GetRayFileFlux, fset = \_\_SetRayFileFlux) Gets or sets the flux of the ray file source.   
  [RayFileFluxFromFile](#a1ab2c1ed9a5234fe7a16364d2454dcea) = property(fget = \_\_GetRayFileFluxFromFile, fset = \_\_SetRayFileFluxFromFile) Gets or sets the property to enable fetching the flux from file.   
  [RayFileFluxUnit](#a2f1cee76b51d01f821f9dba87f1cb19e) = property(fget = \_\_GetRayFileFluxUnit, fset = \_\_SetRayFileFluxUnit) Gets or sets the flux unit of the ray file source.   
  [RayFileSpectrumType](#aa8df6d7451bb89da8818ce69b4d7f5ab) = property(fget = \_\_GetRayFileSpectrumType, fset = \_\_SetRayFileSpectrumType) Gets or sets the spectrum type.   
  [RayFileTemperature](#a452d58fcfc4dec50b2a84ec861c51ca1) = property(fget = \_\_GetRayFileTemperature, fset = \_\_SetRayFileTemperature) Gets or sets the temperature.   
  [RayFileWavelength](#a267e367dde69d09779a71e2156e76103) = property(fget = \_\_GetRayFileWavelength, fset = \_\_SetRayFileWavelength) Gets or sets the wavelength.   
  [RayLength](#ac34ed0a90a26560cbc5671f5f0243421) = property(fget = \_\_GetRayLength, fset = \_\_SetRayLength) Gets or sets the ray length.   
  [SpectrumFilePath](#a1cca2d58b30206743ddcb68d2a673380) = property(fget = \_\_GetSpectrumFilePath, fset = \_\_SetSpectrumFilePath) Gets or set the spectrum file path.   
 ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Feature](class_speos_n_x_1_1_feature_builder.xhtml#a94ea57aab7fe0356cbfbd048b1ad971e) = property(fget = \_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
  [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a0b7259da2de11c688aa435d1f0509134) = property(fget = \_\_GetFullName) Gets the full name of the feature being edited.   
  [Name](class_speos_n_x_1_1_feature_builder.xhtml#aa5998168cabfb2b2e41151349077812c) = property(fget = \_\_GetName, fset = \_\_SetName) Gets or sets the name of the feature being edited.   
  [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a99e8764720550e4ed0eba629a625b2e3) = property(fget = \_\_GetNameWithContext) Gets the name with context of the feature being edited.   
  [Status](class_speos_n_x_1_1_feature_builder.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b) = property(fget = \_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a2b74e1b440341a82332053432b52b42c) (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.   
 <a id="details" name="details"></a>## Detailed Description

Represents a Speos pattern builder.

The Speos pattern builder is used to create and edit Speos pattern features.

To create a new instance of this class, use <a class="el" href="">FeatureCollection::CreateSpeosPatternBuilder</a>



## Property Documentation

<a id="a451c243568b9c7aa0d2ec3b91b6e6681" name="a451c243568b9c7aa0d2ec3b91b6e6681"></a>## [◆ ](#a451c243568b9c7aa0d2ec3b91b6e6681)NumberOfRay

 NumberOfRay = property(fget = \_\_GetNumberOfRay, fset = \_\_SetNumberOfRay)  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="a99743376d4b0701f5b36a90eabc3a75f" name="a99743376d4b0701f5b36a90eabc3a75f"></a>## [◆ ](#a99743376d4b0701f5b36a90eabc3a75f)OneLayerPerInstance

 OneLayerPerInstance = property(fget = \_\_GetOneLayerPerInstance, fset = \_\_SetOneLayerPerInstance)  static 

Gets or sets the property to enable/disable one layer per instance.

True: Enables one layer per instance.  
 False: Disables one layer per instance.

**Prerequisite**: The Pattern file must be a Lightbox file.

**Value type**: Boolean.

The default value is True.





<a id="ac089f6f69a2d9628de4fe6f24c282449" name="ac089f6f69a2d9628de4fe6f24c282449"></a>## [◆ ](#ac089f6f69a2d9628de4fe6f24c282449)OneLayerPerSource

 OneLayerPerSource = property(fget = \_\_GetOneLayerPerSource, fset = \_\_SetOneLayerPerSource)  static 

Gets or sets the property to enable/disable one layer per source.

True: Enables one layer per source.  
 False: Disables one layer per source.

**Value type**: Boolean.

The default value is False.





<a id="ab3f29e6ff66d23cd0f68feaa2fe0c6cc" name="ab3f29e6ff66d23cd0f68feaa2fe0c6cc"></a>## [◆ ](#ab3f29e6ff66d23cd0f68feaa2fe0c6cc)Origins

 Origins = property(fget = \_\_GetOrigins, fset = \_\_SetOrigins)  static 

Gets or sets the origin coordinate systems.

This property takes/returns a list of NX Datum System feature tags.

**Value type**: List of integer (NX Tags).

The default value is an empty list.





<a id="a4424ebed4a779048c360c954208ec558" name="a4424ebed4a779048c360c954208ec558"></a>## [◆ ](#a4424ebed4a779048c360c954208ec558)PatternFilePassword

 PatternFilePassword = property(fget = \_\_GetPatternFilePassword, fset = \_\_SetPatternFilePassword)  static 

Gets or sets the pattern file password.

**Prerequisite**: The Pattern file must be a Lightbox file.

**Value type**: String.

The default value is an empty string.





<a id="ae8395e9ee2d44b39edceb12b1af88ace" name="ae8395e9ee2d44b39edceb12b1af88ace"></a>## [◆ ](#ae8395e9ee2d44b39edceb12b1af88ace)PatternFilePath

 PatternFilePath = property(fget = \_\_GetPatternFilePath, fset = \_\_SetPatternFilePath)  static 

Gets or sets the property pattern file path.

**Value type**: String.

The default value is an empty file path (string).





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

 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="adb7a34add84aefc85395a71273ac9308" name="adb7a34add84aefc85395a71273ac9308"></a>## [◆ ](#adb7a34add84aefc85395a71273ac9308)RayFileData

 [RayFileData](class_speos_n_x_1_1_ray_file_data.xhtml) = property(fget = \_\_GetRayFileData)  static 

Returns the ray file data object.

**Value type**: CRayFileData.  
 This object allows to read data from a ray file.





<a id="a19388654fad9dbf9e77155a79c10e52e" name="a19388654fad9dbf9e77155a79c10e52e"></a>## [◆ ](#a19388654fad9dbf9e77155a79c10e52e)RayFileFlux

 RayFileFlux = property(fget = \_\_GetRayFileFlux, fset = \_\_SetRayFileFlux)  static 

Gets or sets the flux of the ray file source.

**Prerequisite**: The Pattern file must be a ray file.

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

By default the value comes from the ray file, otherwise value is 683. lumen.





<a id="a1ab2c1ed9a5234fe7a16364d2454dcea" name="a1ab2c1ed9a5234fe7a16364d2454dcea"></a>## [◆ ](#a1ab2c1ed9a5234fe7a16364d2454dcea)RayFileFluxFromFile

 RayFileFluxFromFile = property(fget = \_\_GetRayFileFluxFromFile, fset = \_\_SetRayFileFluxFromFile)  static 

Gets or sets the property to enable fetching the flux from file.

True: Enables fetching the flux from file.  
 False: Disables fetching the flux from file.

**Value type**: Boolean.

The default value is True.





<a id="a2f1cee76b51d01f821f9dba87f1cb19e" name="a2f1cee76b51d01f821f9dba87f1cb19e"></a>## [◆ ](#a2f1cee76b51d01f821f9dba87f1cb19e)RayFileFluxUnit

 RayFileFluxUnit = property(fget = \_\_GetRayFileFluxUnit, fset = \_\_SetRayFileFluxUnit)  static 

Gets or sets the flux unit of the ray file source.

**Prerequisite**: The Pattern file must be a ray file.  
 The values are:  
 0 - lumen (lm).  
 1 - watt (W).

**Value type**: Integer.

The default value is 0.





<a id="aa8df6d7451bb89da8818ce69b4d7f5ab" name="aa8df6d7451bb89da8818ce69b4d7f5ab"></a>## [◆ ](#aa8df6d7451bb89da8818ce69b4d7f5ab)RayFileSpectrumType

 RayFileSpectrumType = property(fget = \_\_GetRayFileSpectrumType, fset = \_\_SetRayFileSpectrumType)  static 

Gets or sets the spectrum type.

The values are:  
 0 - Monochromatic, with this value the wavelength property is available.  
 1 - Blackbody, with this value the temperature property is available.  
 2 - Library, with this value the spectrum file property is available.

**Value type**: Integer.

The default value is 0.





<a id="a452d58fcfc4dec50b2a84ec861c51ca1" name="a452d58fcfc4dec50b2a84ec861c51ca1"></a>## [◆ ](#a452d58fcfc4dec50b2a84ec861c51ca1)RayFileTemperature

 RayFileTemperature = property(fget = \_\_GetRayFileTemperature, fset = \_\_SetRayFileTemperature)  static 

Gets or sets the temperature.

**Prerequisite**: The SpectrumType must be 0.

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

The default value is 2856.0 K.





<a id="a267e367dde69d09779a71e2156e76103" name="a267e367dde69d09779a71e2156e76103"></a>## [◆ ](#a267e367dde69d09779a71e2156e76103)RayFileWavelength

 RayFileWavelength = property(fget = \_\_GetRayFileWavelength, fset = \_\_SetRayFileWavelength)  static 

Gets or sets the wavelength.

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

The default value is 555.0 nm.





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

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

Gets or sets the ray length.

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

The default value is 75.0 mm.





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

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

Gets or set the spectrum file path.

**Prerequisite**: The SpectrumType must be 1.

**Value type**: String.

The default value is an empty string.





---

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