diff --git a/src/ol/renderer/webgl/webglatlasmanager.js b/src/ol/renderer/webgl/webglatlasmanager.js index 1d1dd67592..edf1f5ffdb 100644 --- a/src/ol/renderer/webgl/webglatlasmanager.js +++ b/src/ol/renderer/webgl/webglatlasmanager.js @@ -67,14 +67,14 @@ ol.renderer.webgl.AtlasManager = function(opt_size, opt_maxSize, opt_space) { /** - * @param {number} hash The hash of the entry to check. + * @param {string} id The identifier of the entry to check. * @return {ol.renderer.webgl.AtlasInfo} */ -ol.renderer.webgl.AtlasManager.prototype.getInfo = function(hash) { +ol.renderer.webgl.AtlasManager.prototype.getInfo = function(id) { var atlas, info; for (var i = 0, ii = this.atlases_.length; i < ii; i++) { atlas = this.atlases_[i]; - info = atlas.get(hash); + info = atlas.get(id); if (info !== null) { return info; } @@ -86,10 +86,10 @@ ol.renderer.webgl.AtlasManager.prototype.getInfo = function(hash) { /** * Add an image to the atlas manager. * - * If an entry for the given hash already exists, the entry will + * If an entry for the given id already exists, the entry will * be overridden (but the space on the atlas graphic will not be freed). * - * @param {number} hash The hash of the entry to add. + * @param {string} id The identifier of the entry to add. * @param {number} width The width. * @param {number} height The height. * @param {function(*)} renderCallback Called to render the new sprite entry @@ -99,7 +99,7 @@ ol.renderer.webgl.AtlasManager.prototype.getInfo = function(hash) { * @return {ol.renderer.webgl.AtlasInfo} */ ol.renderer.webgl.AtlasManager.prototype.add = - function(hash, width, height, renderCallback, opt_this) { + function(id, width, height, renderCallback, opt_this) { if (width > this.maxSize_ || height > this.maxSize_) { return null; } @@ -107,7 +107,7 @@ ol.renderer.webgl.AtlasManager.prototype.add = var atlas, info; for (var i = 0, ii = this.atlases_.length; i < ii; i++) { atlas = this.atlases_[i]; - info = atlas.add(hash, width, height, renderCallback, opt_this); + info = atlas.add(id, width, height, renderCallback, opt_this); if (info !== null) { return info; } else if (info === null && i === ii - 1) { @@ -179,16 +179,16 @@ ol.renderer.webgl.Atlas = function(size, space) { /** - * @param {number} hash The hash of the entry to check. + * @param {string} id The identifier of the entry to check. * @return {ol.renderer.webgl.AtlasInfo} */ -ol.renderer.webgl.Atlas.prototype.get = function(hash) { - return goog.object.get(this.entries_, hash, null); +ol.renderer.webgl.Atlas.prototype.get = function(id) { + return goog.object.get(this.entries_, id, null); }; /** - * @param {number} hash The hash of the entry to add. + * @param {string} id The identifier of the entry to add. * @param {number} width The width. * @param {number} height The height. * @param {function(*)} renderCallback Called to render the new sprite entry @@ -198,7 +198,7 @@ ol.renderer.webgl.Atlas.prototype.get = function(hash) { * @return {ol.renderer.webgl.AtlasInfo} */ ol.renderer.webgl.Atlas.prototype.add = - function(hash, width, height, renderCallback, opt_this) { + function(id, width, height, renderCallback, opt_this) { var block; for (var i = 0, ii = this.emptyBlocks_.length; i < ii; i++) { block = this.emptyBlocks_[i]; @@ -210,7 +210,7 @@ ol.renderer.webgl.Atlas.prototype.add = offsetY: block.y + this.space_, image: this.canvas_ }; - this.entries_[hash] = entry; + this.entries_[id] = entry; // render the image on the atlas image renderCallback.call(opt_this, this.context_, @@ -240,7 +240,9 @@ ol.renderer.webgl.Atlas.prototype.split_ = var deltaWidth = block.width - width; var deltaHeight = block.height - height; + /** @type {ol.renderer.webgl.AtlasInfo} */ var newBlock1, newBlock2; + if (deltaWidth > deltaHeight) { // split vertically // block right of the inserted entry diff --git a/test/spec/ol/renderer/webgl/webglatlasmanager.test.js b/test/spec/ol/renderer/webgl/webglatlasmanager.test.js index e65bc290c7..e9504b6686 100644 --- a/test/spec/ol/renderer/webgl/webglatlasmanager.test.js +++ b/test/spec/ol/renderer/webgl/webglatlasmanager.test.js @@ -19,59 +19,59 @@ describe('ol.renderer.webgl.Atlas', function() { it('adds one entry', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); - var info = atlas.add(1, 32, 32, defaultRender); + var info = atlas.add('1', 32, 32, defaultRender); expect(info).to.eql( {offsetX: 1, offsetY: 1, image: atlas.canvas_}); - expect(atlas.get(1)).to.eql(info); + expect(atlas.get('1')).to.eql(info); }); it('adds two entries', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); - atlas.add(1, 32, 32, defaultRender); - var info = atlas.add(2, 32, 32, defaultRender); + atlas.add('1', 32, 32, defaultRender); + var info = atlas.add('2', 32, 32, defaultRender); expect(info).to.eql( {offsetX: 34, offsetY: 1, image: atlas.canvas_}); - expect(atlas.get(2)).to.eql(info); + expect(atlas.get('2')).to.eql(info); }); it('adds three entries', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); - atlas.add(1, 32, 32, defaultRender); - atlas.add(2, 32, 32, defaultRender); - var info = atlas.add(3, 32, 32, defaultRender); + atlas.add('1', 32, 32, defaultRender); + atlas.add('2', 32, 32, defaultRender); + var info = atlas.add('3', 32, 32, defaultRender); expect(info).to.eql( {offsetX: 67, offsetY: 1, image: atlas.canvas_}); - expect(atlas.get(3)).to.eql(info); + expect(atlas.get('3')).to.eql(info); }); it('adds four entries (new row)', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); - atlas.add(1, 32, 32, defaultRender); - atlas.add(2, 32, 32, defaultRender); - atlas.add(3, 32, 32, defaultRender); - var info = atlas.add(4, 32, 32, defaultRender); + atlas.add('1', 32, 32, defaultRender); + atlas.add('2', 32, 32, defaultRender); + atlas.add('3', 32, 32, defaultRender); + var info = atlas.add('4', 32, 32, defaultRender); expect(info).to.eql( {offsetX: 1, offsetY: 34, image: atlas.canvas_}); - expect(atlas.get(4)).to.eql(info); + expect(atlas.get('4')).to.eql(info); }); it('returns null when an entry is too big', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); - atlas.add(1, 32, 32, defaultRender); - atlas.add(2, 32, 32, defaultRender); - atlas.add(3, 32, 32, defaultRender); + atlas.add('1', 32, 32, defaultRender); + atlas.add('2', 32, 32, defaultRender); + atlas.add('3', 32, 32, defaultRender); var info = atlas.add(4, 100, 100, defaultRender); expect(info).to.eql(null); @@ -81,11 +81,11 @@ describe('ol.renderer.webgl.Atlas', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); for (var i = 1; i <= 16; i++) { - expect(atlas.add(i, 28, 28, defaultRender)).to.be.ok(); + expect(atlas.add(i.toString(), 28, 28, defaultRender)).to.be.ok(); } // there is no more space for items of this size, the next one will fail - expect(atlas.add(17, 28, 28, defaultRender)).to.eql(null); + expect(atlas.add('17', 28, 28, defaultRender)).to.eql(null); }); }); @@ -94,23 +94,23 @@ describe('ol.renderer.webgl.Atlas', function() { it('adds a bunch of rectangles', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); - expect(atlas.add(1, 64, 32, defaultRender)).to.eql( + expect(atlas.add('1', 64, 32, defaultRender)).to.eql( {offsetX: 1, offsetY: 1, image: atlas.canvas_}); - expect(atlas.add(2, 64, 32, defaultRender)).to.eql( + expect(atlas.add('2', 64, 32, defaultRender)).to.eql( {offsetX: 1, offsetY: 34, image: atlas.canvas_}); - expect(atlas.add(3, 64, 32, defaultRender)).to.eql( + expect(atlas.add('3', 64, 32, defaultRender)).to.eql( {offsetX: 1, offsetY: 67, image: atlas.canvas_}); // this one can not be added anymore - expect(atlas.add(4, 64, 32, defaultRender)).to.eql(null); + expect(atlas.add('4', 64, 32, defaultRender)).to.eql(null); // but there is still room for smaller ones - expect(atlas.add(5, 40, 32, defaultRender)).to.eql( + expect(atlas.add('5', 40, 32, defaultRender)).to.eql( {offsetX: 66, offsetY: 1, image: atlas.canvas_}); - expect(atlas.add(6, 40, 32, defaultRender)).to.eql( + expect(atlas.add('6', 40, 32, defaultRender)).to.eql( {offsetX: 66, offsetY: 34, image: atlas.canvas_}); }); @@ -118,22 +118,22 @@ describe('ol.renderer.webgl.Atlas', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); for (var i = 1; i <= 32; i++) { - expect(atlas.add(i, 28, 14, defaultRender)).to.be.ok(); + expect(atlas.add(i.toString(), 28, 14, defaultRender)).to.be.ok(); } // there is no more space for items of this size, the next one will fail - expect(atlas.add(33, 28, 14, defaultRender)).to.eql(null); + expect(atlas.add('33', 28, 14, defaultRender)).to.eql(null); }); it('fills up the whole atlas (rectangles in landscape format)', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); for (var i = 1; i <= 32; i++) { - expect(atlas.add(i, 14, 28, defaultRender)).to.be.ok(); + expect(atlas.add(i.toString(), 14, 28, defaultRender)).to.be.ok(); } // there is no more space for items of this size, the next one will fail - expect(atlas.add(33, 14, 28, defaultRender)).to.eql(null); + expect(atlas.add('33', 14, 28, defaultRender)).to.eql(null); }); }); @@ -142,13 +142,13 @@ describe('ol.renderer.webgl.Atlas', function() { it('calls the render callback with the right values', function() { var atlas = new ol.renderer.webgl.Atlas(128, 1); var rendererCallback = sinon.spy(); - atlas.add(1, 32, 32, rendererCallback); + atlas.add('1', 32, 32, rendererCallback); expect(rendererCallback.calledOnce).to.be.ok(); expect(rendererCallback.calledWith(atlas.context_, 1, 1)).to.be.ok(); rendererCallback = sinon.spy(); - atlas.add(2, 32, 32, rendererCallback); + atlas.add('2', 32, 32, rendererCallback); expect(rendererCallback.calledOnce).to.be.ok(); expect(rendererCallback.calledWith(atlas.context_, 34, 1)).to.be.ok(); @@ -162,8 +162,8 @@ describe('ol.renderer.webgl.Atlas', function() { context.fillRect(x, y, 32, 32); }; - expect(atlas.add(1, 32, 32, rendererCallback)).to.be.ok(); - expect(atlas.add(2, 32, 32, rendererCallback)).to.be.ok(); + expect(atlas.add('1', 32, 32, rendererCallback)).to.be.ok(); + expect(atlas.add('2', 32, 32, rendererCallback)).to.be.ok(); // no error, ok }); }); @@ -187,18 +187,18 @@ describe('ol.renderer.webgl.AtlasManager', function() { it('adds one entry', function() { var manager = new ol.renderer.webgl.AtlasManager(128); - var info = manager.add(1, 32, 32, defaultRender); + var info = manager.add('1', 32, 32, defaultRender); expect(info).to.eql( {offsetX: 1, offsetY: 1, image: manager.atlases_[0].canvas_}); - expect(manager.getInfo(1)).to.eql(info); + expect(manager.getInfo('1')).to.eql(info); }); it('creates a new atlas if needed', function() { var manager = new ol.renderer.webgl.AtlasManager(128); - expect(manager.add(1, 100, 100, defaultRender)).to.be.ok(); - var info = manager.add(2, 100, 100, defaultRender); + expect(manager.add('1', 100, 100, defaultRender)).to.be.ok(); + var info = manager.add('2', 100, 100, defaultRender); expect(info).to.be.ok(); expect(info.image.width).to.eql(256); expect(manager.atlases_).to.have.length(2); @@ -206,9 +206,9 @@ describe('ol.renderer.webgl.AtlasManager', function() { it('creates new atlases until one is large enough', function() { var manager = new ol.renderer.webgl.AtlasManager(128); - expect(manager.add(1, 100, 100, defaultRender)).to.be.ok(); + expect(manager.add('1', 100, 100, defaultRender)).to.be.ok(); expect(manager.atlases_).to.have.length(1); - var info = manager.add(2, 500, 500, defaultRender); + var info = manager.add('2', 500, 500, defaultRender); expect(info).to.be.ok(); expect(info.image.width).to.eql(512); expect(manager.atlases_).to.have.length(3); @@ -216,8 +216,8 @@ describe('ol.renderer.webgl.AtlasManager', function() { it('checks all existing atlases and create a new if needed', function() { var manager = new ol.renderer.webgl.AtlasManager(128); - expect(manager.add(1, 100, 100, defaultRender)).to.be.ok(); - expect(manager.add(2, 100, 100, defaultRender)).to.be.ok(); + expect(manager.add('1', 100, 100, defaultRender)).to.be.ok(); + expect(manager.add('2', 100, 100, defaultRender)).to.be.ok(); expect(manager.atlases_).to.have.length(2); var info = manager.add(3, 500, 500, defaultRender); expect(info).to.be.ok(); @@ -227,16 +227,16 @@ describe('ol.renderer.webgl.AtlasManager', function() { it('returns null if the size exceeds the maximum size', function() { var manager = new ol.renderer.webgl.AtlasManager(128); - expect(manager.add(1, 100, 100, defaultRender)).to.be.ok(); - expect(manager.add(2, 3000, 3000, defaultRender)).to.eql(null); + expect(manager.add('1', 100, 100, defaultRender)).to.be.ok(); + expect(manager.add('2', 3000, 3000, defaultRender)).to.eql(null); }); }); describe('#getInfo', function() { - it('returns null if no entry for the given hash', function() { + it('returns null if no entry for the given id', function() { var manager = new ol.renderer.webgl.AtlasManager(128); - expect(manager.getInfo(123456)).to.eql(null); + expect(manager.getInfo('123456')).to.eql(null); }); }); });