BoundaryDefinitionBuilder Class¶
-
class
NXOpen.GeometricUtilities.BoundaryDefinitionBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.GeometricUtilities.BoundaryDefinitionBuilder.A boundary definition is a collection of ordered points which can be imagined to be connected by a polyline indicating a boundary. Any point in the collection can be marked as a key point. Marking some points as key points helps to delete part of the boundary efficiently. All the points in a boundary definition are co-planar. A depth value can be specified to define a 3D boundary equivalent to an extrusion. .. versionadded:: NX7.5.0
Properties¶
| Property | Description |
|---|---|
| Depth | Returns the region depth |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AppendPoint | Appends a point to the boundary definition |
| Close | Closes the boundary by appending start point at the end of boundary definition |
| DeleteAll | Deletes all the points in the boundary definition |
| DeleteLastKeyPoint | Deletes last key point and all the points from last key point up to and excluding its previous key point |
| GetPoints | Queries all the boundary definition points |
| SetPlaneNormal | Sets normal of the plane in which boundary is defined |
| Translate | Translates the boundary from its current position using the direction and the magnitude of a vector. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Depth¶
-
BoundaryDefinitionBuilder.Depth¶ Returns the region depth
-------------------------------------Getter Method
Signature
DepthReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
Method Detail¶
AppendPoint¶
-
BoundaryDefinitionBuilder.AppendPoint¶ Appends a point to the boundary definition
Signature
AppendPoint(point, isKeyPoint)Parameters: - point (
NXOpen.Point3d) – Point to append - isKeyPoint (bool) – Flag indicating if point is a key point
New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
- point (
Close¶
-
BoundaryDefinitionBuilder.Close¶ Closes the boundary by appending start point at the end of boundary definition
Signature
Close()Returns: Return type: bool New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
DeleteAll¶
-
BoundaryDefinitionBuilder.DeleteAll¶ Deletes all the points in the boundary definition
Signature
DeleteAll()New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
DeleteLastKeyPoint¶
-
BoundaryDefinitionBuilder.DeleteLastKeyPoint¶ Deletes last key point and all the points from last key point up to and excluding its previous key point
Signature
DeleteLastKeyPoint()New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
GetPoints¶
-
BoundaryDefinitionBuilder.GetPoints¶ Queries all the boundary definition points
Signature
GetPoints()Returns: Return type: list of NXOpen.Point3dNew in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SetPlaneNormal¶
-
BoundaryDefinitionBuilder.SetPlaneNormal¶ Sets normal of the plane in which boundary is defined
Signature
SetPlaneNormal(direction)Parameters: direction ( NXOpen.Vector3d) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Translate¶
-
BoundaryDefinitionBuilder.Translate¶ Translates the boundary from its current position using the direction and the magnitude of a vector.
Signature
Translate(vector)Parameters: vector ( NXOpen.Vector3d) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Validate¶
-
BoundaryDefinitionBuilder.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.