Skip to main content

Class: SimulatorOptions

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

Constructors

Constructor

new SimulatorOptions(options?): SimulatorOptions

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

Parameters

options?
defaultHand?

Handedness = Handedness.LEFT

defaultMode?

SimulatorMode = SimulatorMode.USER

geminilive?

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

renderToRenderTexture?

boolean = true

scenePath?

string = ...

stereo?

{ enabled?: boolean; } = ...

stereo.enabled?

boolean = false

Returns

SimulatorOptions

Properties

defaultHand

defaultHand: Handedness = Handedness.LEFT

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


defaultMode

defaultMode: SimulatorMode = SimulatorMode.USER

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


geminilive

geminilive: boolean = false

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


handPosePanel

handPosePanel: object

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

element

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

enabled

enabled: boolean = true


initialCameraPosition

initialCameraPosition: object

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

x

x: number = 0

y

y: number = 1.5

z

z: number = 0


initialScenePosition

initialScenePosition: object

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

x

x: number = -1.6

y

y: number = 0.3

z

z: number = 0


instructions

instructions: object

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

customInstructions

customInstructions: SimulatorCustomInstruction[]

element

element: string = 'xrblocks-simulator-instructions'

enabled

enabled: boolean = true


modeIndicator

modeIndicator: object

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

element

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

enabled

enabled: boolean = true


renderToRenderTexture

renderToRenderTexture: boolean = true

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


scenePath

scenePath: string

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


stereo

stereo: object

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

enabled

enabled: boolean = false