ShapeFrameBuilder Class¶
-
class
NXOpen.GeometricUtilities.ShapeFrameBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.GeometricUtilities.ShapeFrameBuilderNew in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| Anchor | Returns the anchor of the frame |
| AnchorAttachment | Returns or sets the anchor attachment |
| NumberVertices | Returns the number of vertices of the frame |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| GetMidpointCoords | Gets the coordinates of the i-th midpoint of the frame with respect to the plane |
| GetVertexCoords | Gets the coordinates of the i-th vertex of the frame with respect to the plane |
| SetMidpointCoords | Sets the coordinates of the i-th midpoint of the frame with respect to the plane |
| SetVertexCoords | Sets the coordinates of the i-th vertex of the frame with respect to the plane |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| ShapeFrameBuilderAnchorAttachmentType Enumeration | Represents the anchor attachment type |
Property Detail¶
Anchor¶
-
ShapeFrameBuilder.Anchor¶ Returns the anchor of the frame
-------------------------------------Getter Method
Signature
AnchorReturns: Return type: NXOpen.GeometricUtilities.AnchorLocatorBuilderNew in version NX6.0.0.
License requirements: None.
AnchorAttachment¶
-
ShapeFrameBuilder.AnchorAttachment¶ Returns or sets the anchor attachment
-------------------------------------Getter Method
Signature
AnchorAttachmentReturns: Return type: NXOpen.GeometricUtilities.ShapeFrameBuilderAnchorAttachmentTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AnchorAttachmentParameters: anchorAttachment ( NXOpen.GeometricUtilities.ShapeFrameBuilderAnchorAttachmentType) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
GetMidpointCoords¶
-
ShapeFrameBuilder.GetMidpointCoords¶ Gets the coordinates of the i-th midpoint of the frame with respect to the plane
Signature
GetMidpointCoords(index)Parameters: index (int) – index of midpoint Returns: coordinates of midpoint relative with respect to plane Return type: NXOpen.Point2dNew in version NX6.0.0.
License requirements: None.
GetVertexCoords¶
-
ShapeFrameBuilder.GetVertexCoords¶ Gets the coordinates of the i-th vertex of the frame with respect to the plane
Signature
GetVertexCoords(index)Parameters: index (int) – index of vertex Returns: coordinates of vertex relative with respect to plane Return type: NXOpen.Point2dNew in version NX6.0.0.
License requirements: None.
SetMidpointCoords¶
-
ShapeFrameBuilder.SetMidpointCoords¶ Sets the coordinates of the i-th midpoint of the frame with respect to the plane
Signature
SetMidpointCoords(index, coords)Parameters: - index (int) – index of midpoint
- coords (
NXOpen.Point2d) – coordinates of midpoint relative with respect to plane
New in version NX6.0.0.
License requirements: None.
SetVertexCoords¶
-
ShapeFrameBuilder.SetVertexCoords¶ Sets the coordinates of the i-th vertex of the frame with respect to the plane
Signature
SetVertexCoords(index, coords)Parameters: - index (int) – index of vertex
- coords (
NXOpen.Point2d) – coordinates of vertex relative with respect to plane
New in version NX6.0.0.
License requirements: None.
Validate¶
-
ShapeFrameBuilder.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.