Namespace GEarthExtensions#fx

Defined in: extensions.js.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	GEarthExtensions#fx Contains various animation/effects tools for use in the Google Earth API.

Method Summary
Method Attributes	Method Name and Description
<static>	GEarthExtensions#fx.animateProperty(object, property, options) Animate a numeric property on a plugin object.
<static>	GEarthExtensions#fx.bounce(placemark, options) Bounces a point placemark by animating its altitude.
<static>	GEarthExtensions#fx.cancel(feature) Cancel all animations on a given feature, potentially leaving them in an intermediate visual state.
<static>	GEarthExtensions#fx.rewind(feature) Cancel all animations on a given feature and revert them to their t = 0 state.

Namespace Detail

GEarthExtensions#fx

Contains various animation/effects tools for use in the Google Earth API.

Method Detail

<static> GEarthExtensions#fx.animateProperty(object, property, options)

Animate a numeric property on a plugin object.

Parameters:
{KmlObject} object: The plugin object whose property to animate.
{String} property: The property to animate. This should match 1:1 to the getter/setter methods on the plugin object. For example, to animate a KmlPoint latitude, pass in `latitude`, since the getter/setters are `getLatitude` and `setLatitude`.
{Object} options: The property animation options.
{Number} options.duration Optional, Default: 500: The duration, in milliseconds, of the animation.
{Number} options.start Optional: The value of the property to set at the start of the animation.
{Number} options.end Optional: The desired end value of the property.
{Number} options.delta Optional: If end is not specified, you may set this to the desired change in the property value.
{String|Function} options.easing Optional, Default: 'none': The easing function to use during the animation. Valid values are 'none', 'in', 'out', or 'both'. Alternatively, an easy function mapping `[0.0, 1.0] -> [0.0, 1.0]` can be specified. No easing is `f(x) = x`.
{Function} options.callback 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.
{KmlFeature} options.featureProxy Optional: A feature to associate with this property animation for use with GEarthExtensions#fx.cancel or GEarthExtensions#fx.rewind.

<static> GEarthExtensions#fx.bounce(placemark, options)

Bounces a point placemark by animating its altitude.

Parameters:
{KmlPlacemark} placemark: The point placemark to bounce.
{Object} options Optional: The bounce options.
{Number} options.duration Optional, Default: 300: The duration of the initial bounce, in milliseconds.
{Number} options.startAltitude Optional: The altitude at which to start the bounce, in meters. The default is the point's current altitude.
{Number} options.altitude Optional: The altitude by which the placemark should rise at its peak, in meters. The default is the computed based on the current plugin viewport.
{Number} options.phase Optional: The bounce phase. If no phase is specified, both ascent and descent are performed. If phase=1, then only the ascent is performed. If phase=2, then only the descent and repeat are performed.
{Number} options.repeat Optional, Default: 0: The number of times to repeat the bounce.
{Number} options.dampen Optional, Default: 0.3: The altitude and duration dampening factor that repeat bounces should be scaled by.
{Function} options.callback Optional: A callback function to be triggered after the bounce is completed. The callback's 'this' variable will be bound to the placemark object, and it will receive a single boolean argument that will be true if the bounce was cancelled. Note that the callback is not fired if phase=2.

<static> GEarthExtensions#fx.cancel(feature)

Cancel all animations on a given feature, potentially leaving them in an intermediate visual state.

<static> GEarthExtensions#fx.rewind(feature)

Cancel all animations on a given feature and revert them to their t = 0 state.

Classes