FORGE. ControllerKeyboard

new ControllerKeyboard(viewer, config)

Parameters:
Name Type Description
viewer FORGE.Viewer viewer reference.
config ControllerInstanceConfig the configuration of the controller
Source:

Extends

Members

(readonly) active :boolean

Get the "active" flag of the camera controller. A controller is active when it is currently in use.
Type:
  • boolean
Inherited From:
Source:

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) className :string

Get the class name of the object.
Type:
  • string
Inherited From:
Source:

data :*

Get and set any custom data you want to associate to this object.
Type:
  • *
Inherited From:
Source:

debug :boolean

Get and set the debug flag.
Type:
  • boolean
Inherited From:
Source:

enabled :boolean

Get or set the enabled flag.
Type:
  • boolean
Inherited From:
Source:

(readonly) onControlEnd :FORGE.EventDispatcher

Get the "onControlEnd" FORGE.EventDispatcher of the camera controller.
Type:
Inherited From:
Source:

(readonly) onControlStart :FORGE.EventDispatcher

Get the "onControlStart" FORGE.EventDispatcher of the camera controller.
Type:
Inherited From:
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

(readonly) type :string

Get type of the controller.
Type:
  • string
Inherited From:
Source:

(readonly) uid :string

Get the uid of the object.
Type:
  • string
Inherited From:
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

Methods

_parseConfig(config)

Parse the configuration.
Parameters:
Name Type Description
config ControllerInstanceConfig configuration object to parse.
Source:

destroy()

Destroy routine
Overrides:
  • FORGE.ControllerBase#destroy
Source:

disable()

Disable controller
Overrides:
Source:

enable()

Enable controller
Overrides:
Source:

log(value)

Basic log method, log a string in the console if debug is enabled.
Parameters:
Name Type Description
value * The value you want to log in the console.
Inherited From:
Source:

update()

Update routine.
Source:

warn(valuenullable)

Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
Name Type Attributes Description
value string | Object <nullable>
 The value you want to warn in the console.
Inherited From:
Source:

FORGE. ControllerKeyboard

Members
Methods