@zephyr3d/scene 0.9.3 → 0.9.5

package/dist/scene/mesh.js

@@ -1,4 +1,4 @@
-import { applyMixins, DRef } from '@zephyr3d/base';
+import { castObservable, applyMixins, DRef } from '@zephyr3d/base';
 import { GraphNode } from './graph_node.js';
 import { ShaderHelper } from '../material/shader/helper.js';
 import { LambertMaterial } from '../material/lambert.js';
@@ -17,22 +17,27 @@ import '../material/pbrsg.js';
 import '../material/pbrblueprint.js';
 import '../material/sprite.js';
 import '../material/sprite_std.js';
+import '../material/msdf_text.js';
 import '../utility/blueprint/material/texture.js';
+import { BoundingBox } from '../utility/bounding_volume.js';
 import { mixinDrawable } from '../render/drawable_mixin.js';
+import { calculateMorphBoundingBox } from '../animation/morphtarget.js';
 
-/**
- * Mesh node
- * @public
- */ class Mesh extends applyMixins(GraphNode, mixinDrawable) {
+const MeshBase = castObservable(applyMixins(GraphNode, mixinDrawable))();
+/**
+ * Mesh node
+ * @public
+ */ class Mesh extends MeshBase {
     /** @internal */ _primitive;
     /** @internal */ _material;
     /** @internal */ _castShadow;
     /** @internal */ _skinnedBoundingInfo;
     /** @internal */ _animatedBoundingBox;
-    /** @internal */ _skeletonName;
+    /** @internal */ _skinBindingName;
     /** @internal */ _boneMatrices;
     /** @internal */ _morphData;
     /** @internal */ _morphInfo;
+    /** @internal */ _morphBoundingInfo;
     /** @internal */ _morphDirty;
     /** @internal */ _instanceHash;
     /** @internal */ _batchable;
@@ -43,9 +48,9 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
     /** @internal */ _materialChangeTag;
     /** @internal */ _primitiveChangeTag;
     /** @internal */ _postUpdateCallbacks;
-    /**
-   * Creates an instance of mesh node
-   * @param scene - The scene to which the mesh node belongs
+    /**
+   * Creates an instance of mesh node
+   * @param scene - The scene to which the mesh node belongs
    */ constructor(scene, primitive, material){
         super(scene);
         this._primitive = new DRef();
@@ -56,6 +61,7 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         this._boneMatrices = new DRef();
         this._morphData = null;
         this._morphInfo = null;
+        this._morphBoundingInfo = null;
         this._morphDirty = false;
         this._instanceHash = null;
         this._pickTarget = {
@@ -65,30 +71,25 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         this.primitive = primitive ?? null;
         this.material = material ?? Mesh._getDefaultMaterial();
         this._suspendSkinning = false;
-        this._skeletonName = '';
+        this._skinBindingName = '';
         this._renderBundle = {};
         this._useRenderBundle = true;
         this._materialChangeTag = null;
         this._primitiveChangeTag = null;
         this._postUpdateCallbacks = new Set();
     }
-    /**
-   * {@inheritDoc Drawable.getName}
-   */ getName() {
-        return this._name;
-    }
-    /**
-   * Returns the batch instance ID for the current render pass.
+    /**
+   * Returns the batch instance ID for the current render pass.
    */ getInstanceId(_renderPass) {
         return `${this._instanceHash}:${this.worldMatrixDet >= 0}`;
     }
-    /**
-   * Returns the packed instance-uniform buffer used for batching.
+    /**
+   * Returns the packed instance-uniform buffer used for batching.
    */ getInstanceUniforms() {
         return this._material.get().$instanceUniforms;
     }
-    /**
-   * {@inheritDoc Drawable.getPickTarget }
+    /**
+   * {@inheritDoc Drawable.getPickTarget }
    */ getPickTarget() {
         return this._pickTarget;
     }
@@ -99,11 +100,17 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         };
     }
     get skeletonName() {
-        return this._skeletonName;
+        return this._skinBindingName;
     }
     set skeletonName(name) {
-        if (name !== this._skeletonName) {
-            this._skeletonName = name;
+        this.skinBindingName = name;
+    }
+    get skinBindingName() {
+        return this._skinBindingName;
+    }
+    set skinBindingName(name) {
+        if (name !== this._skinBindingName) {
+            this._skinBindingName = name;
             this.updateSkeletonState();
         }
     }
@@ -123,7 +130,7 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         this._castShadow = b;
     }
     /** Primitive of the mesh */ get primitive() {
-        return this._primitive.get();
+        return this._primitive?.get() ?? null;
     }
     set primitive(prim) {
         const currentPrimitive = this._primitive.get();
@@ -139,10 +146,11 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             this.invalidateBoundingVolume();
             RenderBundleWrapper.drawableChanged(this);
             this._primitiveChangeTag = null;
+            this.dispatchEvent('primitive_changed', prim);
         }
     }
     /** Material of the mesh */ get material() {
-        return this._material.get();
+        return this._material?.get() ?? null;
     }
     set material(m) {
         if (this._material.get() !== m) {
@@ -153,28 +161,44 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             this._instanceHash = this._primitive.get() && m ? `${this.constructor.name}:${this._scene?.id ?? 0}:${this._primitive.get().id}:${m.instanceId}` : null;
             RenderBundleWrapper.drawableChanged(this);
             this._materialChangeTag = null;
+            this.dispatchEvent('material_changed', m);
         }
     }
