Class BearingJoint

Represents a bearing joint.

Hierarchy

  • Joint

    Hierarchy

    • BearingJoint

Constructors

constructor

Properties

fileJoint fileShape create

Accessors

color position rotation shapeId

Methods

getId updateValues _internalCreate convert

Constructors

constructor

Properties

Readonly fileJoint

fileJoint: FileJoint & { controller: undefined }

Readonly fileShape

fileShape: FileShape

Static create

create: ((...args: [position: Vector3, rotation: Axis, childA: Child, childB?: Child, color?: string]) => Joint) = ...

Type declaration

    • (...args: [position: Vector3, rotation: Axis, childA: Child, childB?: Child, color?: string]): Joint

    • Creates a bearing.

      Returns

      The created bearing.

      Parameters

      Returns Joint

Accessors

color

  • get color(): string

  • The color of this shape.

    Returns string

  • set color(value: string): void

  • Parameters

    • value: string

    Returns void

position

rotation

shapeId

  • get shapeId(): string

  • The shapeId of this shape. Determines the model and behavior in-game.

    Returns string

  • set shapeId(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

getId

Protected updateValues

Static _internalCreate

Static convert

  • Attempts to convert a Joint to BearingJoint. Only returns if the Joint's file object is a BearingJoint.

    Returns

    The converted BearingJoint, or undefined if the Joint was not a BearingJoint.

    Parameters

    • potential: Joint

      The Joint to convert.

    Returns undefined | BearingJoint

Settings

Member Visibility

Theme

Generated using TypeDoc