org.cesiumjs.cs.widgets

Class Animation

java.lang.Object

org.cesiumjs.cs.widgets.Animation

@JsType(isNative=true,
        namespace="Cesium",
        name="Animation")
public class Animation
extends Object

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.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
Animation(com.google.gwt.dom.client.Element container, AnimationViewModel viewModel) 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.
Animation(String container, AnimationViewModel viewModel) 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.

Method Summary

Modifier and Type	Method and Description
void	applyThemeChanges() Updates the widget to reflect any modified CSS rules for theming.
com.google.gwt.dom.client.Element	container() Gets parent container.
void	destroy() Destroys the animation widget.
boolean	isDestroyed()
boolean	isHidden() Request for visible of Animation widget.
void	resize() Resizes the widget to match the container size.
void	setHidden(boolean hidden) Method set visible of Animation widget
AnimationViewModel	viewModel() Gets the view model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Animation

@JsConstructor
public Animation(String container,
                                AnimationViewModel viewModel)

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.

     Example:
     
     SimplePanel animationPanel = new SimplePanel();
     Clock clock = new Clock();
     ClockViewModel clockViewModel = new ClockViewModel(clock);
     AnimationViewModel viewModel = new AnimationViewModel(clockViewModel);
     animationPanel.addAttachHandler(new AttachEvent.Handler() {
         {@literal @}Override
         public void onAttachOrDetach(AttachEvent attachEvent) {
             if (attachEvent.isAttached()) {
                 Animation animation = new Animation(((SimplePanel) attachEvent.getSource()).getElement(), viewModel);
                 animation.resize();

                 Cesium.RequestAnimationFrameCallback tick = new Cesium.RequestAnimationFrameCallback() {
                     {@literal @}Override
                     public void Callback(Number timestamp) {
                         clock.tick();
                         Cesium.requestAnimationFrame(this);
                     }
                 };
                 Cesium.requestAnimationFrame(tick);
             }
         }
     });
 
 

Parameters:

container - The DOM element or ID that will contain the widget.

viewModel - The view model used by this widget.

Animation

@JsConstructor
public Animation(com.google.gwt.dom.client.Element container,
                                AnimationViewModel viewModel)

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.

     Example:
     
     SimplePanel animationPanel = new SimplePanel();
     Clock clock = new Clock();
     ClockViewModel clockViewModel = new ClockViewModel(clock);
     AnimationViewModel viewModel = new AnimationViewModel(clockViewModel);
     animationPanel.addAttachHandler(new AttachEvent.Handler() {
         {@literal @}Override
         public void onAttachOrDetach(AttachEvent attachEvent) {
             if (attachEvent.isAttached()) {
                 Animation animation = new Animation(((SimplePanel) attachEvent.getSource()).getElement(), viewModel);
                 animation.resize();

                 Cesium.RequestAnimationFrameCallback tick = new Cesium.RequestAnimationFrameCallback() {
                     {@literal @}Override
                     public void Callback(Number timestamp) {
                         clock.tick();
                         Cesium.requestAnimationFrame(this);
                     }
                 };
                 Cesium.requestAnimationFrame(tick);
             }
         }
     });
 
 

Parameters:

container - The DOM element or ID that will contain the widget.

viewModel - The view model used by this widget.

Method Detail

container

@JsProperty(name="container")
public com.google.gwt.dom.client.Element container()

Gets parent container.

viewModel

@JsProperty(name="viewModel")
public AnimationViewModel viewModel()

Gets the view model.

applyThemeChanges

@JsMethod
public void applyThemeChanges()

Updates the widget to reflect any modified CSS rules for theming.

destroy

@JsMethod
public void destroy()

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

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns:

true if the object has been destroyed, false otherwise.

resize

@JsMethod
public void resize()

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

setHidden

@JsOverlay
public final void setHidden(boolean hidden)

Method set visible of Animation widget

Parameters:

hidden - false to hide Animation widget, true widget is show.

isHidden

@JsOverlay
public final boolean isHidden()

Request for visible of Animation widget.

Returns:

true if widget not hidden, false is hidden