Skip to main content

Class: ModelViewer

Defined in: src/ui/model/ModelViewer.ts:108

Loads and presents one interactive glTF or Gaussian Splat model.

Extends​

Constructors​

Constructor​

new ModelViewer(__namedParameters): ModelViewer

Defined in: src/ui/model/ModelViewer.ts:149

Parameters​

__namedParameters​

ModelViewerOptions = {}

Returns​

ModelViewer

Overrides​

Script.constructor

Properties​

boundingBox​

readonly boundingBox: Box3

Defined in: src/ui/model/ModelViewer.ts:120

Local bounds of the presented model.


isXRScript​

isXRScript: boolean = true

Defined in: src/core/Script.ts:100

Inherited from​

Script.isXRScript


xb?​

optional xb: XBObjectOptions

Defined in: src/interaction/InteractionTypes.ts:34

Inherited from​

Script.xb

Accessors​

manipulation​

Get Signature​

get manipulation(): boolean | ManipulationOptions | undefined

Defined in: src/ui/model/ModelViewer.ts:175

Returns​

boolean | ManipulationOptions | undefined

Set Signature​

set manipulation(value): void

Defined in: src/ui/model/ModelViewer.ts:179

Parameters​
value​

boolean | ManipulationOptions | undefined

Returns​

void

Methods​

dispose()​

dispose(): void

Defined in: src/ui/model/ModelViewer.ts:283

Called when the script is removed from the scene. Opposite of init.

Returns​

void

Overrides​

Script.dispose


init()​

init(__namedParameters): Promise<void>

Defined in: src/ui/model/ModelViewer.ts:185

