ComponentLightBoxExportBuilder Class Reference
Last update: 17.07.2025
Public Member Functions | |
| 'None' | RemoveSources (self, sources) |
| Deletes sources from the simulation. | |
| 'None' | RemoveGeometries (self, tags) |
| Deletes geometries from the component. | |
| 'None' | ReverseFastTransmissionGatheringValues (self, tags) |
| Reverses the fast transmission gathering value for the selected geometries. | |
| 'None' | GeneratePassword (self) |
| Generates a new password. | |
 Public Member Functions inherited from FeatureBuilder | |
| 'None' | Commit (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. | |
Static Public Attributes | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the axis system. | |
| str | BlackBox = property(fget=__GetBlackBox, fset=__SetBlackBox) |
| Gets or sets the property to enable BlackBox. | |
| str | CustomAxisSystem = property(fget=__GetCustomAxisSystem, fset=__SetCustomAxisSystem) |
| Gets or sets the property to enable custom axis system. | |
| str | EnablePassword = property(fget=__GetEnablePassword, fset=__SetEnablePassword) |
| Gets or sets the property to enable password. | |
| str | FastTransmissionGatheringValues = property(fget=__GetFastTransmissionGatheringValues) |
| Returns the fast transmission gathering values for all geometries. | |
| str | Geometries = property(fget=__GetGeometries, fset=__SetGeometries) |
| Gets geometries tag. | |
| str | MeshingAngle = property(fget=__GetMeshingAngle, fset=__SetMeshingAngle) |
| Gets or sets the meshing angle. | |
| str | MeshingEdgeAngle = property(fget=__GetMeshingEdgeAngle, fset=__SetMeshingEdgeAngle) |
| Gets or sets the meshing edge angle. | |
| str | MeshingEdgeSag = property(fget=__GetMeshingEdgeSag, fset=__SetMeshingEdgeSag) |
| Gets or sets the meshing edge sag value. | |
| str | MeshingSagMode = property(fget=__GetMeshingSagMode, fset=__SetMeshingSagMode) |
| Gets or sets the meshing sag mode. | |
| str | MeshingSagValue = property(fget=__GetMeshingSagValue, fset=__SetMeshingSagValue) |
| Gets or sets the meshing sag value. | |
| str | MeshingStepMode = property(fget=__GetMeshingStepMode, fset=__SetMeshingStepMode) |
| Gets or sets the meshing step mode. | |
| str | MeshingStepValue = property(fget=__GetMeshingStepValue, fset=__SetMeshingStepValue) |
| Gets or sets the meshing step fixed value. | |
| str | Password = property(fget=__GetPassword, fset=__SetPassword) |
| Gets or set the password. | |
| str | Sources = property(fget=__GetSources, fset=__SetSources) |
| Gets source features. | |
| str | SpecificFacetEdgesParameters = property(fget=__GetSpecificFacetEdgesParameters, fset=__SetSpecificFacetEdgesParameters) |
| Gets or sets the specific parameters property for facet edges. | |
| Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
Member Function Documentation
◆ GeneratePassword()
| 'None' GeneratePassword | ( | self | ) |
Generates a new password.
Prerequisite The EnablePassword property must be True.
- Returns
- Void.
◆ RemoveGeometries()
| 'None' RemoveGeometries | ( | self, | |
| tags ) |
Deletes geometries from the component.
The DeleteGeometries function takes a list of geometry tag as parameter.
- Parameters
-
[in] tags : List of integer.
- Returns
- void.
◆ RemoveSources()
| 'None' RemoveSources | ( | self, | |
| sources ) |
Deletes sources from the simulation.
- Parameters
-
[in] sources : List of Feature object
- Returns
- void.
◆ ReverseFastTransmissionGatheringValues()
| 'None' ReverseFastTransmissionGatheringValues | ( | self, | |
| tags ) |
Reverses the fast transmission gathering value for the selected geometries.
The ReverseFastTransmissionGatheringValues function takes a list of geometry tag as parameter.
- Parameters
-
[in] tags : List of integer.
The default fast transmission gathering value is False.
- Returns
- void.
Member Data Documentation
◆ AxisSystem
|
static |
Gets the axis system.
Prerequisite The CustomAxisSystem property must be True.
Value type: AxisSystem object.
◆ BlackBox
|
static |
Gets or sets the property to enable BlackBox.
True: Enables BlackBox.
False: Disables BlackBox.
Value type: Boolean.
The default value is False.
◆ CustomAxisSystem
|
static |
Gets or sets the property to enable custom axis system.
True: Enables custom axis system.
False: Disables custom axis system.
Value type: Boolean.
The default value is False.
◆ EnablePassword
|
static |
Gets or sets the property to enable password.
True: Enables password.
False: Disables password.
Value type: Boolean.
The default value is False.
◆ FastTransmissionGatheringValues
|
static |
Returns the fast transmission gathering values for all geometries.
The GetFastTransmissionGatheringValues property returns a list of feature tag.
- Returns
- List of integer.
◆ Geometries
|
static |
Gets geometries tag.
The Geometries property returns a list of feature tag.
- Returns
- List of integer.
◆ MeshingAngle
|
static |
Gets or sets the meshing angle.
Value type: Double (in degrees).
Range: (0.0, 90.0).
The default value is 15.0 degrees.
◆ MeshingEdgeAngle
|
static |
Gets or sets the meshing edge angle.
Prerequisite The SpecificFacetEdgesParameters 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.
◆ MeshingEdgeSag
|
static |
Gets or sets the meshing edge sag value.
Prerequisite The SpecificFacetEdgesParameters 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.
◆ MeshingSagMode
|
static |
Gets or sets the meshing sag mode.
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 0.
◆ MeshingSagValue
|
static |
Gets or sets the meshing sag value.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 0.5 mm.
◆ MeshingStepMode
|
static |
Gets or sets the meshing step mode.
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 0.
◆ MeshingStepValue
|
static |
Gets or sets the meshing step fixed value.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 1.0 mm.
◆ Password
|
static |
Gets or set the password.
Prerequisite The EnablePassword property must be True.
Value type: String.
The default value is an empty string.
◆ Sources
|
static |
Gets source features.
Gets the current source features that are in the component.
Value type: List of Feature object.
◆ SpecificFacetEdgesParameters
|
static |
Gets or sets the specific parameters property for facet edges.
Allows 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.
The documentation for this class was generated from the following file:
- SpeosNX.py
