Skip to content

Relu Spatial Docs

Main Navigation Guide Scripting API API Reference

Appearance

Sidebar Navigation

API Reference

Behaviour

Classes

Behaviour

Type Aliases

UiInteractionEvent

Component

Classes

Components

Component

components

Classes

Components

AnimationComponent

AudioComponent

CameraComponent

EntityType

Environment

ImageComponent

ImageTarget

ImageTargetAnchor

InstanceSlotComponent

InstancedMeshComponent

LightComponent

MaterialComponent

MeshComponent

MeshGeometryComponent

ModelComponent

Name

Object3DRef

ParentId

PhysicsComponent

Postprocessing

PrefabInstance

PrefabNode

ScriptComponent

ScriptObjectComponent

Selectable

SelectionTransformState

SpriteComponent

TransformComponent

UIButtonComponent

UIPanelComponent

UISliderComponent

UITextComponent

UIToggleComponent

VRTeleportAreaComponent

VideoComponent

XRAnchorComponent

XREnvironmentComponent

XRHandPoseComponent

XRInteractableComponent

XRInteractorComponent

XRInteractorSideComponent

XRRigComponent

Type Aliases

AnimationComponentOptions

CameraRuntimeType

CameraProjection

CameraComponentOptions

EnvironmentSkyboxType

EnvironmentGradientEffect

EnvironmentFogType

EnvironmentSkyboxState

EnvironmentFogState

EnvironmentState

ImageTargetReference

ImageTargetAnchorOptions

InstanceTransform

InstancedMeshKind

LightValueState

MaterialTypeValue

TextureFilteringValue

MaterialValueState

EditableMeshObjectKind

CubeMeshParameters

PlaneMeshParameters

RadiusMeshParameters

RadiusHeightMeshParameters

MeshGeometryParametersByKind

MeshGeometryParameters

RigidbodyType

RigidbodyState

ColliderShape

ColliderState

PhysicsState

PostprocessingState

ScriptEntry

ScriptObjectRuntimeState

ScriptObjectComponentInput

TransformModeValue

TransformSpaceValue

Vec3

TransformData

UIButtonOptions

UiFollowMode

UIPanelOptions

UISliderOptions

UiTextAlign

UiTextVAlign

UITextOptions

UIToggleOptions

VrTeleportShape

VRTeleportAreaOptions

XRAnchorOptions

XrEnvironmentKind

XrEnvironmentOrientation

XrHandPoseEntry

XRHandPoseOptions

XrGrabReach

XrDistanceGrabBehavior

XrGrabGesture

XrAttachPoint

XrGrabHands

XrTwoHandRotation

XRInteractableOptions

XrInteractorType

XrHandPreset

XrInteractorSide

XRInteractorOptions

XrTrackingOrigin

XrLocomotionMode

XrEnvironmentPhysics

XRRigOptions

Variables

DEFAULT_ENVIRONMENT_STATE

DEFAULT_INSTANCE_TRANSFORM

DEFAULT_INSTANCED_MESH_PARAMETERS

DEFAULT_MESH_GEOMETRY_PARAMETERS

DEFAULT_RIGIDBODY_STATE

DEFAULT_COLLIDER_STATE

DEFAULT_PHYSICS_STATE

DEFAULT_POSTPROCESSING_STATE

DEFAULT_POSE_CURLS

DEFAULT_POSE_DIRECTIONS

Functions

defaultMaterialValue

normalizePhysicsState

setPhysicsLiveRef

createHandPoseEntry

handPoseDefinitionFor

createAttachPoint

index

Classes

Other

AnimationStateMachine

AnimationStateManager

World

AnimationSystem

CameraSyncSystem

EnvironmentSyncSystem

InputSystem

InstancedMeshSystem

LightSyncSystem

MaterialSyncSystem

MeshGeometrySystem

ObjectManagementSystem

ObjectVisibilitySystem

PhysicsSyncSystem

PostprocessingSyncSystem

RenderSystem

ScriptBehaviourSystem

TransformSyncSystem

UIInteractionSystem

UIPanelSystem

VRTeleportAreaSystem

XRAnchorSystem

XRControllerVisualSystem

XREnvironmentSystem

XRHandPoseSystem

XRHitTestSystem

XRHoverVisualSystem

XRInputSystem

XRInteractionSystem

XRLocomotionSystem

XRSessionSystem

XRTeleportVisualSystem

HandPoseTracker

TeleportAimGate

ThrowVelocityTracker

Scripting

ScriptObject

Systems

AudioSystem

ScriptObjectSystem

VideoSystem

Interfaces

StateMachine

EcsSystem

Type Aliases

AnimationStateCallbacks

ComponentValueMaps

EcsWorldComponentSnapshot

EcsWorldStateSnapshotLike

HydrateWorldFromSnapshotResult

HydrateOptions

ApplyPrefabToSnapshotResult

InstantiateSubtreeResult

NodeKeyMaps

NestedRegion

NodeMaps

SerializeEntitySubtreeResult

SubtreeSnapshot

ExternalRefWarning

RemapSnapshotOptions

SpawnPrefabSource

SpawnPrefabOptions

