Skip to main content

Class: SimulatorOptions

Defined in: src/simulator/SimulatorOptions.ts:36

Constructors​

Constructor​

new SimulatorOptions(options?): SimulatorOptions

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

Parameters​

options?​
activeEnvironmentIndex?​

number = 0

blendingMode?​

"normal" | "screen" = 'normal'

defaultHand?​

Handedness = Handedness.LEFT

defaultMode?​

SimulatorMode = SimulatorMode.USER

deviceCamera?​

{ enabled?: boolean; } = ...

deviceCamera.enabled?​

boolean = true

environments?​

readonly ({ name?: string; scenePath?: string | null; scenePlanesPath?: string | null; videoPath?: string; } | undefined)[] = ...

geminiLivePanel?​

{ element?: string; enabled?: boolean; } = ...

geminiLivePanel.element?​

string = 'xrblocks-simulator-geminilive'

geminiLivePanel.enabled?​

boolean = false

handPosePanel?​

{ element?: string; enabled?: boolean; } = ...

handPosePanel.element?​

string = 'xrblocks-simulator-hand-pose-panel'

handPosePanel.enabled?​

boolean = true

initialCameraPosition?​

{ x?: number; y?: number; z?: number; } = ...

initialCameraPosition.x?​

number = 0

initialCameraPosition.y?​

number = 1.5

initialCameraPosition.z?​

number = 0

initialScenePosition?​

{ x?: number; y?: number; z?: number; } = ...

initialScenePosition.x?​

number = -1.6

initialScenePosition.y?​

number = 0.3

initialScenePosition.z?​

number = 0

instructions?​

{ customInstructions?: readonly ({ description?: string | { }; header?: string | { }; videoSrc?: string; } | undefined)[]; element?: string; enabled?: boolean; showAutomatically?: boolean; } = ...

instructions.customInstructions?​

readonly ({ description?: string | { }; header?: string | { }; videoSrc?: string; } | undefined)[] = ...

instructions.element?​

string = 'xrblocks-simulator-instructions'

instructions.enabled?​

boolean = true

instructions.showAutomatically?​

boolean = false

modeToggle?​

{ enabled?: boolean; toggleKey?: Keycodes | null; toggleOrder?: { Hands?: SimulatorMode; Navigation?: SimulatorMode; PointerLock?: SimulatorMode; User?: SimulatorMode; }; } = ...

modeToggle.enabled?​

boolean = false

modeToggle.toggleKey?​

Keycodes | null = ...

modeToggle.toggleOrder?​

{ Hands?: SimulatorMode; Navigation?: SimulatorMode; PointerLock?: SimulatorMode; User?: SimulatorMode; } = DEFAULT_MODE_TOGGLE_ORDER

modeToggle.toggleOrder.Hands?​

SimulatorMode = SimulatorMode.POINTER_LOCK

modeToggle.toggleOrder.Navigation?​

SimulatorMode = SimulatorMode.CONTROLLER

modeToggle.toggleOrder.PointerLock?​

SimulatorMode = SimulatorMode.USER

modeToggle.toggleOrder.User?​

SimulatorMode = SimulatorMode.POSE

reachAngle?​

{ angle?: number; enabled?: boolean; } = ...

Limits the angular cone in front of the user within which controllers can move.

reachAngle.angle?​

number = Math.PI

The maximum full cone angle in radians around the camera's forward direction (default is Math.PI, a front hemisphere).

reachAngle.enabled?​

boolean = false

reachDistance?​

{ enabled?: boolean; leftHandOrigin?: { x?: number; y?: number; z?: number; }; radius?: number; rightHandOrigin?: { x?: number; y?: number; z?: number; }; } = ...

Limits how far each hand controller can travel from the user's shoulder origin.

reachDistance.enabled?​

boolean = false

reachDistance.leftHandOrigin?​

{ x?: number; y?: number; z?: number; } = ...

The shoulder/chest origin point for the left hand in local camera space.

reachDistance.leftHandOrigin.x?​

number = -0.2

reachDistance.leftHandOrigin.y?​

number = -0.2

reachDistance.leftHandOrigin.z?​

number = 0

reachDistance.radius?​

number = 0.75

The maximum distance in meters a controller can move from its origin point.

reachDistance.rightHandOrigin?​

{ x?: number; y?: number; z?: number; } = ...

The shoulder/chest origin point for the right hand in local camera space.

