Add docs to clarify that distanceTo measures distance on x-y plane only.

git-svn-id: http://svn.openlayers.org/trunk/openlayers@9015 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
2009-03-11 19:24:56 +00:00
parent b682f76f95
commit 9afcb939be
5 changed files with 5 additions and 5 deletions

View File

@@ -130,7 +130,7 @@ OpenLayers.Geometry = OpenLayers.Class({
/** /**
* APIMethod: distanceTo * APIMethod: distanceTo
* Calculate the closest distance between two geometries. * Calculate the closest distance between two geometries (on the x-y plane).
* *
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} The target geometry. * geometry - {<OpenLayers.Geometry>} The target geometry.

View File

@@ -285,7 +285,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
/** /**
* APIMethod: distanceTo * APIMethod: distanceTo
* Calculate the closest distance between two geometries. * Calculate the closest distance between two geometries (on the x-y plane).
* *
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} The target geometry. * geometry - {<OpenLayers.Geometry>} The target geometry.

View File

@@ -415,7 +415,7 @@ OpenLayers.Geometry.LineString = OpenLayers.Class(OpenLayers.Geometry.Curve, {
/** /**
* APIMethod: distanceTo * APIMethod: distanceTo
* Calculate the closest distance between two geometries. * Calculate the closest distance between two geometries (on the x-y plane).
* *
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} The target geometry. * geometry - {<OpenLayers.Geometry>} The target geometry.

View File

@@ -71,7 +71,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
/** /**
* APIMethod: distanceTo * APIMethod: distanceTo
* Calculate the closest distance between two geometries. * Calculate the closest distance between two geometries (on the x-y plane).
* *
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} The target geometry. * geometry - {<OpenLayers.Geometry>} The target geometry.

View File

@@ -158,7 +158,7 @@ OpenLayers.Geometry.Polygon = OpenLayers.Class(
/** /**
* APIMethod: distanceTo * APIMethod: distanceTo
* Calculate the closest distance between two geometries. * Calculate the closest distance between two geometries (on the x-y plane).
* *
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} The target geometry. * geometry - {<OpenLayers.Geometry>} The target geometry.