@relu-interactives/spatial-ecs

---

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

Class: ObjectManagementSystem

Defined in: systems/ObjectManagementSystem.ts:112

Implements

• EcsSystem

Constructors

Constructor

new ObjectManagementSystem(
   scene, 
   camera, 
   isEditor?): ObjectManagementSystem;

Defined in: systems/ObjectManagementSystem.ts:123

Parameters

Parameter	Type	Default value
scene	Scene	undefined
camera	PerspectiveCamera	undefined
isEditor	boolean	false

Returns

ObjectManagementSystem

Methods

register()

register(kind, factory): void;

Defined in: systems/ObjectManagementSystem.ts:133

Parameters

Parameter	Type
kind	EcsEntityKind
factory	EntityFactory

Returns

void

---

registerComponentFactory()

registerComponentFactory(kind, factory): void;

Defined in: systems/ObjectManagementSystem.ts:137

Parameters

Parameter	Type
kind	EcsComponentFactoryKind
factory	ComponentFactory

Returns

void

---

getOrCreateAudioListener()

getOrCreateAudioListener(): AudioListener;

Defined in: systems/ObjectManagementSystem.ts:144

Returns

AudioListener

---

isEditorMode()

isEditorMode(): boolean;

Defined in: systems/ObjectManagementSystem.ts:156

Returns

boolean

---

getComponentFactory()

getComponentFactory(kind): ComponentFactory | null;

Defined in: systems/ObjectManagementSystem.ts:160

Parameters

Parameter	Type
kind	EcsComponentFactoryKind

Returns

ComponentFactory | null

---

createComponentNow()

createComponentNow(
   kind, 
   world, 
   entityId, ...
   args): unknown;

Defined in: systems/ObjectManagementSystem.ts:164

Parameters

Parameter	Type
kind	EcsComponentFactoryKind
world	World
entityId	number
...args	any[]

Returns

unknown

---

requestCreate()

requestCreate(
   kind, 
   payload?, 
   onCreated?): void;

Defined in: systems/ObjectManagementSystem.ts:178

Parameters

Parameter	Type
kind	EcsEntityKind
payload	CreatePayload
onCreated?	(entityId) => void

Returns

void

---

createNow()

createNow(
   kind, 
   world, 
   payload?): number;

Defined in: systems/ObjectManagementSystem.ts:186

Parameters

Parameter	Type
kind	EcsEntityKind
world	World
payload	CreatePayload

Returns

number

---

deleteEntity()

deleteEntity(
   world, 
   entityId, 
   dispose?): boolean;

Defined in: systems/ObjectManagementSystem.ts:238

Removes an entity from the ECS world and its associated Object3D from the THREE.js scene graph.

Parameters

Parameter	Type	Default value	Description
world	World	undefined	The world the entity belongs to.
entityId	number	undefined	The entity to remove.
dispose	boolean	false	When true, traverses the entity's Object3D subtree and calls .dispose() on every BufferGeometry and Material found. Pass true when the entity will not be reused and you want to free GPU memory immediately (e.g. dynamically spawned objects). Defaults to false.

Returns

boolean

true if the entity existed and was removed; false if the entity was not found.

Example

// Remove from scene, keep GPU resources (safe if geometry is shared)
objects.deleteEntity(world, entityId);

// Remove from scene and free GPU memory (use for one-off spawned objects)
objects.deleteEntity(world, entityId, true);

---

setParent()

setParent(
   world, 
   entityId, 
   parentId, 
   options?): boolean;

Defined in: systems/ObjectManagementSystem.ts:272

Parameters

Parameter	Type
world	World
entityId	number
parentId	number | null
options?	{ preserveWorldTransform?: boolean; }
options.preserveWorldTransform?	boolean

Returns

boolean

---

reconcileSceneFromWorld()

reconcileSceneFromWorld(world): void;

Defined in: systems/ObjectManagementSystem.ts:362

Parameters

Parameter	Type
world	World

Returns

void

---

update()

update(world): void;

Defined in: systems/ObjectManagementSystem.ts:406

Parameters

Parameter	Type
world	World

Returns

void

Implementation of

EcsSystem.update