Rapier 3D JavaScript

https://rapier.rs/javascript3d/
Admin
Rapier 3D is a physics engine library for JavaScript that provides rigid body dynamics, collision...
Tokens:206,680
Snippets:2,509
Trust Score:7.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### setUp

Source: https://rapier.rs/javascript3d/classes/KinematicCharacterController.html

Sets the up vector of the character controller.

```APIDOC
## setUp

### Description
Sets the up vector of the character controller.

### Method
setUp

### Parameters
- **up** (Vector) - Required - The up vector.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### setUp(vector): void

Source: https://rapier.rs/javascript3d/classes/KinematicCharacterController.html

Sets the up direction vector.

```APIDOC
## setUp(vector): void

### Description
Sets the direction that goes "up". Used to determine where the floor is, and the floor's angle.

### Method
setUp

### Parameters
- **vector** (Vector) - Required - The up direction vector.

### Returns
void
```

--------------------------------

### get

Source: https://rapier.rs/javascript3d/classes/SoftBodySet.html

Gets a soft body by its handle.

```APIDOC
## get

### Description
Gets a soft body by its handle.

### Method
get

### Parameters
No parameters documented.

### Returns
No return value documented.
```

--------------------------------

### get

Source: https://rapier.rs/javascript3d/classes/SoftBodySet.html

Gets the soft body with the given handle.

```APIDOC
## get

### Description
Gets the soft body with the given handle.

### Method
get

### Signature
get(handle): SoftBody

### Parameters
- **handle** (number) - Required - The handle of the soft body.

### Returns
- **SoftBody** - The soft body with the given handle.
```

--------------------------------

### get

Source: https://rapier.rs/javascript3d/classes/RigidBodySet.html

Gets the rigid body with the given handle.

```APIDOC
## get

### Description
Gets the rigid-body with the given handle.

### Method
get

### Signature
get(handle): RigidBody

### Parameters
- **handle** (number) - Required - The handle of the rigid-body to retrieve.

### Returns
RigidBody
```

--------------------------------

### new World(gravity, rawIntegrationParameters?, rawIslands?, rawBroadPhase?, rawNarrowPhase?, rawBodies?, rawColliders?, rawSoftBodies?, rawImpulseJoints?, rawMultibodyJoints?, rawCCDSolver?, rawPhysicsPipeline?, rawSerializationPipeline?, rawDebugRenderPipeline?)

Source: https://rapier.rs/javascript3d/classes/World.html

Creates a new physics world with the specified gravity and optional raw handles to underlying physics engine components. This constructor initializes all the physics subsystems required for simulation.

```APIDOC
## new World(gravity, rawIntegrationParameters?, rawIslands?, rawBroadPhase?, rawNarrowPhase?, rawBodies?, rawColliders?, rawSoftBodies?, rawImpulseJoints?, rawMultibodyJoints?, rawCCDSolver?, rawPhysicsPipeline?, rawSerializationPipeline?, rawDebugRenderPipeline?)

### Description
Creates a new physics world with the specified gravity and optional raw handles to underlying physics engine components. This constructor initializes all the physics subsystems required for simulation.

### Method
Constructor

### Parameters
- **gravity** (Vector) - Required - The gravity vector applied to all bodies in the world.
- **rawIntegrationParameters** (RawIntegrationParameters) - Optional - Raw handle to integration parameters.
- **rawIslands** (RawIslandManager) - Optional - Raw handle to island manager.
- **rawBroadPhase** (RawBroadPhase) - Optional - Raw handle to broad phase.
- **rawNarrowPhase** (RawNarrowPhase) - Optional - Raw handle to narrow phase.
- **rawBodies** (RawRigidBodySet) - Optional - Raw handle to rigid body set.
- **rawColliders** (RawColliderSet) - Optional - Raw handle to collider set.
- **rawSoftBodies** (RawSoftBodySet) - Optional - Raw handle to soft body set.
- **rawImpulseJoints** (RawImpulseJointSet) - Optional - Raw handle to impulse joint set.
- **rawMultibodyJoints** (RawMultibodyJointSet) - Optional - Raw handle to multibody joint set.
- **rawCCDSolver** (RawCCDSolver) - Optional - Raw handle to CCD solver.
- **rawPhysicsPipeline** (RawPhysicsPipeline) - Optional - Raw handle to physics pipeline.
- **rawSerializationPipeline** (RawSerializationPipeline) - Optional - Raw handle to serialization pipeline.
- **rawDebugRenderPipeline** (RawDebugRenderPipeline) - Optional - Raw handle to debug render pipeline.

