Class SoftBodySet

constructor

• new SoftBodySet(raw?): SoftBodySet

• Parameters

  • Optional raw: RawSoftBodySet

  Returns SoftBodySet

raw

addCluster

• addCluster(handle, particles, bodies, colliders): number

• Adds a cluster over the given particles: a rigid proxy that joints and colliders can attach to. Returns the cluster's index, or null if no particle was valid.

  Parameters

  • handle: number
  • particles: number[] | Uint32Array
  • bodies: RigidBodySet
  • colliders: ColliderSet

  Returns number

contains

• contains(handle): boolean

• Does this set contain a soft body with the given handle?

  Parameters

  • handle: number

  Returns boolean

createSoftBody

• createSoftBody(bodies, colliders, desc): SoftBody

• Creates a new soft body, its hidden root rigid body and its colliders, and returns it.

  Parameters

  • bodies: RigidBodySet

    The set of rigid bodies receiving the body's proxies.
  • colliders: ColliderSet

    The set of colliders receiving the body's colliders.
  • desc: SoftBodyDesc

    The description of the soft body to create.

  Returns SoftBody

cut

• cut(handle, blade, islands, bodies, colliders, impulseJoints, multibodyJoints): SoftBodyTearEvent

• Cuts a soft body along a blade: a segment (two points) in 2D, a triangle (three points) in 3D. Pieces disconnected by the cut become soft bodies of their own.

  Returns the tear event (which must be freed), or null when nothing changed.

  Parameters

  • handle: number
  • blade: Vector[]
  • islands: IslandManager
  • bodies: RigidBodySet
  • colliders: ColliderSet
  • impulseJoints: ImpulseJointSet
  • multibodyJoints: MultibodyJointSet

  Returns SoftBodyTearEvent

finalizeDeserialization

• finalizeDeserialization(bodies, colliders): void

• Internal method, do not call this explicitly.

  Parameters

  • bodies: RigidBodySet
  • colliders: ColliderSet

  Returns void

forEach

• forEach(f): void

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

  Parameters

  • f: ((body) => void)
    • • (body): void

      • Parameters

        • body: SoftBody

        Returns void

  Returns void

free

• free(): void

• Release the WASM memory occupied by this soft-body set.

  Returns void

get

• get(handle): SoftBody

• Gets the soft body with the given handle.

  Parameters

  • handle: number

  Returns SoftBody

getAll

• getAll(): SoftBody[]

• Gets all soft bodies in the list.

  Returns SoftBody[]

len

• len(): number

• The number of soft bodies on this set.

  Returns number

mapNewSoftBodies

• mapNewSoftBodies(bodies, colliders): void

• Wraps the soft bodies the engine created (the pieces a tear split off) that have no JavaScript wrapper yet; the pieces of a tear event are only reachable after this.

  Parameters

  • bodies: RigidBodySet
  • colliders: ColliderSet

  Returns void

remove

• remove(handle, islands, bodies, colliders, impulseJoints, multibodyJoints): void

• Removes a soft body from this set, with its proxies, colliders and attached joints.

  Parameters

  • handle: number
  • islands: IslandManager
  • bodies: RigidBodySet
  • colliders: ColliderSet
  • impulseJoints: ImpulseJointSet
  • multibodyJoints: MultibodyJointSet

  Returns void

removeCluster

• removeCluster(handle, cluster, islands, bodies, colliders, impulseJoints, multibodyJoints): boolean

• Removes a cluster with its proxy, colliders and joints. Returns false if the cluster did not exist.

  Parameters

  • handle: number
  • cluster: number
  • islands: IslandManager
  • bodies: RigidBodySet
  • colliders: ColliderSet
  • impulseJoints: ImpulseJointSet
  • multibodyJoints: MultibodyJointSet

  Returns boolean

tear

• tear(handle, edges, cells, islands, bodies, colliders, impulseJoints, multibodyJoints): SoftBodyTearEvent

• Tears a soft body at once along the given edges and through the given cells, without removing material. Pieces disconnected by the tear become soft bodies of their own.

  Returns the tear event (which must be freed), or null when nothing changed.

  Parameters

  • handle: number
  • edges: number[] | Uint32Array
  • cells: number[] | Uint32Array
  • islands: IslandManager
  • bodies: RigidBodySet
  • colliders: ColliderSet
  • impulseJoints: ImpulseJointSet
  • multibodyJoints: MultibodyJointSet

  Returns SoftBodyTearEvent

wakeUp

• wakeUp(handle, bodies, strong): void

• Wakes a soft body and everything it touches up.

  Parameters

  • handle: number
  • bodies: RigidBodySet
  • strong: boolean

    If true the bodies stay awake for a while even if they are at rest.

  Returns void