Class: SimulatorOptions
Defined in: src/simulator/SimulatorOptions.ts:44
Constructors
Constructor
new SimulatorOptions(
options?):SimulatorOptions
Defined in: src/simulator/SimulatorOptions.ts:121
Parameters
options?
activeEnvironmentIndex?
number = 0
blendingMode?
"screen" | "normal" = 'normal'
defaultHand?
Handedness = Handedness.LEFT
defaultMode?
SimulatorMode = SimulatorMode.USER
deviceCamera?
{ enabled?: boolean; } = ...
deviceCamera.enabled?
boolean = true
environments?
readonly ({ manifestPath?: string; name?: string; } | undefined)[] = ...
geminiLivePanel?
{ element?: string; enabled?: boolean; } = ...
geminiLivePanel.element?
string = 'xrblocks-simulator-geminilive'
geminiLivePanel.enabled?
boolean = false
handPhysics?
{ contactOffset?: number; enabled?: boolean; friction?: number; mass?: number; radius?: number; restitution?: number; } = ...
Optional physical constraints for simulated hands. Requires Rapier.
handPhysics.contactOffset?
number
handPhysics.enabled?
boolean
handPhysics.friction?
number
handPhysics.mass?
number
handPhysics.radius?
number
handPhysics.restitution?
number
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
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
leftHandOrigin?
{ x?: number; y?: number; z?: number; } = ...
Shoulder/chest origin of the left hand in local camera space.
leftHandOrigin.x?
number = -0.2
leftHandOrigin.y?
number = -0.2
leftHandOrigin.z?
number = 0
modeToggle?
{ enabled?: boolean; toggleKey?: Keycodes | null; toggleOrder?: { Editor?: SimulatorMode; Hands?: SimulatorMode; Navigation?: SimulatorMode; PointerLock?: SimulatorMode; User?: SimulatorMode; }; } = ...
modeToggle.enabled?
boolean = false
modeToggle.toggleKey?
Keycodes | null = ...
modeToggle.toggleOrder?
{ Editor?: SimulatorMode; Hands?: SimulatorMode; Navigation?: SimulatorMode; PointerLock?: SimulatorMode; User?: SimulatorMode; } = DEFAULT_MODE_TOGGLE_ORDER
modeToggle.toggleOrder.Editor?
SimulatorMode = SimulatorMode.USER
modeToggle.toggleOrder.Hands?
SimulatorMode = SimulatorMode.POINTER_LOCK
modeToggle.toggleOrder.Navigation?
SimulatorMode = SimulatorMode.CONTROLLER
modeToggle.toggleOrder.PointerLock?
SimulatorMode = SimulatorMode.EDITOR
modeToggle.toggleOrder.User?
SimulatorMode = SimulatorMode.POSE
navMesh?
{ enabled?: boolean; eyeHeight?: number; showDebugVisualizations?: boolean; } = ...
navMesh.enabled?
boolean = false
navMesh.eyeHeight?
number = 1.5
navMesh.showDebugVisualizations?
boolean = false
physics?
{ enabled?: boolean; } = ...
Controls the isolated physics world used by the desktop simulator.
physics.enabled?
boolean = true
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; radius?: number; } = ...
Limits how far each hand controller can travel from the user's shoulder origin.
reachDistance.enabled?
boolean = false
reachDistance.radius?
number = 0.75
The maximum distance in meters a controller can move from its origin point.
renderToRenderTexture?
boolean = true
rightHandOrigin?
{ x?: number; y?: number; z?: number; } = ...
Shoulder/chest origin of the right hand in local camera space.
rightHandOrigin.x?
number = 0.2
rightHandOrigin.y?
number = -0.2
rightHandOrigin.z?
number = 0
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:
"screen"|"normal"='normal'
Defined in: src/simulator/SimulatorOptions.ts:94
defaultHand
defaultHand:
Handedness=Handedness.LEFT
Defined in: src/simulator/SimulatorOptions.ts:49
defaultMode
defaultMode:
SimulatorMode=SimulatorMode.USER
Defined in: src/simulator/SimulatorOptions.ts:48
deviceCamera
deviceCamera:
object
Defined in: src/simulator/SimulatorOptions.ts:85
enabled
enabled:
boolean=true
environments
environments:
object[]
Defined in: src/simulator/SimulatorOptions.ts:46
manifestPath
manifestPath:
string
name?
optionalname:string
Optional display name; otherwise the manifest name is used.
geminiLivePanel
geminiLivePanel:
object
Defined in: src/simulator/SimulatorOptions.ts:69
element
element:
string='xrblocks-simulator-geminilive'
enabled
enabled:
boolean=false
handPhysics
handPhysics:
SimulatorHandPhysicsOptions
Defined in: src/simulator/SimulatorOptions.ts:100
Optional physical constraints for simulated hands. Requires Rapier.
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:45
x
x:
number=0
y
y:
number=1.5
z
z:
number=0
instructions
instructions:
object
Defined in: src/simulator/SimulatorOptions.ts:59
customInstructions
customInstructions:
SimulatorCustomInstruction[]
element
element:
string='xrblocks-simulator-instructions'
enabled
enabled:
boolean=true
showAutomatically
showAutomatically:
boolean=false
leftHandOrigin
leftHandOrigin:
object
Defined in: src/simulator/SimulatorOptions.ts:96
Shoulder/chest origin of the left hand in local camera space.
x
x:
number=-0.2
y
y:
number=-0.2
z
z:
number=0
modeToggle
modeToggle:
object
Defined in: src/simulator/SimulatorOptions.ts:50
enabled
enabled:
boolean=false
toggleKey
toggleKey:
Keycodes|null
toggleOrder
toggleOrder:
object=DEFAULT_MODE_TOGGLE_ORDER
toggleOrder.Editor
Editor:
SimulatorMode=SimulatorMode.USER
toggleOrder.Hands
Hands:
SimulatorMode=SimulatorMode.POINTER_LOCK
toggleOrder.Navigation
Navigation:
SimulatorMode=SimulatorMode.CONTROLLER
toggleOrder.PointerLock
PointerLock:
SimulatorMode=SimulatorMode.EDITOR
toggleOrder.User
User:
SimulatorMode=SimulatorMode.POSE
navMesh
navMesh:
object
Defined in: src/simulator/SimulatorOptions.ts:76
enabled
enabled:
boolean=false
eyeHeight
eyeHeight:
number=1.5
showDebugVisualizations
showDebugVisualizations:
boolean=false
physics
physics:
object
Defined in: src/simulator/SimulatorOptions.ts:82
Controls the isolated physics world used by the desktop simulator.
enabled
enabled:
boolean=true
reachAngle
reachAngle:
object
Defined in: src/simulator/SimulatorOptions.ts:115
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:109
Limits how far each hand controller can travel from the user's shoulder origin.
enabled
enabled:
boolean=false
radius
radius:
number=0.75
The maximum distance in meters a controller can move from its origin point.
renderToRenderTexture
renderToRenderTexture:
boolean=true
Defined in: src/simulator/SimulatorOptions.ts:92
rightHandOrigin
rightHandOrigin:
object
Defined in: src/simulator/SimulatorOptions.ts:98
Shoulder/chest origin of the right hand in local camera space.
x
x:
number=0.2
y
y:
number=-0.2
z
z:
number=0
simulatorSettingsPanel
simulatorSettingsPanel:
object
Defined in: src/simulator/SimulatorOptions.ts:55
element
element:
string='xrblocks-simulator-settings'
enabled
enabled:
boolean=true
stereo
stereo:
object
Defined in: src/simulator/SimulatorOptions.ts:73
enabled
enabled:
boolean=false