mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2025-02-16 23:03:13 +03:00
Code Issues Projects Releases Wiki Activity

Fix conversion methods doc.

Browse Source
This commit is contained in:
Antoine Vandecreme 2015-12-14 18:36:18 -05:00
parent 2dcd40afc6
commit 13bfb4ecfc
1 changed files with 31 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
src/viewport.js
View File

@ -931,7 +931,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
}, },
/** /**
* Scale a delta (translation vector) from pixels coordinates to viewport * Scale a delta (translation vector) from viewport coordinates to pixels
* coordinates. This method does not take rotation into account. * coordinates. This method does not take rotation into account.
* Consider using deltaPixelsFromPoints if you need to account for rotation. * Consider using deltaPixelsFromPoints if you need to account for rotation.
* @param {OpenSeadragon.Point} deltaPoints - The translation vector to convert. * @param {OpenSeadragon.Point} deltaPoints - The translation vector to convert.
@ -946,7 +946,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
}, },
/** /**
* Convert a delta (translation vector) from pixels coordinates to viewport * Convert a delta (translation vector) from viewport coordinates to pixels
* coordinates. * coordinates.
* @param {OpenSeadragon.Point} deltaPoints - The translation vector to convert. * @param {OpenSeadragon.Point} deltaPoints - The translation vector to convert.
* @param {Boolean} [current=false] - Pass true for the current location; * @param {Boolean} [current=false] - Pass true for the current location;
@ -960,7 +960,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
}, },
/** /**
* Scale a delta (translation vector) from viewport coordinates to pixels * Scale a delta (translation vector) from pixels coordinates to viewport
* coordinates. This method does not take rotation into account. * coordinates. This method does not take rotation into account.
* Consider using deltaPointsFromPixels if you need to account for rotation. * Consider using deltaPointsFromPixels if you need to account for rotation.
* @param {OpenSeadragon.Point} deltaPixels - The translation vector to convert. * @param {OpenSeadragon.Point} deltaPixels - The translation vector to convert.
@ -975,7 +975,8 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
}, },
/** /**
* Convert a delta (translation vector) from viewport coordinates to pixels coordinates. * Convert a delta (translation vector) from pixels coordinates to viewport
* coordinates.
* @param {OpenSeadragon.Point} deltaPixels - The translation vector to convert. * @param {OpenSeadragon.Point} deltaPixels - The translation vector to convert.
* @param {Boolean} [current=false] - Pass true for the current location; * @param {Boolean} [current=false] - Pass true for the current location;
* defaults to false (target location). * defaults to false (target location).
@ -986,16 +987,25 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
.rotate(-this.getRotation()); .rotate(-this.getRotation());
}, },
/**
* Scale viewport coordinates to pixels coordinates.
* This method does not take rotation into account.
* Consider using pixelFromPoint if you need to account for rotation.
* @param {OpenSeadragon.Point} point the viewport coordinates
* @param {Boolean} [current=false] - Pass true for the current location;
* defaults to false (target location).
* @returns {OpenSeadragon.Point}
*/
scalePixelFromPoint: function(point, current) { scalePixelFromPoint: function(point, current) {
return this._scalePixelFromPoint(point, this.getBounds(current)); return this._scalePixelFromPoint(point, this.getBounds(current));
}, },
/** /**
* Convert image pixel coordinates to viewport coordinates. * Convert viewport coordinates to pixel coordinates.
* @function * @param {OpenSeadragon.Point} point the viewport coordinates
* @param {Boolean} [current=false] - Pass true for the current location; * @param {Boolean} [current=false] - Pass true for the current location;
* defaults to false (target location). * defaults to false (target location).
* @param {Boolean} [ignoreRotation=false] - Pass true to ignore the rotation * @returns {OpenSeadragon.Point}
*/ */
pixelFromPoint: function(point, current) { pixelFromPoint: function(point, current) {
return this._pixelFromPoint(point, this.getBounds(current)); return this._pixelFromPoint(point, this.getBounds(current));
@ -1019,6 +1029,15 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
bounds); bounds);
}, },
/**
* Scale pixel coordinates to viewport coordinates.
* This method does not take rotation into account.
* Consider using pointFromPixel if you need to account for rotation.
* @param {OpenSeadragon.Point} pixel Pixel coordinates
* @param {Boolean} [current=false] - Pass true for the current location;
* defaults to false (target location).
* @returns {OpenSeadragon.Point}
*/
scalePointFromPixel: function(pixel, current) { scalePointFromPixel: function(pixel, current) {
var bounds = this.getBounds( current ); var bounds = this.getBounds( current );
return pixel.minus( return pixel.minus(
@ -1031,9 +1050,11 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{
}, },
/** /**
* Convert viewport coordinates to image pixel coordinates. * Convert pixel coordinates to viewport coordinates.
* @function * @param {OpenSeadragon.Point} pixel Pixel coordinates
* @param {Boolean} current - Pass true for the current location; defaults to false (target location). * @param {Boolean} [current=false] - Pass true for the current location;
* defaults to false (target location).
* @returns {OpenSeadragon.Point}
*/ */
pointFromPixel: function(pixel, current) { pointFromPixel: function(pixel, current) {
return this.scalePointFromPixel(pixel, current).rotate( return this.scalePointFromPixel(pixel, current).rotate(