Changeset 140

Timestamp:

05/18/06 08:48:52 (3 years ago)

Author:

euzuro

Message:

Changed OpenLayers.Bounds to use left, bottom, right, top INSTEAD OF minlon, minlat, maxlon, maxlat. Removed OpenLayers.Box which was not getting used. JSDOC/coding standard-ified the OpenLayers.Bounds code and wrote thorough testing for it. Should be all good.

Files:

• trunk/openlayers/lib/OpenLayers/Layer/Grid.js (modified) (6 diffs)
• trunk/openlayers/lib/OpenLayers/Layer/Marker.js (modified) (1 diff)
• trunk/openlayers/lib/OpenLayers/Map.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Util.js (modified) (6 diffs)
• trunk/openlayers/tests/test_Bounds.html (modified) (5 diffs)
• trunk/openlayers/tests/test_Tile.html (modified) (1 diff)
• trunk/openlayers/tests/test_Tile_Image.html (modified) (1 diff)

trunk/openlayers/lib/OpenLayers/Layer/Grid.js

@@ -44 +44 @@
-        } else {
-          var i = 0;
-minlat > bounds.minlat
+bottom > bounds.bottom
-             this.insertRow(false); 
-          }
-minlon > bounds.minlon
+left > bounds.left
-             this.insertColumn(true); 
-          }
-maxlat < bounds.maxlat
+top < bounds.top
-             this.insertRow(true); 
-          }
-maxlon < bounds.maxlon
+right < bounds.right
-             this.insertColumn(false); 
-          }
@@ -61 +61 @@
-        var topLeftTile = this.grid[0][0];
-        var bottomRightTile = this.grid[this.grid.length-1][this.grid[0].length-1];
-minlon
-minlat
-maxlon
-maxlat
+left
+bottom
+right
+top
-    },
-    _initTiles:function() {
@@ -74 +74 @@
-        var tilelat = resolution*this.tileSize.h;
-        
-minlon - extent.minlon
+left - extent.left
-        var tilecol = Math.floor(offsetlon/tilelon);
-        var tilecolremain = offsetlon/tilelon - tilecol;
-        var tileoffsetx = -tilecolremain * this.tileSize.w;
-minlon
-
-maxlat - (extent.minlat
+left
+
+top - (extent.bottom
-        var tilerow = Math.ceil(offsetlat/tilelat);
-        var tilerowremain = tilerow - offsetlat/tilelat;
-        var tileoffsety = -tilerowremain * this.tileSize.h;
-minlat
+bottom
-        
-        tileoffsetx = Math.round(tileoffsetx); // heaven help us
@@ -114 +114 @@
-                tileoffsetlon += tilelon;       
-                tileoffsetx += this.tileSize.w;
-maxlon
+right
-            
-            tileoffsetlat -= tilelat;
-            tileoffsety += this.tileSize.h;
-minlat
+bottom
-
-    },
@@ -140 +140 @@
-            var bounds = modelTile.bounds.copyOf();
-            var position = modelTile.position.copyOf();
-minlat = bounds.minlat
-maxlat = bounds.maxlat
+bottom = bounds.bottom
+top = bounds.top
-            position.y = position.y + deltaY;
-            var newTile = this.addTile(bounds, position);
@@ -173 +173 @@
-            var bounds = modelTile.bounds.copyOf();
-            var position = modelTile.position.copyOf();
-minlon = bounds.minlon
-maxlon = bounds.maxlon
+left = bounds.left
+right = bounds.right
-            position.x = position.x + deltaX;
-            var newTile = this.addTile(bounds, position);

trunk/openlayers/lib/OpenLayers/Layer/Marker.js

@@ -51 +51 @@
-        var extent = this.map.getExtent();
-        var pixel = new OpenLayers.Pixel(
-minlon
-maxlat
+left
+top
-                       );
-        var m = marker.generateMarker(pixel);

trunk/openlayers/lib/OpenLayers/Map.js

@@ -223 +223 @@
-    getZoomForExtent: function (bounds) {
-        var size = this.getSize();
-width
+getWidth()
-        var zoom = Math.log(deg_per_pixel / this.maxResolution) / Math.log(2);
-        return Math.floor(Math.max(zoom, 0)); 
@@ -319 +319 @@
-        this.zoom = this.getZoomForExtent( fullExtent );
-        this.setCenter(
-minlon+fullExtent.maxlon
-minlat+fullExtent.maxlat
+left+fullExtent.right
+bottom+fullExtent.top
-                               );
-    },

trunk/openlayers/lib/OpenLayers/Util.js

@@ -1 @@
-
+*
-* @class
-*/
@@ -224 +224 @@
-/**
-* @class This class represents a bounding box. 
-Min and Max Longitudes and Latitude
+left, bottom, right, top float
-*/
-OpenLayers.Bounds = Class.create();
@@ -230 +230 @@
-
-    /** @type float */
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-    * @constructor
-    *
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /** 
-    * @return String representation of OpenLayers.Bounds object. 
-Min lon/lat=5/42 Max lon/lat=10/45 width=5 height=3
+left-bottom=(5,42) right-top=(10,45)
-    * @type String
-    */
-    toString:function(){
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-    },
-
@@ -291 +282 @@
-    */
-    toBBOX:function() {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    * @type Boolean
-    */
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /** @final @type String */
-    CLASS_NAME: "OpenLayers.Bounds"
@@ -328 +434 @@
-};
-
-OpenLayers.Box = Class.create();
-OpenLayers.Box.prototype = {
-    initialize: function(x,y,w,h){
-        this.xy=new OpenLayers.Pixel(x,y);
-        this.sz=new OpenLayers.Size(w,h);
-        this.c = new OpenLayers.Pixel(x+(w/2), y+(h/2));
-        this.br = new OpenLayers.Pixel(x+w-1,y+h-1);
-    },
-
-    /* offset box by df
-    * @df(OpenLayers.Size)
-    */
-    offset:function(df){
-        this.xy=new OpenLayers.Pixel(this.xy.x+df.w,this.xy.y+df.h);
-        this.c = new OpenLayers.Pixel(this.xy.x+(this.sz.w/2), this.xy.y+(this.sz.h/2));
-        var x=this.xy.x;
-        var y=this.xy.y;
-        var w=this.sz.w;
-        var h=this.sz.h;
-        this.br = new OpenLayers.Pixel(x+w-1,y+h-1);
-    },
-
-    getOrigin:function(){return this.xy;},
-    getSize:function(){return this.sz;},
-    getCenter:function(){return this.c;},
-    getBotRight:function(){return this.br;},
-    getWidth:function(){return this.sz.w;},
-    getHeight:function(){return this.sz.h;},
-    getSize:function(){return this.sz;},
-
-    toString:function(){
-        return (this.xy.toString() + " " + this.sz.toString());
-    },
-    copyOf:function(){
-        return new OpenLayers.Box(this.xy.x, this.xy.y, this.sz.w, this.sz.h);
-    },
-    toCoordsString:function(){
-        var x1 = this.xy.x;
-        var x2 = this.xy.x+this.sz.w-1;
-        var y1 = this.xy.y;
-        var y2 = this.xy.y+this.sz.h-1;
-        return (x1+","+y1+","+x2+","+y2);
-    },
-    contains:function(pt){
-        var returnVal = false;
-        
-        var lx=this.xy.x;
-        var ly=this.xy.y;
-        var rx=lx+this.sz.w-1;
-        var ry=ly+this.sz.h-1;
-
-        if (pt != null) {
-            //upper left in
-            returnVal =  (pt.x >=lx && pt.x <=rx && pt.y >=ly && pt.y <= ry);
-        }
-        return returnVal;
-    },
-
-    /**
-    * @param {ol.Box} box
-    * @param {bool} partial - if true, returns whether any part of the passed 
-    *                         in box is within the calling box. otherwise box
-    *                         must contain entire box to return true.
-    *
-    * @return {bool}
-    */
-    containsBox:function(box, partial) {
-        var contains = false;
-        
-        var mainTop = this.xy.y;
-        var mainLeft = this.xy.x;
-        var mainBottom = this.xy.y + this.sz.h;
-        var mainRight = this.xy.x + this.sz.w;
-
-        var top = box.xy.y;
-        var left = box.xy.x;
-        var bottom = box.xy.y + box.sz.h;
-        var right = box.xy.x + box.sz.w;
-
-        var inTop = (top >= mainTop) && (top <= mainBottom);
-        var inLeft = (left >= mainLeft) && (left <= mainRight);
-        var inBottom = (bottom >= mainTop) && (bottom <= mainBottom);
-        var inRight= (right >= mainLeft) && (right <= mainRight);
-        
-        if (partial) {
-            contains = (inTop || inBottom) && (inLeft || inRight );
-        } else {
-            contains = (inTop && inLeft && inBottom && inRight);
-        }
-        
-        return contains;      
-    },
-
-    // is this point the center of the box, +-2 pixels (@todo fix that number!)
-    isCenter:function(pt){
-        var size = this.c.absDiff(pt);
-        return (size.w <= 2 && size.h <= 2);
-    }
-};
-
-
-// Some other helpful things
+
+/**
+* @param {String} sStart
+* 
+* @returns Whether or not this string starts with the string passed in.
+* @type Boolean
+*/
-String.prototype.startsWith = function(sStart){
-==
+ == 
-};
-String.prototype.trim = function() {
@@ -464 +478 @@
-Array.prototype.clear=function() {this.length=0;};
-
+
+
-/** Create a child element (a div currently) that
-* is a proper child of the supplied parent, is invisible,

trunk/openlayers/tests/test_Bounds.html

@@ -5 +5 @@
-    var bounds; 
-    function test_01_Bounds_constructor (t) {
-8
+14
-        bounds = new OpenLayers.Bounds(0,2,10,4);
-        t.ok( bounds instanceof OpenLayers.Bounds, "new OpenLayers.Bounds returns Bounds object" );
-        t.eq( bounds.CLASS_NAME, "OpenLayers.Bounds", "bounds.CLASS_NAME is set correctly" );
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-     }
-
@@ -26 +39 @@
-         t.plan( 1 );
-         bounds = new OpenLayers.Bounds(1,2,3,4);
-Min lon/lat=1/2 Max lon/lat=3/4 width=2 height=2
+left-bottom=(1,2) right-top=(3,4)
-     }
-
-     function test_04_Bounds_contains(t) {
-3
+4
-         bounds = new OpenLayers.Bounds(10,10,40,40);
-
-
-
-
-
-
+
+
+
+
-     }
-
@@ -44 +55 @@
-        bounds = OpenLayers.Bounds.fromString("1,2,3,4");
-        t.ok( bounds instanceof OpenLayers.Bounds, "new OpenLayers.Bounds returns Bounds object" );
-minlon, 1, "bounds.minlon
-minlat, 2, "bounds.minlat
-maxlon, 3, "bounds.maxlon
-maxlat, 4, "bounds.maxlat
+left, 1, "bounds.left
+bottom, 2, "bounds.bottom
+right, 3, "bounds.right
+top, 4, "bounds.top
-     }
-
@@ -54 +65 @@
-        bounds = OpenLayers.Bounds.fromString("1.1,2.2,3.3,4.4");
-        t.ok( bounds instanceof OpenLayers.Bounds, "new OpenLayers.Bounds returns Bounds object" );
-minlon, 1.1, "bounds.minlon
-minlat, 2.2, "bounds.minlat
-maxlon, 3.3, "bounds.maxlon
-maxlat, 4.4, "bounds.maxlat
+left, 1.1, "bounds.left
+bottom, 2.2, "bounds.bottom
+right, 3.3, "bounds.right
+top, 4.4, "bounds.top
-     }
-
@@ -65 +76 @@
-        var bounds = oldBounds.copyOf();
-        t.ok( bounds instanceof OpenLayers.Bounds, "copyOf returns new OpenLayers.Bounds object" );
-minlon, 1, "bounds.minlon
-minlat, 2, "bounds.minlat
-maxlon, 3, "bounds.maxlon
-maxlat, 4, "bounds.maxlat
+left, 1, "bounds.left
+bottom, 2, "bounds.bottom
+right, 3, "bounds.right
+top, 4, "bounds.top
-        
-
-
-
-
+
+
-     }
-
+     function test_08_Bounds_containsBounds(t) {
+         t.plan( 35 );
+         containerBounds = new OpenLayers.Bounds(10,10,40,40);
-
+         //totally outside
+         bounds = new OpenLayers.Bounds(0,0,5,5);
+         t.eq( containerBounds.containsBounds(bounds)              , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ")");
+         t.eq( containerBounds.containsBounds(bounds, false)       , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false" );
+         t.eq( containerBounds.containsBounds(bounds, false, true) , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, false, false), false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is false" );
+         t.eq( containerBounds.containsBounds(bounds, true)        , false , "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, true)  , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is true, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, false) , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is true, inclusive is false" );
+
+         //totally outside on border
+         bounds = new OpenLayers.Bounds(15,0,30,10);
+         t.eq( containerBounds.containsBounds(bounds)              , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ")");
+         t.eq( containerBounds.containsBounds(bounds, false)       , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false" );
+         t.eq( containerBounds.containsBounds(bounds, false, true) , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, false, false), false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is false" );
+         t.eq( containerBounds.containsBounds(bounds, true)        , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, true)  , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, false) , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is true, inclusive is false" );
+
+         //partially inside
+         bounds = new OpenLayers.Bounds(20,20,50,30);
+         t.eq( containerBounds.containsBounds(bounds)              , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ")");
+         t.eq( containerBounds.containsBounds(bounds, false)       , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false" );
+         t.eq( containerBounds.containsBounds(bounds, false, true) , false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, false, false), false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is false" );
+         t.eq( containerBounds.containsBounds(bounds, true)        , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, true)  , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, false) , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is false" );
+
+         //totally inside on border
+         bounds = new OpenLayers.Bounds(10,20,30,30);
+         t.eq( containerBounds.containsBounds(bounds)              , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ")");
+         t.eq( containerBounds.containsBounds(bounds, false)       , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is false" );
+         t.eq( containerBounds.containsBounds(bounds, false, true) , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is false, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, false, false), false, "(" + containerBounds.toBBOX() + ") correctly does not contain (" + bounds.toBBOX() + ") when partial is false, inclusive is false" );
+         t.eq( containerBounds.containsBounds(bounds, true)        , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, true)  , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, false) , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is false" );
+
+         //totally inside
+         bounds = new OpenLayers.Bounds(20,20,30,30);
+         t.eq( containerBounds.containsBounds(bounds)              , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ")");
+         t.eq( containerBounds.containsBounds(bounds, false)       , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is false" );
+         t.eq( containerBounds.containsBounds(bounds, false, true) , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is false, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, false, false), true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is false, inclusive is false" );
+         t.eq( containerBounds.containsBounds(bounds, true)        , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, true)  , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is true" );
+         t.eq( containerBounds.containsBounds(bounds, true, false) , true, "(" + containerBounds.toBBOX() + ") correctly contains (" + bounds.toBBOX() + ") when partial is true, inclusive is false" );
+     }
+     
+     
-  // -->
-  </script>

trunk/openlayers/tests/test_Tile.html

@@ -12 +12 @@
-        t.ok( tile instanceof OpenLayers.Tile, "new OpenLayers.Tile returns Tile object" );
-        t.ok( tile.bounds instanceof OpenLayers.Bounds, "tile.bounds is a Bounds object" );
-minlon, 1, "tile.bounds.minlon
-minlat, 2, "tile.bounds.minlat
-maxlon, 3, "tile.bounds.maxlon
-maxlat, 4, "tile.bounds.maxlat
+left, 1, "tile.bounds.left
+bottom, 2, "tile.bounds.bottom
+right, 3, "tile.bounds.right
+top, 4, "tile.bounds.top
-        t.ok( tile.size instanceof OpenLayers.Size, "tile.size is a Size object" );
-        t.eq( tile.size.w, 5, "tile.size.w is set correctly");

trunk/openlayers/tests/test_Tile_Image.html

@@ -12 +12 @@
-        t.ok( tile instanceof OpenLayers.Tile.Image, "new OpenLayers.Tile returns Tile object" );
-        t.ok( tile.bounds instanceof OpenLayers.Bounds, "tile.bounds is a Bounds object" );
-minlon, 1, "tile.bounds.minlon
-minlat, 2, "tile.bounds.minlat
-maxlon, 3, "tile.bounds.maxlon
-maxlat, 4, "tile.bounds.maxlat
+left, 1, "tile.bounds.left
+bottom, 2, "tile.bounds.bottom
+right, 3, "tile.bounds.right
+top, 4, "tile.bounds.top
-        t.ok( tile.size instanceof OpenLayers.Size, "tile.size is a Size object" );
-        t.eq( tile.size.w, 5, "tile.size.w is set correctly");