From d79abe7448e6505ae3c38888992dcc30610c42b9 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 2 Apr 2015 13:13:40 +0200 Subject: [PATCH] Stable geometry methods --- src/ol/geom/geometry.js | 7 ++++--- src/ol/geom/simplegeometry.js | 6 ++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/ol/geom/geometry.js b/src/ol/geom/geometry.js index 30ecaa7247..3583ccbb9f 100644 --- a/src/ol/geom/geometry.js +++ b/src/ol/geom/geometry.js @@ -202,17 +202,18 @@ ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod; * @param {ol.Extent} extent Extent. * @return {boolean} `true` if the geometry and the extent intersect. * @function - * @api + * @api stable */ ol.geom.Geometry.prototype.intersectsExtent = goog.abstractMethod; /** - * Translate the geometry. + * Translate the geometry. This modifies the geometry coordinates in place. If + * instead you want a new geometry, first `clone()` this geometry. * @param {number} deltaX Delta X. * @param {number} deltaY Delta Y. * @function - * @api + * @api stable */ ol.geom.Geometry.prototype.translate = goog.abstractMethod; diff --git a/src/ol/geom/simplegeometry.js b/src/ol/geom/simplegeometry.js index 456dc28755..d943f00d95 100644 --- a/src/ol/geom/simplegeometry.js +++ b/src/ol/geom/simplegeometry.js @@ -249,10 +249,8 @@ ol.geom.SimpleGeometry.prototype.applyTransform = function(transformFn) { /** - * Translate the geometry. - * @param {number} deltaX Delta X. - * @param {number} deltaY Delta Y. - * @api + * @inheritDoc + * @api stable */ ol.geom.SimpleGeometry.prototype.translate = function(deltaX, deltaY) { var flatCoordinates = this.getFlatCoordinates();