ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #950 from pagameba/doc-animations

Browse Source 
Improve documentation for animation-related stuff.
This commit is contained in:
Tim Schaub
2013-08-30 14:49:07 -07:00
parent 29317c3316 bfa1fbc2cd
commit 96dfe5656d
3 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/objectliterals.jsdoc
View File

@@ -119,31 +119,31 @@
/**
* @typedef {Object} ol.animation.BounceOptions
* @property {number} resolution Resolution.
* @property {number} resolution The resolution to start the bounce from, typically `map.getView().getResolution()`.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds.
* @property {function(number):number|undefined} easing Easing function.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
*/
/**
* @typedef {Object} ol.animation.PanOptions
* @property {ol.Coordinate} source Source.
* @property {ol.Coordinate} source The location to start panning from, typically `map.getView().getCenter()`.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds.
* @property {function(number):number|undefined} easing Easing function.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
*/
/**
* @typedef {Object} ol.animation.RotateOptions
* @property {number} rotation Rotation.
* @property {number} rotation The rotation to apply, in radians.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds.
* @property {function(number):number|undefined} easing Easing function.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
*/
/**
* @typedef {Object} ol.animation.ZoomOptions
* @property {number} resolution number Resolution.
* @property {number} resolution number The resolution to begin zooming from, typically `map.getView().getResolution()`.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds.
* @property {function(number):number|undefined} easing Easing function.

9
src/ol/animation.jsdoc
View File

@@ -1,3 +1,12 @@
/**
* The {ol.animation} static methods are designed to be used with the {@link ol.Map#addPreRenderFunction} and {@link ol.Map#addPreRenderFunctions} methods. For example:
*
* var map = new ol.Map({ ... });
* var zoom = ol.animation.zoom({
* resolution: map.getView().getResolution()
* });
* map.addPreRenderFunction(zoom);
* map.getView().setResolution(map.getView().getResolution() * 2);
*
* @namespace ol.animation
*/

5
src/ol/map.js
View File

@@ -363,7 +363,8 @@ ol.Map.prototype.addLayer = function(layer) {
/**
* Add a prerender function. This can be used for attaching animations to
* be performed before setting the map's center.
* be performed before setting the map's center. The {@link ol.animation}
* namespace provides several static methods for creating prerender functions.
* @param {ol.PreRenderFunction} preRenderFunction Pre-render function.
*/
ol.Map.prototype.addPreRenderFunction = function(preRenderFunction) {
@@ -374,7 +375,7 @@ ol.Map.prototype.addPreRenderFunction = function(preRenderFunction) {
/**
* Add prerender functions. This can be used for attaching animations to
* be performed before setting the map's center.
* be performed before setting the map's center. See {@link ol.animation}
* @param {Array.<ol.PreRenderFunction>} preRenderFunctions
* Pre-render functions.
*/