reachDistance.rightHandOrigin.x?​

number = 0.2

reachDistance.rightHandOrigin.y?​

number = -0.2

reachDistance.rightHandOrigin.z?​

number = 0

renderToRenderTexture?​

boolean = true

simulatorSettingsPanel?​

{ element?: string; enabled?: boolean; } = ...

simulatorSettingsPanel.element?​

string = 'xrblocks-simulator-settings'

simulatorSettingsPanel.enabled?​

boolean = true

stereo?​

{ enabled?: boolean; } = ...

stereo.enabled?​

boolean = false

Returns​

SimulatorOptions

Properties​

activeEnvironmentIndex​

activeEnvironmentIndex: number = 0

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

blendingMode​

blendingMode: "normal" | "screen" = 'normal'

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

defaultHand​

defaultHand: Handedness = Handedness.LEFT

Defined in: src/simulator/SimulatorOptions.ts:52

defaultMode​

defaultMode: SimulatorMode = SimulatorMode.USER

Defined in: src/simulator/SimulatorOptions.ts:51

deviceCamera​

deviceCamera: object

Defined in: src/simulator/SimulatorOptions.ts:79

enabled​

enabled: boolean = true

environments​

environments: SimulatorEnvironment[]

Defined in: src/simulator/SimulatorOptions.ts:38

geminiLivePanel​

geminiLivePanel: object

Defined in: src/simulator/SimulatorOptions.ts:72

element​

element: string = 'xrblocks-simulator-geminilive'

enabled​

enabled: boolean = false

handPosePanel​

handPosePanel: object

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

element​

element: string = 'xrblocks-simulator-hand-pose-panel'

enabled​

enabled: boolean = true

initialCameraPosition​

initialCameraPosition: object

Defined in: src/simulator/SimulatorOptions.ts:37

x​

x: number = 0

y​

y: number = 1.5

z​

z: number = 0

initialScenePosition​

initialScenePosition: object

Defined in: src/simulator/SimulatorOptions.ts:50

x​

x: number = -1.6

y​

y: number = 0.3

z​

z: number = 0

instructions​

instructions: object

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

customInstructions​

customInstructions: SimulatorCustomInstruction[]

element​

element: string = 'xrblocks-simulator-instructions'

enabled​

enabled: boolean = true

showAutomatically​

showAutomatically: boolean = false

modeToggle​

modeToggle: object

Defined in: src/simulator/SimulatorOptions.ts:53

enabled​

enabled: boolean = false

toggleKey​

toggleKey: Keycodes | null

toggleOrder​

toggleOrder: object = DEFAULT_MODE_TOGGLE_ORDER

toggleOrder.Hands​

Hands: SimulatorMode = SimulatorMode.POINTER_LOCK

toggleOrder.Navigation​

Navigation: SimulatorMode = SimulatorMode.CONTROLLER

toggleOrder.PointerLock​

PointerLock: SimulatorMode = SimulatorMode.USER

toggleOrder.User​

User: SimulatorMode = SimulatorMode.POSE

reachAngle​

reachAngle: object

Defined in: src/simulator/SimulatorOptions.ts:100

Limits the angular cone in front of the user within which controllers can move.

angle​

angle: number = Math.PI

The maximum full cone angle in radians around the camera's forward direction (default is Math.PI, a front hemisphere).

enabled​

enabled: boolean = false

reachDistance​

reachDistance: object

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

Limits how far each hand controller can travel from the user's shoulder origin.

enabled​

enabled: boolean = false

leftHandOrigin​

leftHandOrigin: object

The shoulder/chest origin point for the left hand in local camera space.

leftHandOrigin.x​

x: number = -0.2

leftHandOrigin.y​

y: number = -0.2

leftHandOrigin.z​

z: number = 0

radius​

radius: number = 0.75

The maximum distance in meters a controller can move from its origin point.

rightHandOrigin​

rightHandOrigin: object

The shoulder/chest origin point for the right hand in local camera space.

rightHandOrigin.x​

x: number = 0.2

rightHandOrigin.y​

y: number = -0.2

rightHandOrigin.z​

z: number = 0

renderToRenderTexture​

renderToRenderTexture: boolean = true

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

simulatorSettingsPanel​

simulatorSettingsPanel: object

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

element​

element: string = 'xrblocks-simulator-settings'

enabled​

enabled: boolean = true

stereo​

stereo: object

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

enabled​

enabled: boolean = false