Skip to main content

Interface: Simulator

Defined in: src/simulator/Simulator.ts:47

Extends​

Properties​

controls​

controls: SimulatorControls

Defined in: src/simulator/Simulator.ts:77


depth​

depth: SimulatorDepth

Defined in: src/simulator/Simulator.ts:68


editorIcon​

editorIcon: string = 'simulation'

Defined in: src/simulator/Simulator.ts:60


hands​

hands: SimulatorHands

Defined in: src/simulator/Simulator.ts:71


isXRScript​

isXRScript: boolean = true

Defined in: src/core/Script.ts:100

Inherited from​

Script.isXRScript


mainCamera​

mainCamera: Camera

Defined in: src/simulator/Simulator.ts:90


mainScene​

mainScene: Scene

Defined in: src/simulator/Simulator.ts:91


objects​

objects: SimulatorObjects

Defined in: src/simulator/Simulator.ts:65


options​

options: SimulatorOptions

Defined in: src/simulator/Simulator.ts:89


renderDepthPass​

renderDepthPass: boolean = false

Defined in: src/simulator/Simulator.ts:84


renderer?​

optional renderer: WebGLOrWebGPURenderer

Defined in: src/simulator/Simulator.ts:106


renderMode​

renderMode: SimulatorRenderMode = SimulatorRenderMode.DEFAULT

Defined in: src/simulator/Simulator.ts:85


simulatorCamera?​

optional simulatorCamera: SimulatorCamera

Defined in: src/simulator/Simulator.ts:88


simulatorControllerState​

simulatorControllerState: SimulatorControllerState

Defined in: src/simulator/Simulator.ts:70


simulatorScene​

simulatorScene: SimulatorScene

Defined in: src/simulator/Simulator.ts:61


simulatorUser​

simulatorUser: SimulatorUser

Defined in: src/simulator/Simulator.ts:75


simulatorWorld​

simulatorWorld: SimulatorWorld

Defined in: src/simulator/Simulator.ts:62


stereoCameras​

stereoCameras: Camera[] = []

Defined in: src/simulator/Simulator.ts:86


userInterface​

userInterface: SimulatorInterface

Defined in: src/simulator/Simulator.ts:76


xb?​

optional xb: XBObjectOptions

Defined in: src/interaction/InteractionTypes.ts:34

Inherited from​

Script.xb

Accessors​

activeEnvironment​

Get Signature​

get activeEnvironment(): SimulatorEnvironment | undefined

Defined in: src/simulator/Simulator.ts:305

Returns​

SimulatorEnvironment | undefined


activeEnvironmentManifest​

Get Signature​

get activeEnvironmentManifest(): ResolvedSimulatorSceneManifest | undefined

Defined in: src/simulator/Simulator.ts:309

Returns​

ResolvedSimulatorSceneManifest | undefined


dayNightEnabled​

Get Signature​

get dayNightEnabled(): boolean

Defined in: src/simulator/Simulator.ts:350

True when day/night lighting is enabled for the active environment.

Returns​

boolean


userMovementConstrained​

Get Signature​

get userMovementConstrained(): boolean

Defined in: src/simulator/Simulator.ts:113

Returns​

boolean

Methods​

dispose()​

dispose(): void

Defined in: src/simulator/Simulator.ts:375

Called when the script is removed from the scene. Opposite of init.

Returns​

void

Overrides​

Script.dispose


findRandomUserPath()​

findRandomUserPath(): SimulatorUserPath | null

Defined in: src/simulator/Simulator.ts:121

Returns​

SimulatorUserPath | null


getLocations()​

getLocations(): SimulatorLocations

Defined in: src/simulator/Simulator.ts:314

Returns the named world-space locations for the active environment.

Returns​

SimulatorLocations


getRenderCamera()​

getRenderCamera(): Camera

Defined in: src/simulator/Simulator.ts:462

Returns​

Camera


init()​

init(__namedParameters): Promise<void>

Defined in: src/simulator/Simulator.ts:125

