SketchPolygonBuilder Class¶
-
class
NXOpen.
SketchPolygonBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.SketchPolygon
builderTo create a new instance of this class, use
NXOpen.SketchCollection.CreateSketchPolygonBuilder()
Default values.
Property Value LengthDimension.Value 100 (millimeters part), 3.937 (inches part) NumberOfSides 6 RadiusDimension.Value 100 (millimeters part), 3.937 (inches part) RotationDimension.Value 0 Size InscribedRadius New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
CenterPoint | Returns or sets the center point |
LengthDimension | Returns the length dimension. |
NumberOfSides | Returns or sets the number of sides |
RadiusDimension | Returns the radius dimension. |
RotationDimension | Returns the angular dimension |
Size | Returns or sets the size type |
SizePoint | Returns or sets the size point |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateAngleDimension | The flag to indicate if we need to create angle dimension |
CreateLengthDimension | The flag to indicate if we need to create length dimension |
CreateRadiusDimension | The flag to indicate if we need to create radius dimension |
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. |
Enumerations¶
SketchPolygonBuilderSizeType Enumeration | Polygon type |
Property Detail¶
CenterPoint¶
-
SketchPolygonBuilder.
CenterPoint
¶ Returns or sets the center point
-------------------------------------
Getter Method
Signature
CenterPoint
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CenterPoint
Parameters: centerPoint ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
LengthDimension¶
-
SketchPolygonBuilder.
LengthDimension
¶ Returns the length dimension.
This value is only used if
NXOpen.SketchPolygonBuilder.Size()
is set toNXOpen.SketchPolygonBuilderSizeType.SideLength
-------------------------------------
Getter Method
Signature
LengthDimension
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
NumberOfSides¶
-
SketchPolygonBuilder.
NumberOfSides
¶ Returns or sets the number of sides
-------------------------------------
Getter Method
Signature
NumberOfSides
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfSides
Parameters: numberOfSides (int) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
RadiusDimension¶
-
SketchPolygonBuilder.
RadiusDimension
¶ Returns the radius dimension.
This value is only used if
NXOpen.SketchPolygonBuilder.Size()
is set toNXOpen.SketchPolygonBuilderSizeType.InscribedRadius
orNXOpen.SketchPolygonBuilderSizeType.CircumscribedRadius
-------------------------------------
Getter Method
Signature
RadiusDimension
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
RotationDimension¶
-
SketchPolygonBuilder.
RotationDimension
¶ Returns the angular dimension
-------------------------------------
Getter Method
Signature
RotationDimension
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
Size¶
-
SketchPolygonBuilder.
Size
¶ Returns or sets the size type
-------------------------------------
Getter Method
Signature
Size
Returns: Return type: NXOpen.SketchPolygonBuilderSizeType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Size
Parameters: size ( NXOpen.SketchPolygonBuilderSizeType
) –New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
SizePoint¶
-
SketchPolygonBuilder.
SizePoint
¶ Returns or sets the size point
-------------------------------------
Getter Method
Signature
SizePoint
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SizePoint
Parameters: sizePoint ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Method Detail¶
CreateAngleDimension¶
-
SketchPolygonBuilder.
CreateAngleDimension
¶ The flag to indicate if we need to create angle dimension
Signature
CreateAngleDimension(createDim)
Parameters: createDim (bool) – true, to create the angle dimension New in version NX7.5.0.
License requirements: None.
CreateLengthDimension¶
-
SketchPolygonBuilder.
CreateLengthDimension
¶ The flag to indicate if we need to create length dimension
Signature
CreateLengthDimension(createDim)
Parameters: createDim (bool) – true, to create the length dimension New in version NX7.5.0.
License requirements: None.
CreateRadiusDimension¶
-
SketchPolygonBuilder.
CreateRadiusDimension
¶ The flag to indicate if we need to create radius dimension
Signature
CreateRadiusDimension(createDim)
Parameters: createDim (bool) – true, to create the radius dimension New in version NX7.5.0.
License requirements: None.
Validate¶
-
SketchPolygonBuilder.
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.