The goog.fx.Animation Class

goog.fx.Animation
> goog.fx.TransitionBase
> goog.events.EventTarget
> goog.Disposable

goog.fx.Animation(start, end, duration, opt_acc)

Constructor for an animation object.

start {Array.<number>}
Array for start coordinates.
end {Array.<number>}
Array for end coordinates.
duration {number}
Length of animation in milliseconds.
opt_acc {Function=}
Acceleration function, returns 0-1 for inputs 0-1.

The goog.fx.Animation.EventType Enum

Events fired by the animation. … more

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}
The type of the event to listen for.
handler {Function|Object}
The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}
Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}
The callback function.
opt_scope {Object=}
An optional scope to call the callback in.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.cycle(now)

Handles the actual iteration of the animation in a timeout

now {number}
The current time.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}
Event object.
returns {boolean}
If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}
Nothing.

.enableRightPositioningForRtl(useRightPositioningForRtl)

Sets whether the animation should use "right" rather than "left" to position elements. This is a temporary flag to allow clients to transition to the new component at their convenience. At some point "right" will be used for RTL elements by default.

useRightPositioningForRtl {boolean}
True if "right" should be used for positioning, false if "left" should be used for positioning.

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}
The parent EventTarget or null if there is no parent.

.getProgress()

returns {number}
The current progress of the animation, the number is between 0 and 1 inclusive.

.getStateInternal()

Inherited from goog.fx.TransitionBase .

Returns the current state of the animation.

returns {goog.fx.TransitionBase.State}
State of the animation.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}
Whether the object has been disposed of.

.isPaused()

Inherited from goog.fx.TransitionBase .

returns {boolean}
True iff the current state of the animation is paused.

.isPlaying()

Inherited from goog.fx.TransitionBase .

returns {boolean}
True iff the current state of the animation is playing.

.isRightPositioningForRtlEnabled()

Whether the animation should use "right" rather than "left" to position elements. This is a temporary flag to allow clients to transition to the new component at their convenience. At some point "right" will be used for RTL elements by default.

returns {boolean}
True if "right" should be used for positioning, false if "left" should be used for positioning.

.isStopped()

Inherited from goog.fx.TransitionBase .

returns {boolean}
True iff the current state of the animation is stopped.

.onAnimationFrame()

.pause()

Pauses the animation (iff it's playing).

.play(opt_restart)

Starts or resumes an animation.

opt_restart {boolean=}
Whether to restart the animation from the beginning if it has been paused.
returns {boolean}
Whether animation was started.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}
that will be disposed when this object is disposed.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}
The type of the event to listen for.
handler {Function|Object}
The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}
Object in whose scope to call the listener.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}
Parent EventTarget (null if none).

.setProgress(progress)

Sets the progress of the animation.

progress {number}
The new progress of the animation.

.stop(opt_gotoEnd)

Stops the animation.

opt_gotoEnd {boolean=}
If true the animation will move to the end coords.