## On this page

  

 

 # OpticalPropertiesBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for optical properties. [More...](#details)

Inheritance diagram for OpticalPropertiesBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_2025_r1_1/class_speos_n_x_1_1_optical_properties_builder.png)



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

str [Angle](#af01763c3636aab4e703c277727a878eb) = property(fget=\_\_GetAngle, fset=\_\_SetAngle) Gets or sets the meshing angle.   
 str [MeshingEdgeAngle](#ac0f10a91ffb7f32cfe39aac1377214cc) = property(fget=\_\_GetMeshingEdgeAngle, fset=\_\_SetMeshingEdgeAngle) Gets or sets the meshing angle.   
 str [MeshingEdgeSagValue](#aeab20508fadaa7baa3b778c65aef3e07) = property(fget=\_\_GetMeshingEdgeSagValue, fset=\_\_SetMeshingEdgeSagValue) Gets or sets the meshing edge sag value.   
 str [OpticalPropertiesGeometry](#a2a801e5c9c12affbef3ee78dbe9c6f7d) = property(fget=\_\_GetOpticalPropertiesGeometry) Gets optical properties geometry.   
 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 [SagMode](#afe1cceef96f5b68e10b5a0923fa9eefe) = property(fget=\_\_GetSagMode, fset=\_\_SetSagMode) Gets or sets the meshing sag mode.   
 str [SagValue](#a7aaa0ad6bc3314e20c888f5553db94cf) = property(fget=\_\_GetSagValue, fset=\_\_SetSagValue) Gets or sets the meshing sag value.   
 str [SpecificParametersFacetEdges](#a3876e96069f30c7e1013dcf03aa9e380) = property(fget=\_\_GetSpecificParametersFacetEdges, fset=\_\_SetSpecificParametersFacetEdges) Gets or sets the specific parameters property for facet edges.   
 str [StepMode](#a5ec0ea0c299693a2c10ece685df2ea1c) = property(fget=\_\_GetStepMode, fset=\_\_SetStepMode) Gets or sets the meshing step mode.   
 str [StepValue](#af04d19398734f60f323a09c86a3ac08b) = property(fget=\_\_GetStepValue, fset=\_\_SetStepValue) Gets or sets the meshing step value.   
 str [UseMeshingProperties](#a96b6757964d68c2f7693d89378e6eb65) = property(fget=\_\_GetUseMeshingProperties, fset=\_\_SetUseMeshingProperties) Gets or sets the meshing properties property.   
 str [UseOpticalProperties](#abc662ff17f7653357b2282a30d25c56b) = property(fget=\_\_GetUseOpticalProperties, fset=\_\_SetUseOpticalProperties) Gets or sets the optical properties property.   
 str [UseVOPConstringence](#ad5b44417f6a4551ec7d7a9fdb8b67e82) = property(fget=\_\_GetUseVOPConstringence, fset=\_\_SetUseVOPConstringence) Gets or sets the volume optical properties constringence property.   
 str [VOPAbsorption](#ab447b18ea4376d94b49f859f59d2fb16) = property(fget=\_\_GetVOPAbsorption, fset=\_\_SetVOPAbsorption) Gets or sets the volume optical properties absorption.   
 str [VOPConstringence](#a9b77fcce79f58d26da527a14580c4e46) = property(fget=\_\_GetVOPConstringence, fset=\_\_SetVOPConstringence) Gets or sets the volume optical properties constringence.   
 str [VOPIndex](#acc3c3c30c6364f14d4a78a649d92158c) = property(fget=\_\_GetVOPIndex, fset=\_\_SetVOPIndex) Gets or sets the volume optical properties index.   
 str [VOPLibraryFilePath](#af1dac5e2e4008f91d1e551891f403a71) = property(fget=\_\_GetVOPLibraryFilePath, fset=\_\_SetVOPLibraryFilePath) Gets or sets the volume optical properties library file.   
 ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x_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_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x_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_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) 'None' [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
  'None' **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 the builder for optical properties.

The optical properties builder is used to create and edit optical properties features.

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



## Member Data Documentation

<a id="af01763c3636aab4e703c277727a878eb" name="af01763c3636aab4e703c277727a878eb"></a>## [◆ ](#af01763c3636aab4e703c277727a878eb)Angle

 str Angle = property(fget=\_\_GetAngle, fset=\_\_SetAngle)  static 

Gets or sets the meshing angle.

**Prerequisite**: The IsMeshingProperties property must be True.

**Value type**: Double (in degrees).  
**Range**: (0.0, 90.0).

The default value is 15.0 degrees.





<a id="ac0f10a91ffb7f32cfe39aac1377214cc" name="ac0f10a91ffb7f32cfe39aac1377214cc"></a>## [◆ ](#ac0f10a91ffb7f32cfe39aac1377214cc)MeshingEdgeAngle

 str MeshingEdgeAngle = property(fget=\_\_GetMeshingEdgeAngle, fset=\_\_SetMeshingEdgeAngle)  static 

Gets or sets the meshing angle.

**Prerequisite**: The IsSpecificParametersFacetEdges property must be True.

Defines the maximum angular variation in degrees between successive tangents for all points along a solid edge.

**Value type**: Double (in degrees).  
**Range**: (0.0, 90.0).

The default value is 10.0 degrees.





<a id="aeab20508fadaa7baa3b778c65aef3e07" name="aeab20508fadaa7baa3b778c65aef3e07"></a>## [◆ ](#aeab20508fadaa7baa3b778c65aef3e07)MeshingEdgeSagValue

 str MeshingEdgeSagValue = property(fget=\_\_GetMeshingEdgeSagValue, fset=\_\_SetMeshingEdgeSagValue)  static 

Gets or sets the meshing edge sag value.

**Prerequisite**: The IsSpecificParametersFacetEdges property must be True.

Defines the maximum distance between the geometry and the meshing on the edges. The Meshing edge sag value always uses the Fixed mode.

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

The default value is 0.1 mm.





<a id="a2a801e5c9c12affbef3ee78dbe9c6f7d" name="a2a801e5c9c12affbef3ee78dbe9c6f7d"></a>## [◆ ](#a2a801e5c9c12affbef3ee78dbe9c6f7d)OpticalPropertiesGeometry

 str [OpticalPropertiesGeometry](class_speos_n_x_1_1_optical_properties_geometry.xhtml) = property(fget=\_\_GetOpticalPropertiesGeometry)  static 

Gets optical properties geometry.

**Value type**: OpticalPropertiesGeometry object.





<a id="afe1cceef96f5b68e10b5a0923fa9eefe" name="afe1cceef96f5b68e10b5a0923fa9eefe"></a>## [◆ ](#afe1cceef96f5b68e10b5a0923fa9eefe)SagMode

 str SagMode = property(fget=\_\_GetSagMode, fset=\_\_SetSagMode)  static 

Gets or sets the meshing sag mode.

**Prerequisite**: The IsMeshingProperties property must be True.

The values are:  
 0 - Proportional, the value adapts and adjusts to the size of each face of the object.  
 1 - Fixed, the value will remain unchanged no matter the size or shape of the object.

**Value type**: Integer.

The default value is 1.





<a id="a7aaa0ad6bc3314e20c888f5553db94cf" name="a7aaa0ad6bc3314e20c888f5553db94cf"></a>## [◆ ](#a7aaa0ad6bc3314e20c888f5553db94cf)SagValue

 str SagValue = property(fget=\_\_GetSagValue, fset=\_\_SetSagValue)  static 

Gets or sets the meshing sag value.

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

The default value is 0.5 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.  
**Range**: \[0.0, 100.0\].

The default value is 100.0.





<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 IsOpticalProperties property must be True.

The values are:  
 0 - Optical Polished, uses a transparent or perfectly polished material (glass, plastic).  
 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="a3876e96069f30c7e1013dcf03aa9e380" name="a3876e96069f30c7e1013dcf03aa9e380"></a>## [◆ ](#a3876e96069f30c7e1013dcf03aa9e380)SpecificParametersFacetEdges

 str SpecificParametersFacetEdges = property(fget=\_\_GetSpecificParametersFacetEdges, fset=\_\_SetSpecificParametersFacetEdges)  static 

Gets or sets the specific parameters property for facet edges.

**Prerequisite**: The IsMeshingProperties property must be True.

Allows you to control the precision of the meshing on the edges of the faces.

True: Enables specific parameters for facet edges.  
 False: Disables specific parameters for facet edges.

**Value type**: Boolean.

The default value is False.





<a id="a5ec0ea0c299693a2c10ece685df2ea1c" name="a5ec0ea0c299693a2c10ece685df2ea1c"></a>## [◆ ](#a5ec0ea0c299693a2c10ece685df2ea1c)StepMode

 str StepMode = property(fget=\_\_GetStepMode, fset=\_\_SetStepMode)  static 

Gets or sets the meshing step mode.

**Prerequisite**: The IsMeshingProperties property must be True.

The values are:  
 0 - Proportional, the value adapts and adjusts to the size of each face of the object.  
 1 - Fixed, the value will remain unchanged no matter the size or shape of the object.

**Value type**: Integer.

The default value is 1.





<a id="af04d19398734f60f323a09c86a3ac08b" name="af04d19398734f60f323a09c86a3ac08b"></a>## [◆ ](#af04d19398734f60f323a09c86a3ac08b)StepValue

 str StepValue = property(fget=\_\_GetStepValue, fset=\_\_SetStepValue)  static 

Gets or sets the meshing step value.

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

The default value is 1.0 mm.





<a id="a96b6757964d68c2f7693d89378e6eb65" name="a96b6757964d68c2f7693d89378e6eb65"></a>## [◆ ](#a96b6757964d68c2f7693d89378e6eb65)UseMeshingProperties

 str UseMeshingProperties = property(fget=\_\_GetUseMeshingProperties, fset=\_\_SetUseMeshingProperties)  static 

Gets or sets the meshing properties property.

True: Enables meshing properties.  
 False: Disables meshing properties.

**Value type**: Boolean.

The default value is False.





<a id="abc662ff17f7653357b2282a30d25c56b" name="abc662ff17f7653357b2282a30d25c56b"></a>## [◆ ](#abc662ff17f7653357b2282a30d25c56b)UseOpticalProperties

 str UseOpticalProperties = property(fget=\_\_GetUseOpticalProperties, fset=\_\_SetUseOpticalProperties)  static 

Gets or sets the optical properties property.

True: Enables optical properties.  
 False: Disables optical properties.

**Value type**: Boolean.

The default value is True.





<a id="ad5b44417f6a4551ec7d7a9fdb8b67e82" name="ad5b44417f6a4551ec7d7a9fdb8b67e82"></a>## [◆ ](#ad5b44417f6a4551ec7d7a9fdb8b67e82)UseVOPConstringence

 str UseVOPConstringence = property(fget=\_\_GetUseVOPConstringence, fset=\_\_SetUseVOPConstringence)  static 

Gets or sets the volume optical properties constringence property.

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

True: Enables constringence.  
 False: Disables constringence.

**Value type**: Boolean.

The default value is False.





<a id="ab447b18ea4376d94b49f859f59d2fb16" name="ab447b18ea4376d94b49f859f59d2fb16"></a>## [◆ ](#ab447b18ea4376d94b49f859f59d2fb16)VOPAbsorption

 str VOPAbsorption = property(fget=\_\_GetVOPAbsorption, fset=\_\_SetVOPAbsorption)  static 

Gets or sets the volume optical properties absorption.

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

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

The default value is 0.0.





<a id="a9b77fcce79f58d26da527a14580c4e46" name="a9b77fcce79f58d26da527a14580c4e46"></a>## [◆ ](#a9b77fcce79f58d26da527a14580c4e46)VOPConstringence

 str VOPConstringence = property(fget=\_\_GetVOPConstringence, fset=\_\_SetVOPConstringence)  static 

Gets or sets the volume optical properties constringence.

**Prerequisite**: The IsVOPConstringence property must be True.

**Value type**: Double.  
**Range**: The value must be superior or equal to 20.0.

The default value is 60.0





<a id="acc3c3c30c6364f14d4a78a649d92158c" name="acc3c3c30c6364f14d4a78a649d92158c"></a>## [◆ ](#acc3c3c30c6364f14d4a78a649d92158c)VOPIndex

 str VOPIndex = property(fget=\_\_GetVOPIndex, fset=\_\_SetVOPIndex)  static 

Gets or sets the volume optical properties index.

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

**Value type**: Double.  
**Range**: The value must be superior or equal to 1.

The default value is 1.5.





<a id="af1dac5e2e4008f91d1e551891f403a71" name="af1dac5e2e4008f91d1e551891f403a71"></a>## [◆ ](#af1dac5e2e4008f91d1e551891f403a71)VOPLibraryFilePath

 str VOPLibraryFilePath = property(fget=\_\_GetVOPLibraryFilePath, fset=\_\_SetVOPLibraryFilePath)  static 

Gets or sets the volume optical properties library file.

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

**value type**: String.

The default value is an empty string.





---

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