Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CameraAnimation

Abstract class used as base to define camera animations.

Hierarchy

Index

Constructors

constructor

Properties

Protected duration

duration: number = 10000

Duration of a whole animation in milliseconds. Defaults to 10 seconds.

Protected easing

easing: (amount: number) => number = TWEEN.Easing.Linear.None

Easing function that control acceleration. Defaults to EasingFunction.Linear.

Type declaration

    • (amount: number): number
    • Parameters

      • amount: number

      Returns number

Protected mapView

mapView: MapView

MapView which will be affected by the animation.

Optional name

name: undefined | string

Animation's name.

Protected Optional onFinished

onFinished: undefined | (() => void)

Callback that gets triggered once the animation ends.

Protected repeat

repeat: number = 0

Number of times the animation should be repeated. Defaults to 0.

Protected running

running: boolean = false

True if animation is being played.

Protected stopped

stopped: boolean = false

True if the animation has been interrupted.

Protected Optional tween

tween: TWEEN.Tween<GeoCoordinates | Record<string, number>>

Tweening controller.

Accessors

isRunning

  • get isRunning(): boolean

Methods

Abstract start

  • start(time?: undefined | number, onFinished?: undefined | (() => void)): void
  • Start the animation.

    Parameters

    • Optional time: undefined | number

      Duration of the animation in milliseconds.

    • Optional onFinished: undefined | (() => void)

      Callback that gets triggered once the animation ends.

    Returns void

Abstract stop

  • stop(): void

update

  • update(time?: undefined | number): boolean

Generated using TypeDoc