<World>

This component provides the basic physics context and loads rapier.

All components that rely on physics (e.g. <RigidBody> or <Collider>) must be a child of <World>.

Structure

A typical structure of a physics-enabled wrapper component might look like this:

1
<script lang="ts">
2
  import { Canvas } from '@threlte/core'
3
  import { World } from '@threlte/rapier'
4
  import Scene from './Scene.svelte'
5
</script>
6

7
<Canvas>
8
  <World>
9
    <Scene />
10
    <!-- Everything is happening inside this component -->
11
  </World>
12
</Canvas>

This structure ensures that all components inside the component <Scene> have access to the physics context.

Fallback

rapier is a Rust-based physics engine and as such bundled and used as a WASM module. If loading of rapier fails for any reason, a slot with the name fallback is mounted to e.g. display a fallback scene without physics.

1
<script lang="ts">
2
  import { Canvas } from '@threlte/core'
3
  import { World } from '@threlte/rapier'
4
  import Scene from './Scene.svelte'
5
  import FallbackScene from './FallbackScene.svelte'
6
</script>
7

8
<Canvas>
9
  <World>
10
    <Scene />
11
    {#snippet fallback()}
12
      <FallbackScene />
13
    {/snippet}
14
  </World>
15
</Canvas>

Component Signature

Props

name

type

required

default

gravity

Position

{ y: -9.81 }

rawBodies

RawRigidBodySet

rawBroadPhase

RawBroadPhase

rawCCDSolver

RawCCDSolver

rawColliders

RawColliderSet

rawDebugRenderPipeline

RawDebugRenderPipeline

rawImpulseJoints

RawImpulseJointSet

rawIntegrationParameters

RawIntegrationParameters

rawIslands

RawIslandManager

rawMultibodyJoints

RawMultibodyJointSet

rawNarrowPhase

RawNarrowPhase

rawPhysicsPipeline

RawPhysicsPipeline

rawQueryPipeline

RawQueryPipeline

rawSerializationPipeline

RawSerializationPipeline