@relu-interactives/spatial-ecs

---

@relu-interactives/spatial-ecs / index / XREnvironmentSystem

Class: XREnvironmentSystem

Defined in: systems/XREnvironmentSystem.ts:172

Implements

• EcsSystem

Constructors

Constructor

new XREnvironmentSystem(): XREnvironmentSystem;

Returns

XREnvironmentSystem

Methods

update()

update(world, deltaTime?): void;

Defined in: systems/XREnvironmentSystem.ts:201

Parameters

Parameter	Type	Default value
world	World	undefined
deltaTime	number	0

Returns

void

Implementation of

EcsSystem.update

---

getDetectedCount()

getDetectedCount(): {
  planes: number;
  meshes: number;
};

Defined in: systems/XREnvironmentSystem.ts:329

How many pieces of real geometry are currently colliding. Script-facing.

Returns

{
  planes: number;
  meshes: number;
}

Name	Type	Defined in
planes	number	systems/XREnvironmentSystem.ts:329
meshes	number	systems/XREnvironmentSystem.ts:329

---

getDebugSnapshot()

getDebugSnapshot(world): {
  kind: "plane" | "mesh";
  label: string | null;
  position: {
     x: number;
     y: number;
     z: number;
  };
  radius: number;
  emulated: boolean;
}[];

Defined in: systems/XREnvironmentSystem.ts:340

A census of every surface currently spawned: what it is, where it sits and roughly how big it is. Built for the template's post-session readout, so a mystery shape on the headset can be looked up by its label instead of guessed at — a small-radius entry at head height IS the mystery shape, and a clean list means whatever was seen did not come from this system.

Parameters

Parameter	Type
world	World

Returns

---

dispose()

dispose(world): void;

Defined in: systems/XREnvironmentSystem.ts:911

Parameters

Parameter	Type
world	World

Returns

void

Implementation of

EcsSystem.dispose