### Returns
- **World** - The newly created World instance.
```

--------------------------------

### get(handle)

Source: https://rapier.rs/javascript3d/classes/ColliderSet.html

Gets the collider with the given handle.

```APIDOC
## get(handle)

### Description
Gets the collider with the given handle.

### Parameters
- **handle** (number) - Required - The handle of the collider to retrieve.

### Returns
- **Collider** - The collider with the given handle.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/SerializationPipeline.html

Creates a new SerializationPipeline instance. Optionally accepts a raw RawSerializationPipeline.

```APIDOC
## constructor

### Description
Creates a new SerializationPipeline instance.

### Method
constructor

### Signature
new SerializationPipeline(raw?): SerializationPipeline

### Parameters
- **raw** (RawSerializationPipeline) - Optional - The raw serialization pipeline.

### Returns
SerializationPipeline
```

--------------------------------

### get

Source: https://rapier.rs/javascript3d/classes/ImpulseJointSet.html

Gets the joint with the given handle. Returns null if no joint with the specified handle exists.

```APIDOC
## get

### Description
Gets the joint with the given handle. Returns null if no joint with the specified handle exists.

### Method
get

### Signature
get(handle): ImpulseJoint

### Parameters
- **handle** (number) - Required - The integer handle of the joint to retrieve.

### Returns
ImpulseJoint
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/SdpMatrix3Ops.html

Creates a new SdpMatrix3Ops instance.

```APIDOC
## constructor

### Description
Creates a new SdpMatrix3Ops instance.

### Method
constructor

### Signature
new SdpMatrix3Ops(): SdpMatrix3Ops

### Returns
SdpMatrix3Ops
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/NarrowPhase.html

Creates a new NarrowPhase instance.

```APIDOC
## constructor

### Description
Creates a new NarrowPhase instance.

### Method
constructor

### Parameters
- `raw` (RawNarrowPhase) - Optional - The raw narrow-phase object.

### Returns
NarrowPhase
```

--------------------------------

### indexForwardAxis (get)

Source: https://rapier.rs/javascript3d/classes/DynamicRayCastVehicleController.html

Gets the chassis’ local forward direction (0 = x, 1 = y, 2 = z).

```APIDOC
## indexForwardAxis (get)

### Description
The chassis’ local _forward_ direction (`0 = x, 1 = y, 2 = z`).

### Method
get indexForwardAxis()

### Returns
number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/BroadPhase.html

Creates a new BroadPhase instance.

```APIDOC
## constructor

### Description
Creates a new BroadPhase instance. Optionally accepts a raw broad-phase object.

### Method
constructor

### Parameters
- `raw` (RawBroadPhase) - Optional - The raw broad-phase object.

### Returns
BroadPhase
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript3d/classes/ImpulseJointSet.html

Gets all joints in the list.

```APIDOC
## getAll

### Description
Gets all joints in the list.

### Method
getAll

### Signature
getAll(): ImpulseJoint[]

### Returns
ImpulseJoint[] - joint list.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/SoftMeshBinding.html

Creates a new SoftMeshBinding instance with the specified binding mode.

```APIDOC
## constructor

### Description
Creates a new SoftMeshBinding instance with the specified binding mode.

### Signature
`new SoftMeshBinding(mode): SoftMeshBinding`

### Parameters
- **mode** (SoftMeshBindingMode) - The binding mode to use.

### Returns
- **SoftMeshBinding** - The new SoftMeshBinding instance.
```

--------------------------------

### shape

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the shape of this collider.

```APIDOC
## shape

### Description
The shape of this collider.

### Accessor
get shape(): Shape

### Returns
Shape
```

--------------------------------

### wakeUp(): void

Source: https://rapier.rs/javascript3d/classes/SoftBody.html

Wakes this soft body up.

```APIDOC
## wakeUp(): void

### Description
Wakes this soft body up.

### Method
wakeUp

### Returns
void
```

--------------------------------

### volume

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the volume of the collider.

```APIDOC
## volume

### Description
Gets the volume of the collider.

### Method
volume

### Returns
Number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/RigidBodySet.html

Creates a new RigidBodySet instance. Optionally accepts a raw RigidBodySet.

```APIDOC
## constructor

### Description
Creates a new RigidBodySet instance.

### Method
constructor

### Signature
new RigidBodySet(raw?): RigidBodySet

### Parameters
- **raw** (RawRigidBodySet) - Optional - The raw rigid body set.

### Returns
RigidBodySet
```

