Skip to main content

Class: Core

Defined in: src/core/Core.ts:94

Core is the central engine of the XR Blocks framework, acting as a singleton manager for all XR subsystems. Its primary goal is to abstract low-level WebXR and THREE.js details, providing a simplified and powerful API for developers and AI agents to build interactive XR applications.

Constructors​

Constructor​

new Core(simulatorLoader): Core

Defined in: src/core/Core.ts:325

Core is a singleton manager that manages all XR "blocks". It initializes core components and abstractions like the scene, camera, user, UI, AI, and input managers.

Parameters​

simulatorLoader​

SimulatorLoader = loadSimulatorModule

Returns​

Core

Properties​

ai​

ai: AI

Defined in: src/core/Core.ts:225


camera​

camera: PerspectiveCamera

Defined in: src/core/Core.ts:123

The main camera for rendering.


context​

context: Context

Defined in: src/core/Core.ts:166

Manages agent-facing observations of the app/session.


depth​

depth: Depth

Defined in: src/core/Core.ts:220


deviceCamera?​

optional deviceCamera: XRDeviceCamera

Defined in: src/core/Core.ts:219


effects?​

optional effects: XREffects

Defined in: src/core/Core.ts:224


gestureRecognition?​

optional gestureRecognition: GestureRecognition

Defined in: src/core/Core.ts:227


input​

input: Input

Defined in: src/core/Core.ts:120

Manages hand, mouse, gaze inputs.


lighting?​

optional lighting: Lighting

Defined in: src/core/Core.ts:221


options​

options: Options

Defined in: src/core/Core.ts:218


permissionsManager​

permissionsManager: PermissionsManager

Defined in: src/core/Core.ts:244


physics?​

optional physics: Physics

Defined in: src/core/Core.ts:222


poseEstimation?​

optional poseEstimation: PoseEstimator

Defined in: src/core/Core.ts:226


registry​

registry: Registry

Defined in: src/core/Core.ts:111

Registry used for dependency injection on existing subsystems.


renderSceneOverride()?​

optional renderSceneOverride: (renderer, scene, camera) => void

Defined in: src/core/Core.ts:238

Parameters​

renderer​

SupportedRenderer

scene​

Scene

camera​

Camera

Returns​

void


scene​

scene: Scene<Object3DEventMap>

Defined in: src/core/Core.ts:126

The root scene graph for all objects.


screenshotSynthesizer​

screenshotSynthesizer: ScreenshotSynthesizer

Defined in: src/core/Core.ts:99

Component responsible for capturing screenshots of the XR scene for AI.


scriptsManager​

scriptsManager: ScriptsManager

Defined in: src/core/Core.ts:232


simulator?​

optional simulator: Simulator

Defined in: src/core/Core.ts:144

The desktop XR simulator after its runtime chunk has loaded.


simulatorRunning​

simulatorRunning: boolean = false

Defined in: src/core/Core.ts:178

Whether the XR simulator is currently active.


sound​

sound: CoreSound

Defined in: src/core/Core.ts:132

Manages all (spatial) audio playback.


splats​

splats: RadixSplatManager

Defined in: src/core/Core.ts:135

Manages @sparkjsdev/radix 3D Gaussian Splatting on WebGPURenderer.


textureLoader​

textureLoader: TextureLoader

Defined in: src/core/Core.ts:169

A shared texture loader.


timer​

timer: Timer

Defined in: src/core/Core.ts:116

A timer for tracking time deltas. Call timer.getDelta() or getDeltaTime().


transition?​

optional transition: XRTransition

Defined in: src/core/Core.ts:228


user​

user: User

Defined in: src/core/Core.ts:129

Represents the user in the XR scene.


waitFrame​

waitFrame: WaitFrame

Defined in: src/core/Core.ts:103

Component responsible for waiting for the next frame.


webXRSessionManager?​

optional webXRSessionManager: WebXRSessionManager

Defined in: src/core/Core.ts:243


world​

world: World

Defined in: src/core/Core.ts:163

Manages real-world understanding: planes, meshes, objects, and sounds.


xrButton?​

optional xrButton: XRButton

Defined in: src/core/Core.ts:223


xrReferenceSpaceCache​

xrReferenceSpaceCache: XRReferenceSpaceCache

Defined in: src/core/Core.ts:107

Caches WebXR reference spaces for the active session.


xrSystemsGroup​

xrSystemsGroup: XRSystems

Defined in: src/core/Core.ts:138

A container to hold all the systems in the scene hierarchy.


instance?​

static optional instance: Core

Defined in: src/core/Core.ts:95

Accessors​

currentFrame​

Get Signature​

get currentFrame(): XRFrame | null | undefined

Defined in: src/core/Core.ts:229

Returns​

XRFrame | null | undefined


elapsedTime​

Get Signature​

get elapsedTime(): number

Defined in: src/core/Core.ts:268

Returns​

number


environmentBlendMode​

Get Signature​

get environmentBlendMode(): XREnvironmentBlendMode | undefined

Defined in: src/core/Core.ts:273

The active XR session's environment blend mode, or undefined outside XR.

Returns​

XREnvironmentBlendMode | undefined


isPaused​

Get Signature​

get isPaused(): boolean

Defined in: src/core/Core.ts:264

Returns​

boolean


lifecycle​

Get Signature​

get lifecycle(): CoreLifecycleState

Defined in: src/core/Core.ts:278

Current state of this terminal Core lifetime.

Returns​

CoreLifecycleState


renderer​

Get Signature​

get renderer(): SupportedRenderer

Defined in: src/core/Core.ts:250

The WebGL, WebGPU, or Serializer renderer, created during Core.init. Reading it before init() has run returns undefined and logs a one-time warning.

Returns​

SupportedRenderer

Set Signature​

set renderer(renderer): void

Defined in: src/core/Core.ts:260

Parameters​
renderer​

SupportedRenderer

Returns​

void

Methods​

dispose()​

dispose(): Promise<void>

Defined in: src/core/Core.ts:382

Returns​

Promise<void>


init()​

init(options): Promise<void>

Defined in: src/core/Core.ts:512

Initializes the Core system with a given set of options. This includes setting up the renderer, enabling features like controllers, depth sensing, and physics, and starting the render loop.

Parameters​

options​

Options = ...

Configuration options for the session.

Returns​

Promise<void>


pause()​

pause(): void

Defined in: src/core/Core.ts:282

Returns​

void


resume()​

resume(): void

Defined in: src/core/Core.ts:287

Returns​

void


startSimulator()​

startSimulator(): Promise<Simulator>

Defined in: src/core/Core.ts:1121

Returns​

Promise<Simulator>


stepFrame()​

stepFrame(dtMs): void

Defined in: src/core/Core.ts:291

Parameters​

dtMs​

number = 16.67

Returns​

void