Class RigidBodyDesc

Hierarchy

  • RigidBodyDesc

Constructors

constructor

Properties

additionalSolverIterations angularDamping angularInertiaLocalFrame angvel canSleep ccdEnabled centerOfMass dominanceGroup enabled gravityScale linearDamping linvel mass massOnly principalAngularInertia rotation rotationsEnabledX rotationsEnabledY rotationsEnabledZ sleeping status translation translationsEnabledX translationsEnabledY translationsEnabledZ userData?

Methods

enabledRotations enabledTranslations lockRotations lockTranslations restrictRotations restrictTranslations setAdditionalMass setAdditionalMassProperties setAdditionalSolverIterations setAngularDamping setAngvel setCanSleep setCcdEnabled setDominanceGroup setEnabled setGravityScale setLinearDamping setLinvel setRotation setSleeping setTranslation setUserData dynamic fixed kinematicPositionBased kinematicVelocityBased newDynamic newKinematicPositionBased newKinematicVelocityBased newStatic

Constructors

constructor

Properties

additionalSolverIterations

additionalSolverIterations: number

angularDamping

angularDamping: number

angularInertiaLocalFrame

angularInertiaLocalFrame: Rotation

angvel

angvel: Vector

canSleep

canSleep: boolean

ccdEnabled

ccdEnabled: boolean

centerOfMass

centerOfMass: Vector

dominanceGroup

dominanceGroup: number

enabled

enabled: boolean

gravityScale

gravityScale: number

linearDamping

linearDamping: number

linvel

linvel: Vector

mass

mass: number

massOnly

massOnly: boolean

principalAngularInertia

principalAngularInertia: Vector

rotation

rotation: Rotation

rotationsEnabledX

rotationsEnabledX: boolean

rotationsEnabledY

rotationsEnabledY: boolean

rotationsEnabledZ

rotationsEnabledZ: boolean

sleeping

sleeping: boolean

status

status: RigidBodyType

translation

translation: Vector

translationsEnabledX

translationsEnabledX: boolean

translationsEnabledY

translationsEnabledY: boolean

translationsEnabledZ

translationsEnabledZ: boolean

Optional userData

userData?: unknown

Methods

enabledRotations

  • Allow rotation of this rigid-body only along specific axes.

    Parameters

    • rotationsEnabledX: boolean

      Are rotations along the X axis enabled?

    • rotationsEnabledY: boolean

      Are rotations along the y axis enabled?

    • rotationsEnabledZ: boolean

      Are rotations along the Z axis enabled?

    Returns RigidBodyDesc

enabledTranslations

  • Allow translation of this rigid-body only along specific axes.

    Parameters

    • translationsEnabledX: boolean

      Are translations along the X axis enabled?

    • translationsEnabledY: boolean

      Are translations along the y axis enabled?

    • translationsEnabledZ: boolean

      Are translations along the Z axis enabled?

    Returns RigidBodyDesc

lockRotations

  • Locks all rotations that would have resulted from forces on the created rigid-body.

    Returns RigidBodyDesc

lockTranslations

  • Locks all translations that would have resulted from forces on the created rigid-body.

    Returns RigidBodyDesc

restrictRotations

  • Allow rotation of this rigid-body only along specific axes.

    Deprecated

    use this.enabledRotations with the same arguments instead.

    Parameters

    • rotationsEnabledX: boolean

      Are rotations along the X axis enabled?

    • rotationsEnabledY: boolean

      Are rotations along the y axis enabled?

    • rotationsEnabledZ: boolean

      Are rotations along the Z axis enabled?

    Returns RigidBodyDesc

restrictTranslations

  • Allow translation of this rigid-body only along specific axes.

    Deprecated

    use this.enabledTranslations with the same arguments instead.

    Parameters

    • translationsEnabledX: boolean

      Are translations along the X axis enabled?

    • translationsEnabledY: boolean

      Are translations along the y axis enabled?

    • translationsEnabledZ: boolean

      Are translations along the Z axis enabled?

    Returns RigidBodyDesc

setAdditionalMass

  • Sets the initial mass of the rigid-body being built, before adding colliders' contributions.

    Parameters

    • mass: number

      − The initial mass of the rigid-body to create.

    Returns RigidBodyDesc

setAdditionalMassProperties

  • Sets the mass properties of the rigid-body being built.

    Note that the final mass properties of the rigid-bodies depends on the initial mass-properties of the rigid-body (set by this method) to which is added the contributions of all the colliders with non-zero density attached to this rigid-body.

    Therefore, if you want your provided mass properties to be the final mass properties of your rigid-body, don't attach colliders to it, or only attach colliders with densities equal to zero.

    Parameters

    • mass: number

      − The initial mass of the rigid-body to create.

    • centerOfMass: Vector

      − The initial center-of-mass of the rigid-body to create.

    • principalAngularInertia: Vector

      − The initial principal angular inertia of the rigid-body to create. These are the eigenvalues of the angular inertia matrix.

    • angularInertiaLocalFrame: Rotation

      − The initial local angular inertia frame of the rigid-body to create. These are the eigenvectors of the angular inertia matrix.

    Returns RigidBodyDesc