--------------------------------

### vertices

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the vertices of the collider.

```APIDOC
## vertices

### Description
Gets the vertices of the collider.

### Method
vertices

### Returns
Array
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/SoftBody.html

Creates a new SoftBody instance.

```APIDOC
## constructor

### Description
Creates a new SoftBody instance.

### Method
constructor

### Signature
new SoftBody(rawSet, bodies, colliders, handle): SoftBody

### Parameters
- **rawSet** (RawSoftBodySet) - Required - The raw soft body set.
- **bodies** (RigidBodySet) - Required - The rigid body set.
- **colliders** (ColliderSet) - Required - The collider set.
- **handle** (number) - Required - The handle for this soft body.

### Returns
SoftBody
```

--------------------------------

### translation

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the translation of the collider.

```APIDOC
## translation

### Description
Gets the translation of the collider.

### Method
translation

### Returns
Vector
```

--------------------------------

### version(): string

Source: https://rapier.rs/javascript3d/functions/version.html

Returns the version of the rapier3d library as a string.

```APIDOC
## version(): string

### Description
Returns the version of the rapier3d library as a string.

### Method
version

### Signature
version(): string

### Returns
- **string** - The version string of the library.

```

--------------------------------

### rotation

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the rotation of the collider.

```APIDOC
## rotation

### Description
Gets the rotation of the collider.

### Method
rotation

### Returns
Rotation
```

--------------------------------

### radius

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the radius of the collider.

```APIDOC
## radius

### Description
Gets the radius of the collider.

### Method
radius

### Returns
Number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/DebugRenderPipeline.html

Creates a new DebugRenderPipeline instance. Optionally accepts a raw RawDebugRenderPipeline object.

```APIDOC
## constructor

### Description
Creates a new DebugRenderPipeline instance.

### Method
constructor

### Parameters
- **raw** (RawDebugRenderPipeline) - Optional - The raw debug render pipeline object.

### Returns
DebugRenderPipeline

```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/HalfSpace.html

Creates a new halfspace delimited by an infinite plane.

```APIDOC
## new HalfSpace(normal)

### Description
Creates a new halfspace delimited by an infinite plane.

### Parameters
- **normal** (Vector) - The outward normal of the plane.

### Returns
- **HalfSpace** - The newly created halfspace.
```

--------------------------------

### mass

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the mass of the collider.

```APIDOC
## mass

### Description
Gets the mass of the collider.

### Method
mass

### Returns
Number
```

--------------------------------

### indices

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the indices of the collider.

```APIDOC
## indices

### Description
Gets the indices of the collider.

### Method
indices

### Returns
Uint32Array
```

--------------------------------

### Methods

Source: https://rapier.rs/javascript3d/classes/SoftRecoverySettings.html

Methods to convert SoftRecoverySettings to and from raw settings.

```APIDOC
## intoRaw()

### Description
Converts the SoftRecoverySettings into a raw representation.

### Returns
- **RawSoftRecoverySettings** - The raw settings object.

## fromRaw(raw)

### Description
Creates a SoftRecoverySettings from a raw settings object.

### Parameters
- **raw** (RawSoftRecoverySettings) - The raw settings to convert.

### Returns
- **SoftRecoverySettings** - A new SoftRecoverySettings instance.
```

--------------------------------

### heightfieldScale

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the scale of the heightfield.

```APIDOC
## heightfieldScale

### Description
Gets the scale of the heightfield.

### Method
heightfieldScale

### Returns
Vector
```

--------------------------------

### new SoftRecoverySettings()

Source: https://rapier.rs/javascript3d/classes/SoftRecoverySettings.html

Creates a new SoftRecoverySettings instance with default settings.

```APIDOC
## new SoftRecoverySettings()

### Description
Creates a new SoftRecoverySettings instance with default settings.

### Constructor
`new SoftRecoverySettings()`

### Returns
- **SoftRecoverySettings** - A new instance of SoftRecoverySettings.
```

--------------------------------

### new Ray(origin, dir)

Source: https://rapier.rs/javascript3d/classes/Ray.html

Builds a ray from its origin and direction.

```APIDOC
## new Ray(origin, dir)

### Description
Builds a ray from its origin and direction.

### Parameters
- **origin** (Vector) - Required - The ray's starting point.
- **dir** (Vector) - Required - The ray's direction of propagation.

### Returns
- **Ray** - The constructed ray.
```

--------------------------------

### density

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the density of the collider.

