## On this page

  

 

 # SpeosPatternBuilder Class Reference

 Last update: 16.07.2025 

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

Inheritance diagram for SpeosPatternBuilder:

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



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

str [NumberOfRay](#a1811cd5b1ac3b0bd6e780bce2adfe042) = property(fget=\_\_GetNumberOfRay, fset=\_\_SetNumberOfRay) Gets or sets the number of rays.   
 str [OneLayerPerInstance](#ab24ca1c352bf77ba8740d79858d6fa2c) = property(fget=\_\_GetOneLayerPerInstance, fset=\_\_SetOneLayerPerInstance) Gets or sets the property to enable/disable one layer per instance.   
 str [OneLayerPerSource](#ae7aa6dd8b1bfaff2908ed9f25783c946) = property(fget=\_\_GetOneLayerPerSource, fset=\_\_SetOneLayerPerSource) Gets or sets the property to enable/disable one layer per source.   
 str [Origins](#a4b072293f37e4db7570153b2d65b496f) = property(fget=\_\_GetOrigins, fset=\_\_SetOrigins) Gets or sets the origin coordinate systems.   
 str [PatternFilePassword](#a9a0ed1de41cc0ad2f9eaecb650c351b7) = property(fset=\_\_SetPatternFilePassword) Sets the pattern file password.   
 str [PatternFilePath](#a381b9f9b8adf1001987c9017e0e6047e) = property(fget=\_\_GetPatternFilePath, fset=\_\_SetPatternFilePath) Gets or sets the property pattern file path.   
 str [PreviewMode](#af000d33c17bc2049aded27ce88b25ec9) = property(fget=\_\_GetPreviewMode, fset=\_\_SetPreviewMode) Gets or sets the preview mode.   
 str [RayFileData](#a3e7228c07824410503a15c4370c1c00b) = property(fget=\_\_GetRayFileData) Returns the ray file data object.   
 str [RayFileFlux](#aca19f0643dca83d85a2956a24f8878b1) = property(fget=\_\_GetRayFileFlux, fset=\_\_SetRayFileFlux) Gets or sets the flux of the ray file source.   
 str [RayFileFluxFromFile](#a3b1e2cd013f1de188a3be2d6680321e4) = property(fget=\_\_GetRayFileFluxFromFile, fset=\_\_SetRayFileFluxFromFile) Gets or sets the property to enable fetching the flux from file.   
 str [RayFileFluxUnit](#ad971475f4158e2892d3270726b0cecf9) = property(fget=\_\_GetRayFileFluxUnit, fset=\_\_SetRayFileFluxUnit) Gets or sets the flux unit of the ray file source.   
 str [RayFileSpectrumType](#a64adac973675b19e2654171dfa67c719) = property(fget=\_\_GetRayFileSpectrumType, fset=\_\_SetRayFileSpectrumType) Gets or sets the spectrum type.   
 str [RayFileTemperature](#ade7cb3a85114414096c67f36ed5720b1) = property(fget=\_\_GetRayFileTemperature, fset=\_\_SetRayFileTemperature) Gets or sets the temperature.   
 str [RayFileWavelength](#a605593aa31e6ab2d228cc0bc31a91e06) = property(fget=\_\_GetRayFileWavelength, fset=\_\_SetRayFileWavelength) Gets or sets the wavelength.   
 str [RayLength](#a24786b401f788b91236f7c5238005822) = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength) Gets or sets the ray length.   
 str [SpectrumFilePath](#a92b012ddaebe46fb4504668c118ac6ab) = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath) Gets or sets the spectrum file path.   
 ![-](/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 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>



## Member Data Documentation

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

 str 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="ab24ca1c352bf77ba8740d79858d6fa2c" name="ab24ca1c352bf77ba8740d79858d6fa2c"></a>## [◆ ](#ab24ca1c352bf77ba8740d79858d6fa2c)OneLayerPerInstance

 str 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="ae7aa6dd8b1bfaff2908ed9f25783c946" name="ae7aa6dd8b1bfaff2908ed9f25783c946"></a>## [◆ ](#ae7aa6dd8b1bfaff2908ed9f25783c946)OneLayerPerSource

 str 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="a4b072293f37e4db7570153b2d65b496f" name="a4b072293f37e4db7570153b2d65b496f"></a>## [◆ ](#a4b072293f37e4db7570153b2d65b496f)Origins

 str 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="a9a0ed1de41cc0ad2f9eaecb650c351b7" name="a9a0ed1de41cc0ad2f9eaecb650c351b7"></a>## [◆ ](#a9a0ed1de41cc0ad2f9eaecb650c351b7)PatternFilePassword

 str PatternFilePassword = property(fset=\_\_SetPatternFilePassword)  static 

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

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

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

 str 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="a3b1e2cd013f1de188a3be2d6680321e4" name="a3b1e2cd013f1de188a3be2d6680321e4"></a>## [◆ ](#a3b1e2cd013f1de188a3be2d6680321e4)RayFileFluxFromFile

 str 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="ad971475f4158e2892d3270726b0cecf9" name="ad971475f4158e2892d3270726b0cecf9"></a>## [◆ ](#ad971475f4158e2892d3270726b0cecf9)RayFileFluxUnit

 str 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="a64adac973675b19e2654171dfa67c719" name="a64adac973675b19e2654171dfa67c719"></a>## [◆ ](#a64adac973675b19e2654171dfa67c719)RayFileSpectrumType

 str 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="ade7cb3a85114414096c67f36ed5720b1" name="ade7cb3a85114414096c67f36ed5720b1"></a>## [◆ ](#ade7cb3a85114414096c67f36ed5720b1)RayFileTemperature

 str 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="a605593aa31e6ab2d228cc0bc31a91e06" name="a605593aa31e6ab2d228cc0bc31a91e06"></a>## [◆ ](#a605593aa31e6ab2d228cc0bc31a91e06)RayFileWavelength

 str 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="a24786b401f788b91236f7c5238005822" name="a24786b401f788b91236f7c5238005822"></a>## [◆ ](#a24786b401f788b91236f7c5238005822)RayLength

 str 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="a92b012ddaebe46fb4504668c118ac6ab" name="a92b012ddaebe46fb4504668c118ac6ab"></a>## [◆ ](#a92b012ddaebe46fb4504668c118ac6ab)SpectrumFilePath

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

Gets or sets 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\_2412.py**