setAdditionalSolverIterations

  • Sets the number of additional solver iterations that will be run for this rigid-body and everything that interacts with it directly or indirectly through contacts or joints.

    Compared to increasing the global World.numSolverIteration, setting this value lets you increase accuracy on only a subset of the scene, resulting in reduced performance loss.

    Parameters

    • iters: number

      The new number of additional solver iterations (default: 0).

    Returns RigidBodyDesc

setAngularDamping

  • Sets the angular damping of the rigid-body to create.

    This will progressively slowdown the rotational movement of the rigid-body.

    Parameters

    • damping: number

      The angular damping coefficient. Should be >= 0. The higher this value is, the stronger the rotational slowdown will be.

    Returns RigidBodyDesc

setAngvel

  • Sets the initial angular velocity of the rigid-body to create.

    Parameters

    • vel: Vector

      The angular velocity to set.

    Returns RigidBodyDesc

setCanSleep

  • Sets whether or not the rigid-body to create can sleep.

    Parameters

    • can: boolean

      true if the rigid-body can sleep, false if it can't.

    Returns RigidBodyDesc

setCcdEnabled

  • Sets whether Continuous Collision Detection (CCD) is enabled for this rigid-body.

    Parameters

    • enabled: boolean

      true if the rigid-body has CCD enabled.

    Returns RigidBodyDesc

setDominanceGroup

  • Parameters

    • group: number

    Returns RigidBodyDesc

setEnabled

  • Sets whether the created rigid-body will be enabled or disabled.

    Parameters

    • enabled: boolean

      − If set to false the rigid-body will be disabled at creation.

    Returns RigidBodyDesc

setGravityScale

  • Sets the scale factor applied to the gravity affecting the rigid-body being built.

    Parameters

    • scale: number

      The scale factor. Set this to 0.0 if the rigid-body needs to ignore gravity.

    Returns RigidBodyDesc

setLinearDamping

  • Sets the linear damping of the rigid-body to create.

    This will progressively slowdown the translational movement of the rigid-body.

    Parameters

    • damping: number

      The angular damping coefficient. Should be >= 0. The higher this value is, the stronger the translational slowdown will be.

    Returns RigidBodyDesc

setLinvel

  • Sets the initial linear velocity of the rigid-body to create.

    Parameters

    • x: number

      The linear velocity to set along the x axis.

    • y: number

      The linear velocity to set along the y axis.

    • z: number

      The linear velocity to set along the z axis.

    Returns RigidBodyDesc

setRotation

setSleeping

  • Sets whether or not the rigid-body is to be created asleep.

    Parameters

    • sleeping: boolean

    Returns RigidBodyDesc

setTranslation

  • Sets the initial translation of the rigid-body to create.

    Parameters

    • x: number
    • y: number
    • z: number

    Returns RigidBodyDesc

setUserData

  • Sets the user-defined object of this rigid-body.

    Parameters

    • Optional data: unknown

    Returns RigidBodyDesc

Static dynamic

  • A rigid-body descriptor used to build a dynamic rigid-body.

    Returns RigidBodyDesc

Static fixed

  • A rigid-body descriptor used to build a fixed rigid-body.

    Returns RigidBodyDesc

Static kinematicPositionBased

  • A rigid-body descriptor used to build a position-based kinematic rigid-body.

    Returns RigidBodyDesc

Static kinematicVelocityBased

  • A rigid-body descriptor used to build a velocity-based kinematic rigid-body.

    Returns RigidBodyDesc

Static newDynamic

  • A rigid-body descriptor used to build a dynamic rigid-body.

    Deprecated

    The method has been renamed to .dynamic().

    Returns RigidBodyDesc

Static newKinematicPositionBased

  • A rigid-body descriptor used to build a position-based kinematic rigid-body.

    Deprecated

    The method has been renamed to .kinematicPositionBased().

    Returns RigidBodyDesc

Static newKinematicVelocityBased

  • A rigid-body descriptor used to build a velocity-based kinematic rigid-body.

    Deprecated

    The method has been renamed to .kinematicVelocityBased().

    Returns RigidBodyDesc

Static newStatic

  • A rigid-body descriptor used to build a fixed rigid-body.

    Deprecated

    The method has been renamed to .fixed().

    Returns RigidBodyDesc

Settings

Member Visibility

Theme

Generated using TypeDoc