Class SoftBody

constructor

• new SoftBody(rawSet, bodies, colliders, handle): SoftBody

• Parameters

  • rawSet: RawSoftBodySet
  • bodies: RigidBodySet
  • colliders: ColliderSet
  • handle: number

  Returns SoftBody

Readonly handle

Optional userData

addForce

• addForce(force, wakeUp): void

• Adds a force to every particle of this soft body (spread by mass).

  Parameters

  • force: Vector
  • wakeUp: boolean

  Returns void

addParticleForce

• addParticleForce(i, force, wakeUp): void

• Adds a force to the i-th particle of this soft body.

  Parameters

  • i: number
  • force: Vector
  • wakeUp: boolean

  Returns void

applyImpulse

• applyImpulse(impulse, wakeUp): void

• Applies an impulse to every particle of this soft body (spread by mass).

  Parameters

  • impulse: Vector
  • wakeUp: boolean

  Returns void

applyImpulseAtPoint

• applyImpulseAtPoint(impulse, point, falloffRadius, wakeUp): void

• Applies an impulse to the particles within falloffRadius of point, scaled down linearly with their distance to it (falloffRadius <= 0 applies it to every particle).

  Parameters

  • impulse: Vector
  • point: Vector
  • falloffRadius: number
  • wakeUp: boolean

  Returns void

applyParticleImpulse

• applyParticleImpulse(i, impulse, wakeUp): void

• Applies an impulse to the i-th particle of this soft body.

  Parameters

  • i: number
  • impulse: Vector
  • wakeUp: boolean

  Returns void

applyRadialImpulse

• applyRadialImpulse(center, magnitude, falloffRadius, wakeUp): void

• Applies an impulse of the given magnitude pushing the particles away from center (a blast), scaled down linearly up to falloffRadius.

  Parameters

  • center: Vector
  • magnitude: number
  • falloffRadius: number
  • wakeUp: boolean

  Returns void

attachParticle

• attachParticle(i, body): void

• Attaches the i-th particle to a rigid body, at the particle's current position.

  Parameters

  • i: number
  • body: RigidBody

  Returns void

attachmentBody

• attachmentBody(i): RigidBody

• The rigid body of the i-th attachment.

  Parameters

  • i: number

  Returns RigidBody

attachmentParticle

• attachmentParticle(i): number

• The particle of the i-th attachment.

  Parameters

  • i: number

  Returns number

boundary

• boundary(): Uint32Array

• The boundary elements of this soft body (segments in 2D, triangles in 3D), flattened (two or three particle indices per element), oriented outward.

  Returns Uint32Array

cellModel

• cellModel(): SoftBodyCellModel

• The constitutive model of this soft body's cells.

  Returns SoftBodyCellModel

cellRestVolume

• cellRestVolume(i): number

• The rest area/volume of the i-th cell.

  Parameters

  • i: number

  Returns number

cellStiffnessScale

• cellStiffnessScale(i): number

• The stiffness multiplier of the i-th cell.

  Parameters

  • i: number

  Returns number

cellStress

• cellStress(i): number

• The load of the i-th cell relative to its tear threshold (1 tears it).

  Parameters

  • i: number

  Returns number

cellTearResistance

• cellTearResistance(i): number

• The multiplier of the tear thresholds of the i-th cell.

  Parameters

  • i: number

  Returns number

cells

• cells(): Uint32Array

• The particles of every cell, flattened (three indices per cell in 2D, four in 3D).

  Returns Uint32Array

centerOfMass

• centerOfMass(target?): Vector

• The center of mass of this soft body's particles.

  Parameters

  • Optional target: Vector

  Returns Vector

clusterParticles

• clusterParticles(i): Uint32Array

• The particles of the i-th cluster.

  Parameters

  • i: number

  Returns Uint32Array

clusterProxy

• clusterProxy(i): RigidBody

