ManageToolPartBuilder Class¶
-
class
NXOpen.CAM.
ManageToolPartBuilder
¶ Bases:
NXOpen.Builder
Represents an Export Tool Part Builder
This is an abstract class, and cannot be instantiated.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
ExportToggleState | Returns or sets the export tool part toggle state |
Tag | Returns the Tag for this object. |
ToolMountingJunction | Returns or sets the tool mounting junction |
Methods¶
Method | Description |
---|---|
AskR1ToolTipJunction | The r1 tool tip junction, applies for turning tools only |
AskToolTipJunction | The tool_tip_tracking_point, tool_tip_radius_id parameters apply for turning tools only. |
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. |
GetNumToolCutter | Get the number of tool cutter objects @return Number of cutter objects |
GetObject | Returns the object currently being edited by this builder. |
GetToolCutter | Get the tool’s cuttre geometry objects |
SetToolCutter | Sets the geometry objects for the tool’s cutter |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateR1ToolTipJunction | Updates the r1 tool tip junction and related tracking point (1. |
UpdateToolTipJunction | Updates the tool tip junction. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ExportToggleState¶
-
ManageToolPartBuilder.
ExportToggleState
¶ Returns or sets the export tool part toggle state
-------------------------------------
Getter Method
Signature
ExportToggleState()
Returns: if true export also tool part on export, otherwise don’t Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportToggleState(state)
Parameters: state (bool) – if true export also tool part on export, otherwise don’t New in version NX6.0.0.
License requirements: None.
ToolMountingJunction¶
-
ManageToolPartBuilder.
ToolMountingJunction
¶ Returns or sets the tool mounting junction
-------------------------------------
Getter Method
Signature
ToolMountingJunction()
Returns: Return type: NXOpen.NXObject
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolMountingJunction(toolMountingJunction)
Parameters: toolMountingJunction ( NXOpen.NXObject
) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
AskR1ToolTipJunction¶
-
ManageToolPartBuilder.
AskR1ToolTipJunction
¶ The r1 tool tip junction, applies for turning tools only
Signature
AskR1ToolTipJunction()
Returns: a tuple Return type: A tuple consisting of (r1ToolTipJunction, r1ToolTipTrackingPoint). r1ToolTipJunction is a NXOpen.NXObject
. The Tool Tip Junction at radius R1r1ToolTipTrackingPoint is a int. The tracking point (1..9) where the junction origin is locatedNew in version NX6.0.0.
License requirements: None.
AskToolTipJunction¶
-
ManageToolPartBuilder.
AskToolTipJunction
¶ The tool_tip_tracking_point, tool_tip_radius_id parameters apply for turning tools only.
Otherwise they are set to zero
Signature
AskToolTipJunction()
Returns: a tuple Return type: A tuple consisting of (toolTipJunction, toolTipTrackingPoint, toolTipRadiusId). toolTipJunction is a NXOpen.NXObject
. The Tool Tip Junction at radius R1toolTipTrackingPoint is a int. The tracking point (1..9) where the junction origin is located toolTipRadiusId is a int. The radius id where the junction origin is locatedNew in version NX8.5.0.
License requirements: None.
GetNumToolCutter¶
-
ManageToolPartBuilder.
GetNumToolCutter
¶ Get the number of tool cutter objects
Signature
GetNumToolCutter()
Returns: Number of cutter objects Return type: int New in version NX7.5.0.
License requirements: None.
GetToolCutter¶
-
ManageToolPartBuilder.
GetToolCutter
¶ Get the tool’s cuttre geometry objects
Signature
GetToolCutter()
Returns: Array with the cutter objects Return type: list of NXOpen.NXObject
New in version NX7.5.0.
License requirements: None.
SetToolCutter¶
-
ManageToolPartBuilder.
SetToolCutter
¶ Sets the geometry objects for the tool’s cutter
Signature
SetToolCutter(tagArray)
Parameters: tagArray (list of NXOpen.NXObject
) – Array holding the cutter objectsNew in version NX7.5.0.
License requirements: None.
UpdateR1ToolTipJunction¶
-
ManageToolPartBuilder.
UpdateR1ToolTipJunction
¶ Updates the r1 tool tip junction and related tracking point (1.
.9)
Signature
UpdateR1ToolTipJunction(r1ToolTipJunction, r1ToolTipTrackingPoint)
Parameters: - r1ToolTipJunction (
NXOpen.NXObject
) – The tool tip junction at radius R1 - r1ToolTipTrackingPoint (int) – The tracking point (1..9) where the junction origin is located
New in version NX6.0.0.
License requirements: None.
- r1ToolTipJunction (
UpdateToolTipJunction¶
-
ManageToolPartBuilder.
UpdateToolTipJunction
¶ Updates the tool tip junction.
The tool_tip_tracking_point, tool_tip_radius_id parameters apply for turning tools only.
Signature
UpdateToolTipJunction(r1ToolTipJunction, toolTipTrackingPoint, toolTipRadiusId)
Parameters: - r1ToolTipJunction (
NXOpen.NXObject
) – The tool tip junction at radius R1 - toolTipTrackingPoint (int) – The tracking point (1..9) where the junction origin is located
- toolTipRadiusId (int) – The radius id (1,2,3..) where the junction origin is located
New in version NX8.5.0.
License requirements: None.
- r1ToolTipJunction (
Validate¶
-
ManageToolPartBuilder.
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.