@shopware-ag/dive 1.10.0 → 1.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware-ag/dive",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Shopware Spatial Framework",
   "type": "module",
   "main": "./build/dive.cjs",

package/src/com/types.ts

@@ -26,7 +26,7 @@ export type COMModel = COMBaseEntity & {
     rotation: Vector3Like;
     scale: Vector3Like;
     loaded: boolean;
-    material?: COMMaterial;
+    material?: Partial<COMMaterial>;
 };
 
 export type COMGeometry = {
@@ -38,10 +38,11 @@ export type COMGeometry = {
 
 export type COMMaterial = {
     color: string | number;
+    map: Texture | null;
     roughness: number;
-    roughnessMap?: Texture;
+    roughnessMap: Texture | null;
     metalness: number;
-    metalnessMap?: Texture;
+    metalnessMap: Texture | null;
 }
 
 export type COMPrimitive = COMBaseEntity & {
@@ -49,7 +50,7 @@ export type COMPrimitive = COMBaseEntity & {
     rotation: Vector3Like;
     scale: Vector3Like;
     geometry: COMGeometry;
-    material: COMMaterial;
+    material?: Partial<COMMaterial>;
 };
 
 export type COMEntity = COMPov | COMLight | COMModel | COMPrimitive;

package/src/model/Model.ts

@@ -79,37 +79,44 @@ export default class DIVEModel extends Object3D implements DIVESelectable, DIVEM
         });
     }
 
-    public SetMaterial(material: COMMaterial): void {
-        console.error('HERE', this._mesh);
-
+    public SetMaterial(material: Partial<COMMaterial>): void {
         // if there is no material, create a new one
         if (!this._material) {
             this._material = new MeshStandardMaterial();
         }
 
-        this._material.color = new Color(material.color);
+        // apply color if supplied
+        if (material.color !== undefined) this._material.color = new Color(material.color);
+
+        // apply albedo map if supplied
+        if (material.map !== undefined) this._material.map = material.map;
 
-        // if there is a roughness map, use it, otherwise use the roughness value
-        if (material.roughnessMap) {
+        // set roughness value
+        // if supplied, apply roughness map
+        // if we applied a roughness map, set roughness to 1.0
+        if (material.roughness !== undefined) this._material.roughness = material.roughness;
+        if (material.roughnessMap !== undefined) {
             this._material.roughnessMap = material.roughnessMap;
-            this._material.roughness = 1.0;
-        } else {
-            this._material.roughness = material.roughness;
+
+            if (this._material.roughnessMap) {
+                this._material.roughness = 1.0;
+            }
         }
 
-        // if there is a metalness map, use it, otherwise use the metalness value
-        if (material.metalnessMap) {
+        // set metalness value
+        // if supplied, apply metalness map
+        // if we applied a metalness map, set metalness to 1.0
+        if (material.metalness !== undefined) this._material.metalness = material.metalness;
+        if (material.metalnessMap !== undefined) {
             this._material.metalnessMap = material.metalnessMap;
-            this._material.metalness = 0.0;
-        } else {
-            this._material.metalness = material.metalness;
+
+            if (this._material.metalnessMap) {
+                this._material.metalness = 1.0;
+            }
         }
 
         // if the mesh is already set, update the material
-
-        if (this._mesh) {
-            this._mesh.material = this._material;
-        }
+        if (this._mesh) this._mesh.material = this._material;
     }
 
     public SetToWorldOrigin(): void {

package/src/model/__test__/Model.test.ts

@@ -356,14 +356,15 @@ describe('dive/model/DIVEModel', () => {
 
         expect(() => model.SetMaterial({
             color: 0xff00ff,
+            map: 'This_Is_A_Texture' as unknown as Texture,
             roughness: 0,
-            roughnessMap: 'this is a Texture' as unknown as Texture,
+            roughnessMap: 'This_Is_A_Texture' as unknown as Texture,
             metalness: 1,
-            metalnessMap: 'this is a Texture' as unknown as Texture,
+            metalnessMap: 'This_Is_A_Texture' as unknown as Texture,
         } as COMMaterial)).not.toThrow();
         expect((model['_material'] as MeshStandardMaterial).roughness).toBe(1);
         expect((model['_material'] as MeshStandardMaterial).roughnessMap).toBeDefined();
-        expect((model['_material'] as MeshStandardMaterial).metalness).toBe(0);
+        expect((model['_material'] as MeshStandardMaterial).metalness).toBe(1);
         expect((model['_material'] as MeshStandardMaterial).metalnessMap).toBeDefined();
     });
 

package/src/primitive/Primitive.ts

@@ -65,26 +65,41 @@ export class DIVEPrimitive extends Object3D implements DIVESelectable, DIVEMovea
         });
     }
 
-    public SetMaterial(material: COMMaterial): void {
+    public SetMaterial(material: Partial<COMMaterial>): void {
         const primitiveMaterial = this._mesh.material as MeshStandardMaterial;
 
-        primitiveMaterial.color = new Color(material.color);
+        // apply color if supplied
+        if (material.color !== undefined) primitiveMaterial.color = new Color(material.color);
 
-        // if there is a roughness map, use it, otherwise use the roughness value
-        if (material.roughnessMap) {
+        // apply albedo map if supplied
+        if (material.map !== undefined) primitiveMaterial.map = material.map;
+
+        // set roughness value
+        // if supplied, apply roughness map
+        // if we applied a roughness map, set roughness to 1.0
+        if (material.roughness !== undefined) primitiveMaterial.roughness = material.roughness;
+        if (material.roughnessMap !== undefined) {
             primitiveMaterial.roughnessMap = material.roughnessMap;
-            primitiveMaterial.roughness = 1.0;
-        } else {
-            primitiveMaterial.roughness = material.roughness;
+
+            if (primitiveMaterial.roughnessMap) {
+                primitiveMaterial.roughness = 1.0;
+            }
         }
 
-        // if there is a metalness map, use it, otherwise use the metalness value
-        if (material.metalnessMap) {
+        // set metalness value
+        // if supplied, apply metalness map
+        // if we applied a metalness map, set metalness to 1.0
+        if (material.metalness !== undefined) primitiveMaterial.metalness = material.metalness;
+        if (material.metalnessMap !== undefined) {
             primitiveMaterial.metalnessMap = material.metalnessMap;
-            primitiveMaterial.metalness = 0.0;
-        } else {
-            primitiveMaterial.metalness = material.metalness;
+
+            if (primitiveMaterial.metalnessMap) {
+                primitiveMaterial.metalness = 1.0;
+            }
         }
+
+        // if the mesh is already set, update the material
+        if (this._mesh) this._mesh.material = primitiveMaterial;
     }
 
     public SetToWorldOrigin(): void {

package/src/primitive/__test__/Primitive.test.ts

@@ -419,14 +419,15 @@ describe('dive/primitive/DIVEPrimitive', () => {
 
         expect(() => primitive.SetMaterial({
             color: 0xff00ff,
+            map: 'This_Is_A_Texture' as unknown as Texture,
             roughness: 0,
-            roughnessMap: 'this is a Texture' as unknown as Texture,
+            roughnessMap: 'This_Is_A_Texture' as unknown as Texture,
             metalness: 1,
-            metalnessMap: 'this is a Texture' as unknown as Texture,
+            metalnessMap: 'This_Is_A_Texture' as unknown as Texture,
         } as COMMaterial)).not.toThrow();
         expect(material.roughness).toBe(1);
         expect(material.roughnessMap).toBeDefined();
-        expect(material.metalness).toBe(0);
+        expect(material.metalness).toBe(1);
         expect(material.metalnessMap).toBeDefined();
     });
 });