```APIDOC
## density

### Description
Gets the density of the collider.

### Method
density

### Returns
Number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/IntegrationParameters.html

Creates a new IntegrationParameters instance. Optionally accepts a raw integration parameters object.

```APIDOC
## constructor

### Description
Creates a new IntegrationParameters instance.

### Parameters
- `raw` (RawIntegrationParameters) - Optional - Raw integration parameters.

### Returns
IntegrationParameters
```

--------------------------------

### shape

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the shape of the collider.

```APIDOC
## shape

### Description
Gets the shape of the collider.

### Accessor
shape

### Returns
Shape
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/PhysicsPipeline.html

Creates a new PhysicsPipeline instance. Optionally accepts a raw pointer to an existing pipeline.

```APIDOC
## constructor

### Description
Creates a new PhysicsPipeline instance. Optionally accepts a raw pointer to an existing pipeline.

### Method
constructor

### Signature
`new PhysicsPipeline(raw?): PhysicsPipeline`

### Parameters
- `raw` (RawPhysicsPipeline) - Optional - Raw pointer to an existing pipeline.

### Returns
- `PhysicsPipeline` - The new pipeline instance.
```

--------------------------------

### getAll()

Source: https://rapier.rs/javascript3d/classes/ColliderSet.html

Gets all colliders in the list.

```APIDOC
## getAll()

### Description
Gets all colliders in the list.

### Returns
- **Collider[]** - The list of all colliders.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/CharacterCollision.html

Creates a new CharacterCollision instance.

```APIDOC
## constructor

### Description
Creates a new CharacterCollision instance.

### Method
constructor

### Signature
new CharacterCollision(): CharacterCollision

### Returns
- **CharacterCollision** - The newly created CharacterCollision instance.
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript3d/classes/SoftBodySet.html

Gets all soft bodies in the list.

```APIDOC
## getAll

### Description
Gets all soft bodies in the list.

### Method
getAll

### Signature
getAll(): SoftBody[]

### Returns
- **SoftBody[]** - An array of all soft bodies.
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript3d/classes/SoftBodySet.html

Gets all soft bodies in the set.

```APIDOC
## getAll

### Description
Gets all soft bodies in the set.

### Method
getAll

### Parameters
No parameters documented.

### Returns
No return value documented.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/UnitImpulseJoint.html

Creates a new UnitImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new UnitImpulseJoint instance.

### Method
constructor

### Signature
`new UnitImpulseJoint(rawSet, bodySet, handle): UnitImpulseJoint`

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle of the joint.

### Returns
- **UnitImpulseJoint** - The new joint instance.
```

--------------------------------

### Static fromRaw

Source: https://rapier.rs/javascript3d/classes/SdpMatrix3Ops.html

Creates a SdpMatrix3 from a RawSdpMatrix3.

```APIDOC
## Static fromRaw

### Description
Creates a SdpMatrix3 from a RawSdpMatrix3.

### Method
Static fromRaw

### Signature
fromRaw(raw): SdpMatrix3

### Parameters
- **raw** (RawSdpMatrix3) - Required - The raw matrix data.

### Returns
SdpMatrix3
```

--------------------------------

### collider

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the collider at the given index.

```APIDOC
## collider

### Description
Gets the collider at the given index.

### Method
collider

### Parameters
- **i** (number) - The index of the collider.

### Returns
- **Collider** - The collider at the given index.
```

--------------------------------

### mass

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the mass of the rigid body.

```APIDOC
## mass

### Description
Gets the mass of the rigid body.

### Method
mass

### Parameters
- None

### Returns
- **number** - The mass.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/RotationOps.html

Creates a new RotationOps instance.

```APIDOC
## new RotationOps()

### Description
Creates a new RotationOps instance.

### Returns
- RotationOps
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/RevoluteImpulseJoint.html

Creates a new RevoluteImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new RevoluteImpulseJoint instance.

### Method
constructor

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle of the joint.

### Returns
- **RevoluteImpulseJoint** - The new joint instance.
```

--------------------------------

### rotation

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the rotation of the rigid body.

```APIDOC
## rotation

### Description
Gets the rotation of the rigid body.

### Method
rotation

### Parameters
- None

### Returns
- **Quaternion** - The rotation quaternion.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/ShapeCastHit.html

Creates a new ShapeCastHit instance with the given time of impact, witness points, and normals.

```APIDOC
## constructor

### Description
Creates a new ShapeCastHit instance with the given time of impact, witness points, and normals.

### Method
constructor