• The rigid body standing for the i-th cluster: joints and colliders attach to it.

  Parameters

  • i: number

  Returns RigidBody

clusterShapeMatchingEnabled

• clusterShapeMatchingEnabled(i): boolean

• Does the i-th cluster hold its shape by shape matching?

  Parameters

  • i: number

  Returns boolean

detachParticle

• detachParticle(i): boolean

• Detaches the i-th particle from the rigid body it was attached to.

  Returns false if the particle was not attached.

  Parameters

  • i: number

  Returns boolean

dihedralRestAngle

• dihedralRestAngle(i): number

• The rest angle of the i-th dihedral.

  Parameters

  • i: number

  Returns number

dihedrals

• dihedrals(): Uint32Array

• The particles of every dihedral, flattened (four indices per dihedral: the shared edge, then the two opposite vertices).

  Returns Uint32Array

edgeImpulse

• edgeImpulse(i): number

• The impulse applied by the i-th edge during the last step.

  Parameters

  • i: number

  Returns number

edgePlasticStrain

• edgePlasticStrain(i): number

• The relative change of the i-th edge's rest length due to plastic flow.

  Parameters

  • i: number

  Returns number

edgeRestLength

• edgeRestLength(i): number

• The rest length of the i-th edge.

  Parameters

  • i: number

  Returns number

edgeStress

• edgeStress(i): number

• The load of the i-th edge relative to its tear threshold (1 tears it).

  Parameters

  • i: number

  Returns number

edgeTearResistance

• edgeTearResistance(i): number

• The multiplier of the tear thresholds of the i-th edge.

  Parameters

  • i: number

  Returns number

edges

• edges(): Uint32Array

• The particle pairs of every edge, flattened (two indices per edge).

  Returns Uint32Array

enableClusterShapeMatching

• enableClusterShapeMatching(i, enabled): void

• Enables or disables shape matching on the i-th cluster.

  Parameters

  • i: number
  • enabled: boolean

  Returns void

enableVolumePreservation

• enableVolumePreservation(enabled): void

• Enables or disables the global area/volume preservation of this soft body.

  Parameters

  • enabled: boolean

  Returns void

finalizeDeserialization

• finalizeDeserialization(bodies, colliders): void
• Internal

  Parameters

  • bodies: RigidBodySet
  • colliders: ColliderSet

  Returns void

gravityScale

• gravityScale(): number

• The gravity scale of this soft body's particles.

  Returns number

hasPendingTears

• hasPendingTears(): boolean

• Are there tears requested for the next step?

  Returns boolean

isClusterLive

• isClusterLive(i): boolean

• Does the i-th cluster still exist?

  Parameters

  • i: number

  Returns boolean

isEdgeBend

• isEdgeBend(i): boolean

• Is the i-th edge a bending edge (rather than a structural one)?

  Parameters

  • i: number

  Returns boolean

isEnabled

• isEnabled(): boolean

• Is this soft body enabled (simulated)?

  Returns boolean

isMeshOriented

• isMeshOriented(i): boolean

• Does the shape of the i-th collision mesh carry the ORIENTED flag (see SoftBodyDesc.setOriented)?

  Parameters

  • i: number

  Returns boolean

isMeshSkinned

• isMeshSkinned(i): boolean

• Is the i-th collision mesh skinned (embedded in the cells) rather than bound vertex-to-particle?

  Parameters

  • i: number

  Returns boolean

isParticleDamaged

• isParticleDamaged(i): boolean

• Has an element of the i-th particle torn?

  Parameters

  • i: number

  Returns boolean

isParticleOnSurface

• isParticleOnSurface(i): boolean

• Does the i-th particle lie on the body's surface?

  Parameters

  • i: number

  Returns boolean

isParticlePinned

• isParticlePinned(i): boolean

• Is the i-th particle pinned (held in place)?

  Parameters

  • i: number

  Returns boolean

isSleeping

• isSleeping(): boolean

