Compatibility of engine v1 with data format of engine v2

src/deprecated/compatibility-v2-utils.js

@@ -0,0 +1,22 @@
+// add StandardMaterial parameter types the engine v2 supports to avoid validation warnings
+export function __adjustStandardMaterialParameterTypes(types) {
+    types.useGamma = 'boolean';
+    types.aoIntensity = 'number';
+}
+
+const _tintProperties = [
+    'ambientTint',
+    'emissiveTint',
+    'diffuseTint',
+    'sheenTint'
+];
+
+// in the engine v2 material json data, the tints were removed and are assumed to be always true
+// for the engine v1, force them to be true
+export function __adjustStandardMaterialData(data) {
+    _tintProperties.forEach((prop) => {
+        if (data[prop] === undefined) {
+            data[prop] = true;
+        }
+    });
+}

src/deprecated/compatibility-v2.js

@@ -0,0 +1,25 @@
+import { StandardMaterial } from '../scene/materials/standard-material.js';
+
+// useGammaTonemap is renamed to useGamma
+Object.defineProperty(StandardMaterial.prototype, 'useGamma', {
+    get: function () {
+        return this.useGammaTonemap;
+    },
+    set: function (value) {
+        this.useGammaTonemap = value;
+    }
+});
+
+// ignore aoIntensity as it's not supported
+Object.defineProperty(StandardMaterial.prototype, 'aoIntensity', {
+    get: function () {
+        return 1;
+    },
+    set: function (value) {
+    }
+});
+
+// dummy export to avoid the module being removed by rollup
+// TODO: remove this export when the module has other exports
+export function __dummyFunction() {
+}

src/framework/parsers/material/json-standard-material.js

@@ -11,6 +11,7 @@ import { SPECULAR_BLINN, SPECULAR_PHONG } from '../../../scene/constants.js';
 import { StandardMaterial } from '../../../scene/materials/standard-material.js';
 import { StandardMaterialValidator } from '../../../scene/materials/standard-material-validator.js';
 import { standardMaterialParameterTypes } from '../../../scene/materials/standard-material-parameters.js';
+import { __adjustStandardMaterialData } from '../../../deprecated/compatibility-v2-utils.js';
 
 /**
  * Convert incoming JSON data into a {@link StandardMaterial}.
@@ -164,6 +165,9 @@ class JsonStandardMaterialParser {
             }
         }
 
+        // data migration for engine v2 data compatibility
+        __adjustStandardMaterialData(data);
+
         return data;
     }
 

src/index.js

@@ -395,5 +395,9 @@ export { XrViews } from './framework/xr/xr-views.js';
 // BACKWARDS COMPATIBILITY
 export * from './deprecated/deprecated.js';
 
+// ENGINE V2 DATA COMPATIBILITY
+export * from './deprecated/compatibility-v2.js';
+export * from './deprecated/compatibility-v2-utils.js';
+
 // EXTRAS
 export * from './extras/index.js';

src/scene/materials/standard-material-parameters.js

@@ -1,3 +1,5 @@
+import { __adjustStandardMaterialParameterTypes } from '../../deprecated/compatibility-v2-utils.js';
+
 function _textureParameter(name, channel = true, vertexColor = true) {
     const result = {};
     result[`${name}Map`] = 'texture';
@@ -164,6 +166,9 @@ const standardMaterialParameterTypes = {
     // msdfVertexColorChannel
 };
 
+// handle engine v2 compatibility
+__adjustStandardMaterialParameterTypes(standardMaterialParameterTypes);
+
 const standardMaterialTextureParameters = [];
 for (const key in standardMaterialParameterTypes) {
     const type = standardMaterialParameterTypes[key];