### Signature
`new ShapeCastHit(time_of_impact, witness1, witness2, normal1, normal2): ShapeCastHit`

### Parameters
- **time_of_impact** (number) - Required - The time of impact of the two shapes.
- **witness1** (Vector) - Required - The contact point on the first shape at the time of impact, expressed in the local-space of the first shape.
- **witness2** (Vector) - Required - The contact point on the second shape at the time of impact, expressed in the local-space of the second shape.
- **normal1** (Vector) - Required - The outward normal on the first shape at the time of impact, expressed in the local-space of the first shape.
- **normal2** (Vector) - Required - The outward normal on the second shape at the time of impact, expressed in the local-space of the second shape.

### Returns
- **ShapeCastHit** - The newly created ShapeCastHit instance.
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript3d/classes/RigidBodySet.html

Gets all rigid bodies in the set.

```APIDOC
## getAll

### Description
Gets all rigid-bodies in the list.

### Method
getAll

### Signature
getAll(): RigidBody[]

### Returns
RigidBody[] - rigid-bodies list.
```

--------------------------------

### activeEvents

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the events active for this collider.

```APIDOC
## activeEvents()

### Description
The events active for this collider.

### Method
activeEvents

### Returns
ActiveEvents
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/PrismaticImpulseJoint.html

Creates a new PrismaticImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new PrismaticImpulseJoint instance.

### Method
constructor

### Signature
`new PrismaticImpulseJoint(rawSet, bodySet, handle): PrismaticImpulseJoint`

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle of the joint.

### Returns
- **PrismaticImpulseJoint** - The new joint instance.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/RopeImpulseJoint.html

Creates a new RopeImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new RopeImpulseJoint instance.

### Method
constructor

### Signature
`new RopeImpulseJoint(rawSet, bodySet, handle): RopeImpulseJoint`

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle of the joint.

### Returns
- **RopeImpulseJoint** - The new joint instance.
```

--------------------------------

### solverGroups

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the solver groups of the collider.

```APIDOC
## solverGroups

### Description
Gets the solver groups of the collider.

### Method
solverGroups

### Returns
InteractionGroups
```

--------------------------------

### shapeType

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the shape type of the collider.

```APIDOC
## shapeType

### Description
Gets the shape type of the collider.

### Method
shapeType

### Returns
ShapeType
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/PidController.html

Creates a new PidController instance with the given parameters, bodies, and PID gains.

```APIDOC
## constructor

### Description
Creates a new PidController instance.

### Signature
`new PidController(params, bodies, kp, ki, kd, axes): PidController`

### Parameters
- **params** (IntegrationParameters) - Required - The integration parameters.
- **bodies** (RigidBodySet) - Required - The set of rigid bodies.
- **kp** (number) - Required - Proportional gain.
- **ki** (number) - Required - Integral gain.
- **kd** (number) - Required - Derivative gain.
- **axes** (PidAxesMask) - Required - The axes mask for PID control.

### Returns
- **PidController** - The new PidController instance.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/SoftBodySet.html

Creates a new SoftBodySet instance. Optionally accepts a raw RawSoftBodySet object.

```APIDOC
## constructor

### Description
Creates a new SoftBodySet instance.

### Method
constructor

### Signature
`new SoftBodySet(raw?: RawSoftBodySet): SoftBodySet`

### Parameters
- **raw** (RawSoftBodySet) - Optional - A raw soft body set object.

### Returns
- **SoftBodySet** - The new SoftBodySet instance.
```

--------------------------------

### roundRadius

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the round radius of the collider.

```APIDOC
## roundRadius

### Description
Gets the round radius of the collider.

### Method
roundRadius

### Returns
Number
```

--------------------------------

### restitution

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the restitution coefficient of the collider.

```APIDOC
## restitution

### Description
Gets the restitution coefficient of the collider.

### Method
restitution

### Returns
Number
```

--------------------------------

### free

Source: https://rapier.rs/javascript3d/classes/World.html

Release the WASM memory occupied by this physics world.

```APIDOC
## free

### Description
Release the WASM memory occupied by this physics world.
All the fields of this physics world will be freed as well, so there is no need to call their `.free()` methods individually.

### Method
free

### Signature
free(): void

### Returns
void
```

--------------------------------

### heightfieldNRows

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the number of rows in the heightfield.

```APIDOC
## heightfieldNRows

### Description
Gets the number of rows in the heightfield.

### Method
heightfieldNRows

### Returns
Number
```

--------------------------------

