CameraEventAggregator

new CameraEventAggregator(element)

Aggregates input events. For example, suppose the following inputs are received between frames: left mouse button down, mouse move, mouse move, left mouse button up. These events will be aggregated into one event with a start and end position of the mouse.
Name Type Default Description
element Canvas document optional The element to handle events for.
See:
Source: Scene/CameraEventAggregator.js, line 248

Methods

anyButtonDown() → Boolean

Gets whether any mouse button is down, a touch has started, or the wheel has been moved.
Returns:
Whether any mouse button is down, a touch has started, or the wheel has been moved.
Source: Scene/CameraEventAggregator.js, line 376

destroy() → undefined

Removes mouse listeners held by this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Returns:
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
handler = handler && handler.destroy();
See:
Source: Scene/CameraEventAggregator.js, line 468

getButtonPressTime(type, modifier) → Date

Gets the time the button was pressed or the touch was started.
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
The time the button was pressed or the touch was started.
Source: Scene/CameraEventAggregator.js, line 392

getButtonReleaseTime(type, modifier) → Date

Gets the time the button was released or the touch was ended.
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
The time the button was released or the touch was ended.
Source: Scene/CameraEventAggregator.js, line 411

getLastMovement(type, modifier) → Object|undefined

Gets the start and end position of the last move event (not the aggregated event).
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
An object with two Cartesian2 properties: startPosition and endPosition or undefined.
Source: Scene/CameraEventAggregator.js, line 335

getMovement(type, modifier) → Object

Gets the aggregated start and end position of the current event.
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
An object with two Cartesian2 properties: startPosition and endPosition.
Source: Scene/CameraEventAggregator.js, line 315

isButtonDown(type, modifier) → Boolean

Gets whether the mouse button is down or a touch has started.
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
Whether the mouse button is down or a touch has started.
Source: Scene/CameraEventAggregator.js, line 359

isDestroyed() → Boolean

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:
Source: Scene/CameraEventAggregator.js, line 446

isMoving(type, modifier) → Boolean

Gets if a mouse button down or touch has started and has been moved.
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
Returns true if a mouse button down or touch has started and has been moved; otherwise, false
Source: Scene/CameraEventAggregator.js, line 296