Class Index | File Index

Classes


Class GEarthExtensions#fx.TimedAnimation


Extends GEarthExtensions#fx.Animation.
Generic class for animations of a fixed duration.
Defined in: extensions.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GEarthExtensions#fx.TimedAnimation(duration, renderCallback, completionCallback)
Method Summary
Method Attributes Method Name and Description
 
Render the frame at the given time after the animation was started.
Methods borrowed from class GEarthExtensions#fx.Animation:
rewind, start, stop
Class Detail
GEarthExtensions#fx.TimedAnimation(duration, renderCallback, completionCallback)
Parameters:
{Number} duration
The length of time for which this animation should run, in seconds.
{Function} renderCallback
A method that will be called to render a frame of the animation. Its sole parameter will be the time, in seconds, of the frame to render.
{Function} completionCallback Optional
A callback method to fire when the animation is completed/stopped. The callback will receive an object literal argument that will contain a 'cancelled' boolean value that will be true if the effect was cancelled.
Method Detail
renderFrame(time)
Render the frame at the given time after the animation was started.
Parameters:
{Number} time
The time of the frame to render, in seconds.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Oct 30 2012 11:34:31 GMT-0700 (PDT)