• Is this soft body sleeping?

  Returns boolean

isValid

• isValid(): boolean

• Checks if this soft body is still valid (i.e. that it has not been deleted from the soft-body set yet).

  Returns boolean

linearDamping

• linearDamping(): number

• The linear damping of this soft body's particles.

  Returns number

mass

• mass(): number

• The total mass of this soft body's particles.

  Returns number

material

• material(): SoftBodyMaterial

• A copy of this soft body's material.

  Returns SoftBodyMaterial

meshCluster

• meshCluster(i): number

• The cluster holding the i-th collision mesh.

  Parameters

  • i: number

  Returns number

meshCollider

• meshCollider(i): Collider

• The collider holding the i-th collision mesh.

  Parameters

  • i: number

  Returns Collider

meshCollisionEnabled

• meshCollisionEnabled(i): boolean

• Does the i-th collision mesh collide?

  Parameters

  • i: number

  Returns boolean

meshIndices

• meshIndices(i): Uint32Array

• The elements of the i-th collision mesh, flattened (two vertex indices per segment in 2D, three per triangle in 3D).

  Parameters

  • i: number

  Returns Uint32Array

meshOfCollider

• meshOfCollider(collider): number

• The index of the collision mesh held by a deformable collider of this soft body.

  Parameters

  • collider: Collider

  Returns number

meshVertices

• meshVertices(i): Float32Array

• The world-space vertex positions of the i-th collision mesh, flattened.

  Parameters

  • i: number

  Returns Float32Array

numAttachments

• numAttachments(): number

• The number of particles attached to rigid bodies.

  Returns number

numCells

• numCells(): number

• The number of cells (triangles in 2D, tetrahedra in 3D) of this soft body.

  Returns number

numClusters

• numClusters(): number

• The number of cluster slots of this soft body (some may have been removed: see isClusterLive).

  Returns number

numDihedrals

• numDihedrals(): number

• The number of dihedral bending constraints of this soft body.

  Returns number

numEdges

• numEdges(): number

• The number of edges (structural and bending) of this soft body.

  Returns number

numMeshes

• numMeshes(): number

• The number of collision meshes held by this soft body's clusters (its own deformable surface included).

  Returns number

numParticles

• numParticles(): number

• The number of particles of this soft body.

  Returns number

origin

• origin(): number

• The soft body this one was split off from by a tear, if any.

  Returns number

particleMass

• particleMass(i): number

• The mass of the i-th particle.

  Parameters

  • i: number

  Returns number

particlePosition

• particlePosition(i, target?): Vector

• The world-space position of the i-th particle.

  Parameters

  • i: number
  • Optional target: Vector

  Returns Vector

particlePositions

• particlePositions(): Float32Array

• The world-space positions of every particle, flattened (two or three floats per particle).

  Returns Float32Array

particleRadius

• particleRadius(): number

• The thickness of this soft body's particles.

  Returns number

particleRestPosition

• particleRestPosition(i, target?): Vector

• The rest position of the i-th particle (the position its constraints hold it at).

  Parameters

  • i: number
  • Optional target: Vector

  Returns Vector

particleVelocities

• particleVelocities(): Float32Array

• The velocities of every particle, flattened (two or three floats per particle).

  Returns Float32Array

particleVelocity

• particleVelocity(i, target?): Vector

• The velocity of the i-th particle.

  Parameters

  • i: number
  • Optional target: Vector

  Returns Vector

pieces

• pieces(): number[]

• The handles of the soft bodies that tears split off from this one.

  Returns number[]

resetForces

• resetForces(wakeUp): void

• Resets the user forces applied to this soft body's particles.

  Parameters

  • wakeUp: boolean

  Returns void

resetPlasticity

• resetPlasticity(): void

• Forgets every plastic deformation: the rest shapes return to their initial values.

  Returns void

restVolume

• restVolume(): number

• The rest area/volume enclosed by this soft body's closed surfaces.

  Returns number

