Update version

CHANGES.md

@@ -6,7 +6,9 @@ Change Log
 * Fixed a bug in `addPipelineExtras` that made it try to add extras to null objects.
 * Expose `triangleAxisAlignedBoundingBoxOverlap`, an implementation of Tomas Akenine-Möller algorithm for determining if a triangle overlaps an axis aligned bounding box.
 * Merged [gltf-statistics](https://github.com/AnalyticalGraphicsInc/gltf-statistics) as a stage in the pipeline.
-* Added `updateVersion` stage for patching glTF `0.8` -> `1.0` changes; `addDefaults` no longer calls `processModelMaterialsCommon`. [#223](https://github.com/AnalyticalGraphicsInc/gltf-pipeline/pull/223) 
+* Added `updateVersion` stage for upgrading the glTF version of an asset, including upgrading from `1.0` to `2.0`. [#223](https://github.com/AnalyticalGraphicsInc/gltf-pipeline/pull/223) 
+   * All pipeline stages now operator on glTF `2.0` assets.
+   * `addDefaults` no longer automatically upgrades glTF `0.8` to `1.0`.
 
 ### 0.1.0-alpha10 - 2017-01-10
 * Added `tangentsBitangents` generation option

gulpfile.js

@@ -165,13 +165,17 @@ function amdify(source, subDependencyMapping) {
             paths.push(requireMapping[variable]);
         }
     }
-    var definePathsHeader = '\'' + paths.join('\',\n        \'') + '\'';
-    var defineVariablesHeader = variables.join(',\n        ');
     var defineHeader = '/*global define*/\n' +
-        'define([\n' +
-        '        ' + definePathsHeader + '\n' +
-        '    ], function(\n' +
-        '        ' + defineVariablesHeader + ') {\n    ';
+            'define([], function() {\n    ';
+    if (paths.length > 0) {
+        var definePathsHeader = '\'' + paths.join('\',\n        \'') + '\'';
+        var defineVariablesHeader = variables.join(',\n        ');
+        defineHeader = '/*global define*/\n' +
+            'define([\n' +
+            '        ' + definePathsHeader + '\n' +
+            '    ], function(\n' +
+            '        ' + defineVariablesHeader + ') {\n    ';
+    }
     var defineFooter = '\n});\n';
     if (defined(returnValue)) {
         defineFooter = '\n    return ' + returnValue + ';' + defineFooter;
@@ -196,7 +200,9 @@ gulp.task('build-cesium', function () {
         'numberOfComponentsForType.js',
         'parseBinaryGltf.js',
         'processModelMaterialsCommon.js',
-        'techniqueParameterForSemantic.js'
+        'removePipelineExtras.js',
+        'techniqueParameterForSemantic.js',
+        'updateVersion.js'
     ];
     var subDependencyMapping = {
         cesium : {

index.js

@@ -2,6 +2,7 @@ module.exports = {
     AccessorReader : require('./lib/AccessorReader'),
     addCesiumRTC : require('./lib/addCesiumRTC'),
     addDefaults : require('./lib/addDefaults'),
+    addExtensionsRequired : require('./lib/addExtensionsRequired'),
     addExtensionsUsed : require('./lib/addExtensionsUsed'),
     addPipelineExtras : require('./lib/addPipelineExtras'),
     bakeAmbientOcclusion : require('./lib/bakeAmbientOcclusion'),
@@ -39,6 +40,7 @@ module.exports = {
     removeUnusedVertices : require('./lib/removeUnusedVertices'),
     triangleAxisAlignedBoundingBoxOverlap : require('./lib/triangleAxisAlignedBoundingBoxOverlap'),
     uninterleaveAndPackBuffers : require('./lib/uninterleaveAndPackBuffers'),
+    updateVersion : require('./lib/updateVersion'),
     writeAccessor : require('./lib/writeAccessor'),
     writeBinaryGltf : require('./lib/writeBinaryGltf'),
     writeBufferComponent : require('./lib/writeBufferComponent'),

lib/RemoveUnusedProperties.js

@@ -74,6 +74,14 @@ RemoveUnusedProperties.removeNodes = function(gltf) {
                                 nodeStack.push(child);
                             }
                         }
+                        var skeletons = nodes[node].skeletons;
+                        if (defined(skeletons)) {
+                            var skeletonsLength = skeletons.length;
+                            for (var k = 0; k < skeletonsLength; k++) {
+                                var skeleton = skeletons[k];
+                                nodeStack.push(skeleton);
+                            }
+                        }
                     }
                 }
             }
@@ -191,13 +199,13 @@ RemoveUnusedProperties.removeAccessors = function(gltf) {
     if (defined(animations)) {
         for (var animationId in animations) {
             if (animations.hasOwnProperty(animationId)) {
-                var parameters = animations[animationId].parameters;
-                if (defined(parameters)) {
-                    for (var parameterId in parameters) {
-                        if (parameters.hasOwnProperty(parameterId)) {
-                            var animationAccessorId = parameters[parameterId];
-                            usedAccessorIds[animationAccessorId] = true;
-                        }
+                var animation = animations[animationId];
+                var samplers = animation.samplers;
+                for (var samplerId in samplers) {
+                    if (samplers.hasOwnProperty(samplerId)) {
+                        var sampler = samplers[samplerId];
+                        usedAccessorIds[sampler.input] = true;
+                        usedAccessorIds[sampler.output] = true;
                     }
                 }
             }
@@ -268,16 +276,23 @@ RemoveUnusedProperties.removeTextures = function(gltf) {
     var techniques = gltf.techniques;
 
     // Build hash of used textures by iterating through materials and techniques
+    var i;
+    var values;
+    var valueLength;
+    var value;
     if (defined(materials)) {
         for (var materialId in materials) {
             if (materials.hasOwnProperty(materialId)) {
                 if (defined(materials[materialId].values)) {
-                    var values = materials[materialId].values;
+                    values = materials[materialId].values;
                     for (var valueId in values) {
                         if (values.hasOwnProperty(valueId)) {
-                            if (typeof values[valueId] === 'string') {
-                                var materialTextureId = values[valueId];
-                                usedTextureIds[materialTextureId] = true;
+                            value = values[valueId];
+                            valueLength = value.length;
+                            for (i = 0; i < valueLength; i++) {
+                                if (typeof value[i] === 'string') {
+                                    usedTextureIds[value[i]] = true;
+                                }
                             }
                         }
                     }
@@ -292,11 +307,13 @@ RemoveUnusedProperties.removeTextures = function(gltf) {
                     var parameters = techniques[techniqueId].parameters;
                     for (var parameterId in parameters) {
                         if (parameters.hasOwnProperty(parameterId)) {
-                            if (defined(parameters[parameterId].value)) {
-                                var value = parameters[parameterId].value;
-                                if (typeof value === 'string') {
-                                    var techniqueTextureId = value;
-                                    usedTextureIds[techniqueTextureId] = true;
+                            value = parameters[parameterId].value;
+                            if (defined(value)) {
+                                valueLength = value.length;
+                                for (i = 0; i < valueLength; i++) {
+                                    if (typeof value[i] === 'string') {
+                                        usedTextureIds[value[i]] = true;
+                                    }
                                 }
                             }
                         }

lib/addDefaults.js

@@ -18,7 +18,6 @@ var gltfTemplate = {
     animations : {
         '*' : {
             channels : [],
-            parameters : {},
             samplers : {
                 '*' : {
                     interpolation : 'LINEAR'
@@ -30,7 +29,7 @@ var gltfTemplate = {
         premultipliedAlpha : false,
         profile : {
             api : 'WebGL',
-            version : '1.0.3'
+            version : '1.0'
         }
     },
     buffers : {
@@ -158,9 +157,7 @@ var gltfTemplate = {
             attributes: {},
             uniforms: {},
             states: {
-                '*': {
-                    enable: []
-                }
+                enable: []
             }
         }
     },
@@ -172,7 +169,8 @@ var gltfTemplate = {
             type: WebGLConstants.UNSIGNED_BYTE
         }
     },
-    extensionsUsed : []
+    extensionsUsed : [],
+    extensionsRequired : []
 };
 
 function addDefaultsFromTemplate(object, template) {
@@ -221,6 +219,14 @@ function addDefaultsFromTemplate(object, template) {
     }
 }
 
+var defaultMaterial = {
+    values : {
+        emission : [
+            0.5, 0.5, 0.5, 1.0
+        ]
+    }
+};
+
 var defaultTechnique = {
     attributes : {
         a_position : 'position'
@@ -268,6 +274,7 @@ var defaultVertexShader = {
     type : WebGLConstants.VERTEX_SHADER,
     extras : {
         _pipeline : {
+            extension : '.vert',
             source : '' +
                 'precision highp float;\n' +
                 '\n' +
@@ -288,7 +295,7 @@ var defaultFragmentShader = {
     type : WebGLConstants.FRAGMENT_SHADER,
     extras : {
         _pipeline : {
-            extension : '.vert',
+            extension: '.frag',
             source : '' +
                 'precision highp float;\n' +
                 '\n' +
@@ -302,6 +309,30 @@ var defaultFragmentShader = {
     }
 };
 
+function addDefaultMaterial(gltf) {
+    var meshes = gltf.meshes;
+
+    var defaultMaterialId;
+
+    for (var meshId in meshes) {
+        if (meshes.hasOwnProperty(meshId)) {
+            var mesh = meshes[meshId];
+            var primitives = mesh.primitives;
+            var primitivesLength = primitives.length;
+            for (var i = 0; i < primitivesLength; i++) {
+                var primitive = primitives[i];
+                if (!defined(primitive.material)) {
+                    if (!defined(defaultMaterialId)) {
+                        defaultMaterialId = getUniqueId(gltf, 'defaultMaterial');
+                        gltf.materials[defaultMaterialId] = clone(defaultMaterial, true);
+                    }
+                    primitive.material = defaultMaterialId;
+                }
+            }
+        }
+    }
+}
+
 function addDefaultTechnique(gltf) {
     var materials = gltf.materials;
     var techniques = gltf.techniques;
@@ -394,6 +425,19 @@ function enableDiffuseTransparency(gltf) {
     }
 }
 
+function selectDefaultScene(gltf) {
+    var scenes = gltf.scenes;
+
+    if (!defined(gltf.scene)) {
+        for (var sceneId in scenes) {
+            if (scenes.hasOwnProperty(sceneId)) {
+                gltf.scene = sceneId;
+                break;
+            }
+        }
+    }
+}
+
 function optimizeForCesium(gltf) {
     // Give the diffuse uniform a semantic to support color replacement in 3D Tiles
     var techniques = gltf.techniques;
@@ -424,8 +468,10 @@ function optimizeForCesium(gltf) {
 function addDefaults(gltf, options) {
     options = defaultValue(options, {});
     addDefaultsFromTemplate(gltf, gltfTemplate);
+    addDefaultMaterial(gltf);
     addDefaultTechnique(gltf);
     enableDiffuseTransparency(gltf);
+    selectDefaultScene(gltf);
     if (options.optimizeForCesium) {
         optimizeForCesium(gltf);
     }

lib/addExtensionsRequired.js

@@ -0,0 +1,26 @@
+'use strict';
+var Cesium = require('cesium');
+var addExtensionsUsed = require('./addExtensionsUsed');
+
+var defined = Cesium.defined;
+
+module.exports = addExtensionsRequired;
+
+/**
+ * Adds an extension to gltf.extensionsRequired if it does not already exist.
+ * Initializes extensionsRequired if it is not defined.
+ *
+ * @param {Object} gltf A javascript object containing a glTF asset.
+ * @param {String} extension The extension to add.
+ */
+function addExtensionsRequired(gltf, extension) {
+    var extensionsRequired = gltf.extensionsRequired;
+    if (!defined(extensionsRequired)) {
+        extensionsRequired = [];
+        gltf.extensionsRequired = extensionsRequired;
+    }
+    if (extensionsRequired.indexOf(extension) < 0) {
+        extensionsRequired.push(extension);
+    }
+    addExtensionsUsed(gltf, extension);
+}

lib/addPipelineExtras.js

@@ -10,8 +10,11 @@ module.exports = addPipelineExtras;
 var exceptions = {
     attributes: true,
     uniforms: true,
-    extensions: true
+    extensions: true,
+    values: true,
+    samplers: true
 };
+
 /**
  * Adds extras._pipeline to each object that can have extras in the glTF asset.
  *
@@ -20,47 +23,31 @@ var exceptions = {
  */
 function addPipelineExtras(gltf) {
     var objectStack = [];
-    gltf.extras = defaultValue(gltf.extras, {});
-    gltf.extras._pipeline = defaultValue(gltf.extras._pipeline, {});
     for (var rootObjectId in gltf) {
         if (gltf.hasOwnProperty(rootObjectId)) {
             var rootObject = gltf[rootObjectId];
-            for (var topLevelObjectId in rootObject) {
-                if (rootObject.hasOwnProperty(topLevelObjectId)) {
-                    var topLevelObject = rootObject[topLevelObjectId];
-                    if (defined(topLevelObject) && typeof topLevelObject === 'object') {
-                        objectStack.push(topLevelObject);
-                    }
-                }
-            }
+            objectStack.push(rootObject);
         }
     }
-    if (defined(gltf.asset)) {
-        objectStack.push(gltf.asset);
-    }
     while (objectStack.length > 0) {
         var object = objectStack.pop();
-        if (Array.isArray(object)) {
-            var length = object.length;
-            for (var i = 0; i < length; i++) {
-                var item = object[i];
-                if (defined(item) && typeof item === 'object') {
-                    objectStack.push(item);
-                }
-            }
-        } else {
-            object.extras = defaultValue(object.extras, {});
-            object.extras._pipeline = defaultValue(object.extras._pipeline, {});
-            for (var propertyId in object) {
-                if (object.hasOwnProperty(propertyId)) {
-                    var property = object[propertyId];
-                    if (defined(property) && typeof property === 'object' && propertyId !== 'extras' && !exceptions[propertyId]) {
-                        objectStack.push(property);
+        for (var propertyId in object) {
+            if (object.hasOwnProperty(propertyId)) {
+                var property = object[propertyId];
+                if (defined(property) && typeof property === 'object' && propertyId !== 'extras') {
+                    objectStack.push(property);
+                    if (!exceptions[propertyId] && !Array.isArray(property)) {
+                        property.extras = defaultValue(property.extras, {});
+                        property.extras._pipeline = defaultValue(property.extras._pipeline, {});
                     }
                 }
             }
         }
     }
-
+    gltf.extras = defaultValue(gltf.extras, {});
+    gltf.extras._pipeline = defaultValue(gltf.extras._pipeline, {});
+    gltf.asset = defaultValue(gltf.asset, {});
+    gltf.asset.extras = defaultValue(gltf.asset.extras, {});
+    gltf.asset.extras._pipeline = defaultValue(gltf.asset.extras._pipeline, {});
     return gltf;
 }

lib/generateModelMaterialsCommon.js

@@ -1,6 +1,6 @@
 'use strict';
 var Cesium = require('cesium');
-var addExtensionsUsed = require('./addExtensionsUsed');
+var addExtensionsRequired = require('./addExtensionsRequired');
 
 var defaultValue = Cesium.defaultValue;
 var defined = Cesium.defined;
@@ -24,7 +24,7 @@ function generateModelMaterialsCommon(gltf, kmcOptions) {
     kmcOptions = defaultValue(kmcOptions, {});
     kmcOptions.doubleSided = defaultValue(kmcOptions.doubleSided, false);
     kmcOptions.technique = defaultValue(kmcOptions.technique, 'PHONG');
-    addExtensionsUsed(gltf, 'KHR_materials_common');
+    addExtensionsRequired(gltf, 'KHR_materials_common');
     var materialsCommon;
     var materials = gltf.materials;
     var nodes = gltf.nodes;