Fix material clone name (#2576)

* fix: material name clone bug

Author: GuoLei1990

packages/core/src/Entity.ts

@@ -251,7 +251,7 @@ export class Entity extends EngineObject {
    */
   constructor(engine: Engine, name?: string, ...components: ComponentConstructor[]) {
     super(engine);
-    this.name = name ?? "New Entity";
+    this.name = name ?? "Entity";
     for (let i = 0, n = components.length; i < n; i++) {
       this.addComponent(components[i]);
     }

packages/core/src/Renderer.ts

@@ -486,7 +486,7 @@ export class Renderer extends Component implements IComponentCustomClone {
 
   private _createInstanceMaterial(material: Material, index: number): Material {
     const insMaterial: Material = material.clone();
-    insMaterial.name = insMaterial.name + "(Instance)";
+    insMaterial.name = material.name + "(Instance)";
     this._addResourceReferCount(material, -1);
     this._addResourceReferCount(insMaterial, 1);
     this._materialsInstanced[index] = true;

packages/core/src/material/BaseMaterial.ts

@@ -220,7 +220,7 @@ export class BaseMaterial extends Material {
    */
   override clone(): BaseMaterial {
     const dest = new BaseMaterial(this._engine, this.shader);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 

packages/core/src/material/BlinnPhongMaterial.ts

@@ -177,7 +177,7 @@ export class BlinnPhongMaterial extends BaseMaterial {
 
   override clone(): BlinnPhongMaterial {
     var dest: BlinnPhongMaterial = new BlinnPhongMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 }

packages/core/src/material/Material.ts

@@ -84,14 +84,15 @@ export class Material extends ReferResource implements IClone {
   constructor(engine: Engine, shader: Shader) {
     super(engine);
     this.shader = shader;
+    this.name = shader.name;
   }
 
   /**
    * Clone and return the instance.
    */
   clone(): Material {
     const dest = new Material(this._engine, this.shader);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 
@@ -112,6 +113,11 @@ export class Material extends ReferResource implements IClone {
     this._shader._addReferCount(value);
   }
 
+  protected _cloneToAndModifyName(target: Material): void {
+    this.cloneTo(target);
+    target.name = this.name + "(Clone)";
+  }
+
   /**
    * @override
    */

packages/core/src/material/PBRMaterial.ts

@@ -484,7 +484,7 @@ export class PBRMaterial extends PBRBaseMaterial {
    */
   override clone(): PBRMaterial {
     const dest = new PBRMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 

packages/core/src/material/PBRSpecularMaterial.ts

@@ -75,7 +75,7 @@ export class PBRSpecularMaterial extends PBRBaseMaterial {
    */
   override clone(): PBRSpecularMaterial {
     const dest = new PBRSpecularMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 }

packages/core/src/material/UnlitMaterial.ts

@@ -73,7 +73,7 @@ export class UnlitMaterial extends BaseMaterial {
    */
   override clone(): UnlitMaterial {
     const dest = new UnlitMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 }

packages/core/src/particle/ParticleMaterial.ts

@@ -56,7 +56,7 @@ export class ParticleMaterial extends BaseMaterial {
    */
   override clone(): ParticleMaterial {
     const dest = new ParticleMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 }

packages/core/src/sky/SkyBoxMaterial.ts

@@ -96,7 +96,7 @@ export class SkyBoxMaterial extends Material {
 
   override clone(): SkyBoxMaterial {
     const dest = new SkyBoxMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 }

packages/core/src/sky/SkyProceduralMaterial.ts

@@ -149,7 +149,7 @@ export class SkyProceduralMaterial extends Material {
    */
   override clone(): SkyProceduralMaterial {
     const dest = new SkyProceduralMaterial(this._engine);
-    this.cloneTo(dest);
+    this._cloneToAndModifyName(dest);
     return dest;
   }
 }

tests/src/core/MeshRenderer.test.ts

@@ -196,15 +196,15 @@ describe("MeshRenderer", async function () {
     // Test that getInstanceMaterial works correctly.
     const material = mr.getInstanceMaterial();
     expect(material).to.be.instanceOf(UnlitMaterial);
-    expect(material.name).to.be.equal("undefined(Instance)");
+    expect(material.name).to.be.equal("unlit(Instance)");
 
     // Test that material0 is same as material.
     const material0 = mr.getInstanceMaterial(0);
     expect(material0).to.be.eq(material);
 
     const material2 = mr.getInstanceMaterial(2);
     expect(material2).to.be.instanceOf(PBRMaterial);
-    expect(material2.name).to.be.equal("undefined(Instance)");
+    expect(material2.name).to.be.equal("pbr(Instance)");
 
     expect(mr.getInstanceMaterial(1)).to.be.null;
 
@@ -220,9 +220,9 @@ describe("MeshRenderer", async function () {
     // Test that getInstanceMaterials works correctly.
     const materials = mr.getInstanceMaterials();
     expect(materials[0]).to.be.instanceOf(UnlitMaterial);
-    expect(materials[0].name).to.be.equal("undefined(Instance)");
+    expect(materials[0].name).to.be.equal("unlit(Instance)");
     expect(materials[1]).to.be.instanceOf(PBRMaterial);
-    expect(materials[1].name).to.be.equal("undefined(Instance)");
+    expect(materials[1].name).to.be.equal("pbr(Instance)");
   });
 
   it("priority", () => {

tests/src/core/material/Material.test.ts

@@ -91,4 +91,12 @@ describe("Material", () => {
       }
     }
   });
+
+  it("clone", () => {
+    const material = new Material(engine, Shader.find("blinn-phong"));
+    expect(material.name).to.equal("blinn-phong");
+
+    const clone = material.clone();
+    expect(clone.name).to.equal("blinn-phong(Clone)");
+  });
 });