CameraEventAggregator - Cesium Documentation

# 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:

  - ScreenSpaceEventHandler
  Source: Scene/CameraEventAggregator.js, line 257

### Members

#### anyButtonDown :Boolean

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

#### currentMousePosition :Cartesian2

  Gets the current mouse position.
  Source: Scene/CameraEventAggregator.js, line 306

### Methods

#### 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:

  - CameraEventAggregator#isDestroyed
  Source: Scene/CameraEventAggregator.js, line 505

#### 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 435

#### 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 453

#### 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 372

#### 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 353

#### getStartMousePosition(type, modifier) → Cartesian2

  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.
  Source: Scene/CameraEventAggregator.js, line 413

#### 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 395

#### 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:

  - CameraEventAggregator#destroy
  Source: Scene/CameraEventAggregator.js, line 485

#### 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 335

#### reset()

  Signals that all of the events have been handled and the aggregator should be reset to handle new events.
  Source: Scene/CameraEventAggregator.js, line 467