HingeJointBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HingeJointBuilder Class

class `NXOpen.Mechatronics.``HingeJointBuilder`

  Bases: `NXOpen.Mechatronics.PhysicsJointBuilder`

  Represents a `NXOpen.Mechatronics.HingeJoint` builder.

  To create a new instance of this class, use `NXOpen.Mechatronics.HingeJointCollection.CreateHingeJointBuilder()`

  New in version NX7.5.1.

# Properties

Property | Description
--- | ---
Attachment | Returns the attachment of joint.
AxisVector | Returns or sets the axis vector.
Base | Returns the base of joint.
BaseAnchorPoint | Returns or sets the anchor point of base.
BaseAxisVector | Returns or sets the axis vector of base.
EnableLowerLimit | Returns or sets the lower limit option.
EnableUpperLimit | Returns or sets the upper limit option.
LowerLimit | Returns the lower limit.
Name | Returns or sets the name.
Point | Returns or sets the origin point.
Positioning | Returns or sets a boolean value that indicates whether to create an assembly joint.
StartAngle | Returns the start angle.
Tag | Returns the Tag for this object.
UpperLimit | Returns the upper limit.

# 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.
SetAttachment | Sets the attachment.
SetBase | Sets the base.
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.

# Property Detail

## AxisVector

`HingeJointBuilder.``AxisVector`

  Returns or sets the axis vector.

  `-------------------------------------`

  Getter Method

  Signature `AxisVector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `AxisVector`

  Parameters: | axisVector (`NXOpen.Direction`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## EnableLowerLimit

`HingeJointBuilder.``EnableLowerLimit`

  Returns or sets the lower limit option.

  If the enable is true, then the joint will be applied a lower limit in movement.

  `-------------------------------------`

  Getter Method

  Signature `EnableLowerLimit`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `EnableLowerLimit`

  Parameters: | enable (bool) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## EnableUpperLimit

`HingeJointBuilder.``EnableUpperLimit`

  Returns or sets the upper limit option.

  If the enable is true, then the joint will be applied an upper limit in movement.

  `-------------------------------------`

  Getter Method

  Signature `EnableUpperLimit`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `EnableUpperLimit`

  Parameters: | enable (bool) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## LowerLimit

`HingeJointBuilder.``LowerLimit`

  Returns the lower limit.

  The lower limit setup for joint movement.

  `-------------------------------------`

  Getter Method

  Signature `LowerLimit`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Point

`HingeJointBuilder.``Point`

  Returns or sets the origin point.

  `-------------------------------------`

  Getter Method

  Signature `Point`

  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `Point`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## StartAngle

`HingeJointBuilder.``StartAngle`

  Returns the start angle.

  `-------------------------------------`

  Getter Method

  Signature `StartAngle`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## UpperLimit

`HingeJointBuilder.``UpperLimit`

  Returns the upper limit.

  The upper limit setup for joint movement.

  `-------------------------------------`

  Getter Method

  Signature `UpperLimit`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## Validate

`HingeJointBuilder.``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.