PathConstraintJointBuilder Class¶
-
class
NXOpen.Mechatronics.
PathConstraintJointBuilder
¶ Bases:
NXOpen.Mechatronics.PhysicsJointBuilder
Represents a
NXOpen.Mechatronics.PathConstraintJoint
builder.To create a new instance of this class, use
NXOpen.Mechatronics.PathConstraintJointCollection.CreatePathConstraintJointBuilder()
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
Attachment | Returns the attachment of joint. |
AxisVector | Returns or sets the axis vector which is tangent to the path curve at the selected point |
Base | Returns the base of joint. |
BaseAnchorPoint | Returns or sets the anchor point of base. |
BaseAxisVector | Returns or sets the axis vector of base. |
FrameList | Returns the list containing the defined frames. |
Name | Returns or sets the name. |
PathPreview | Returns or sets the path preview |
PathType | Returns or sets the path type. |
PointOnCurve | Returns or sets the selected point on curve |
Positioning | Returns or sets a boolean value that indicates whether to create an assembly joint. |
Tag | Returns the Tag for this object. |
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. |
EvaluatePath | Evaluate the composited path with the curves. |
GeneratePathCurves | Generate the path curves from the coordinates systems. |
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. |
GetPathCurves | Get the path curves that constrain the movement of the attachment |
NewPathFrame | Creates a NXOpen.Mechatronics.PathConstraintFrameBuilder object. |
SetAttachment | Sets the attachment. |
SetBase | Sets the base. |
SetPathCurvesFromCurves | Set the path curves that constrain the movement of the attachment |
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¶
PathConstraintJointBuilderPathTypes Enumeration | the path types |
Property Detail¶
AxisVector¶
-
PathConstraintJointBuilder.
AxisVector
¶ Returns or sets the axis vector which is tangent to the path curve at the selected point
-------------------------------------
Getter Method
Signature
AxisVector
Returns: Return type: NXOpen.Direction
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AxisVector
Parameters: axisVector ( NXOpen.Direction
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
FrameList¶
-
PathConstraintJointBuilder.
FrameList
¶ Returns the list containing the defined frames.
-------------------------------------
Getter Method
Signature
FrameList
Returns: Return type: NXOpen.Mechatronics.PathConstraintFrameBuilderList
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
PathPreview¶
-
PathConstraintJointBuilder.
PathPreview
¶ Returns or sets the path preview
-------------------------------------
Getter Method
Signature
PathPreview
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
PathPreview
Parameters: enable (bool) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
PathType¶
-
PathConstraintJointBuilder.
PathType
¶ Returns or sets the path type.
-------------------------------------
Getter Method
Signature
PathType
Returns: Return type: NXOpen.Mechatronics.PathConstraintJointBuilderPathTypes
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
PathType
Parameters: pathType ( NXOpen.Mechatronics.PathConstraintJointBuilderPathTypes
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
PointOnCurve¶
-
PathConstraintJointBuilder.
PointOnCurve
¶ Returns or sets the selected point on curve
-------------------------------------
Getter Method
Signature
PointOnCurve
Returns: Return type: NXOpen.Point
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
PointOnCurve
Parameters: pointOnCurve ( NXOpen.Point
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
EvaluatePath¶
-
PathConstraintJointBuilder.
EvaluatePath
¶ Evaluate the composited path with the curves.
Signature
EvaluatePath(curves)
Parameters: curves (list of NXOpen.NXObject
) – curve or edgeNew in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
GeneratePathCurves¶
-
PathConstraintJointBuilder.
GeneratePathCurves
¶ Generate the path curves from the coordinates systems.
Signature
GeneratePathCurves()
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
GetPathCurves¶
-
PathConstraintJointBuilder.
GetPathCurves
¶ Get the path curves that constrain the movement of the attachment
Signature
GetPathCurves()
Returns: curve or edge Return type: list of NXOpen.NXObject
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
NewPathFrame¶
-
PathConstraintJointBuilder.
NewPathFrame
¶ Creates a
NXOpen.Mechatronics.PathConstraintFrameBuilder
object.Signature
NewPathFrame()
Returns: Return type: NXOpen.Mechatronics.PathConstraintFrameBuilder
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetPathCurvesFromCurves¶
-
PathConstraintJointBuilder.
SetPathCurvesFromCurves
¶ Set the path curves that constrain the movement of the attachment
Signature
SetPathCurvesFromCurves(pathCurves)
Parameters: pathCurves (list of NXOpen.NXObject
) – curve or edgeNew in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
PathConstraintJointBuilder.
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.