Player API

Player

This is the root player api object, from which all other modules are accessed.

Functions

Create Snapshot

The Snapshot feature will simply capture an image from the current player canvas. It is useful if you made some sene-graph change without using configuration or if you want to create a fast snapshot of what is exactly in the player at the current moment. Keep in mind you may want to switch to a specific or frame the camera before you take the snapshot:

await player.snapshotAsync()

You can find a more robust snapshot example in our recipe.

InitManipulator(player)

Kind: global function

parameter

type

player

player

UpdateManipulator(player)

Kind: global function

parameter

type

player

player

HoverManipulator(player, [obj], [intersection])

Kind: global function

parameter

type

player

player

[obj]

THREE.Object3D

[intersection]

any

ToolEventHandler(ev)

Kind: global function

parameter

type

ev

EventControllerMouseEvent