-    /**
-   * {@inheritDoc SceneNode.isMesh}
+    /**
+   * {@inheritDoc SceneNode.isMesh}
    */ isMesh() {
         return true;
     }
-    /**
-   * Sets the bounding box for animation
-   * @param bbox - The bounding box for animation
+    /**
+   * Sets the bounding box for animation
+   * @param bbox - The bounding box for animation
    */ setAnimatedBoundingBox(bbox) {
         this._animatedBoundingBox = bbox;
         this.invalidateBoundingVolume();
     }
-    /**
-   * Gets the bounding box for animation
+    /**
+   * Gets the bounding box for animation
    */ getAnimatedBoundingBox() {
         return this._animatedBoundingBox ?? null;
     }
-    /**
-   * Sets the texture that contains the bone matrices for skeletal animation
-   * @param matrices - The texture that contains the bone matrices
+    /**
+   * Sets morph target bounding data used to update the animated bounding box when weights change.
+   * @param info - Morph target bounding data
+   */ setMorphBoundingInfo(info) {
+        this._morphBoundingInfo = info ? {
+            targetBoxes: info.targetBoxes.map((box)=>box.clone()),
+            originBox: info.originBox.clone()
+        } : null;
+        this.updateMorphBoundingBox();
+    }
+    /**
+   * Gets morph target bounding data.
+   */ getMorphBoundingInfo() {
+        return this._morphBoundingInfo;
+    }
+    /**
+   * Sets the texture that contains the bone matrices for skeletal animation
+   * @param matrices - The texture that contains the bone matrices
    */ setBoneMatrices(matrices) {
         if (this._boneMatrices.get() !== matrices) {
             this._boneMatrices.set(matrices);
@@ -182,9 +206,9 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             RenderBundleWrapper.drawableChanged(this);
         }
     }
