Animation - Cesium Documentation

Animation

new Animation

Animation widget

The Animation widget provides buttons for play, pause, and reverse, along with the current time and date, surrounded by a "shuttle ring" for controlling the speed of animation.

The "shuttle ring" concept is borrowed from video editing, where typically a "jog wheel" can be rotated to move past individual animation frames very slowly, and a surrounding shuttle ring can be twisted to control direction and speed of fast playback. Cesium typically treats time as continuous (not broken into pre-defined animation frames), so this widget offers no jog wheel. Instead, the shuttle ring is capable of both fast and very slow playback. Click and drag the shuttle ring pointer itself (shown above in green), or click in the rest of the ring area to nudge the pointer to the next preset speed in that direction.

The Animation widget also provides a "realtime" button (in the upper-left) that keeps animation time in sync with the end user's system clock, typically displaying "today" or "right now." This mode is not available in ClockRange.CLAMPED or ClockRange.LOOP_STOP mode if the current time is outside of Clock's startTime and endTime.

Parameters:

Name	Type	Description
`container`	Element \| String	The DOM element or ID that will contain the widget.
`viewModel`	AnimationViewModel	The view model used by this widget.

Throws:

DeveloperError : Element with id "container" does not exist in the document.

Example

// In HTML head, include a link to Animation.css stylesheet,
// and in the body, include: <div id="animationContainer"></div>

var clock = new Cesium.Clock();
var clockViewModel = new Cesium.ClockViewModel(clock);
var viewModel = new Cesium.AnimationViewModel(clockViewModel);
var widget = new Cesium.Animation('animationContainer', viewModel);

function tick() {
    clock.tick();
    Cesium.requestAnimationFrame(tick);
}
Cesium.requestAnimationFrame(tick);

See:

Source:

/Source/Widgets/Animation/Animation.js

Members

container :Element

Gets the parent container.

viewModel :AnimationViewModel

Gets the view model.

Methods

applyThemeChanges

Updates the widget to reflect any modified CSS fules for themeing.

Example

//Switch to the cesium-lighter theme.
document.body.className = 'cesium-lighter';
animation.applyThemeChanges();

destroy

Destroys the animation widget. Should be called if permanently removing the widget from layout.

isDestroyed

Returns:

Boolean true if the object has been destroyed, false otherwise.

resize

Resizes the widget to match the container size. This function should be called whenever the container size is changed.