Relu Spatial Docs

Appearance

Component Catalog ​

Every entity in @relu-interactives/spatial-ecs is a bag of components. This catalog is a directory of every component shipped in the package, grouped by responsibility. Each entry below has a dedicated page with a screenshot of the editor inspector and a full property reference.

Component Catalog Image

TIP

Browsing the API? The auto-generated TypeDoc reference for every component class lives under API Reference → components.

Identity & hierarchy ​

  • Name — human-readable label shown in the editor hierarchy.
  • Entity Type — tag identifying which factory created the entity.
  • Parent — parent entity reference; reconciled into the three.js scene graph each frame.

Transform & motion ​

Rendering ​

  • Mesh — primitive mesh Object3D.
  • Mesh Geometry — editable parametric geometry (cube, sphere, plane, capsule, cylinder).
  • Material — material catalog and texture maps.
  • Image — 2D image rendered as a textured quad.
  • Sprite — camera-facing billboard.
  • Video — video texture with optional green-screen keying.
  • Model — GLTF/GLB asset reference loaded asynchronously.
  • Instanced Mesh — groups instance-slot entities into a single GPU-instanced draw call for high-count identical objects.
  • Instance Slot — marks an entity as a single instance within an InstancedMeshComponent group.

Lighting & atmosphere ​

  • Light — directional, point, spot, ambient, hemisphere, or rect-area light.
  • Environment — singleton skybox, fog, and gravity state.
  • Postprocessing — singleton postprocessing stack (bloom, DoF, vignette, tonemap, etc.).
  • Camera — perspective/orthographic camera with 3d/ar runtime modes.

Audio ​

  • Audio — audio clip with positional/listener options.

Physics ​

  • Physics — combined Rapier rigid body (dynamic, fixed, kinematic) and collider (cuboid, ball, capsule, cylinder, trimesh) with per-axis motion locks and sensor support.

AR & image tracking ​

Animation ​

  • Animation — clip catalog and AnimationStateMachine.

Scripts ​

  • Script — authored behaviour scripts attached to an entity.