Player API

Modules

Camera

This module is for manipulating the camera.

Configurator

This module is used to interact with the active configurator.

Player

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

Scene

This module is a high level scene graph manipulation and query library.

• Either id, name, or regex's can be used for node names.
• All get functions return the value, or undefined if no match is found
• All find functions return an id or a Path
• All filter functions return an array of id or Path

Selection

This module is used to interact with the current scene selection set, which is the set of currently selected nodes in the active scene.

Tools

This module is for interacting with tools, which are responsible for updating the scene based on keyboard, mouse, and touch interfaces.

The default set of tools installed will handle scene navigation (orbit, pan, zoom).

Functions

InitManipulator(player) ⇒ Object

UpdateManipulator(player) ⇒ void

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

ToolEventHandler(ev) ⇒ void

Typedefs

QueryObject : object

Color : object

SelectionSetStyle : object

WidgetResult : object

Manipulator : object

EventControllerMouseEvent : object

ToolEventHandlers : object

Tool : object

Camera

This module is for manipulating the camera.

• Camera
  • ~orbit(dx, dy)
  • ~pan(dx, dy)
  • ~zoom(delta)
  • ~frameBoundingSphere([assetIds], [direction], [options])
  • ~getPosition([target])
  • ~setPosition([position])
  • ~getQuaternion([target])
  • ~setQuaternion([quaternion])

Camera~orbit(dx, dy)

Orbit the active camera.

Kind: inner method of Camera

Example

player.camera.orbit(1, 0);

Camera~pan(dx, dy)

Pan the active camera.

Kind: inner method of Camera

Example

player.camera.pan(1, 0);

Camera~zoom(delta)

Zoom the active camera.

Kind: inner method of Camera

Example

player.camera.zoom(1);

Camera~frameBoundingSphere([assetIds], [direction], [options])

frame the active camera.

Kind: inner method of Camera

Example

player.cameraController.frameBoundingSphere();

Camera~getPosition([target])

get the active camera's position

Kind: inner method of Camera

Example

console.log(player.cameraController.getPosition(tmpVector3));

Camera~setPosition([position])

set the active camera's position

Kind: inner method of Camera

Example

player.cameraController.setPosition(new Vector3(0, 0, 10));

Camera~getQuaternion([target])

get the active camera's quaternion

Kind: inner method of Camera

Example

console.log(player.cameraController.getQuaternion(tmpQuaternion));

Camera~setQuaternion([quaternion])

set the active camera's quaternion

Kind: inner method of Camera

Example

player.cameraController.setQuaternion(new Quaternion().setFromAxisAngle(new Vector3(0,1,0), Math.PI));

Configurator

This module is used to interact with the active configurator.

• Configurator
  • ~getAttributes() ⇒ object.<string, any>
  • ~getMetadata() ⇒ object.<string, any>
  • ~getConfiguration() ⇒ object.<string, any>
  • ~setConfiguration(conf) ⇒ object.<string, any>
  • ~prefetchAttributes(attributes) ⇒ Promise.<void>

Configurator~getAttributes() ⇒ object.<string, any>

Returns all enabled attributes.

Kind: inner method of Configurator

Configurator~getMetadata() ⇒ object.<string, any>

Returns all metadata.

Kind: inner method of Configurator

Configurator~getConfiguration() ⇒ object.<string, any>

Retrieves the active configuration with the form { [attributeName]: value }.

Kind: inner method of Configurator

Configurator~setConfiguration(conf) ⇒ object.<string, any>

Sets the active configuration.

Kind: inner method of Configurator

Example

const configurator = await player.getConfigurator();
configurator.setConfiguration({ Color: 'Blue' });

Configurator~prefetchAttributes(attributes) ⇒ Promise.<void>

Prefetches all images for attributes specified to improve loading performance (only applies to 2D player).

Kind: inner method of Configurator

Example

const configurator = await player.getConfigurator();
await configurator.prefetchAttributes(['Rotation'])

Player

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

Scene

This module is a high level scene graph manipulation and query library.

• Either id, name, or regex's can be used for node names.
• All get functions return the value, or undefined if no match is found
• All find functions return an id or a Path
• All filter functions return an array of id or Path

• Scene
  • ~find(query)
  • ~fetch(id)
  • ~alignNode(nodeId, alignNodeId)
  • "PHASES"

Scene~find(query)

Finds first matching node. (See {@tutorial sdk-SceneGraph})

Kind: inner method of Scene

Example

// Return the node uuid
scene.find({ name: 'Box' }); -> ['uuid']
// Return the path to the transform operator
scene.find({ name: 'Box', plug: 'Transform', property: 'translation' }); -> ['uuid','plugs','Transform',0]
// Match the first node that starts with Box
scene.find({ name: 'Box*' });

