digilib: client/digitallibrary/jquery/jquery.digilib.geometry.js comparison

comparison client/digitallibrary/jquery/jquery.digilib.geometry.js @ 800:ac1d6b056a6f jquery

geometry: overlapsRect() plus some comment clarifications

author	hertzhaft
date	Sun, 20 Feb 2011 11:55:51 +0100
parents	912519475259
children	1f9940d4bd35

comparison

equal deleted inserted replaced

-:de7bc4c9a4c0
+:ac1d6b056a6f
 that.setPosition = function(pos) {
 this.x = pos.x;
 this.y = pos.y;
 return this;
 };
+// adds pos to the position
 that.setPt1 = that.setPosition; // TODO: not really the same
-// adds pos to the position
 that.addPosition = function(pos) {
 this.x += pos.x;
 this.y += pos.y;
 return this;
 };
 return position({
 x : this.x + this.width / 2,
 y : this.y + this.height / 2
 });
 };
-// moves this Rectangle's center to position pos
+// moves this rectangle's center to position pos
 that.setCenter = function(pos) {
 this.x = pos.x - this.width / 2;
 this.y = pos.y - this.height / 2;
 return this;
 };
+// returns true if both rectangles have equal position and proportion
 that.equals = function(other) {
-// equal props
 var eq = (this.x === other.x && this.y === other.y && this.width === other.width);
 return eq;
 };
 // returns the area of this Rectangle
 that.getArea = function() {
 var ct = ((pos.x >= this.x) && (pos.y >= this.y)
 && (pos.x <= this.x + this.width) && (pos.y <= this.y
 + this.height));
 return ct;
 };
-// returns if rectangle "rect" is contained in this rectangle
+// returns true if rectangle "rect" is contained in this rectangle
 that.containsRect = function(rect) {
 return (this.containsPosition(rect.getPt1()) && this
 .containsPosition(rect.getPt2()));
 };
+// returns true if rectangle "rect" and this rectangle overlap
+that.overlapsRect = function(rect) {
+return (this.containsPosition(rect.getPt1()) || this
+.containsPosition(rect.getPt2()));
+};
 // changes this rectangle's x/y values so it stays inside of rectangle
-// rect
+// "rect", keeping the proportions
-// keeping the proportions
 that.stayInside = function(rect) {
 if (this.x < rect.x) {
 this.x = rect.x;
 }
 if (this.y < rect.y) {
 if (this.y + this.height > rect.y + rect.height) {
 this.y = rect.y + rect.height - this.height;
 }
 return this;
 };
-// clips this rectangle so it stays inside of rectangle rect
+// clips this rectangle so it stays inside of rectangle "rect"
 that.clipTo = function(rect) {
 var p1 = rect.getPt1();
 var p2 = rect.getPt2();
 var this2 = this.getPt2();
 this.setPosition(position(Math.max(this.x, p1.x), Math.max(this.y, p1.y)));
 this.setPt2(position(Math.min(this2.x, p2.x), Math.min(this2.y, p2.y)));
 return this;
 };
-// returns the intersection of the given Rectangle and this one
+// returns the intersection of rectangle "rect" and this one
 that.intersect = function(rect) {
 // FIX ME: not really, it should return null if there is no overlap
 var sec = rect.copy();
 if (sec.x < this.x) {
 sec.width = sec.width - (this.x - sec.x);
 if (sec.y + sec.height > this.y + this.height) {
 sec.height = (this.y + this.height) - sec.y;
 }
 return sec;
 };
-// returns a Rectangle that fits into this one (by moving first)
+// returns a copy of rectangle "rect" that fits into this one
+// (moving it first)
 that.fit = function(rect) {
 var sec = rect.copy();
 sec.x = Math.max(sec.x, this.x);
 sec.y = Math.max(sec.y, this.x);
 if (sec.x + sec.width > this.x + this.width) {
 if (sec.y + sec.height > this.y + this.height) {
 sec.y = this.y + this.height - sec.height;
 }
 return sec.intersect(this);
 };
-// adjusts position and size of $elem to this rectangle
+// adjusts position and size of jQuery element "$elem" to this rectangle
 that.adjustDiv = function($elem) {
 $elem.offset({
 left : this.x,
 top : this.y
 });
 $elem.width(this.width).height(this.height);
 };
-// returns size and position in css-compatible format
+// returns position and size of this rectangle in css-compatible format
 that.getAsCss = function() {
 return {
 left : this.x,
 top : this.y,
 width : this.width,
 height : this.height
 };
 };
+// returns position and size of this rectangle formatted for SVG attributes
+that.getAsSvg = function() {
+return [this.x, this.y, this.width, this.height].join(" ");
+};
+// returns size and position of this rectangle formatted for ??? (w x h@x,y)
 that.toString = function() {
 return this.width + "x" + this.height + "@" + this.x + "," + this.y;
 };
 return that;
 };