-    /**
-   * Sets the texture that contains the morph target data
-   * @param data - The texture that contains the morph target data
+    /**
+   * Sets the texture that contains the morph target data
+   * @param data - The texture that contains the morph target data
    */ setMorphData(data) {
         if (!data) {
             if (this._morphData) {
@@ -220,20 +244,20 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             RenderBundleWrapper.drawableChanged(this);
         }
     }
-    /**
-   * Sets the skinned bounding info
-   * @param info - The skinned bounding info
+    /**
+   * Sets the skinned bounding info
+   * @param info - The skinned bounding info
    */ setSkinnedBoundingInfo(info) {
         this._skinnedBoundingInfo = info;
     }
-    /**
-   * {@inheritDoc Drawable.getMorphData}
+    /**
+   * {@inheritDoc Drawable.getMorphData}
    */ getMorphData() {
         return this._morphData;
     }
-    /**
-   * Sets the buffer that contains the morph target information
-   * @param info - The buffer that contains the morph target information
+    /**
+   * Sets the buffer that contains the morph target information
+   * @param info - The buffer that contains the morph target information
    */ setMorphInfo(info) {
         if (!info) {
             if (this._morphInfo) {
@@ -267,27 +291,28 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
                 this._morphInfo.buffer.set(morphUniformBuffer);
             }
             this._morphDirty = false;
+            this.updateMorphBoundingBox();
             this._renderBundle = {};
             RenderBundleWrapper.drawableChanged(this);
         }
     }
-    /**
-   * {@inheritDoc Drawable.getMorphInfo}
+    /**
+   * {@inheritDoc Drawable.getMorphInfo}
    */ getMorphInfo() {
         return this._morphInfo;
     }
-    /**
-   * Get the number of morph targets
-   *
-   * @returns The number of morph targets
+    /**
+   * Get the number of morph targets
+   *
+   * @returns The number of morph targets
    */ getNumMorphTargets() {
         return this._morphInfo?.data[3] ?? 0;
     }
-    /**
-   * Get the name of the morph target by index
-   *
-   * @param index - The index of the morph target
-   * @returns The name of the morph target, or null if not found
+    /**
+   * Get the name of the morph target by index
+   *
+   * @param index - The index of the morph target
+   * @returns The name of the morph target, or null if not found
    */ getMorphTargetName(index) {
         if (this._morphInfo && index >= 0 && index < this._morphInfo.data[3]) {
             const name = Object.keys(this._morphInfo.names).find((key)=>this._morphInfo.names[key] === index);
@@ -295,28 +320,46 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         }
         return null;
     }
-    /**
-   * Update morph target weight
-   *
-   * @param name - The name of the morph target
-   * @param weight - The weight of the morph target
+    /**
+   * Get the index of the morph target by name
+   * @param name - The name of the morph target
+   * @returns The index of the morph target, or -1 if not found
+   */ getMorphTargetIndexByName(name) {
+        return this._morphInfo?.names?.[name] ?? -1;
+    }
+    /**
+   * Update morph target weight
+   *
+   * @param name - The name of the morph target
+   * @param weight - The weight of the morph target
    */ setMorphWeight(name, weight) {
-        const index = this._morphInfo?.names?.[name];
-        if (index !== undefined && index >= 0 && index < this._morphInfo.data[3]) {
+        const index = this.getMorphTargetIndexByName(name);
+        if (index >= 0) {
+            this.setMorphWeightByIndex(index, weight);
+        }
+    }
+    /**
+   * Update morph target weight by index
+   *
+   * @param index - The index of the morph target
+   * @param weight - The weight of the morph target
+   */ setMorphWeightByIndex(index, weight) {
+        if (index >= 0 && index < this._morphInfo.data[3]) {
             if (this._morphInfo.data[4 + index] !== weight) {
                 this._morphInfo.data[4 + index] = weight;
                 this._morphDirty = true;
+                this.updateMorphBoundingBox();
                 this.scene.queueUpdateNode(this);
             }
         } else {
-            console.warn(`Morph target ${name} not found`);
+            console.warn(`Morph target index out of range: ${index}`);
         }
     }
-    /**
-   * Get morph target weight
-   *
-   * @param name - The name of the morph target
-   * @returns The weight of the morph target, or 0 if not found
+    /**
+   * Get morph target weight
+   *
+   * @param name - The name of the morph target
+   * @returns The weight of the morph target, or 0 if not found
    */ getMorphWeight(name) {
         const index = this._morphInfo?.names?.[name];
         if (index !== undefined && index >= 0 && index < this._morphInfo.data[3]) {
@@ -324,14 +367,15 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         }
         return 0;
     }
-    /**
-   * Update morph target weight
-   *
-   * @param weight - The morph target weights. The length must not exceed the mesh's morph target count.
+    /**
+   * Update morph target weights
+   *
+   * @param weight - The morph target weights. The length must not exceed the mesh's morph target count.
    */ updateMorphWeights(weight) {
         if (this._morphInfo && weight && weight.length <= this._morphInfo.data[3]) {
             this._morphInfo.data.set(weight, 4);
             this._morphDirty = true;
+            this.updateMorphBoundingBox();
             this.scene.queueUpdateNode(this);
         }
     }
@@ -355,35 +399,50 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             this._postUpdateCallbacks.delete(callback);
         }
     }
-    /**
-   * {@inheritDoc Drawable.isBatchable}
+    /**
+   * {@inheritDoc Drawable.isBatchable}
    */ isBatchable() {
         return this._batchable && !this._boneMatrices.get() && !this._morphData && (this._material.get()?.isBatchable() ?? false);
     }
-    /**
-   * {@inheritDoc Drawable.getQueueType}
+    /**
+   * {@inheritDoc Drawable.getQueueType}
    */ getQueueType() {
         return this.material?.getQueueType() ?? QUEUE_OPAQUE;
     }
-    /**
-   * {@inheritDoc Drawable.isUnlit}
+    /**
+   * {@inheritDoc Drawable.isUnlit}
    */ isUnlit() {
         return !this.material?.supportLighting();
     }
