Class ColliderSet

A set of rigid bodies that can be handled by a physics pipeline.

To avoid leaking WASM resources, this MUST be freed manually with colliderSet.free() once you are done using it (and all the rigid-bodies it created).

Hierarchy

  • ColliderSet

Constructors

constructor

Properties

map raw

Methods

castClosure contains createCollider finalizeDeserialization forEach free get getAll len remove unmap

Constructors

constructor

  • Parameters

    • Optional raw: RawColliderSet

    Returns ColliderSet

Properties

Private map

map: any

raw

raw: RawColliderSet

Methods

castClosure

  • Internal

    Type Parameters

    • Res

    Parameters

    Returns ((handle: number) => Res)

      • (handle: number): Res
      • Internal

        Parameters

        • handle: number

        Returns Res

contains

  • Does this set contain a collider with the given handle?

    Parameters

    • handle: number

      The collider handle to check.

    Returns boolean

createCollider

  • Creates a new collider and return its integer handle.

    Parameters

    • bodies: RigidBodySet

      The set of bodies where the collider's parent can be found.

    • desc: ColliderDesc

      The collider's description.

    • parentHandle: number

      The integer handle of the rigid-body this collider is attached to.

    Returns Collider

finalizeDeserialization

  • Internal

    Parameters

    Returns void

forEach

  • Applies the given closure to each collider contained by this set.

    Parameters

    • f: ((collider: Collider) => void)

      The closure to apply.

    Returns void

free

  • Release the WASM memory occupied by this collider set.

    Returns void

get

  • Gets the rigid-body with the given handle.

    Parameters

    • handle: number

      The handle of the rigid-body to retrieve.

    Returns Collider

getAll

  • Gets all colliders in the list.

    Returns

    collider list.

    Returns Collider[]

len

  • The number of colliders on this set.

    Returns number

remove

  • Remove a collider from this set.

    Parameters

    • handle: number

      The integer handle of the collider to remove.

    • islands: IslandManager
    • bodies: RigidBodySet

      The set of rigid-body containing the rigid-body the collider is attached to.

    • wakeUp: boolean

      If true, the rigid-body the removed collider is attached to will be woken-up automatically.

    Returns void

unmap

  • Internal function, do not call directly.

    Parameters

    • handle: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc