Merge pull request #1797 from xeokit/fix/xeok-136

XEOK-136: Deprecate preset property on EmphasisMaterial
xeokit · Feb 3, 2025 · 356d61c · 356d61c
2 parents 249703e + 7dfd34c
commit 356d61c
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 7 deletions.
diff --git a/src/viewer/scene/materials/EmphasisMaterial.js b/src/viewer/scene/materials/EmphasisMaterial.js
@@ -224,7 +224,7 @@ class EmphasisMaterial extends Material {
      * @param {Number[]} [cfg.edgeColor=[0.2,0.2,0.2]]  RGB color of xray edges.
      * @param {Number} [cfg.edgeAlpha=0.5] Transparency of xray edges. A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
      * @param {Number} [cfg.edgeWidth=1] Width of xray edges, in pixels.
-     * @param {String} [cfg.preset] Selects a preset EmphasisMaterial configuration - see {@link EmphasisMaterial#presets}.
+     * @param {String} [cfg.preset] Deprecated - will be removed in future releases - Selects a preset EmphasisMaterial configuration - see {@link EmphasisMaterial#presets}.
      * @param {Boolean} [cfg.backfaces=false] Whether to render geometry backfaces when emphasising.
      * @param {Boolean} [cfg.glowThrough=true] Whether to make the emphasized object appear to float on top of other objects, as if it were "glowing through" them.
      */
@@ -563,13 +563,15 @@ class EmphasisMaterial extends Material {
     }
 
     /**
+     * @deprecated
      * Selects a preset EmphasisMaterial configuration.
      *
      * Default value is "default".
      *
      * @type {String}
      */
     set preset(value) {
+        console.warn("EmphasisMaterial.preset is deprecated and will be removed in future versions.");
         value = value || "default";
         if (this._preset === value) {
             return;
@@ -591,13 +593,15 @@ class EmphasisMaterial extends Material {
     }
 
     /**
+     * @deprecated
      * Gets the current preset EmphasisMaterial configuration.
      *
      * Default value is "default".
      *
      * @type {String}
      */
     get preset() {
+        console.warn("EmphasisMaterial.preset is deprecated and will be removed in future versions.");
         return this._preset;
     }
 

diff --git a/src/viewer/scene/scene/Scene.js b/src/viewer/scene/scene/Scene.js
@@ -1994,7 +1994,13 @@ class Scene extends Component {
     get xrayMaterial() {
         return this.components["default.xrayMaterial"] || new EmphasisMaterial(this, {
             id: "default.xrayMaterial",
-            preset: "sepia",
+            fill: true,
+            fillColor: [0.970588207244873, 0.7965892553329468, 0.6660899519920349],
+            fillAlpha: 0.4,
+            edges: true,
+            edgeColor: [0.529411792755127, 0.4577854573726654, 0.4100345969200134],
+            edgeAlpha: 1.0,
+            edgeWidth: 1,
             dontClear: true
         });
     }
@@ -2013,7 +2019,13 @@ class Scene extends Component {
     get highlightMaterial() {
         return this.components["default.highlightMaterial"] || new EmphasisMaterial(this, {
             id: "default.highlightMaterial",
-            preset: "yellowHighlight",
+            fill: true,
+            fillColor: [1.0, 1.0, 0.0],
+            fillAlpha: 0.5,
+            edges: true,
+            edgeColor: [1.0, 1.0, 1.0],
+            edgeAlpha: 1.0,
+            edgeWidth: 1,
             dontClear: true
         });
     }
@@ -2032,7 +2044,13 @@ class Scene extends Component {
     get selectedMaterial() {
         return this.components["default.selectedMaterial"] || new EmphasisMaterial(this, {
             id: "default.selectedMaterial",
-            preset: "greenSelected",
+            fill: true,
+            fillColor: [0.0, 1.0, 0.0],
+            fillAlpha: 0.5,
+            edges: true,
+            edgeColor: [1.0, 1.0, 1.0],
+            edgeAlpha: 1.0,
+            edgeWidth: 1,
             dontClear: true
         });
     }
@@ -2051,7 +2069,10 @@ class Scene extends Component {
     get edgeMaterial() {
         return this.components["default.edgeMaterial"] || new EdgeMaterial(this, {
             id: "default.edgeMaterial",
-            preset: "default",
+            fill: true,
+            fillColor: [0.4, 0.4, 0.4],
+            fillAlpha: 0.2,
+            edges: true,
             edgeColor: [0.0, 0.0, 0.0],
             edgeAlpha: 1.0,
             edgeWidth: 1,
@@ -2067,7 +2088,13 @@ class Scene extends Component {
     get pointsMaterial() {
         return this.components["default.pointsMaterial"] || new PointsMaterial(this, {
             id: "default.pointsMaterial",
-            preset: "default",
+            fill: true,
+            fillColor: [0.4, 0.4, 0.4],
+            fillAlpha: 0.2,
+            edges: true,
+            edgeColor: [0.2, 0.2, 0.2],
+            edgeAlpha: 0.5,
+            edgeWidth: 1,
             dontClear: true
         });
     }
@@ -2080,7 +2107,13 @@ class Scene extends Component {
     get linesMaterial() {
         return this.components["default.linesMaterial"] || new LinesMaterial(this, {
             id: "default.linesMaterial",
-            preset: "default",
+            fill: true,
+            fillColor: [0.4, 0.4, 0.4],
+            fillAlpha: 0.2,
+            edges: true,
+            edgeColor: [0.2, 0.2, 0.2],
+            edgeAlpha: 0.5,
+            edgeWidth: 1,
             dontClear: true
         });
     }