-    /**
-   * {@inheritDoc Drawable.needSceneColor}
+    /**
+   * {@inheritDoc Drawable.needSceneColor}
    */ needSceneColor() {
         return this.material?.needSceneColor() ?? false;
     }
-    /**
-   * {@inheritDoc Drawable.needSceneDepth}
+    /**
+   * {@inheritDoc Drawable.needSceneDepth}
    */ needSceneDepth() {
         return this.material?.needSceneDepth() ?? false;
     }
+    /** @internal */ updateMorphBoundingBox() {
+        if (!this._morphInfo || !this._morphBoundingInfo) {
+            return;
+        }
+        const numTargets = Math.min(this._morphInfo.data[3], this._morphBoundingInfo.targetBoxes.length);
+        if (numTargets <= 0) {
+            return;
+        }
+        const weights = this._morphInfo.data instanceof Float32Array ? this._morphInfo.data.subarray(4, 4 + numTargets) : new Float32Array(Array.from(this._morphInfo.data.subarray(4, 4 + numTargets)));
+        const bbox = new BoundingBox();
+        calculateMorphBoundingBox(bbox, this._morphBoundingInfo.targetBoxes, weights, numTargets);
+        bbox.minPoint.addBy(this._morphBoundingInfo.originBox.minPoint);
+        bbox.maxPoint.addBy(this._morphBoundingInfo.originBox.maxPoint);
+        this.setAnimatedBoundingBox(bbox);
+    }
     /** @internal */ updateMorphState() {
         if (this._morphInfo && this._morphDirty) {
-            console.log(`jawOpen: ${this._morphInfo.data[20]}`);
             this._morphInfo.buffer.get().bufferSubData(4 * 4, this._morphInfo.data, 4, this._morphInfo.data[3]);
+            this.updateMorphBoundingBox();
             this._morphDirty = false;
         }
     }
@@ -393,21 +452,23 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             this.setAnimatedBoundingBox(null);
             return;
         }
-        const skeleton = this._skeletonName && this.findSkeletonById(this._skeletonName);
-        if (skeleton) {
-            this.setBoneMatrices(skeleton.jointTexture);
-            skeleton.computeBoundingBox(this._skinnedBoundingInfo, this.invWorldMatrix);
+        const binding = this._skinBindingName && this.findSkinBindingById(this._skinBindingName);
+        if (binding) {
+            this.setBoneMatrices(binding.jointTexture);
+            binding.computeBoundingBox(this._skinnedBoundingInfo, this.invWorldMatrix);
             this.setAnimatedBoundingBox(this._skinnedBoundingInfo.boundingBox);
         } else {
             this.setBoneMatrices(null);
-            this.setAnimatedBoundingBox(null);
+            if (!this._morphInfo || !this._morphBoundingInfo) {
+                this.setAnimatedBoundingBox(null);
+            }
         }
-        if (this._skeletonName) {
+        if (this._skinBindingName) {
             this.scene.queueUpdateNode(this);
         }
     }
-    /**
-   * {@inheritDoc Drawable.draw}
+    /**
+   * {@inheritDoc Drawable.draw}
    */ draw(ctx, renderQueue, hash) {
         const material = this.material;
         const primitive = this.primitive;
@@ -433,23 +494,23 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
             }
         }
     }
-    /**
-   * {@inheritDoc Drawable.getMaterial}
+    /**
+   * {@inheritDoc Drawable.getMaterial}
    */ getMaterial() {
         return this.material;
     }
-    /**
-   * {@inheritDoc Drawable.getPrimitive}
+    /**
+   * {@inheritDoc Drawable.getPrimitive}
    */ getPrimitive() {
         return this.primitive;
     }
-    /**
-   * {@inheritDoc Drawable.getBoneMatrices}
+    /**
+   * {@inheritDoc Drawable.getBoneMatrices}
    */ getBoneMatrices() {
         return this._boneMatrices.get();
     }
-    /**
-   * {@inheritDoc Drawable.getNode}
+    /**
+   * {@inheritDoc Drawable.getNode}
    */ getNode() {
         // mesh transform should be ignored when skinned
         return this;
@@ -471,6 +532,7 @@ import { mixinDrawable } from '../render/drawable_mixin.js';
         this._boneMatrices.dispose();
         this.setMorphData(null);
         this.setMorphInfo(null);
+        this.setMorphBoundingInfo(null);
         this._renderBundle = null;
         RenderBundleWrapper.drawableChanged(this);
     }