MWDesignGuideLinesBuilder Class¶
-
class
NXOpen.Tooling.
MWDesignGuideLinesBuilder
¶ Bases:
NXOpen.Builder
The builder for designing guide lines in Mold Wizard.
To create a new instance of this class, use
NXOpen.Tooling.MWDesignGuideLinesCollection.CreateBuilder()
Default values.
Property Value GuideDirection Normal GuideLength.Value 0 (millimeters part), 0 (inches part) SnapAngleLimit 30 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
GuideDirection | Returns or sets the direction type for creating or editing the guide line. |
GuideLength | Returns the length for the guide line. |
GuideOrPartingLine | Returns the guide line or parting line. |
GuideVector | Returns or sets the vector for the guide line. |
SnapAngleLimit | Returns or sets the snap angle limit for snapping the guide line direction to one of the WCS axis. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AutoCreateGuideLines | Button for creating guide lines automatically at locations where there are not exactly two parting lines are connecting. |
Commit | Commits any edits that have been applied to the builder. |
CreateGuideLine | Create a guide line given a parting line and coordinates close to one of its end points. |
DeleteAllGuideLines | Button for deleting all the guide lines. |
DeleteGuideLine | Delete a given guide line. |
DeleteSelectedGuideLine | Button for deleting the selected guide line. |
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. |
UpdateGuideLineDirection | Update the guide line with a new direction. |
UpdateGuideLineDirectionAndLength | Update the guide line with a new direction and length. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
MWDesignGuideLinesBuilderDirectionType Enumeration | The type of direction for the guide line to be created. |
Property Detail¶
GuideDirection¶
-
MWDesignGuideLinesBuilder.
GuideDirection
¶ Returns or sets the direction type for creating or editing the guide line.
-------------------------------------
Getter Method
Signature
GuideDirection
Returns: Return type: NXOpen.Tooling.MWDesignGuideLinesBuilderDirectionType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GuideDirection
Parameters: guideDirection ( NXOpen.Tooling.MWDesignGuideLinesBuilderDirectionType
) –New in version NX7.5.0.
License requirements: None.
GuideLength¶
-
MWDesignGuideLinesBuilder.
GuideLength
¶ Returns the length for the guide line.
-------------------------------------
Getter Method
Signature
GuideLength
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
GuideOrPartingLine¶
-
MWDesignGuideLinesBuilder.
GuideOrPartingLine
¶ Returns the guide line or parting line.
-------------------------------------
Getter Method
Signature
GuideOrPartingLine
Returns: Return type: NXOpen.SelectCurve
New in version NX7.5.0.
License requirements: None.
GuideVector¶
-
MWDesignGuideLinesBuilder.
GuideVector
¶ Returns or sets the vector for the guide line.
-------------------------------------
Getter Method
Signature
GuideVector
Returns: Return type: NXOpen.Direction
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GuideVector
Parameters: guideVector ( NXOpen.Direction
) –New in version NX7.5.0.
License requirements: None.
SnapAngleLimit¶
-
MWDesignGuideLinesBuilder.
SnapAngleLimit
¶ Returns or sets the snap angle limit for snapping the guide line direction to one of the WCS axis.
-------------------------------------
Getter Method
Signature
SnapAngleLimit
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SnapAngleLimit
Parameters: snapAngleLimit (float) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
AutoCreateGuideLines¶
-
MWDesignGuideLinesBuilder.
AutoCreateGuideLines
¶ Button for creating guide lines automatically at locations where there are not exactly two parting lines are connecting.
Signature
AutoCreateGuideLines()
New in version NX7.5.0.
License requirements: None.
CreateGuideLine¶
-
MWDesignGuideLinesBuilder.
CreateGuideLine
¶ Create a guide line given a parting line and coordinates close to one of its end points.
If there is an existing guide line at the same location, a new one will not be created and the existing guide line will be returned.
Signature
CreateGuideLine(partingLineTag, closePoint, length)
Parameters: - partingLineTag (
NXOpen.Curve
) – Parting line on which a guide line will be placed - closePoint (
NXOpen.Point3d
) – Point close to one of the end points of the parting line - length (float) – Length of the guide line to be created
Returns: a tuple
Return type: A tuple consisting of (guideLine, created). guideLine is a
NXOpen.Curve
. Existing or newly created guide line created is a int. 1 if a guide line has been created, or 0 if existing guide line is returnedNew in version NX7.5.0.
License requirements: None.
- partingLineTag (
DeleteAllGuideLines¶
-
MWDesignGuideLinesBuilder.
DeleteAllGuideLines
¶ Button for deleting all the guide lines.
Signature
DeleteAllGuideLines()
New in version NX7.5.0.
License requirements: None.
DeleteGuideLine¶
-
MWDesignGuideLinesBuilder.
DeleteGuideLine
¶ Delete a given guide line.
Signature
DeleteGuideLine(guideLine)
Parameters: guideLine ( NXOpen.Curve
) – Guide lineNew in version NX7.5.0.
License requirements: None.
DeleteSelectedGuideLine¶
-
MWDesignGuideLinesBuilder.
DeleteSelectedGuideLine
¶ Button for deleting the selected guide line.
Signature
DeleteSelectedGuideLine()
New in version NX7.5.0.
License requirements: None.
UpdateGuideLineDirection¶
-
MWDesignGuideLinesBuilder.
UpdateGuideLineDirection
¶ Update the guide line with a new direction.
Signature
UpdateGuideLineDirection(directionType, guideLine)
Parameters: - directionType (
NXOpen.Tooling.MWDesignGuideLinesBuilderDirectionType
) – Direction type - guideLine (
NXOpen.Curve
) – Guide line
New in version NX7.5.0.
License requirements: None.
- directionType (
UpdateGuideLineDirectionAndLength¶
-
MWDesignGuideLinesBuilder.
UpdateGuideLineDirectionAndLength
¶ Update the guide line with a new direction and length.
Signature
UpdateGuideLineDirectionAndLength(guideLine, guideLineVector, guideLinelength)
Parameters: - guideLine (
NXOpen.Curve
) – Guide line - guideLineVector (
NXOpen.Vector3d
) – Direction vector of the guide line - guideLinelength (float) – Length of the guide line
New in version NX11.0.1.
License requirements: None.
- guideLine (
Validate¶
-
MWDesignGuideLinesBuilder.
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.