Merge pull request #500 from ripe-tech/ns/499-environment

#499 Load environment file bases on config

CHANGELOG.md

@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Update `.gitignore` to ignore CSR documentation compilation files - [#478](https://github.com/ripe-tech/ripe-sdk/issues/478)
 * Update CSR documentation with proper configuration with title and logo - [#478](https://github.com/ripe-tech/ripe-sdk/issues/478)
 * Improve CSR deinitialization logic - [#493](https://github.com/ripe-tech/ripe-sdk/issues/493)
+* Load environment file based on config - [499](https://github.com/ripe-tech/ripe-sdk/issues/499)
 
 ### Fixed
 

src/js/api/brand.js

@@ -142,14 +142,13 @@ ripe.Ripe.prototype.getFontUrl = function(name, format, options) {
 /**
  * Returns the URL for the environment file of the 3D scene.
  *
- * @param {Object} options A map with options, such as:
- *  - 'brand' - The brand of the model.
- *  - 'model' - The name of the model.
- *  - 'version' - The version of the build, defaults to latest.
+ * @param {String} name The name of the environment map.
+ * @param {String} format The file format of the environment map.
+ * @param {Object} options A map with options.
  * @returns {String} The URL of the environment for the 3D scene.
  */
-ripe.Ripe.prototype.get3dSceneEnvironmentUrl = function(options) {
-    return "https://www.dl.dropboxusercontent.com/s/o0v07nn5egjrjl5/studio2.hdr";
+ripe.Ripe.prototype.getSceneEnvironmentUrl = function(name, format, options) {
+    return `https://cdn.platforme.com/3d/environment/${name}.${format}`;
 };
 
 /**

src/js/visual/configurator-csr.js

@@ -1317,6 +1317,9 @@ ripe.ConfiguratorCsr.prototype._unpackSceneOptions = function(options) {
     const cameraOptions = {};
     const zoomOptions = {};
 
+    // unpacks root options
+    const environment = options.environment;
+
     // unpacks renderer options
     rendererOptions.toneMapping = options.tone_mapping
         ? ripe.CsrUtils.toToneMappingValue(options.tone_mapping)
@@ -1350,6 +1353,7 @@ ripe.ConfiguratorCsr.prototype._unpackSceneOptions = function(options) {
     }
 
     return {
+        environment: environment,
         rendererOptions: rendererOptions,
         cameraOptions: cameraOptions,
         zoomOptions: zoomOptions
@@ -1381,8 +1385,9 @@ ripe.ConfiguratorCsr.prototype._loadCsrAssets = async function(
     this.dracoLoader = ripe.CsrUtils.loadDracoLoader();
 
     // computes environment file URL
-    const envUrl = this.owner.get3dSceneEnvironmentUrl();
-    const envFormat = "hdr";
+    const environment = sceneOptions.environment || "studio2";
+    const environmentFormat = "hdr";
+    const environmentUrl = this.owner.getSceneEnvironmentUrl(environment, environmentFormat);
 
     const optionsParams = initialsOptions.options || {};
 
@@ -1440,7 +1445,7 @@ ripe.ConfiguratorCsr.prototype._loadCsrAssets = async function(
     ] = await Promise.all([
         this._loadMesh(meshUrl, meshFormat),
         fontUrl ? this._loadExternalFont(font, fontUrl) : null,
-        envUrl ? ripe.CsrUtils.loadEnvironment(envUrl, envFormat) : null,
+        environmentUrl ? ripe.CsrUtils.loadEnvironment(environmentUrl, environmentFormat) : null,
         baseTextureUrl ? ripe.CsrUtils.loadTexture(baseTextureUrl) : null,
         displacementTextureUrl ? ripe.CsrUtils.loadTexture(displacementTextureUrl) : null,
         metallicTextureUrl ? ripe.CsrUtils.loadTexture(metallicTextureUrl) : null,