CameraEventAggregator

new Cesium.CameraEventAggregator(canvas)
Scene/CameraEventAggregator.js 303

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
canvas HTMLCanvasElement document optional The element to handle events for.
See:

Members

anyButtonDown : Boolean
Scene/CameraEventAggregator.js 363

Gets whether any mouse button is down, a touch has started, or the wheel has been moved.

currentMousePosition : Cartesian2
Scene/CameraEventAggregator.js 352

Gets the current mouse position.

Methods

destroy()
Scene/CameraEventAggregator.js 561

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.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
handler = handler && handler.destroy();
See:

getButtonPressTime(type, modifier) → Date
Scene/CameraEventAggregator.js 489

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.

getButtonReleaseTime(type, modifier) → Date
Scene/CameraEventAggregator.js 507

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.

getLastMovement(type, modifier) → Object|undefined
Scene/CameraEventAggregator.js 423

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.

getMovement(type, modifier) → Object
Scene/CameraEventAggregator.js 404

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.

getStartMousePosition(type, modifier) → Cartesian2
Scene/CameraEventAggregator.js 464

Gets the mouse position that started the aggregation.
Name Type Description
type CameraEventType The camera event type.
modifier KeyboardEventModifier optional The keyboard modifier.
Returns:
The mouse position.

isButtonDown(type, modifier) → Boolean
Scene/CameraEventAggregator.js 446

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.

isDestroyed() → Boolean
Scene/CameraEventAggregator.js 542

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:

isMoving(type, modifier) → Boolean
Scene/CameraEventAggregator.js 386

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

reset()
Scene/CameraEventAggregator.js 524

Signals that all of the events have been handled and the aggregator should be reset to handle new events.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.