rootBody

• rootBody(): RigidBody

• The hidden rigid body standing for this soft body in joints and islands.

  Returns RigidBody

setAdditionalPgsIterations

• setAdditionalPgsIterations(iterations): void

• Sets the extra internal PGS iterations run per substep for this soft body and everything it touches.

  Parameters

  • iterations: number

  Returns void

setClusterEdgeSoftness

• setClusterEdgeSoftness(i, softness): void

• Overrides the softness of the edges of the i-th cluster (null restores the material's).

  Parameters

  • i: number
  • softness: SpringCoefficients

  Returns void

setClusterKinematicTarget

• setClusterKinematicTarget(i, translation, rotation): void

• Moves the i-th cluster rigidly to the given pose over the next step.

  Parameters

  • i: number
  • translation: Vector
  • rotation: Rotation

  Returns void

setClusterPinned

• setClusterPinned(i, pinned): void

• Pins (or releases) every particle of the i-th cluster.

  Parameters

  • i: number
  • pinned: boolean

  Returns void

setClusterStiffnessScale

• setClusterStiffnessScale(i, scale): void

• Scales the stiffness of the elements of the i-th cluster.

  Parameters

  • i: number
  • scale: number

  Returns void

setClusterTearResistance

• setClusterTearResistance(i, resistance): void

• Scales the tear thresholds of the elements of the i-th cluster.

  Parameters

  • i: number
  • resistance: number

  Returns void

setEnabled

• setEnabled(enabled): void

• Enables or disables this soft body.

  Parameters

  • enabled: boolean

  Returns void

setMaterial

• setMaterial(material): void

• Replaces this soft body's material.

  Parameters

  • material: SoftBodyMaterial

  Returns void

setParticleKinematicTarget

• setParticleKinematicTarget(i, position): void

• Moves the pinned i-th particle to position over the next step, like a position-based kinematic body (it pushes what it meets), then holds it there. Ignored for a free particle.

  Parameters

  • i: number
  • position: Vector

  Returns void

setParticlePinned

• setParticlePinned(i, pinned): void

• Pins (or releases) the i-th particle.

  Parameters

  • i: number
  • pinned: boolean

  Returns void

setParticlePosition

• setParticlePosition(i, position): void

• Sets the world-space position of the i-th particle.

  Parameters

  • i: number
  • position: Vector

  Returns void

setParticleVelocity

• setParticleVelocity(i, velocity): void

• Sets the velocity of the i-th particle.

  Parameters

  • i: number
  • velocity: Vector

  Returns void

setSolver

• setSolver(solver): void

• Sets the solver holding the cells of this soft body together.

  Parameters

  • solver: SoftBodySolver

  Returns void

setVolumeFactor

• setVolumeFactor(factor): void

• Sets the target volume multiplier of the volume preservation (> 1 inflates the body).

  Parameters

  • factor: number

  Returns void

solver

• solver(): SoftBodySolver

• The solver holding the cells of this soft body together.

  Returns SoftBodySolver

tearCell

• tearCell(i): void

• Requests the i-th cell to tear at the end of the next step.

  Parameters

  • i: number

  Returns void

tearEdge

• tearEdge(i): void

• Requests the i-th edge to tear at the end of the next step.

  Parameters

  • i: number

  Returns void

topologyVersion

• topologyVersion(): number

• A counter incremented by every change of the body's topology (tears, cuts, splits).

  Returns number

volume

• volume(): number

• The current area/volume enclosed by this soft body's closed surfaces.

  Returns number

volumeFactor

• volumeFactor(): number

• The target volume multiplier of the volume preservation (> 1 inflates the body).

  Returns number

volumePreservationEnabled

• volumePreservationEnabled(): boolean

• Is the global area/volume preservation of this soft body enabled?

  Returns boolean

wakeUp

• wakeUp(): void

• Wakes this soft body up.

  Returns void