CalculateAreaBuilder Class¶
-
class
NXOpen.Tooling.CalculateAreaBuilder¶ Bases:
NXOpen.BuilderThe CalculateArea builder
To create a new instance of this class, use
NXOpen.Tooling.CalculateAreaCollection.CreateBuilder()Default values.
Property Value AngularAccuracy.Value 1.0 DimTolerance.Value 0.01 (millimeters part), 0.001 (inches part) ToggleSideArea 0 New in version NX7.0.0.
Properties¶
| Property | Description |
|---|---|
| AngularAccuracy | Returns the angular accuracy used as the minimum angle between two reference planes. |
| DimTolerance | Returns the dim tolerance used as the area calculation tolerance. |
| PlaneDefine | Returns or sets the plane defined as the reference plane to calculate area, the type could be planar face, datum plane and plane. |
| SelectionTarget | Returns the target body to calculate area. |
| Tag | Returns the Tag for this object. |
| ToggleSideArea | Returns or sets the toggle side area to indicate calculate side area or not. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AngularAccuracy¶
-
CalculateAreaBuilder.AngularAccuracy¶ Returns the angular accuracy used as the minimum angle between two reference planes.
-------------------------------------Getter Method
Signature
AngularAccuracy()Returns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
DimTolerance¶
-
CalculateAreaBuilder.DimTolerance¶ Returns the dim tolerance used as the area calculation tolerance.
-------------------------------------Getter Method
Signature
DimTolerance()Returns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
PlaneDefine¶
-
CalculateAreaBuilder.PlaneDefine¶ Returns or sets the plane defined as the reference plane to calculate area, the type could be planar face, datum plane and plane.
-------------------------------------Getter Method
Signature
PlaneDefine()Returns: Return type: NXOpen.NXObjectNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneDefine(planeDefine)Parameters: planeDefine ( NXOpen.NXObject) –New in version NX7.5.0.
License requirements: None.
SelectionTarget¶
-
CalculateAreaBuilder.SelectionTarget¶ Returns the target body to calculate area.
It can be a single solid/sheet body, or multiple solid/sheet bodies.
-------------------------------------Getter Method
Signature
SelectionTarget()Returns: Return type: NXOpen.SelectBodyListNew in version NX7.5.0.
License requirements: None.
ToggleSideArea¶
-
CalculateAreaBuilder.ToggleSideArea¶ Returns or sets the toggle side area to indicate calculate side area or not.
-------------------------------------Getter Method
Signature
ToggleSideArea()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToggleSideArea(toggleSideArea)Parameters: toggleSideArea (bool) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
CalculateAreaBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.