Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JointParams

Hierarchy

  • JointParams

Index

Constructors

Private constructor

Properties

anchor1

anchor1: Vector

anchor2

anchor2: Vector

axis1

axis1: Vector

axis2

axis2: Vector

frame1

frame1: Rotation

frame2

frame2: Rotation

jointType

jointType: JointType

limits

limits: Array<number>

limitsEnabled

limitsEnabled: boolean

tangent1

tangent1: Vector

tangent2

tangent2: Vector

Methods

intoRaw

  • intoRaw(): RawJointParams
  • intoRaw(): RawJointParams
  • Returns RawJointParams

  • Returns RawJointParams

Static ball

  • Create a new joint descriptor that builds Ball joints.

    A ball joints allows three relative rotational degrees of freedom by preventing any relative translation between the anchors of the two attached rigid-bodies.

    Parameters

    • anchor1: Vector

      Point where the joint is attached on the first rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • anchor2: Vector

      Point where the joint is attached on the second rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    Returns JointParams

  • Create a new joint descriptor that builds Ball joints.

    A ball joints allows three relative rotational degrees of freedom by preventing any relative translation between the anchors of the two attached rigid-bodies.

    Parameters

    • anchor1: Vector

      Point where the joint is attached on the first rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • anchor2: Vector

      Point where the joint is attached on the second rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    Returns JointParams

Static fixed

  • Creates a new joint descriptor that builds a Fixed joint.

    A fixed joint removes all the degrees of freedom between the affected bodies, ensuring their anchor and local frames coincide in world-space.

    Parameters

    • anchor1: Vector

      Point where the joint is attached on the first rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • frame1: Rotation

      The reference orientation of the joint wrt. the first rigid-body.

    • anchor2: Vector

      Point where the joint is attached on the second rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • frame2: Rotation

      The reference orientation of the joint wrt. the second rigid-body.

    Returns JointParams

  • Creates a new joint descriptor that builds a Fixed joint.

    A fixed joint removes all the degrees of freedom between the affected bodies, ensuring their anchor and local frames coincide in world-space.

    Parameters

    • anchor1: Vector

      Point where the joint is attached on the first rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • frame1: Rotation

      The reference orientation of the joint wrt. the first rigid-body.

    • anchor2: Vector

      Point where the joint is attached on the second rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • frame2: Rotation

      The reference orientation of the joint wrt. the second rigid-body.

    Returns JointParams

Static prismatic

  • Creates a new joint descriptor that builds a Prismatic joint.

    A prismatic joint removes all the degrees of freedom between the affected bodies, except for the translation along one axis.

    Parameters

    • anchor1: Vector

      Point where the joint is attached on the first rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • axis1: Vector

      Axis of the joint, expressed in the local-space of the first rigid-body it is attached to.

    • anchor2: Vector

      Point where the joint is attached on the second rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • axis2: Vector

      Axis of the joint, expressed in the local-space of the second rigid-body it is attached to.

    Returns JointParams

  • Creates a new joint descriptor that builds a Prismatic joint.

    A prismatic joint removes all the degrees of freedom between the affected bodies, except for the translation along one axis.

    Parameters

    • anchor1: Vector

      Point where the joint is attached on the first rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • axis1: Vector

      Axis of the joint, expressed in the local-space of the first rigid-body it is attached to.

    • anchor2: Vector

      Point where the joint is attached on the second rigid-body affected by this joint. Expressed in the local-space of the rigid-body.

    • axis2: Vector

      Axis of the joint, expressed in the local-space of the second rigid-body it is attached to.

    Returns JointParams

Generated using TypeDoc