Initializes an instance with XR controllers, grips, hands, and default options. We allow all scripts to quickly access its user (e.g., user.isSelecting(), user.hands), world (e.g., physical depth mesh, lighting estimation, and recognized objects), and scene (the root of three.js's scene graph). If this returns a promise, we will wait for it.

Parameters​

__namedParameters​
depth​

Depth

interaction​

Interaction

registry​

Registry

rendererHolder​

RendererHolder

scene​

Scene

timer​

Timer

Returns​

Promise<void>

Overrides​

Script.init


initPhysics()​

initPhysics(_physics): void | Promise<void>

Defined in: src/core/Script.ts:119

Enables depth-aware interactions with physics. See /samples/advanced/ballpit

Parameters​

_physics​

Physics

Returns​

void | Promise<void>

Inherited from​

Script.initPhysics


load()​

load(source): Promise<void>

Defined in: src/ui/model/ModelViewer.ts:221

Replaces the current model. The file format is inferred from the URL.

Parameters​

source​

string | ModelSource

Returns​

Promise<void>


onHoverEnter()​

onHoverEnter(event): void

Defined in: src/ui/model/ModelViewer.ts:273

Called when a source starts hovering over this object.

Parameters​

event​

HoverEvent

Returns​

void

Overrides​

Script.onHoverEnter


onHoverExit()​

onHoverExit(event): void

Defined in: src/ui/model/ModelViewer.ts:278

Called when a source stops hovering over this object.

Parameters​

event​

HoverEvent

Returns​

void

Overrides​

Script.onHoverExit


onHovering()​

onHovering(_event): void

Defined in: src/core/Script.ts:234

Called while a source hovers over this object.

Parameters​

_event​

HoverEvent

The hover source, target, surface, and intersection. Call event.stopPropagation() to stop bubbling to ancestor Scripts.

Returns​

void

Inherited from​

Script.onHovering


onKeyDown()​

onKeyDown(_event): void

Defined in: src/core/Script.ts:159

Called on keyboard keypress.

Parameters​

_event​

KeyEvent

Event containing .code to read the keyboard key.

Returns​

void

Inherited from​

Script.onKeyDown


onKeyUp()​

onKeyUp(_event): void

Defined in: src/core/Script.ts:160

Parameters​

_event​

KeyEvent

Returns​

void

Inherited from​

Script.onKeyUp


onLongSelect()​

onLongSelect(_event): void

Defined in: src/core/Script.ts:153

Called when an object selection reaches the long-select delay.

Parameters​

_event​

LongSelectEvent

Returns​

void

Inherited from​

Script.onLongSelect


onObjectGrabbing()​

onObjectGrabbing(_event): void

Defined in: src/core/Script.ts:260

Called every frame a hand is grabbing this object.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabbing


onObjectGrabEnd()​

onObjectGrabEnd(_event): void

Defined in: src/core/Script.ts:265

Called when a hand stops grabbing this object. This ends built-in direct-touch manipulation without ending contact.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabEnd


onObjectGrabStart()​

onObjectGrabStart(_event): void

Defined in: src/core/Script.ts:256

Called when a hand starts grabbing this object (touching + pinching). A grab starts built-in direct-touch manipulation when enabled.

Parameters​

_event​

ObjectGrabEvent

Returns​

void

Inherited from​

Script.onObjectGrabStart


onObjectLongSelect()​

onObjectLongSelect(_event): void

Defined in: src/core/Script.ts:210

Called once when a captured selection is held for the long-select delay. Manipulation captures do not emit this callback.

Parameters​

_event​

LongSelectEvent

The controller and completed hold duration. Call event.stopPropagation() to stop bubbling to ancestor Scripts. Call event.stopGlobalPropagation() to suppress global selection callbacks for the rest of this capture

Returns​

void

Inherited from​

Script.onObjectLongSelect


onObjectManipulate()​

onObjectManipulate(_event): void

Defined in: src/core/Script.ts:216

Called for each phase of an automatic object manipulation. Call event.stopPropagation() to stop bubbling. Calling preventDefault() on a start event suppresses the automatic action.

Parameters​

_event​

ManipulationEvent

Returns​

void

Inherited from​

Script.onObjectManipulate


onObjectSelectEnd()​

onObjectSelectEnd(_event): void

Defined in: src/core/Script.ts:201

Called when a source stops selecting the object this Script represents.

Parameters​

_event​

SelectEndEvent

The completed state and end reason. Call event.stopPropagation() to stop bubbling to ancestor Scripts. Call event.stopGlobalPropagation() to suppress global selection callbacks for the rest of this capture

Returns​

void

Inherited from​

Script.onObjectSelectEnd


onObjectSelectStart()​

onObjectSelectStart(_event): void

Defined in: src/core/Script.ts:193

Called when a source starts selecting the object this Script represents.

Parameters​

_event​

SelectEvent

event.target is the logical object and event.source.controller identifies the controller. Call event.stopPropagation() to stop bubbling to ancestor Scripts. Call event.stopGlobalPropagation() to suppress global selection callbacks for the rest of this capture

Returns​

void

Inherited from​

Script.onObjectSelectStart


onObjectTouchEnd()​

onObjectTouchEnd(_event): void

Defined in: src/core/Script.ts:251

Called when a hand's index finger stops touching this object. This ends the default selection lifecycle after the touch callback.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouchEnd


onObjectTouching()​

onObjectTouching(_event): void

Defined in: src/core/Script.ts:246

Called every frame that a hand's index finger is touching this object. The object remains selected during these frames unless touch selection was prevented when contact started.

Parameters​

_event​

ObjectTouchEvent

Returns​

void

Inherited from​

Script.onObjectTouching


onObjectTouchStart()​

onObjectTouchStart(_event): void

Defined in: src/core/Script.ts:240

Called when a hand's index finger starts touching this object. Direct touch starts the object's selection lifecycle by default. Call event.preventDefault() to handle contact without selecting.

Parameters​

_event​

ObjectTouchStartEvent

Returns​

void

Inherited from​

Script.onObjectTouchStart


onSelect()​

onSelect(_event): void

Defined in: src/core/Script.ts:145

Called whenever pinch / mouse click successfully completes, globally.

Parameters​

_event​

SelectEvent

The interaction source and completed target.

Returns​

void

Inherited from​

Script.onSelect


onSelectEnd()​

onSelectEnd(_event): void

Defined in: src/core/Script.ts:139

Called whenever pinch / mouse click discontinues, globally.

Parameters​

_event​

SelectEndEvent

The completed state and end reason.

Returns​

void

Inherited from​

Script.onSelectEnd


onSelecting()​

onSelecting(_event): void

Defined in: src/core/Script.ts:150

Called whenever pinch / mouse click is happening, globally.

Parameters​

_event​

SelectEvent

Returns​

void

Inherited from​

Script.onSelecting


onSelectStart()​

onSelectStart(_event): void

Defined in: src/core/Script.ts:133

Called whenever pinch / mouse click starts, globally.

Parameters​

_event​

SelectEvent

The interaction source and optional captured target.

Returns​

void

Inherited from​

Script.onSelectStart


onSimulatorStarted()​

onSimulatorStarted(): void

Defined in: src/core/Script.ts:125

Returns​

void

Inherited from​

Script.onSimulatorStarted


onSqueeze()​

onSqueeze(_event): void

Defined in: src/core/Script.ts:182

Called whenever gamepad trigger successfully completes, globally.

Parameters​

_event​

SelectEvent

event.source.controller identifies the controller.

Returns​

void

Inherited from​

Script.onSqueeze


onSqueezeEnd()​

onSqueezeEnd(_event): void

Defined in: src/core/Script.ts:171

Called whenever gamepad trigger stops, globally.

Parameters​

_event​

SelectEvent

event.source.controller identifies the controller.

Returns​

void

Inherited from​

Script.onSqueezeEnd


onSqueezeStart()​

onSqueezeStart(_event): void

Defined in: src/core/Script.ts:166

Called whenever gamepad trigger starts, globally.

Parameters​

_event​

SelectEvent

event.source.controller identifies the controller.

Returns​

void

Inherited from​

Script.onSqueezeStart


onSqueezing()​

onSqueezing(_event): void

Defined in: src/core/Script.ts:176

Called whenever gamepad is being triggered, globally.

Parameters​

_event​

SelectEvent

Returns​

void

Inherited from​

Script.onSqueezing


onXRSessionEnded()​

onXRSessionEnded(): void

Defined in: src/core/Script.ts:123

Returns​

void

Inherited from​

Script.onXRSessionEnded


onXRSessionStarted()​

onXRSessionStarted(_session?): void

Defined in: src/core/Script.ts:122

Parameters​

_session?​

XRSession

Returns​

void

Inherited from​

Script.onXRSessionStarted


physicsStep()​

physicsStep(): void

Defined in: src/core/Script.ts:120

Returns​

void

Inherited from​

Script.physicsStep


playAnimation()​

playAnimation(__namedParameters): void

Defined in: src/ui/model/ModelViewer.ts:255

Plays every animation in the loaded glTF.

Parameters​

__namedParameters​

PlayModelAnimationOptions = {}

Returns​

void


setContent()​

setContent(content): void

Defined in: src/ui/model/ModelViewer.ts:244

Presents an existing Three.js object. The caller retains ownership of its geometry, materials, and textures.

Parameters​

content​

Object3D

Returns​

void


update()​

update(): void

Defined in: src/ui/model/ModelViewer.ts:267

Runs per frame.

Returns​

void

Overrides​

Script.update