Relu Spatial

Appearance

@relu-interactives/spatial-ecs

@relu-interactives/spatial-ecs / index

index ​

Classes ​

Other ​

ClassDescription
AnimationStateMachine-
AnimationStateManager-
World-
AnimationSystem-
CameraSyncSystem-
EnvironmentSyncSystem-
InputSystem-
LightSyncSystem-
MaterialSyncSystem-
MeshGeometrySystem-
ObjectManagementSystem-
ObjectVisibilitySystem-
PhysicsSyncSystem-
PostprocessingSyncSystem-
RenderSystem-
ScriptBehaviourSystem-
TransformSyncSystem-

Systems ​

ClassDescription
AudioSystemReconciles AudioComponent state with the underlying THREE.js audio objects each frame.
VideoSystemReconciles VideoComponent state with the underlying HTML video element and THREE.js mesh/material each frame.

Interfaces ​

InterfaceDescription
StateMachine-
EcsSystem-

Type Aliases ​

Type AliasDescription
AnimationStateCallbacks-
EcsWorldComponentSnapshot-
EcsWorldStateSnapshotLike-
HydrateWorldFromSnapshotResult-
MouseButton-
EcsComponentFactoryKind-
ComponentFactory-
SelectionContextOptional context that enables raycast-based onSelect / onDeselect dispatch. When provided, pointer/touch taps on the canvas fire a raycast against the scene. If the hit object (or any ancestor) carries userData.entityId, every Behaviour instance for that entity receives onSelect(); the previously selected entity's instances receive onDeselect().
KeyboardKey-

Variables ​

VariableDescription
HYDRATABLE_ENTITY_KINDS-
KeyboardKeys-

Functions ​

FunctionDescription
createAnimationComponent-
createAudioComponent-
createCameraComponent-
createEntityTypeComponent-
createEnvironmentComponent-
createImageComponent-
createImageTargetAnchorComponent-
createImageTargetComponent-
createLightComponent-
createMaterialComponent-
createMeshComponent-
createMeshGeometryComponent-
createModelComponent-
createNameComponent-
createObject3DRefComponent-
createParentIdComponent-
createPhysicsComponent-
createPostprocessingComponent-
createScriptComponent-
createSelectableComponent-
createSelectionTransformStateComponent-
createSpriteComponent-
createTransformComponent-
createVideoComponent-
registerDefaultComponentFactories-
registerDefaultFactories-
hydrateWorldFromSnapshotDetailed-
hydrateWorldFromSnapshot-

References ​

Component ​

Re-exports Component

Behaviour ​

Re-exports Behaviour

CoreComponents ​

Renames and re-exports components

EntityId ​

Re-exports EntityId

EcsEntityKind ​

Re-exports EcsEntityKind

EcsEntityEditorKind ​

Re-exports EcsEntityEditorKind

SelectionListener ​

Re-exports SelectionListener

TextInput ​

Re-exports TextInput

FloatInput ​

Re-exports FloatInput

ColorInput ​

Re-exports ColorInput

Vector2Input ​

Re-exports Vector2Input

Vector3Input ​

Re-exports Vector3Input

SliderInput ​

Re-exports SliderInput

Re-exports DropdownOption

Re-exports DropdownInput

CheckboxInput ​

Re-exports CheckboxInput

ToggleInput ​

Re-exports ToggleInput

AssetInput ​

Re-exports AssetInput

ComponentInput ​

Re-exports ComponentInput

WorldEntityView ​

Re-exports WorldEntityView

ParentLookup ​

Re-exports ParentLookup

Vec3 ​

Re-exports Vec3

IntersectionResult ​

Re-exports IntersectionResult