Option for saving 'gltf.extras'

README.md

@@ -114,6 +114,7 @@ As a convenience the PBR textures may be supplied directly to the command line.
 |`--baseColorTexture`|Path to the baseColor/diffuse texture that should override textures in the .mtl file.|No|
 |`--emissiveTexture`|Path to the emissive texture that should override textures in the .mtl file.|No|
 |`--alphaTexture`|Path to the alpha texture that should override textures in the .mtl file.|No|
+|`--extrasPath`|Path to the json file that contains an object for storing application-specific data. It will be saved to the top-level of the glTF.|No|
 
 ## Build Instructions
 

bin/obj2gltf.js

@@ -122,6 +122,17 @@ const argv = yargs
             describe : 'The glTF will be saved with the KHR_materials_unlit extension.',
             type : 'boolean',
             default : defaults.unlit
+        },
+        extrasPath : {
+            describe : 'Path to the json file that contains an object for storing application-specific data. It will be saved to the top-level of the glTF.',
+            type : 'string',
+            normalize : true,
+            coerce : function (p) {
+                if (p.length === 0) {
+                    throw new Error('Input path must be a file name');
+                }
+                return path.resolve(p);
+            }
         }
     }).parse(args);
 
@@ -170,6 +181,10 @@ const options = {
     outputDirectory : outputDirectory
 };
 
+if (defined(argv.extrasPath)) {
+    options.extras = JSON.parse(fsExtra.readFileSync(argv.extrasPath));
+}
+
 console.time('Total');
 
 obj2gltf(objPath, options)

lib/createGltf.js

@@ -108,6 +108,10 @@ function createGltf(objData, options) {
         gltf.extensionsRequired.push('KHR_materials_unlit');
     }
 
+    if (options.extras) {
+        gltf.extras = options.extras;
+    }
+
     return gltf;
 }
 

lib/obj2gltf.js

@@ -37,6 +37,7 @@ module.exports = obj2gltf;
  * @param {Logger} [options.logger] A callback function for handling logged messages. Defaults to console.log.
  * @param {Writer} [options.writer] A callback function that writes files that are saved as separate resources.
  * @param {String} [options.outputDirectory] Output directory for writing separate resources when options.writer is not defined.
+ * @param {Object} [options.extras] An object for storing application-specific data. It will be saved to the top-level of the glTF.
  * @return {Promise} A promise that resolves to the glTF JSON or glb buffer.
  */
 function obj2gltf(objPath, options) {

specs/data/extras/dummy.json

@@ -0,0 +1,16 @@
+{
+    "cities": [
+        "Bangkok",
+        "Beijing",
+        "Jarkata",
+        "Sydney",
+        "London",
+        "Tokyo",
+        "San Francisco",
+        "New York"
+    ],
+    "coordinates": {
+        "x": 35.12,
+        "y": -21.49
+    }
+}

specs/lib/obj2gltfSpec.js

@@ -14,6 +14,8 @@ const outputDirectory = 'output';
 
 const textureUrl = 'specs/data/box-textured/cesium.png';
 
+const extrasPath = 'specs/data/extras/dummy.json';
+
 describe('obj2gltf', () => {
     beforeEach(() => {
         spyOn(fsExtra, 'outputFile').and.returnValue(Promise.resolve());
@@ -55,6 +57,17 @@ describe('obj2gltf', () => {
         expect(fsExtra.outputFile.calls.count()).toBe(5); // Saves out .png and four .bin for positions, normals, uvs, and indices
     });
 
+    it('converts obj to gltf with extras', async () => {
+        const extras = JSON.parse(fsExtra.readFileSync(extrasPath));
+        const options = {
+            extras : extras
+        };
+        const gltf = await obj2gltf(texturedObjPath, options);
+        expect(gltf).toBeDefined();
+        expect(gltf.images.length).toBe(1);
+        expect(gltf.extras).toBe(extras);
+    });
+
     it('converts obj to glb with separate resources', async () => {
         const options = {
             separate : true,