### new IslandManager(raw?)

Source: https://rapier.rs/javascript3d/classes/IslandManager.html

Constructs a new IslandManager instance. Optionally accepts a raw island manager. The instance must be freed manually with free() to avoid leaking WASM resources.

```APIDOC
## new IslandManager(raw?)

### Description
Constructs a new IslandManager instance. Optionally accepts a raw island manager. The instance must be freed manually with free() to avoid leaking WASM resources.

### Method
constructor

### Parameters
- **raw** (RawIslandManager) - Optional - The raw island manager.

### Returns
IslandManager
```

--------------------------------

### new CCDSolver(raw?)

Source: https://rapier.rs/javascript3d/classes/CCDSolver.html

Creates a new CCDSolver instance. Optionally accepts a raw RawCCDSolver object.

```APIDOC
## new CCDSolver(raw?)

### Description
Creates a new CCDSolver instance. Optionally accepts a raw RawCCDSolver object.

### Constructor
`new CCDSolver(raw?)`

### Parameters
- **raw** (RawCCDSolver) - Optional - The raw CCD solver object.

### Returns
- **CCDSolver** - The new CCDSolver instance.
```

--------------------------------

### heightfieldNCols

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the number of columns in the heightfield.

```APIDOC
## heightfieldNCols

### Description
Gets the number of columns in the heightfield.

### Method
heightfieldNCols

### Returns
Number
```

--------------------------------

### heightfieldHeights

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the heightfield heights of the collider.

```APIDOC
## heightfieldHeights

### Description
Gets the heightfield heights of the collider.

### Method
heightfieldHeights

### Returns
Float32Array
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/DynamicRayCastVehicleController.html

Creates a new DynamicRayCastVehicleController instance with the given chassis and physics world components.

```APIDOC
## constructor

### Description
Creates a new DynamicRayCastVehicleController instance.

### Method
constructor

### Parameters
- **chassis** (RigidBody) - Required - The rigid body representing the vehicle chassis.
- **broadPhase** (BroadPhase) - Required - The broad phase of the physics world.
- **narrowPhase** (NarrowPhase) - Required - The narrow phase of the physics world.
- **bodies** (RigidBodySet) - Required - The set of rigid bodies in the world.
- **colliders** (ColliderSet) - Required - The set of colliders in the world.

### Returns
DynamicRayCastVehicleController
```

--------------------------------

### createRigidBody

Source: https://rapier.rs/javascript3d/classes/RigidBodySet.html

Creates a new rigid body and returns it.

```APIDOC
## createRigidBody

### Description
Creates a new rigid-body and return its integer handle.

### Method
createRigidBody

### Signature
createRigidBody(colliderSet, desc): RigidBody

### Parameters
- **colliderSet** (ColliderSet) - Required - The collider set.
- **desc** (RigidBodyDesc) - Required - The description of the rigid-body to create.

### Returns
RigidBody
```

--------------------------------

### halfHeight

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the half height of the collider.

```APIDOC
## halfHeight

### Description
Gets the half height of the collider.

### Method
halfHeight

### Returns
Number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/PointProjection.html

Creates a new PointProjection instance with the given point and isInside flag.

```APIDOC
## constructor

### Description
Creates a new PointProjection instance.

### Signature
`new PointProjection(point: Vector, isInside: boolean): PointProjection`

### Parameters
- **point** (Vector) - Required - The projection of the point on the collider.
- **isInside** (boolean) - Required - Whether the point is inside the collider.

### Returns
- **PointProjection** - The newly created PointProjection instance.
```

--------------------------------

### halfExtents

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the half extents of the collider.

```APIDOC
## halfExtents

### Description
Gets the half extents of the collider.

### Method
halfExtents

### Returns
Vector
```

--------------------------------

### friction

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the friction coefficient of the collider.

```APIDOC
## friction

### Description
Gets the friction coefficient of the collider.

### Method
friction

### Returns
Number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/Voxels.html

Creates a new shape made of voxels.

```APIDOC
## constructor

### Description
Creates a new shape made of voxels.

### Method
constructor

### Signature
new Voxels(data, voxelSize): Voxels