Scene~fetch(id)

Fetch an asset, to make it available for querying sceneGraph data.

Kind: inner method of Scene

Scene~alignNode(nodeId, alignNodeId)

Move nodeId to align with alignNodeId, optionally using anchorNodeId to do the alignment.

Kind: inner method of Scene

Example

// Move the sword to place the sword handle in the hand
scene.alignNode(swordId, handId, { anchorNodeId: swordHandleId, withRotation: true });

"PHASES"

There are three events that are triggered in turn as the scene loads: PRELOADED, LOADED, and RENDERED.

Kind: event emitted by Scene
Read only: true
Properties

Selection

This module is used to interact with the current scene selection set, which is the set of currently selected nodes in the active scene.

• Selection
  • ~includes ⇒ boolean
  • ~toggle(query) ⇒ void
  • ~add(query) ⇒ void
  • ~remove(query) ⇒ void
  • ~clear() ⇒ void
  • ~set(query) ⇒ void
  • ~getStyle() ⇒ SelectionSetStyle
  • ~setStyle(selectionSetStyle) ⇒ void

Selection~includes ⇒ boolean

Checks if the selection set includes node(s).

Kind: inner property of Selection

Selection~toggle(query) ⇒ void

Toggles node(s) to the selection set.

Kind: inner method of Selection

Example

selectionSet.add({ name: 'Box' });

Selection~add(query) ⇒ void

Adds node(s) to the selection set.

Kind: inner method of Selection

Example

selectionSet.add({ name: 'Box' });

Selection~remove(query) ⇒ void

Removes node(s) from the selection set.

Kind: inner method of Selection

Example

selectionSet.remove({ name: 'Box' });

Selection~clear() ⇒ void

Removes all node(s) from the selection set.

Kind: inner method of Selection

Selection~set(query) ⇒ void

Set the node(s) of the selection set.

Kind: inner method of Selection

Selection~getStyle() ⇒ SelectionSetStyle

Returns the style object for the selection set.

Kind: inner method of Selection

Selection~setStyle(selectionSetStyle) ⇒ void

Sets the selection set styling properties.

Kind: inner method of Selection

Example

selectionSet.setStyle({ outlineColor: '#00ff00', outlineThinkness: 5, color: '#ff0000', opacity: 0.5 });

Tools

This module is for interacting with tools, which are responsible for updating the scene based on keyboard, mouse, and touch interfaces.

The default set of tools installed will handle scene navigation (orbit, pan, zoom).

• Tools
  • ~addTool(tool) ⇒ void
  • ~addTools(tools) ⇒ void
  • ~setTool(key, attrs) ⇒ void
  • ~setTools(tools) ⇒ void
  • ~removeTool(toolName)
  • ~removeTools(toolNames)
  • ~setPrimary(toolName)
  • ~getPrimaryTool() ⇒ string

Tools~addTool(tool) ⇒ void

Adds a tool to the player.

Kind: inner method of Tools

Example

player.addTool('orbit')

Tools~addTools(tools) ⇒ void

Adds an array of tools to the player.

Kind: inner method of Tools

Example

player.addTools(['pan', 'orbit', 'zoom'])

Tools~setTool(key, attrs) ⇒ void

Updates an existing tool.

Kind: inner method of Tools

Example

player.setTool('orbit', { enabled: false })

Tools~setTools(tools) ⇒ void

Updates existing tools.

Kind: inner method of Tools

Example

player.setTools({ 'orbit', { enabled: false }, 'pan': { enabled: true } })

Tools~removeTool(toolName)

Removes a tool from the player.

Kind: inner method of Tools

Example

player.removeTool('orbit')

Tools~removeTools(toolNames)

Removes an array of tools from the player.

Kind: inner method of Tools

Example

player.removeTools(['pan', 'orbit', 'zoom'])

Tools~setPrimary(toolName)

Sets a tool as Primary tool.

Kind: inner method of Tools

Example

player.setPrimary('zoom')

Tools~getPrimaryTool() ⇒ string

Gets the current primary tool.

Kind: inner method of Tools
Returns: string -

primaryToolName

player.getPrimaryTool()

InitManipulator(player) ⇒ Object

Kind: global function

UpdateManipulator(player) ⇒ void

Kind: global function

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

Kind: global function

ToolEventHandler(ev) ⇒ void

Kind: global function

QueryObject : object

Kind: global typedef
Properties

Color : object

Kind: global typedef
Properties

SelectionSetStyle : object

Kind: global typedef
Properties

WidgetResult : object

Kind: global typedef
Properties

Manipulator : object

Kind: global typedef
Properties

EventControllerMouseEvent : object

Kind: global typedef
Properties

ToolEventHandlers : object

Kind: global typedef
Properties

Tool : object

Kind: global typedef
Properties