SceneControls

SceneControls

Scene controls navigation menu

Constructor

new SceneControls()

Source:

Members

(static) defaultOptions

Source:

Assign the default options which are supported by the SceneControls ui

activeControl :String

Source:

The name of the active Scene Control toolset

Type:

activeTool :String|null

Source:

Return the name of the active tool within the active control set

Type:

control :Object|null

Source:

Return the active control set

Type:
  • Object | null

controls :Array

Source:

The Array of Scene Control buttons which are currently rendered

Type:

isRuler

Source:

A convenience reference for whether the currently active tool is a Ruler

tool

Source:

Return the actively controled tool

Methods

getData() → {Object}

Source:

Provide data to the HTML template for rendering

Returns:
Type
Object

initialize(control, layer)

Source:

Initialize the Scene Controls by obtaining the set of control buttons and rendering the HTML

Parameters:
Name Type Description
control String

An optional control set to set as active

layer String

An optional layer name to target as the active control