Skip to main content

Class: Simulator

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

Extends​

Constructors​

Constructor​

new Simulator(renderMainScene): Simulator

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

Parameters​

renderMainScene​

(cameraOverride?) => void

Returns​

Simulator

Overrides​

Script.constructor

Properties​

camera?​

optional camera: SimulatorCamera

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

controls​

controls: SimulatorControls

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

depth​

depth: SimulatorDepth

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

effects?​

optional effects: XREffects

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

hands​

hands: SimulatorHands

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

isXRScript​

isXRScript: boolean = true

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

Inherited from​

Script.isXRScript

mainCamera​

mainCamera: Camera

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

mainScene​

mainScene: Scene

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

options​

options: SimulatorOptions

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

renderDepthPass​

renderDepthPass: boolean = false

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

renderer​

renderer: WebGLRenderer

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

renderMode​

renderMode: SimulatorRenderMode = SimulatorRenderMode.DEFAULT

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

simulatorControllerState​

simulatorControllerState: SimulatorControllerState

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

simulatorScene​

simulatorScene: SimulatorScene

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

simulatorUser​

simulatorUser: SimulatorUser

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

stereoCameras​

stereoCameras: Camera[] = []

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

userInterface​

userInterface: SimulatorInterface

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

ux​

ux: UX

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

Inherited from​

Script.ux

virtualSceneFullScreenQuad?​

optional virtualSceneFullScreenQuad: FullScreenQuad

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

virtualSceneRenderTarget?​

optional virtualSceneRenderTarget: WebGLRenderTarget<Texture<unknown>>

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

dependencies​

static dependencies: object

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

camera​

camera: typeof Camera = THREE.Camera

depth​

depth: typeof Depth = Depth

input​

input: typeof Input = Input

options​

options: typeof Options = Options

registry​

registry: typeof Registry = Registry

renderer​

renderer: typeof WebGLRenderer = THREE.WebGLRenderer

scene​

scene: typeof Scene = THREE.Scene

simulatorOptions​

simulatorOptions: typeof SimulatorOptions = SimulatorOptions

timer​

timer: typeof Timer = THREE.Timer

Methods​

dispose()​

dispose(): void

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

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

Returns​

void

Inherited from​

Script.dispose

getRenderCamera()​

getRenderCamera(): Camera

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

Returns​

Camera

init()​

init(__namedParameters): Promise<void>

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

Initializes an instance with XR controllers, grips, hands, raycaster, 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

options​

Options

registry​

Registry

renderer​

WebGLRenderer

scene​

Scene

simulatorOptions​

SimulatorOptions

timer​

Timer

Returns​

Promise<void>

Overrides​

Script.init

initPhysics()​

initPhysics(_physics): void | Promise<void>

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

Enables depth-aware interactions with physics. See /demos/ballpit

Parameters​

_physics​

Physics

Returns​

void | Promise<void>

Inherited from​

Script.initPhysics

onBeforeSimulatorSceneRender()​

onBeforeSimulatorSceneRender(): void

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

Returns​

void

onHoverEnter()​

onHoverEnter(_controller): void

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

Called when the controller starts hovering over this object with reticle.

Parameters​

_controller​

Object3D

An XR controller.

Returns​

void

Inherited from​

Script.onHoverEnter

onHoverExit()​

onHoverExit(_controller): void

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

Called when the controller hovers over this object with reticle.

Parameters​

_controller​

Object3D

An XR controller.

Returns​

void

Inherited from​

Script.onHoverExit

onHovering()​

onHovering(_controller): void

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

Called when the controller hovers over this object with reticle.

Parameters​

_controller​

Object3D

An XR controller.

Returns​

void

Inherited from​

Script.onHovering

onKeyDown()​

onKeyDown(_event): void

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

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:111

Parameters​

_event​

KeyEvent

Returns​

void

Inherited from​

Script.onKeyUp

onObjectGrabbing()​

onObjectGrabbing(_event): void

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

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:192

Called when a hand stops grabbing this object.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabEnd

onObjectGrabStart()​

onObjectGrabStart(_event): void

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