Initializes an instance with XR controllers, grips, hands, and default options. We allow all scripts to quickly access its user (e.g., user.isSelecting(), user.hands), world (e.g., physical depth mesh, lighting estimation, and recognized objects), and scene (the root of three.js's scene graph). If this returns a promise, we will wait for it.

Parameters​

__namedParameters​
camera​

Camera

depth​

Depth

input​

Input

interaction​

Interaction

options​

Options

registry​

Registry

scene​

Scene

simulatorOptions​

SimulatorOptions

timer​

Timer

world​

World

Returns​

Promise<void>

Overrides​

Script.init


initPhysics()​

initPhysics(_physics): void | Promise<void>

Defined in: src/core/Script.ts:119

Enables depth-aware interactions with physics. See /samples/advanced/ballpit

Parameters​

_physics​

Physics

Returns​

void | Promise<void>

Inherited from​

Script.initPhysics


moveUser()​

moveUser(desiredCameraPosition): void

Defined in: src/simulator/Simulator.ts:117

Parameters​

desiredCameraPosition​

Vector3

Returns​

void


onHoverEnter()​

onHoverEnter(_event): void

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

Called when a source starts hovering over this object.

Parameters​

_event​

HoverEvent

The hover source, target, surface, and intersection. Call event.stopPropagation() to stop bubbling to ancestor Scripts.

Returns​

void

Inherited from​

Script.onHoverEnter


onHoverExit()​

onHoverExit(_event): void

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

Called when a source stops hovering over this object.

Parameters​

_event​

HoverEvent

The hover source, target, surface, and intersection. Call event.stopPropagation() to stop bubbling to ancestor Scripts.

Returns​

void

Inherited from​

Script.onHoverExit


onHovering()​

onHovering(_event): void

Defined in: src/core/Script.ts:234

Called while a source hovers over this object.

Parameters​

_event​

HoverEvent

The hover source, target, surface, and intersection. Call event.stopPropagation() to stop bubbling to ancestor Scripts.

Returns​

void

Inherited from​

Script.onHovering


onKeyDown()​

onKeyDown(_event): void

Defined in: src/core/Script.ts:159

Called on keyboard keypress.

Parameters​

_event​

KeyEvent

Event containing .code to read the keyboard key.

Returns​

void

Inherited from​

Script.onKeyDown


onKeyUp()​

onKeyUp(_event): void

Defined in: src/core/Script.ts:160

Parameters​

_event​

KeyEvent

Returns​

void

Inherited from​

Script.onKeyUp


onLongSelect()​

onLongSelect(_event): void

Defined in: src/core/Script.ts:153

Called when an object selection reaches the long-select delay.

Parameters​

_event​

LongSelectEvent

Returns​

void

Inherited from​

Script.onLongSelect


onObjectGrabbing()​

onObjectGrabbing(_event): void

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

Called every frame a hand is grabbing this object.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabbing


onObjectGrabEnd()​

onObjectGrabEnd(_event): void

Defined in: src/core/Script.ts:265

Called when a hand stops grabbing this object. This ends built-in direct-touch manipulation without ending contact.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabEnd


onObjectGrabStart()​

onObjectGrabStart(_event): void

Defined in: src/core/Script.ts:256

Called when a hand starts grabbing this object (touching + pinching). A grab starts built-in direct-touch manipulation when enabled.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabStart


onObjectLongSelect()​

onObjectLongSelect(_event): void

Defined in: src/core/Script.ts:210

Called once when a captured selection is held for the long-select delay. Manipulation captures do not emit this callback.

Parameters​

_event​

LongSelectEvent

The controller and completed hold duration. Call event.stopPropagation() to stop bubbling to ancestor Scripts. Call event.stopGlobalPropagation() to suppress global selection callbacks for the rest of this capture

Returns​

void

Inherited from​

Script.onObjectLongSelect


onObjectManipulate()​

onObjectManipulate(_event): void

Defined in: src/core/Script.ts:216

Called for each phase of an automatic object manipulation. Call event.stopPropagation() to stop bubbling. Calling preventDefault() on a start event suppresses the automatic action.

Parameters​

_event​

ManipulationEvent

Returns​

void

Inherited from​

Script.onObjectManipulate


onObjectSelectEnd()​

onObjectSelectEnd(_event): void

Defined in: src/core/Script.ts:201

Called when a source stops selecting the object this Script represents.

Parameters​

_event​

SelectEndEvent

The completed state and end reason. Call event.stopPropagation() to stop bubbling to ancestor Scripts. Call event.stopGlobalPropagation() to suppress global selection callbacks for the rest of this capture

Returns​

void

Inherited from​

Script.onObjectSelectEnd


onObjectSelectStart()​

onObjectSelectStart(_event): void

Defined in: src/core/Script.ts:193

Called when a source starts selecting the object this Script represents.

Parameters​

_event​

SelectEvent

event.target is the logical object and event.source.controller identifies the controller. Call event.stopPropagation() to stop bubbling to ancestor Scripts. Call event.stopGlobalPropagation() to suppress global selection callbacks for the rest of this capture

Returns​

void

Inherited from​

Script.onObjectSelectStart


onObjectTouchEnd()​

onObjectTouchEnd(_event): void

Defined in: src/core/Script.ts:251

Called when a hand's index finger stops touching this object. This ends the default selection lifecycle after the touch callback.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouchEnd


onObjectTouching()​

onObjectTouching(_event): void

Defined in: src/core/Script.ts:246

Called every frame that a hand's index finger is touching this object. The object remains selected during these frames unless touch selection was prevented when contact started.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouching


onObjectTouchStart()​

onObjectTouchStart(_event): void

Defined in: src/core/Script.ts:240

Called when a hand's index finger starts touching this object. Direct touch starts the object's selection lifecycle by default. Call event.preventDefault() to handle contact without selecting.

Parameters​

_event​

ObjectTouchStartEvent

Returns​

void

Inherited from​

Script.onObjectTouchStart


onSelect()​

onSelect(_event): void

Defined in: src/core/Script.ts:145

Called whenever pinch / mouse click successfully completes, globally.

Parameters​

_event​

SelectEvent

The interaction source and completed target.

Returns​

void

Inherited from​

Script.onSelect


onSelectEnd()​

onSelectEnd(_event): void

Defined in: src/core/Script.ts:139

Called whenever pinch / mouse click discontinues, globally.

Parameters​

_event​

SelectEndEvent

The completed state and end reason.

Returns​

void

Inherited from​

Script.onSelectEnd


onSelecting()​

onSelecting(_event): void

Defined in: src/core/Script.ts:150

Called whenever pinch / mouse click is happening, globally.

Parameters​

_event​

SelectEvent

Returns​

void

Inherited from​

Script.onSelecting


onSelectStart()​

onSelectStart(_event): void

Defined in: src/core/Script.ts:133

Called whenever pinch / mouse click starts, globally.

Parameters​

_event​

SelectEvent

The interaction source and optional captured target.

Returns​

void

Inherited from​

Script.onSelectStart


onSimulatorStarted()​

onSimulatorStarted(): void

Defined in: src/core/Script.ts:125

Returns​

void

Inherited from​

Script.onSimulatorStarted


onSqueeze()​

onSqueeze(_event): void

Defined in: src/core/Script.ts:182

Called whenever gamepad trigger successfully completes, globally.

Parameters​

_event​

SelectEvent

event.source.controller identifies the controller.

Returns​

void

Inherited from​

Script.onSqueeze


onSqueezeEnd()​

onSqueezeEnd(_event): void

Defined in: src/core/Script.ts:171

Called whenever gamepad trigger stops, globally.

Parameters​

_event​

SelectEvent

event.source.controller identifies the controller.

Returns​

void

Inherited from​

Script.onSqueezeEnd


onSqueezeStart()​

onSqueezeStart(_event): void

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

Called whenever gamepad trigger starts, globally.

Parameters​

_event​

SelectEvent

event.source.controller identifies the controller.

Returns​

void

Inherited from​

Script.onSqueezeStart


onSqueezing()​

onSqueezing(_event): void

Defined in: src/core/Script.ts:176

Called whenever gamepad is being triggered, globally.

Parameters​

_event​

SelectEvent

Returns​

void

Inherited from​

Script.onSqueezing


onXRSessionEnded()​

onXRSessionEnded(): void

Defined in: src/simulator/Simulator.ts:367

Returns​

void

Overrides​

Script.onXRSessionEnded


onXRSessionStarted()​

onXRSessionStarted(): void

Defined in: src/simulator/Simulator.ts:359

Returns​

void

Overrides​

Script.onXRSessionStarted


physicsStep()​

physicsStep(): void

Defined in: src/simulator/Simulator.ts:354

Returns​

void

Overrides​

Script.physicsStep


preloadDayNight()​

preloadDayNight(): Promise<void>

Defined in: src/simulator/Simulator.ts:334

Fetches the active environment's night bake ahead of first use so the day/night lighting can start without a visible delay. No-op when the active environment declares no day/night lighting.

Returns​

Promise<void>


renderFrame()​

renderFrame(): void

Defined in: src/simulator/Simulator.ts:474

Renders one complete simulator frame (physical environment + virtual scene) to the default framebuffer. Called by Core when the simulator is running.

Returns​

void


setDayNightEnabled()​

setDayNightEnabled(enabled): Promise<void>

Defined in: src/simulator/Simulator.ts:344

Enables or disables day/night lighting for the active environment. The DayNightCycle chunk and the night bake are only fetched on first enable, never at environment load. No-op when the active environment declares no day/night lighting.

Parameters​

enabled​

boolean

Returns​

Promise<void>


setEnvironment()​

Call Signature​

setEnvironment(manifestPath): Promise<void>

Defined in: src/simulator/Simulator.ts:281

Loads and activates a simulator environment at runtime.

Parameters​
manifestPath​

string

Returns​

Promise<void>

Call Signature​

setEnvironment(name, manifestPath): Promise<void>

Defined in: src/simulator/Simulator.ts:282

Loads and activates a simulator environment at runtime.

Parameters​
name​

string

manifestPath​

string

Returns​

Promise<void>


setStereoRenderMode()​

setStereoRenderMode(mode): void

Defined in: src/simulator/Simulator.ts:438

Parameters​

mode​

SimulatorRenderMode

Returns​

void


setTimeOfDay()​

setTimeOfDay(t): Promise<void>

Defined in: src/simulator/Simulator.ts:324

Sets the time of day for the active environment's day/night lighting (0 = day endpoint, 1 = night endpoint). Initializes the lighting lazily on first use. No-op when the active environment declares no day/night lighting.

Parameters​

t​

number

Returns​

Promise<void>


setupStereoCameras()​

setupStereoCameras(camera): void

Defined in: src/simulator/Simulator.ts:443

Parameters​

camera​

Camera

Returns​

void


simulatorUpdate()​

simulatorUpdate(): void

Defined in: src/simulator/Simulator.ts:429

Returns​

void


update()​

update(_time?, _frame?): void

Defined in: src/core/Script.ts:114

Runs per frame.

Parameters​

_time?​

number

_frame?​

XRFrame

Returns​

void

Inherited from​

Script.update