WorkpieceBuilder Class¶
-
class
NXOpen.Tooling.WorkpieceBuilder¶ Bases:
NXOpen.BuilderMold Wizard work piece builder
To create a new instance of this class, use
NXOpen.Tooling.WorkpieceCollection.CreateWorkpieceBuilder()Default values.
Property Value BlockType UserDefinedBlock GenerateMethod DistanceAllowance RoundDimensionValue 0 RoundPrecision 0 ShowBoundbox 0 New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| BlockType | Returns or sets the work piece shape type access functions |
| GenerateMethod | Returns or sets the generate method access functions |
| ReferencePoint | Returns or sets the reference point to generate the work piece |
| RoundDimensionValue | Returns or sets the dimension round value |
| RoundPrecision | Returns or sets the round precision |
| SelectWorkPieceBody | Returns the work piece body selection |
| ShowBoundbox | Returns or sets the setting to show the bounding box of the product or not |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the selection type to select the work piece |
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. |
| ResetSizes | Resets workpiece sizes |
| 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¶
| WorkpieceBuilderMethodType Enumeration | the unit type includes the work piece define method |
| WorkpieceBuilderTypes Enumeration | the unit type includes product and combined work piece type |
| WorkpieceBuilderWorkPieceType Enumeration | the unit type includes the work piece create method |
Property Detail¶
BlockType¶
-
WorkpieceBuilder.BlockType¶ Returns or sets the work piece shape type access functions
-------------------------------------Getter Method
Signature
BlockType()Returns: Return type: NXOpen.Tooling.WorkpieceBuilderWorkPieceTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BlockType(blockType)Parameters: blockType ( NXOpen.Tooling.WorkpieceBuilderWorkPieceType) –New in version NX6.0.0.
License requirements: None.
GenerateMethod¶
-
WorkpieceBuilder.GenerateMethod¶ Returns or sets the generate method access functions
-------------------------------------Getter Method
Signature
GenerateMethod()Returns: Return type: NXOpen.Tooling.WorkpieceBuilderMethodTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GenerateMethod(generateMethod)Parameters: generateMethod ( NXOpen.Tooling.WorkpieceBuilderMethodType) –New in version NX6.0.0.
License requirements: None.
ReferencePoint¶
-
WorkpieceBuilder.ReferencePoint¶ Returns or sets the reference point to generate the work piece
-------------------------------------Getter Method
Signature
ReferencePoint()Returns: Return type: NXOpen.PointNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReferencePoint(referencePoint)Parameters: referencePoint ( NXOpen.Point) –New in version NX6.0.0.
License requirements: None.
RoundDimensionValue¶
-
WorkpieceBuilder.RoundDimensionValue¶ Returns or sets the dimension round value
-------------------------------------Getter Method
Signature
RoundDimensionValue()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RoundDimensionValue(roundDimensionValue)Parameters: roundDimensionValue (bool) – New in version NX6.0.0.
License requirements: None.
RoundPrecision¶
-
WorkpieceBuilder.RoundPrecision¶ Returns or sets the round precision
-------------------------------------Getter Method
Signature
RoundPrecision()Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RoundPrecision(roundPrecision)Parameters: roundPrecision (float) – New in version NX6.0.0.
License requirements: None.
SelectWorkPieceBody¶
-
WorkpieceBuilder.SelectWorkPieceBody¶ Returns the work piece body selection
-------------------------------------Getter Method
Signature
SelectWorkPieceBody()Returns: Return type: NXOpen.SelectBodyListNew in version NX6.0.0.
License requirements: None.
ShowBoundbox¶
-
WorkpieceBuilder.ShowBoundbox¶ Returns or sets the setting to show the bounding box of the product or not
-------------------------------------Getter Method
Signature
ShowBoundbox()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowBoundbox(showBoundbox)Parameters: showBoundbox (bool) – New in version NX6.0.0.
License requirements: None.
Type¶
-
WorkpieceBuilder.Type¶ Returns or sets the selection type to select the work piece
-------------------------------------Getter Method
Signature
Type()Returns: Return type: NXOpen.Tooling.WorkpieceBuilderTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(type)Parameters: type ( NXOpen.Tooling.WorkpieceBuilderTypes) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
ResetSizes¶
-
WorkpieceBuilder.ResetSizes¶ Resets workpiece sizes
Signature
ResetSizes()New in version NX9.0.0.
License requirements: None.
Validate¶
-
WorkpieceBuilder.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.