Skip to main content

Class: SimulatorOptions

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

Constructors​

Constructor​

new SimulatorOptions(options?): SimulatorOptions

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

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 (undefined | { name?: string; scenePath?: null | string; scenePlanesPath?: null | string; videoPath?: string; })[] = ...

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 (undefined | { description?: string | { }; header?: string | { }; videoSrc?: string; })[]; element?: string; enabled?: boolean; } = ...

instructions.customInstructions?​

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

instructions.element?​

string = 'xrblocks-simulator-instructions'

instructions.enabled?​

boolean = false

modeToggle?​

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

modeToggle.enabled?​

boolean = false

modeToggle.toggleKey?​

null | Keycodes = ...

modeToggle.toggleOrder?​

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

modeToggle.toggleOrder.Hands?​

SimulatorMode = SimulatorMode.USER

modeToggle.toggleOrder.Navigation?​

SimulatorMode = SimulatorMode.CONTROLLER

modeToggle.toggleOrder.User?​

SimulatorMode = SimulatorMode.POSE

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

blendingMode​

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

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

defaultHand​

defaultHand: Handedness = Handedness.LEFT

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

defaultMode​

defaultMode: SimulatorMode = SimulatorMode.USER

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

deviceCamera​

deviceCamera: object

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

enabled​

enabled: boolean = true

environments​

environments: SimulatorEnvironment[]

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

geminiLivePanel​

geminiLivePanel: object

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

element​

element: string = 'xrblocks-simulator-geminilive'

enabled​

enabled: boolean = false

handPosePanel​

handPosePanel: object

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

element​

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

enabled​

enabled: boolean = true

initialCameraPosition​

initialCameraPosition: object

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

x​

x: number = 0

y​

y: number = 1.5

z​

z: number = 0

initialScenePosition​

initialScenePosition: object

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

x​

x: number = -1.6

y​

y: number = 0.3

z​

z: number = 0

instructions​

instructions: object

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

customInstructions​

customInstructions: SimulatorCustomInstruction[]

element​

element: string = 'xrblocks-simulator-instructions'

enabled​

enabled: boolean = false

modeToggle​

modeToggle: object

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

enabled​

enabled: boolean = false

toggleKey​

toggleKey: null | Keycodes

toggleOrder​

toggleOrder: object = DEFAULT_MODE_TOGGLE_ORDER

toggleOrder.Hands​

Hands: SimulatorMode = SimulatorMode.USER

toggleOrder.Navigation​

Navigation: SimulatorMode = SimulatorMode.CONTROLLER

toggleOrder.User​

User: SimulatorMode = SimulatorMode.POSE

renderToRenderTexture​

renderToRenderTexture: boolean = true

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

simulatorSettingsPanel​

simulatorSettingsPanel: object

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

element​

element: string = 'xrblocks-simulator-settings'

enabled​

enabled: boolean = true

stereo​

stereo: object

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

enabled​

enabled: boolean = false