SpeosPatternBuilder Class Reference
Last update: 17.07.2025Represents a Speos pattern builder. More...
Properties | |
| NumberOfRay = property(fget = __GetNumberOfRay, fset = __SetNumberOfRay) | |
| Gets or sets the number of rays. | |
| OneLayerPerInstance = property(fget = __GetOneLayerPerInstance, fset = __SetOneLayerPerInstance) | |
| Gets or sets the property to enable/disable one layer per instance. | |
| OneLayerPerSource = property(fget = __GetOneLayerPerSource, fset = __SetOneLayerPerSource) | |
| Gets or sets the property to enable/disable one layer per source. | |
| Origins = property(fget = __GetOrigins, fset = __SetOrigins) | |
| Gets or sets the origin coordinate systems. | |
| PatternFilePassword = property(fget = __GetPatternFilePassword, fset = __SetPatternFilePassword) | |
| Gets or sets the pattern file password. | |
| PatternFilePath = property(fget = __GetPatternFilePath, fset = __SetPatternFilePath) | |
| Gets or sets the property pattern file path. | |
| PreviewMode = property(fget = __GetPreviewMode, fset = __SetPreviewMode) | |
| Gets or sets the preview mode. | |
| RayFileData = property(fget = __GetRayFileData) | |
| Returns the ray file data object. | |
| RayFileFlux = property(fget = __GetRayFileFlux, fset = __SetRayFileFlux) | |
| Gets or sets the flux of the ray file source. | |
| RayFileFluxFromFile = property(fget = __GetRayFileFluxFromFile, fset = __SetRayFileFluxFromFile) | |
| Gets or sets the property to enable fetching the flux from file. | |
| RayFileFluxUnit = property(fget = __GetRayFileFluxUnit, fset = __SetRayFileFluxUnit) | |
| Gets or sets the flux unit of the ray file source. | |
| RayFileSpectrumType = property(fget = __GetRayFileSpectrumType, fset = __SetRayFileSpectrumType) | |
| Gets or sets the spectrum type. | |
| RayFileTemperature = property(fget = __GetRayFileTemperature, fset = __SetRayFileTemperature) | |
| Gets or sets the temperature. | |
| RayFileWavelength = property(fget = __GetRayFileWavelength, fset = __SetRayFileWavelength) | |
| Gets or sets the wavelength. | |
| RayLength = property(fget = __GetRayLength, fset = __SetRayLength) | |
| Gets or sets the ray length. | |
| SpectrumFilePath = property(fget = __GetSpectrumFilePath, fset = __SetSpectrumFilePath) | |
| Gets or set the spectrum file path. | |
 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 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 FeatureCollection::CreateSpeosPatternBuilder
Property Documentation
◆ NumberOfRay
|
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.
◆ OneLayerPerInstance
|
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.
◆ OneLayerPerSource
|
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.
◆ Origins
|
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.
◆ PatternFilePassword
|
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.
◆ PatternFilePath
|
static |
Gets or sets the property pattern file path.
Value type: String.
The default value is an empty file path (string).
◆ PreviewMode
|
static |
Gets or sets the preview mode.
The values are:
0 - Meshing.
1 - BoundingBox.
Value type: Integer.
The default value is Meshing (0).
◆ RayFileData
|
static |
Returns the ray file data object.
Value type: CRayFileData.
This object allows to read data from a ray file.
◆ RayFileFlux
|
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.
◆ RayFileFluxFromFile
|
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.
◆ RayFileFluxUnit
|
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.
◆ RayFileSpectrumType
|
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.
◆ RayFileTemperature
|
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.
◆ RayFileWavelength
|
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.
◆ RayLength
|
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.
◆ SpectrumFilePath
|
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
