Skip to main content

Class: SimulatorOptions

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

Constructors​

Constructor​

new SimulatorOptions(options?): SimulatorOptions

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

Parameters​

options?​
blendingMode?​

"normal" | "screen" = 'normal'

defaultHand?​

Handedness = Handedness.LEFT

defaultMode?​

SimulatorMode = SimulatorMode.USER

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 = true

modeIndicator?​

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

modeIndicator.element?​

string = 'xrblocks-simulator-mode-indicator'

modeIndicator.enabled?​

boolean = true

modeToggle?​

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

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

scenePath?​

null | string = ...

scenePlanesPath?​

null | string = ...

stereo?​

{ enabled?: boolean; } = ...

stereo.enabled?​

boolean = false

videoPath?​

string = undefined

Returns​

SimulatorOptions

Properties​

blendingMode​

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

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

defaultHand​

defaultHand: Handedness = Handedness.LEFT

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

defaultMode​

defaultMode: SimulatorMode = SimulatorMode.USER

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

geminiLivePanel​

geminiLivePanel: object

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

element​

element: string = 'xrblocks-simulator-geminilive'

enabled​

enabled: boolean = false

handPosePanel​

handPosePanel: object

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

element​

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

enabled​

enabled: boolean = true

initialCameraPosition​

initialCameraPosition: object

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

x​

x: number = 0

y​

y: number = 1.5

z​

z: number = 0

initialScenePosition​

initialScenePosition: object

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

x​

x: number = -1.6

y​

y: number = 0.3

z​

z: number = 0

instructions​

instructions: object

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

customInstructions​

customInstructions: SimulatorCustomInstruction[]

element​

element: string = 'xrblocks-simulator-instructions'

enabled​

enabled: boolean = true

modeIndicator​

modeIndicator: object

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

element​

element: string = 'xrblocks-simulator-mode-indicator'

enabled​

enabled: boolean = true

modeToggle​

modeToggle: object

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

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

scenePath​

scenePath: null | string

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

scenePlanesPath​

scenePlanesPath: null | string

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

stereo​

stereo: object

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

enabled​

enabled: boolean = false

videoPath?​

optional videoPath: string = undefined

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