PrefabAsset

MouseButton

EcsComponentFactoryKind

ComponentFactory

SelectionContext

UiCanvasLike

XrHandPoseEventDetail

XrHitResult

KeyboardKey

ModuleLoader

XrHandJointName

XrFinger

XrHandJoints

XrFingerCurl

XrPalmPose

XrHandShape

XrFingerTarget

XrHandPoseAxis

XrHandPoseDirection

XrHandPoseOrientation

XrHandPoseDefinition

XrHandPoseMatch

XrHandPoseContext

XrHandPoseEvent

HandPoseTrackerOptions

HandMaterialOptions

VelocitySample

XrHandedness

XrInputKind

XrInputState

XrCapabilities

Variables

HYDRATABLE_ENTITY_KINDS

NODE_KEY_SEPARATOR

ADDED_NODE_MARKER_COMPONENT

OVERRIDE_DIFF_EXCLUDED_COMPONENTS

OVERRIDE_ROOT_EXCLUDED_COMPONENTS

PREFAB_FILE_VERSION

PREFAB_FILE_VERSION_NESTED

SCRIPT_OBJECT_ROOT_FLAG

XR_HOVER_SHELL_FLAG

KeyboardKeys

SHARED_MODEL_RESOURCE_FLAG

XR_FINGERS

PINCH_FINGERS

FALLBACK_HAND_SCALE

STRAIGHT_COS

CURLED_COS

MATCH_FALLOFF

DEFAULT_DIRECTION_TOLERANCE

DEFAULT_ENTER_CONFIDENCE

DEFAULT_EXIT_CONFIDENCE

DEFAULT_MIN_HOLD_SECONDS

DEFAULT_LOST_GRACE_SECONDS

HAND_POSE_PRESETS

HAND_POSE_PRESET_IDS

ARC_GRAVITY

ARC_SPEED

ARC_STEPS

ARC_MAX_TIME

VELOCITY_SAMPLES

MAX_SAMPLE_AGE_SECONDS

MAX_PLAUSIBLE_SPEED

NO_XR_CAPABILITIES

Functions

createAnimationComponent

createAudioComponent

createCameraComponent

createEntityTypeComponent

createEnvironmentComponent

createImageComponent

createImageTargetAnchorComponent

createImageTargetComponent

createInstanceSlotComponent

createInstancedMeshComponent

createLightComponent

createMaterialComponent

createMeshComponent

createMeshGeometryComponent

createModelComponent

createNameComponent

createObject3DRefComponent

createParentIdComponent

createPhysicsComponent

createPostprocessingComponent

createScriptComponent

createScriptObjectComponent

createSelectableComponent

createSelectionTransformStateComponent

createSpriteComponent

createTransformComponent

createUIButtonComponent

createUIPanelComponent

createUISliderComponent

createUITextComponent

createUIToggleComponent

createVRTeleportAreaComponent

createVideoComponent

createXRAnchorComponent

createXRHandPoseComponent

createXRInteractableComponent

createXRInteractorComponent

createXRInteractorSideComponent

createXRRigComponent

registerDefaultComponentFactories

registerDefaultFactories

buildComponentValueMaps

hydrateWorldFromSnapshotDetailed

hydrateWorldFromSnapshot

restorePostCreateComponents

restoreComponentState

applyPrefabToSnapshotInstances

collectEntitySubtree

collectDirectPrefabDependencies

instantiateSubtree

buildNodeKeyMapsFromSnapshot

collectSnapshotSubtreeIds

findTopLevelNestedRegions

findSnapshotRootEntityIds

buildNodeMapsFromSnapshot

indexSnapshotByEntity

canonicalizeComponentValue

decanonicalizeComponentValue

encodeOverride

parseOverride

groupOverridePaths

collectDiffPaths

computeInstanceOverrides

mergeComponentValue

serializeEntitySubtree

remapSnapshotEntityIds

setPrefabAssetUrlResolver

loadPrefab

clearPrefabCache

spawnPrefab

despawnPrefab

prefabFileVersionFor

parsePrefabAsset

setDracoDecoderPath

resolveDracoDecoderPath

loadSharedGltf

clearModelCache

computeFingerCurl

computePalmWidth

estimateHandScale

computePinch

computeSpread

computePalmPose

computeHandShape

matchHandPose

getHandPosePreset

cloneHandPose

handPoseFromCurls

createHandMaterial

applyHandMaterial

sampleTeleportArc

arcGroundCrossing

angularVelocityFrom

readXrCapabilities

types

Type Aliases

EntityId

EcsEntityKind

EcsEntityEditorKind

SelectionListener

TextInput

FloatInput

ColorInput

Vector2Input

Vector3Input

SliderInput

DropdownOption

DropdownInput

CheckboxInput

ToggleInput

AssetInput

EntityInput

ComponentKind

ComponentInput

WorldEntityView

ParentLookup

Vec3

IntersectionResult

On this page

@relu-interactives/spatial-ecs

@relu-interactives/spatial-ecs

Modules

Module	Description
Behaviour	-
Component	-
components	-
index	-
types	-

Pager

Next pageBehaviour