Load updated b3dm header

Source/Scene/Batched3DModel3DTileContent.js

@@ -1,6 +1,7 @@
 /*global define*/
 define([
         '../Core/Color',
+        '../Core/ComponentDatatype',
         '../Core/defaultValue',
         '../Core/defined',
         '../Core/defineProperties',
@@ -19,10 +20,12 @@ define([
         './Cesium3DTileBatchTable',
         './Cesium3DTileContentState',
         './Cesium3DTileFeature',
+        './Cesium3DTileFeatureTable',
         './getAttributeOrUniformBySemantic',
         './Model'
     ], function(
         Color,
+        ComponentDatatype,
         defaultValue,
         defined,
         defineProperties,
@@ -41,6 +44,7 @@ define([
         Cesium3DTileBatchTable,
         Cesium3DTileContentState,
         Cesium3DTileFeature,
+        Cesium3DTileFeatureTable,
         getAttributeOrUniformBySemantic,
         Model) {
     'use strict';
@@ -296,28 +300,65 @@ define([
         var byteLength = view.getUint32(byteOffset, true);
         byteOffset += sizeOfUint32;
 
+        var featureTableJsonByteLength = view.getUint32(byteOffset, true);
+        byteOffset += sizeOfUint32;
+
+        var featureTableBinaryByteLength = view.getUint32(byteOffset, true);
+        byteOffset += sizeOfUint32;
+
         var batchTableJsonByteLength = view.getUint32(byteOffset, true);
         byteOffset += sizeOfUint32;
 
         var batchTableBinaryByteLength = view.getUint32(byteOffset, true);
         byteOffset += sizeOfUint32;
 
-        var batchLength = view.getUint32(byteOffset, true);
-        byteOffset += sizeOfUint32;
+        var batchLength;
 
         // TODO : remove this legacy check before merging into master
-        // Legacy header:  [batchLength] [batchTableByteLength]
-        // Current header: [batchTableJsonByteLength] [batchTableBinaryByteLength] [batchLength]
-        // If the header is in the legacy format 'batchLength' will be the start of the JSON string (a quotation mark) or the glTF magic.
-        // Accordingly the first byte of uint32 will be either 0x22 or 0x67 and so the uint32 will exceed any reasonable 'batchLength'.
-        if (batchLength > 10000000) {
+        // Legacy header #1: [batchLength] [batchTableByteLength]
+        // Legacy header #2: [batchTableJsonByteLength] [batchTableBinaryByteLength] [batchLength]
+        // Current header: [featureTableJsonByteLength] [featureTableBinaryByteLength] [batchTableJsonByteLength] [batchTableBinaryByteLength]
+        // If the header is in the first legacy format 'batchTableJsonByteLength' will be the start of the JSON string (a quotation mark) or the glTF magic.
+        // Accordingly its first byte will be either 0x22 or 0x67, and so the minimum uint32 expected is 0x22000000 = 570425344 = 570MB. It is unlikely that the feature table JSON will exceed this length.
+        // The check for the second legacy format is similar, except it checks 'batchTableBinaryByteLength' instead
+        if (batchTableJsonByteLength >= 570425344) {
+            // First legacy check
+            byteOffset -= sizeOfUint32 * 2;
+            batchLength = featureTableJsonByteLength;
+            batchTableJsonByteLength = featureTableBinaryByteLength;
+            batchTableBinaryByteLength = 0;
+            featureTableJsonByteLength = 0;
+            featureTableBinaryByteLength = 0;
+            deprecationWarning('b3dm-legacy-header', 'This b3dm header is using the legacy format [batchLength] [batchTableByteLength]. The new format is [featureTableJsonByteLength] [featureTableBinaryByteLength] [batchTableJsonByteLength] [batchTableBinaryByteLength] from https://github.com/AnalyticalGraphicsInc/3d-tiles/blob/master/TileFormats/Batched3DModel/README.md.');
+        } else if (batchTableBinaryByteLength >= 570425344) {
+            // Second legacy check
             byteOffset -= sizeOfUint32;
             batchLength = batchTableJsonByteLength;
-            batchTableJsonByteLength = batchTableBinaryByteLength;
-            batchTableBinaryByteLength = 0;
-            deprecationWarning('b3dm-legacy-header', 'This b3dm header is using the legacy format [batchLength] [batchTableByteLength]. The new format is [batchTableJsonByteLength] [batchTableBinaryByteLength] [batchLength] from https://github.com/AnalyticalGraphicsInc/3d-tiles/blob/master/TileFormats/Batched3DModel/README.md.');
+            batchTableJsonByteLength = featureTableJsonByteLength;
+            batchTableBinaryByteLength = featureTableBinaryByteLength;
+            featureTableJsonByteLength = 0;
+            featureTableBinaryByteLength = 0;
+            deprecationWarning('b3dm-legacy-header', 'This b3dm header is using the legacy format [batchTableJsonByteLength] [batchTableBinaryByteLength] [batchLength]. The new format is [featureTableJsonByteLength] [featureTableBinaryByteLength] [batchTableJsonByteLength] [batchTableBinaryByteLength] from https://github.com/AnalyticalGraphicsInc/3d-tiles/blob/master/TileFormats/Batched3DModel/README.md.');
+        }
+
+        var featureTableJson;
+        if (featureTableJsonByteLength === 0) {
+            featureTableJson = {
+                BATCH_LENGTH : defaultValue(batchLength, 0)
+            };
+        } else {
+            var featureTableString = getStringFromTypedArray(uint8Array, byteOffset, featureTableJsonByteLength);
+            featureTableJson = JSON.parse(featureTableString);
+            byteOffset += featureTableJsonByteLength;
         }
 
+        var featureTableBinary = new Uint8Array(arrayBuffer, byteOffset, featureTableBinaryByteLength);
+        byteOffset += featureTableBinaryByteLength;
+
+        var featureTable = new Cesium3DTileFeatureTable(featureTableJson, featureTableBinary);
+
+        batchLength = featureTable.getGlobalProperty('BATCH_LENGTH', ComponentDatatype.UNSIGNED_INT);
+        featureTable.featuresLength = batchLength;
         this._featuresLength = batchLength;
 
         var batchTableJson;

Specs/Cesium3DTilesTester.js

@@ -1,5 +1,6 @@
 /*global define*/
 define([
+        'Core/arrayFill',
         'Core/Color',
         'Core/defaultValue',
         'Core/defined',
@@ -9,6 +10,7 @@ define([
         'Scene/TileBoundingSphere',
         'Specs/pollToPromise'
     ], function(
+        arrayFill,
         Color,
         defaultValue,
         defined,
@@ -216,20 +218,26 @@ define([
         var magic = defaultValue(options.magic, [98, 51, 100, 109]);
         var version = defaultValue(options.version, 1);
         var featuresLength = defaultValue(options.featuresLength, 1);
+        var featureTableJson = {
+            BATCH_LENGTH : featuresLength
+        };
+        var featureTableJsonString = JSON.stringify(featureTableJson);
+        var featureTableJsonByteLength = featureTableJsonString.length;
 
-        var headerByteLength = 24;
+        var headerByteLength = 28;
         var byteLength = headerByteLength;
         var buffer = new ArrayBuffer(byteLength);
         var view = new DataView(buffer);
         view.setUint8(0, magic[0]);
         view.setUint8(1, magic[1]);
         view.setUint8(2, magic[2]);
         view.setUint8(3, magic[3]);
-        view.setUint32(4, version, true);          // version
-        view.setUint32(8, byteLength, true);       // byteLength
-        view.setUint32(12, 0, true);               // batchTableJsonByteLength
-        view.setUint32(16, 0, true);               // batchTableBinaryByteLength
-        view.setUint32(20, featuresLength, true);  // batchLength
+        view.setUint32(4, version, true);                       // version
+        view.setUint32(8, byteLength, true);                    // byteLength
+        view.setUint32(12, featureTableJsonByteLength, true);   // featureTableJsonByteLength
+        view.setUint32(16, 0, true);                            // featureTableBinaryByteLength
+        view.setUint32(20, 0, true);                            // batchTableJsonByteLength
+        view.setUint32(24, 0, true);                            // batchTableBinaryByteLength
 
         return buffer;
     };
@@ -247,7 +255,7 @@ define([
         var featuresLength = defaultValue(options.featuresLength, 1);
         var featureTableJson = {
             INSTANCES_LENGTH : featuresLength,
-            POSITION : new Array(featuresLength * 3).fill(0)
+            POSITION : arrayFill(new Array(featuresLength * 3), 0)
         };
         var featureTableJsonString = JSON.stringify(featureTableJson);
         var featureTableJsonByteLength = featureTableJsonString.length;

Specs/Data/Cesium3DTiles/Batched/BatchedDeprecated/tileset.json → Specs/Data/Cesium3DTiles/Batched/BatchedDeprecated1/tileset.json

@@ -35,7 +35,7 @@
     },
     "geometricError": 0,
     "content": {
-      "url": "batchedDeprecated.b3dm"
+      "url": "batchedDeprecated1.b3dm"
     }
   }
 }

Specs/Data/Cesium3DTiles/Batched/BatchedDeprecated2/tileset.json

@@ -0,0 +1,41 @@
+{
+  "asset": {
+    "version": "0.0"
+  },
+  "properties": {
+    "id": {
+      "minimum": 0,
+      "maximum": 9
+    },
+    "Longitude": {
+      "minimum": -1.3196972173766555,
+      "maximum": -1.3196718547473905
+    },
+    "Latitude": {
+      "minimum": 0.6988624606923348,
+      "maximum": 0.6988888301460953
+    },
+    "Height": {
+      "minimum": 6.2074098233133554,
+      "maximum": 12.83180232718587
+    }
+  },
+  "geometricError": 70,
+  "root": {
+    "refine": "add",
+    "boundingVolume": {
+      "region": [
+        -1.3197004795898053,
+        0.6988582109,
+        -1.3196595204101946,
+        0.6988897891,
+        0,
+        20
+      ]
+    },
+    "geometricError": 0,
+    "content": {
+      "url": "batchedDeprecated2.b3dm"
+    }
+  }
+}

Specs/Data/Cesium3DTiles/Instanced/InstancedWithTransform/tileset.json

@@ -42,7 +42,7 @@
         0,
         0,
         0,
-        30
+        15
       ]
     },
     "geometricError": 0,

Specs/Data/Cesium3DTiles/Tilesets/TilesetReplacementWithViewerRequestVolume/tileset.json

@@ -1,7 +1,6 @@
 {
   "asset": {
-    "version": "0.0",
-    "tilesetVersion": "1.2.3"
+    "version": "0.0"
   },
   "properties": {
     "id": {

Specs/Data/Cesium3DTiles/Tilesets/TilesetWithTransforms/tileset.json

@@ -58,7 +58,7 @@
             0,
             0,
             0,
-            30
+            15
           ]
         },
         "transform": [

Specs/Scene/Batched3DModel3DTileContentSpec.js

@@ -36,7 +36,8 @@ defineSuite([
     var withTransformRegionUrl = './Data/Cesium3DTiles/Batched/BatchedWithTransformRegion/';
     var texturedUrl = './Data/Cesium3DTiles/Batched/BatchedTextured/';
     var compressedTexturesUrl = './Data/Cesium3DTiles/Batched/BatchedCompressedTextures/';
-    var deprecatedUrl = './Data/Cesium3DTiles/Batched/BatchedDeprecated/';
+    var deprecated1Url = './Data/Cesium3DTiles/Batched/BatchedDeprecated1/';
+    var deprecated2Url = './Data/Cesium3DTiles/Batched/BatchedDeprecated2/';
     var gltfZUpUrl = './Data/Cesium3DTiles/Batched/BatchedGltfZUp';
 
     function setCamera(longitude, latitude) {
@@ -75,9 +76,21 @@ defineSuite([
         return Cesium3DTilesTester.loadTileExpectError(scene, arrayBuffer, 'b3dm');
     });
 
-    it('recognizes the legacy b3dm format', function() {
+    it('recognizes the legacy 20-byte header', function() {
         spyOn(Batched3DModel3DTileContent, '_deprecationWarning');
-        return Cesium3DTilesTester.loadTileset(scene, deprecatedUrl)
+        return Cesium3DTilesTester.loadTileset(scene, deprecated1Url)
+            .then(function(tileset) {
+                expect(Batched3DModel3DTileContent._deprecationWarning).toHaveBeenCalled();
+                Cesium3DTilesTester.expectRenderTileset(scene, tileset);
+                var batchTable = tileset._root._content.batchTable;
+                expect(batchTable.batchTableJson).toBeDefined();
+                expect(batchTable.batchTableBinary).toBeUndefined();
+            });
+    });
+
+    it('recognizes the legacy 24-byte header', function() {
+        spyOn(Batched3DModel3DTileContent, '_deprecationWarning');
+        return Cesium3DTilesTester.loadTileset(scene, deprecated2Url)
             .then(function(tileset) {
                 expect(Batched3DModel3DTileContent._deprecationWarning).toHaveBeenCalled();
                 Cesium3DTilesTester.expectRenderTileset(scene, tileset);
@@ -89,7 +102,7 @@ defineSuite([
 
     it('logs deprecation warning for use of BATCHID without prefixed underscore', function() {
         spyOn(Batched3DModel3DTileContent, '_deprecationWarning');
-        return Cesium3DTilesTester.loadTileset(scene, deprecatedUrl)
+        return Cesium3DTilesTester.loadTileset(scene, deprecated1Url)
             .then(function(tileset) {
                 expect(Batched3DModel3DTileContent._deprecationWarning).toHaveBeenCalled();
                 Cesium3DTilesTester.expectRenderTileset(scene, tileset);

Specs/Scene/Cesium3DTilesetSpec.js

@@ -153,7 +153,7 @@ defineSuite([
     }
 
     function viewAllTiles() {
-        setZoom(20.0);
+        setZoom(15.0);
     }
 
     function viewRootOnly() {

Specs/Scene/Instanced3DModel3DTileContentSpec.js

@@ -47,7 +47,7 @@ defineSuite([
     function setCamera(longitude, latitude) {
         // One instance is located at the center, point the camera there
         var center = Cartesian3.fromRadians(longitude, latitude);
-        scene.camera.lookAt(center, new HeadingPitchRange(0.0, -1.57, 30.0));
+        scene.camera.lookAt(center, new HeadingPitchRange(0.0, -1.57, 27.0));
     }
 
     beforeAll(function() {