CircularFrameBuilder Class¶
-
class
NXOpen.GeometricUtilities.CircularFrameBuilder¶ Bases:
NXOpen.GeometricUtilities.ShapeFrameBuilderRepresents a
NXOpen.GeometricUtilities.CircularFrameBuilderNew 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 |
| Subtype | Returns or sets the subtype |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| GetAngle | Gets the i-th angle of the circular frame |
| GetMidpointCoords | Gets the coordinates of the i-th midpoint of the frame with respect to the plane |
| GetRadius | Gets the i-th radius of the circular frame |
| GetVertexCoords | Gets the coordinates of the i-th vertex of the frame with respect to the plane |
| SetAngle | Sets the i-th angle of the circular frame |
| SetMidpointCoords | Sets the coordinates of the i-th midpoint of the frame with respect to the plane |
| SetRadius | Sets the i-th radius of the circular frame |
| 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¶
| CircularFrameBuilderSubtypes Enumeration | Represents the circular frame subtypes |
Property Detail¶
Subtype¶
-
CircularFrameBuilder.Subtype¶ Returns or sets the subtype
-------------------------------------Getter Method
Signature
SubtypeReturns: Return type: NXOpen.GeometricUtilities.CircularFrameBuilderSubtypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SubtypeParameters: subtype ( NXOpen.GeometricUtilities.CircularFrameBuilderSubtypes) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
GetAngle¶
-
CircularFrameBuilder.GetAngle¶ Gets the i-th angle of the circular frame
Signature
GetAngle(index)Parameters: index (int) – index of angle Returns: angle Return type: float New in version NX6.0.0.
License requirements: None.
GetRadius¶
-
CircularFrameBuilder.GetRadius¶ Gets the i-th radius of the circular frame
Signature
GetRadius(index)Parameters: index (int) – index of radius Returns: radius Return type: float New in version NX6.0.0.
License requirements: None.
SetAngle¶
-
CircularFrameBuilder.SetAngle¶ Sets the i-th angle of the circular frame
Signature
SetAngle(index, angle)Parameters: - index (int) – index of angle
- angle (float) – angle
New in version NX6.0.0.
License requirements: None.
SetRadius¶
-
CircularFrameBuilder.SetRadius¶ Sets the i-th radius of the circular frame
Signature
SetRadius(index, radius)Parameters: - index (int) – index of radius
- radius (float) – radius
New in version NX6.0.0.
License requirements: None.
Validate¶
-
CircularFrameBuilder.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.