### Parameters
- **data** (Int32Array | Float32Array) - Required - Defines the set of voxels. If this is a `Int32Array` then each voxel is defined from its (signed) grid coordinates, with 3 (resp 2) contiguous integers per voxel in 3D (resp 2D). If this is a `Float32Array`, each voxel will be such that they contain at least one point from this array (where each point is defined from 3 (resp 2) contiguous numbers per point in 3D (resp 2D).
- **voxelSize** (Vector) - Required - The size of each voxel.

### Returns
- **Voxels** - The newly created Voxels shape.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/Cuboid.html

Creates a new 3D cuboid with specified half-width, half-height, and half-depth.

```APIDOC
## constructor

### Description
Creates a new 3D cuboid with the given half-extents.

### Method
constructor

### Parameters
- **hx** (number) - Required - The half width of the cuboid.
- **hy** (number) - Required - The half height of the cuboid.
- **hz** (number) - Required - The half depth of the cuboid.

### Returns
- **Cuboid** - The newly created cuboid.
```

--------------------------------

### contactSkin

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the contact skin of the collider.

```APIDOC
## contactSkin

### Description
Gets the contact skin of the collider.

### Method
contactSkin

### Returns
Number
```

--------------------------------

### collisionGroups

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the collision groups of the collider.

```APIDOC
## collisionGroups

### Description
Gets the collision groups of the collider.

### Method
collisionGroups

### Returns
InteractionGroups
```

--------------------------------

### fromRaw

Source: https://rapier.rs/javascript3d/classes/RayColliderHit.html

Static method to create a RayColliderHit from raw data.

```APIDOC
## fromRaw

### Description
Static method to create a RayColliderHit from raw data.

### Method
fromRaw (static)

### Signature
fromRaw(colliderSet, raw): RayColliderHit

### Parameters
- **colliderSet** (ColliderSet) - Required - The collider set containing the collider.
- **raw** (RawRayColliderHit) - Required - The raw ray collider hit data.

### Returns
RayColliderHit
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/FixedImpulseJoint.html

Creates a new FixedImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new FixedImpulseJoint instance.

### Method
constructor

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle for the joint.

### Returns
- **FixedImpulseJoint** - The new joint instance.
```

--------------------------------

### activeHooks

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the active hooks of the collider.

```APIDOC
## activeHooks

### Description
Gets the active hooks of the collider.

### Method
activeHooks

### Returns
ActiveHooks
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/RoundTriangle.html

Creates a new triangle shape with round corners.

```APIDOC
## constructor

### Description
Creates a new triangle shape with round corners.

### Signature
`new RoundTriangle(a, b, c, borderRadius): RoundTriangle`

### Parameters
- **a** (Vector) - Required - The first point of the triangle.
- **b** (Vector) - Required - The second point of the triangle.
- **c** (Vector) - Required - The third point of the triangle.
- **borderRadius** (number) - Required - The radius of the borders of this triangle. In 3D, this is also equal to half the thickness of the triangle.

### Returns
- **RoundTriangle** - The newly created triangle shape.
```

--------------------------------

### activeEvents

Source: https://rapier.rs/javascript3d/classes/Collider.html

Gets the active events of the collider.

```APIDOC
## activeEvents

### Description
Gets the active events of the collider.

### Method
activeEvents

### Returns
ActiveEvents
```

--------------------------------

### timingVelocityAssembly()

Source: https://rapier.rs/javascript3d/classes/World.html

Returns the time spent in milliseconds by the last step to run the constraint initialization. This timing is included in timingSolver. Only works if the internal profiler is enabled with World.profilerEnabled = true.

```APIDOC
## timingVelocityAssembly()

### Description
Returns the time spent in milliseconds by the last step to run the constraint initialization. This timing is included in `timingSolver`. Only works if the internal profiler is enabled with `World.profilerEnabled = true`.

### Method
`timingVelocityAssembly`

### Signature
`timingVelocityAssembly(): number`

### Parameters
None

### Returns
- **number** - The time spent in milliseconds by the last step to run the constraint initialization.
```

--------------------------------

### timestep

Source: https://rapier.rs/javascript3d/classes/World.html

Gets or sets the current simulation timestep.

```APIDOC
## timestep

### Description
Gets or sets the current simulation timestep.

### Getter
- **get timestep(): number** - Returns the current timestep.

### Setter
- **set timestep(dt: number): void** - Sets the new simulation timestep.

#### Parameters
- **dt** (number) - Required - The timestep length, in seconds.

### Returns
- **number** (getter) - The current timestep.
- **void** (setter)
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/RoundCylinder.html

Creates a new RoundCylinder with the given half-height, radius, and border radius.

```APIDOC
## constructor

### Description
Creates a new cylinder with the given radius and half-height.

### Method
constructor

### Signature
new RoundCylinder(halfHeight, radius, borderRadius): RoundCylinder

### Parameters
- **halfHeight** (number) - Required - The balls half-height along the `y` axis.
- **radius** (number) - Required - The balls radius.
- **borderRadius** (number) - Required - The radius of the borders of this cylinder.

### Returns
RoundCylinder
```

--------------------------------

### new

Source: https://rapier.rs/javascript3d/classes/VectorOps.html

Creates a new Vector with the given x, y, and z components.

```APIDOC
## new(x, y, z)

### Description
Creates a new Vector with the given x, y, and z components.

### Parameters
- **x** (number) - Required - The x component.
- **y** (number) - Required - The y component.
- **z** (number) - Required - The z component.

### Returns
- Vector
```

--------------------------------

### get type

Source: https://rapier.rs/javascript3d/classes/Shape.html

Returns the concrete type of this shape.

```APIDOC
## get type

### Description
Returns the concrete type of this shape.

### Method
get

### Returns
- **ShapeType** - The concrete type of this shape.

```

--------------------------------

### constructor

Source: https://rapier.rs/javascript3d/classes/VectorOps.html

Creates a new VectorOps instance. This constructor is not typically used directly as all methods are static.

```APIDOC
## new VectorOps()

### Description
Creates a new VectorOps instance. This constructor is not typically used directly as all methods are static.

### Returns
- VectorOps
```

--------------------------------

### softCcdPrediction

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the soft-CCD prediction distance for this rigid-body.

```APIDOC
## softCcdPrediction

### Description
Gets the soft-CCD prediction distance for this rigid-body. See the documentation of `RigidBodyDesc.setSoftCcdPrediction` for additional details.

### Method
softCcdPrediction

### Parameters
None

### Returns
number
```

--------------------------------

### enableSnapToGround

Source: https://rapier.rs/javascript3d/classes/KinematicCharacterController.html

Enables snap-to-ground with the given distance.

```APIDOC
## enableSnapToGround

### Description
Enables snap-to-ground with the given distance.

### Method
enableSnapToGround

### Parameters
- **distance** (number) - Required - The snap-to-ground distance.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### dominanceGroup

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the dominance group of the rigid body.

```APIDOC
## dominanceGroup

### Description
Gets the dominance group of the rigid body.

### Method
dominanceGroup

### Parameters
- None

### Returns
- **number** - The dominance group.
```

--------------------------------

### bodyType

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the body type of the rigid body.

```APIDOC
## bodyType

### Description
Gets the body type of the rigid body.

### Method
bodyType

### Parameters
- None

### Returns
- **RigidBodyType** - The body type.
```

--------------------------------

### wakeUp

Source: https://rapier.rs/javascript3d/classes/SoftBodySet.html

Wakes a soft body and everything it touches up.

```APIDOC
## wakeUp

### Description
Wakes a soft body and everything it touches up.

### Method
wakeUp

### Signature
wakeUp(handle, bodies, strong): void

### Parameters
- **handle** (number) - Required - The handle of the soft body.
- **bodies** (RigidBodySet) - Required - The set of rigid bodies.
- **strong** (boolean) - Required - If `true` the bodies stay awake for a while even if they are at rest.

### Returns
- **void**
```

--------------------------------

### free

Source: https://rapier.rs/javascript3d/classes/PhysicsPipeline.html

Frees the underlying resources of the PhysicsPipeline instance.

```APIDOC
## free

### Description
Frees the underlying resources of the PhysicsPipeline instance.

### Method
free

### Signature
`free(): void`

### Returns
- `void`
```

--------------------------------

### principalInertia

Source: https://rapier.rs/javascript3d/classes/RigidBody.html

Gets the principal inertia of the rigid body.

```APIDOC
## principalInertia

### Description
Gets the principal inertia of the rigid body.

### Method
principalInertia

### Parameters
- None

### Returns
- **Vector** - The principal inertia vector.
```

--------------------------------

### Static restoreSnapshot(data)

Source: https://rapier.rs/javascript3d/classes/World.html

Creates a new physics world from a snapshot. This new physics world will be an identical copy of the snapshoted physics world.

```APIDOC
## Static restoreSnapshot(data)

### Description
Creates a new physics world from a snapshot. This new physics world will be an identical copy of the snapshoted physics world.

### Method
`restoreSnapshot` (static)

### Signature
`restoreSnapshot(data): World`

### Parameters
- **data** (Uint8Array) - Required - The snapshot data.

### Returns
- **World** - A new physics world that is an identical copy of the snapshoted physics world.
```
Tokens:
Raw