Called when a hand starts grabbing this object (touching + pinching).

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabStart

onObjectSelectEnd()​

onObjectSelectEnd(_event): boolean

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

Called when the controller stops selecting this object the script represents, e.g. View, ModelView.

Parameters​

_event​

SelectEvent

event.target holds its controller.

Returns​

boolean

Whether the event was handled

Inherited from​

Script.onObjectSelectEnd

onObjectSelectStart()​

onObjectSelectStart(_event): boolean

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

Called when the controller starts selecting this object the script represents, e.g. View, ModelView.

Parameters​

_event​

SelectEvent

event.target holds its controller.

Returns​

boolean

Whether the event was handled

Inherited from​

Script.onObjectSelectStart

onObjectTouchEnd()​

onObjectTouchEnd(_event): void

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

Called when a hand's index finger stops touching this object.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouchEnd

onObjectTouching()​

onObjectTouching(_event): void

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

Called every frame that a hand's index finger is touching this object.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouching

onObjectTouchStart()​

onObjectTouchStart(_event): void

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

Called when a hand's index finger starts touching this object.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouchStart

onSelect()​

onSelect(_event): void

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

Called whenever pinch / mouse click successfully completes, globally.

Parameters​

_event​

SelectEvent

event.target holds its controller.

Returns​

void

Inherited from​

Script.onSelect

onSelectEnd()​

onSelectEnd(_event): void

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

Called whenever pinch / mouse click discontinues, globally.

Parameters​

_event​

SelectEvent

event.target holds its controller

Returns​

void

Inherited from​

Script.onSelectEnd

onSelecting()​

onSelecting(_event): void

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

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:87

Called whenever pinch / mouse click starts, globally.

Parameters​

_event​

SelectEvent

event.target holds its controller

Returns​

void

Inherited from​

Script.onSelectStart

onSimulatorSceneRendered()​

onSimulatorSceneRendered(): void

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

Returns​

void

onSimulatorStarted()​

onSimulatorStarted(): void

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

Returns​

void

Inherited from​

Script.onSimulatorStarted

onSqueeze()​

onSqueeze(_event): void

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

Called whenever gamepad trigger successfully completes, globally.

Parameters​

_event​

SelectEvent

event.target holds its controller.

Returns​

void

Inherited from​

Script.onSqueeze

onSqueezeEnd()​

onSqueezeEnd(_event): void

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

Called whenever gamepad trigger stops, globally.

Parameters​

_event​

SelectEvent

event.target holds its controller.

Returns​

void

Inherited from​

Script.onSqueezeEnd

onSqueezeStart()​

onSqueezeStart(_event): void

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

Called whenever gamepad trigger starts, globally.

Parameters​

_event​

SelectEvent

event.target holds its controller.

Returns​

void

Inherited from​

Script.onSqueezeStart

onSqueezing()​

onSqueezing(_event): void

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

Called whenever gamepad is being triggered, globally.

Parameters​

_event​

SelectEvent

Returns​

void

Inherited from​

Script.onSqueezing

onXRSessionEnded()​

onXRSessionEnded(): void

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

Returns​

void

Inherited from​

Script.onXRSessionEnded

onXRSessionStarted()​

onXRSessionStarted(_session?): void

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

Parameters​

_session?​

XRSession

Returns​

void

Inherited from​

Script.onXRSessionStarted

physicsStep()​

physicsStep(): void

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

Returns​

void

Inherited from​

Script.physicsStep

renderScene()​

renderScene(): void

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

Returns​

void

renderSimulatorScene()​

renderSimulatorScene(): void

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

Returns​

void

setStereoRenderMode()​

setStereoRenderMode(mode): void

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

Parameters​

mode​

SimulatorRenderMode

Returns​

void

setupStereoCameras()​

setupStereoCameras(camera): void

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

Parameters​

camera​

Camera

Returns​

void

simulatorUpdate()​

simulatorUpdate(): void

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

Returns​

void

update()​

update(_time?, _frame?): void

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

Runs per frame.

Parameters​

_time?​

number

_frame?​

XRFrame

Returns​

void

Inherited from​

Script.update