API Docs for: 2.0.0
Show:

KeyboardZoomCamera Class

Extends Component
Module: input
Parent Module: BIMSURFER

A KeyboardZoomCamera lets you zoom a Camera using the + and - keys.

Overview

  • Zooming involves moving the Camera's eye closer and farther to its look position.
  • If desired, you can have multiple KeyboardZoomCameras within the same Viewer.
  • Multiple KeyboardZoomCameras can drive the same Camera, or can each drive their own separate Camera.
  • At any instant, the KeyboardZoomCameras we're driving is the one whose active property is true.
  • You can switch a KeyboardZoomCameras to a different Camera at any time.

TODO

Example

Constructor

KeyboardZoomCamera

(
  • [viewer]
  • [cfg]
  • [camera]
)

Parameters:

  • [viewer] Viewer optional

    Parent Viewer.

  • [cfg] optional

    Configs

    • [id] String optional

      Optional ID, unique among all components in the parent viewer, generated automatically when omitted.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this KeyboardZoomCamera.

  • [camera] Camera optional

    The Camera to control.

Methods

destroy

()

Destroys this component.

Removes this Component from its Viewer.

Fires a destroyed event on this Component.

error

(
  • message
)

Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] <component id>: <message>

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Fires an event on this component.

Notifies existing subscribers to the event, retains the event to give to any subsequent notifications on that location as they are made.

Parameters:

  • event String

    The event type name

  • value Object

    The event

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

log

(
  • message
)

Logs a console debugging message for this component.

The console message will have this format: [LOG] <component id>: <message>

Parameters:

  • message String

    The message to log

off

(
  • handle
)

Cancels an event subscription that was previously made with on or once.

Parameters:

  • handle String

    Subscription handle

on

(
  • event
  • callback
  • [scope=this]
)
String

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    Publication event

  • callback Function

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is handled.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

warn

(
  • message
)

Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] <component id>: <message>

Parameters:

  • message String

    The message to log

Properties

active

Boolean

Flag which indicates whether this KeyboardZoomCamera is active or not.

Fires an active event on change.

className

String final

Inherited from Component but overwritten in src/viewer/input/keyboardZoomCamera.js:37

JavaScript class name for this Component.

destroyed

Boolean

True as soon as this Component has been destroyed

id

String final

Unique ID for this Component within its parent Viewer.

Items in this map

Unknown

metadata

Object

Metadata on this component.

viewer

Viewer final

The Viewer that contains this Component.

Events

active

Fired whenever this KeyboardZoomCamera's active property changes.

Event Payload:

  • value Object

    The property's new value

destroyed

Fired when this Component is destroyed.