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

Geometry: Added "along" to the API documentation

Browse Source
This commit is contained in:
Tobias Bieniek
2013-03-25 19:10:50 +01:00
parent 29976ba98a
commit 6b79391b5e
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
lib/OpenLayers/Geometry.js
View File

@@ -438,7 +438,7 @@ OpenLayers.Geometry.segmentsIntersect = function(seg1, seg2, options) {
* representing endpoint coordinates. * representing endpoint coordinates.
* *
* Returns: * Returns:
* {Object} An object with distance, x, and y properties. The distance * {Object} An object with distance, along, x, and y properties. The distance
* will be the shortest distance between the input point and segment. * will be the shortest distance between the input point and segment.
* The x and y properties represent the coordinates along the segment * The x and y properties represent the coordinates along the segment
* where the shortest distance meets the segment. The along attribute * where the shortest distance meets the segment. The along attribute
@@ -463,11 +463,12 @@ OpenLayers.Geometry.distanceToSegment = function(point, segment) {
* representing endpoint coordinates. * representing endpoint coordinates.
* *
* Returns: * Returns:
* {Object} An object with squared distance, x, and y properties. The distance * {Object} An object with squared distance, along, x, and y properties.
* will be the shortest distance between the input point and segment. * The distance will be the shortest distance between the input point and
* The x and y properties represent the coordinates along the segment * segment. The x and y properties represent the coordinates along the
* where the shortest distance meets the segment. The along attribute * segment where the shortest distance meets the segment. The along
* describes how far between the two segment points the given point is. * attribute describes how far between the two segment points the given
* point is.
*/ */
OpenLayers.Geometry.distanceSquaredToSegment = function(point, segment) { OpenLayers.Geometry.distanceSquaredToSegment = function(point, segment) {
var x0 = point.x; var x0 = point.x;