OpticalPropertiesBuilder Class Reference
Last update: 17.07.2025Represents the builder for optical properties. More...
Properties | |
| Angle = property(fget = __GetAngle, fset = __SetAngle) | |
| Gets or sets the meshing angle. | |
| MeshingEdgeAngle = property(fget = __GetMeshingEdgeAngle, fset = __SetMeshingEdgeAngle) | |
| Gets or sets the meshing angle. | |
| MeshingEdgeSagValue = property(fget = __GetMeshingEdgeSagValue, fset = __SetMeshingEdgeSagValue) | |
| Gets or sets the meshing edge sag value. | |
| OpticalPropertiesGeometry = property(fget = __GetOpticalPropertiesGeometry) | |
| Gets optical properties geometry. | |
| SOPLibraryFilePath = property(fget = __GetSOPLibraryFilePath, fset = __SetSOPLibraryFilePath) | |
| Gets or sets the surface optical properties library file. | |
| SOPParametersFilePath = property(fget = __GetSOPParametersFilePath, fset = __SetSOPParametersFilePath) | |
| Gets or sets the surface optical properties parameters file. | |
| SOPPluginFilePath = property(fget = __GetSOPPluginFilePath, fset = __SetSOPPluginFilePath) | |
| Gets or sets the surface optical properties plug-in file. | |
| SOPReflectance = property(fget = __GetSOPReflectance, fset = __SetSOPReflectance) | |
| Gets or sets the surface optical properties reflectance. | |
| SOPType = property(fget = __GetSOPType, fset = __SetSOPType) | |
| Gets or sets the surface optical properties. | |
| SagMode = property(fget = __GetSagMode, fset = __SetSagMode) | |
| Gets or sets the meshing sag mode. | |
| SagValue = property(fget = __GetSagValue, fset = __SetSagValue) | |
| Gets or sets the meshing sag value. | |
| SpecificParametersFacetEdges = property(fget = __GetSpecificParametersFacetEdges, fset = __SetSpecificParametersFacetEdges) | |
| Gets or sets the specific parameters property for facet edges. | |
| StepMode = property(fget = __GetStepMode, fset = __SetStepMode) | |
| Gets or sets the meshing step mode. | |
| StepValue = property(fget = __GetStepValue, fset = __SetStepValue) | |
| Gets or sets the meshing step value. | |
| UseMeshingProperties = property(fget = __GetUseMeshingProperties, fset = __SetUseMeshingProperties) | |
| Gets or sets the meshing properties property. | |
| UseOpticalProperties = property(fget = __GetUseOpticalProperties, fset = __SetUseOpticalProperties) | |
| Gets or sets the optical properties property. | |
| UseVOPConstringence = property(fget = __GetUseVOPConstringence, fset = __SetUseVOPConstringence) | |
| Gets or sets the volume optical properties constringence property. | |
| VOPAbsorption = property(fget = __GetVOPAbsorption, fset = __SetVOPAbsorption) | |
| Gets or sets the volume optical properties absorption. | |
| VOPConstringence = property(fget = __GetVOPConstringence, fset = __SetVOPConstringence) | |
| Gets or sets the volume optical properties constringence. | |
| VOPIndex = property(fget = __GetVOPIndex, fset = __SetVOPIndex) | |
| Gets or sets the volume optical properties index. | |
| VOPLibraryFilePath = property(fget = __GetVOPLibraryFilePath, fset = __SetVOPLibraryFilePath) | |
| Gets or sets the volume optical properties library file. | |
| VOPType = property(fget = __GetVOPType, fset = __SetVOPType) | |
| Gets or sets the volume optical properties type. | |
 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 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 FeatureCollection::CreateOpticalPropertiesBuilder
Property Documentation
◆ Angle
|
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.
◆ MeshingEdgeAngle
|
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.
◆ MeshingEdgeSagValue
|
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.
◆ OpticalPropertiesGeometry
|
static |
Gets optical properties geometry.
Value type: OpticalPropertiesGeometry object.
◆ SagMode
|
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.
◆ SagValue
|
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.
◆ SOPLibraryFilePath
|
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.
◆ SOPParametersFilePath
|
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.
◆ SOPPluginFilePath
|
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.
◆ SOPReflectance
|
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.
◆ SOPType
|
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.
◆ SpecificParametersFacetEdges
|
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.
◆ StepMode
|
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.
◆ StepValue
|
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.
◆ UseMeshingProperties
|
static |
Gets or sets the meshing properties property.
True: Enables meshing properties.
False: Disables meshing properties.
Value type: Boolean.
The default value is False.
◆ UseOpticalProperties
|
static |
Gets or sets the optical properties property.
True: Enables optical properties.
False: Disables optical properties.
Value type: Boolean.
The default value is True.
◆ UseVOPConstringence
|
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.
◆ VOPAbsorption
|
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.
◆ VOPConstringence
|
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
◆ VOPIndex
|
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.
◆ VOPLibraryFilePath
|
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.
◆ VOPType
|
static |
Gets or sets the volume optical properties type.
Prerequisite: The IsOpticalProperties property must be True.
The values are:
0 - Optic, uses transparent colorless part without bulk scattering.
1 - Opaque (Solid Body), uses non transparent part.
2 - Library, with this value the VOPLibraryFile property is available and must be defined.
3 - None, does not apply a volume optical properties on surface in case you have a surface geometry.
Value type: Integer.
The default value is 1.
The documentation for this class was generated from the following file:
- SpeosNX.py
