@zephyr3d/scene 0.7.0 → 0.8.0

package/dist/utility/serialization/manager.js

@@ -4,7 +4,7 @@ import { getSceneNodeClass, getGraphNodeClass } from './scene/node.js';
 import { getBatchGroupClass } from './scene/batch.js';
 import { getCameraClass, getPerspectiveCameraClass, getOrthoCameraClass } from './scene/camera.js';
 import { getPunctualLightClass, getDirectionalLightClass, getSpotLightClass, getPointLightClass } from './scene/light.js';
-import { getMeshMaterialClass, getPBRBluePrintMaterialClass, getUnlitMaterialClass, getLambertMaterialClass, getBlinnMaterialClass, getPBRMetallicRoughnessMaterialClass, getPBRSpecularGlossinessMaterialClass, getParticleMaterialClass } from './scene/material.js';
+import { getMeshMaterialClass, getPBRBluePrintMaterialClass, getSpriteBlueprintMaterialClass, getUnlitMaterialClass, getLambertMaterialClass, getBlinnMaterialClass, getPBRMetallicRoughnessMaterialClass, getPBRSpecularGlossinessMaterialClass, getParticleMaterialClass, getSpriteMaterialClass, getStandardSpriteMaterialClass } from './scene/material.js';
 import { getMeshClass } from './scene/mesh.js';
 import { getParticleNodeClass } from './scene/particle.js';
 import { getBoxShapeClass, getBoxFrameShapeClass, getSphereShapeClass, getTorusShapeClass, getCylinderShapeClass, getPlaneShapeClass, getTetrahedronShapeClass } from './scene/primitive.js';
@@ -22,11 +22,18 @@ import '../../material/unlit.js';
 import '../../material/particle.js';
 import '../../material/meshmaterial.js';
 import '../../material/grassmaterial.js';
-import '../../material/terrainmaterial.js';
 import '../../material/terrain-cm.js';
 import '../../material/pbrmr.js';
 import '../../material/pbrsg.js';
 import '../../material/pbrblueprint.js';
+import '../../material/sprite.js';
+import '../../material/sprite_std.js';
+import { PBRBlockNode, SpriteBlockNode, VertexBlockNode } from '../blueprint/material/pbr.js';
+import { ConstantScalarNode, ConstantVec2Node, ConstantVec3Node, ConstantVec4Node, ConstantBooleanNode, ConstantBVec2Node, ConstantBVec3Node, ConstantBVec4Node } from '../blueprint/common/constants.js';
+import { ConstantTexture2DNode, ConstantTexture2DArrayNode, ConstantTextureCubeNode, TextureSampleNode } from '../blueprint/material/texture.js';
+import { MakeVectorNode, SwizzleNode, EqualNode, NotEqualNode, LogicallyAndNode, LogicallyOrNode, CompComparisonNode, AnyConditionNode, AllConditionNode, SelectionNode, Degrees2RadiansNode, Radians2DegreesNode, SinNode, CosNode, TanNode, ArcSinNode, ArcCosNode, ArcTanNode, ArcTan2Node, SinHNode, CosHNode, TanHNode, ArcsineHNode, ArccosineHNode, ArctangentHNode, ExpNode, Exp2Node, LogNode, Log2Node, SqrtNode, InvSqrtNode, AbsNode, SignNode, FloorNode, CeilNode, FractNode, DDXNode, DDYNode, FWidthNode, CompAddNode, CompSubNode, CompMulNode, CompDivNode, ModNode, MinNode, MaxNode, PowNode, StepNode, SmoothStepNode, FmaNode, ClampNode, SaturateNode, MixNode, NormalizeNode, TransformNode, FaceForwardNode, ReflectNode, RefractNode, LengthNode, DistanceNode, DotProductNode, CrossProductNode, Hash1Node, Hash2Node, Hash3Node, SimplexNoise2DNode, PerlinNoise2DNode } from '../blueprint/common/math.js';
+import { VertexColorNode, VertexUVNode, VertexPositionNode, VertexNormalNode, VertexTangentNode, VertexBinormalNode, ViewMatrixNode, ProjectionMatrixNode, ViewProjMatrixNode, InvProjMatrixNode, InvViewProjMatrixNode, BillboardMatrixNode, CameraPositionNode, CameraNearFarNode, SkyEnvTextureNode, ElapsedTimeNode, ResolveVertexPositionNode, ResolveVertexTangentNode, ResolveVertexNormalNode } from '../blueprint/material/inputs.js';
+import { FunctionInputNode, FunctionOutputNode, FunctionCallNode } from '../blueprint/material/func.js';
 import '../../render/renderer.js';
 import '../../render/primitive.js';
 import '../../render/sky.js';
@@ -35,23 +42,17 @@ import '../../shaders/atmosphere.js';
 import { SceneNode } from '../../scene/scene_node.js';
 import '../../shadow/shadowmapper.js';
 import '../../scene/mesh.js';
+import '../../scene/basesprite.js';
 import '../../scene/water.js';
 import '../../scene/particlesys.js';
 import '../../scene/batchgroup.js';
-import '../../scene/terrain/patch.js';
-import '../../scene/terrain/grass.js';
 import '../../scene/terrain-cm/terrain-cm.js';
 import '../../scene/terrain-cm/grass.js';
 import { AssetManager } from '../../asset/assetmanager.js';
 import '../../animation/eulerrotationtrack.js';
 import '../../animation/skeleton.js';
 import { getJSONPropClass, getJSONNumberClass, getJSONStringClass, getJSONBoolClass, getJSONObjectClass, getJSONArrayClass } from './json.js';
-import { ConstantScalarNode, ConstantVec2Node, ConstantVec3Node, ConstantVec4Node } from '../blueprint/common/constants.js';
-import { ConstantTexture2DNode, ConstantTexture2DArrayNode, ConstantTextureCubeNode, TextureSampleNode } from '../blueprint/material/texture.js';
-import { MakeVectorNode, SwizzleNode, Degrees2RadiansNode, Radians2DegreesNode, SinNode, CosNode, TanNode, ArcSinNode, ArcCosNode, ArcTanNode, ArcTan2Node, SinHNode, CosHNode, TanHNode, ArcsineHNode, ArccosineHNode, ArctangentHNode, ExpNode, Exp2Node, LogNode, Log2Node, SqrtNode, InvSqrtNode, AbsNode, SignNode, FloorNode, CeilNode, FractNode, DDXNode, DDYNode, FWidthNode, CompAddNode, CompSubNode, CompMulNode, CompDivNode, ModNode, MinNode, MaxNode, PowNode, StepNode, FmaNode, ClampNode, SaturateNode, MixNode, NormalizeNode, TransformNode, FaceForwardNode, ReflectNode, RefractNode, LengthNode, DistanceNode, DotProductNode, CrossProductNode, Hash1Node, Hash2Node, Hash3Node, SimplexNoise2DNode, PerlinNoise2DNode } from '../blueprint/common/math.js';
-import { VertexColorNode, VertexUVNode, VertexPositionNode, VertexNormalNode, VertexTangentNode, VertexBinormalNode, ViewMatrixNode, ProjectionMatrixNode, ViewProjMatrixNode, InvProjMatrixNode, InvViewProjMatrixNode, BillboardMatrixNode, CameraPositionNode, CameraNearFarNode, SkyEnvTextureNode, ElapsedTimeNode, ResolveVertexPositionNode, ResolveVertexTangentNode, ResolveVertexNormalNode } from '../blueprint/material/inputs.js';
-import { PBRBlockNode, VertexBlockNode } from '../blueprint/material/pbr.js';
-import { FunctionInputNode, FunctionOutputNode, FunctionCallNode } from '../blueprint/material/func.js';
+import { getSpriteClass } from './scene/sprite.js';
 
 const defaultValues = {
     bool: false,
@@ -168,6 +169,7 @@ const defaultValues = {
             getSceneNodeClass(this),
             getGraphNodeClass(),
             getMeshClass(),
+            getSpriteClass(),
             getWaterClass(this),
             getTerrainClass(this),
             getFFTWaveGeneratorClass(),
@@ -184,12 +186,15 @@ const defaultValues = {
             getSceneClass(this),
             ...getMeshMaterialClass(),
             ...getPBRBluePrintMaterialClass(),
+            ...getSpriteBlueprintMaterialClass(),
             ...getUnlitMaterialClass(this),
             ...getLambertMaterialClass(this),
             ...getBlinnMaterialClass(this),
             ...getPBRMetallicRoughnessMaterialClass(this),
             ...getPBRSpecularGlossinessMaterialClass(this),
             ...getParticleMaterialClass(this),
+            ...getSpriteMaterialClass(),
+            ...getStandardSpriteMaterialClass(this),
             getBoxShapeClass(),
             getBoxFrameShapeClass(),
             getSphereShapeClass(),
@@ -201,11 +206,23 @@ const defaultValues = {
             ConstantVec2Node.getSerializationCls(),
             ConstantVec3Node.getSerializationCls(),
             ConstantVec4Node.getSerializationCls(),
+            ConstantBooleanNode.getSerializationCls(),
+            ConstantBVec2Node.getSerializationCls(),
+            ConstantBVec3Node.getSerializationCls(),
+            ConstantBVec4Node.getSerializationCls(),
             ConstantTexture2DNode.getSerializationCls(),
             ConstantTexture2DArrayNode.getSerializationCls(),
             ConstantTextureCubeNode.getSerializationCls(),
             MakeVectorNode.getSerializationCls(),
             SwizzleNode.getSerializationCls(),
+            EqualNode.getSerializationCls(),
+            NotEqualNode.getSerializationCls(),
+            LogicallyAndNode.getSerializationCls(),
+            LogicallyOrNode.getSerializationCls(),
+            CompComparisonNode.getSerializationCls(),
+            AnyConditionNode.getSerializationCls(),
+            AllConditionNode.getSerializationCls(),
+            SelectionNode.getSerializationCls(),
             Degrees2RadiansNode.getSerializationCls(),
             Radians2DegreesNode.getSerializationCls(),
             SinNode.getSerializationCls(),
@@ -244,6 +261,7 @@ const defaultValues = {
             MaxNode.getSerializationCls(),
             PowNode.getSerializationCls(),
             StepNode.getSerializationCls(),
+            SmoothStepNode.getSerializationCls(),
             FmaNode.getSerializationCls(),
             ClampNode.getSerializationCls(),
             SaturateNode.getSerializationCls(),
@@ -279,6 +297,7 @@ const defaultValues = {
             SkyEnvTextureNode.getSerializationCls(),
             ElapsedTimeNode.getSerializationCls(),
             PBRBlockNode.getSerializationCls(),
+            SpriteBlockNode.getSerializationCls(),
             VertexBlockNode.getSerializationCls(),
             ResolveVertexPositionNode.getSerializationCls(),
             ResolveVertexTangentNode.getSerializationCls(),
@@ -512,10 +531,31 @@ const defaultValues = {
             json.Init = initParams;
         }
         if (flags.saveProps) {
-            while(info){
-                await this.serializeObjectProps(obj, info, json.Object, asyncTasks);
-                info = this.getClassByConstructor(info.parent);
+            await this.serializeObjectProps(obj, json.Object, asyncTasks, info);
+        }
+        return json;
+    }
+    /**
+   * Serialize object properties into a JSON structure.
+   *
+   * @param obj - The target object to serialize.
+   * @param json - The JSON structure to populate.
+   * @param asyncTasks - Optional list to collect async tasks for embedded asset export.
+   * @param info - Optional serialization metadata for the object's class.
+   * @returns A Promise that resolves when serialization is complete.
+   */ async serializeObjectProps(obj, json, asyncTasks, info) {
+        if (!info) {
+            const cls = this.getClasses();
+            const index = cls.findIndex((val)=>val.ctor === obj.constructor);
+            if (index < 0) {
+                throw new Error('Serialize object properties failed: Cannot found serialization meta data');
             }
+            info = cls[index];
+        }
+        json = json ?? {};
+        while(info){
+            await this.serializeObjectPropsForCls(obj, info, json, asyncTasks);
+            info = this.getClassByConstructor(info.parent);
         }
         return json;
     }
@@ -558,14 +598,31 @@ const defaultValues = {
         }
         const obj = p instanceof Promise ? await p : p;
         if (loadProps) {
-            while(info){
-                await this.deserializeObjectProps(obj, info, json);
-                info = this.getClassByConstructor(info.parent);
-            }
+            await this.deserializeObjectProps(obj, json, info);
         }
         return obj;
     }
     /**
+   * Deserialize object properties from JSON into an existing object instance.
+   *
+   * @param obj - The target object to populate.
+   * @param json - The JSON structure containing serialized properties.
+   * @param info - Optional serialization metadata for the object's class.
+   */ async deserializeObjectProps(obj, json, info) {
+        if (!info) {
+            const cls = this.getClasses();
+            const index = cls.findIndex((val)=>val.ctor === obj.constructor);
+            if (index < 0) {
+                throw new Error('Deserialize object properties failed: Cannot found serialization meta data');
+            }
+            info = cls[index];
+        }
+        while(info){
+            await this.deserializeObjectPropsForCls(obj, info, json);
+            info = this.getClassByConstructor(info.parent);
+        }
+    }
+    /**
    * Load a model by ID and track the allocation for reverse lookup.
    *
    * @param id - Model identifier or path.
@@ -632,6 +689,12 @@ const defaultValues = {
         await this._assetManager.reloadBluePrintMaterials(filter);
     }
     /**
+   * Mark specific blue print as changed
+   * @param path - BluePrint file path
+   */ invalidateBluePrint(path) {
+        this._assetManager.invalidateBluePrint(path);
+    }
+    /**
    * Load a primitive by ID and track the allocation for reverse lookup.
    *
    * @param id - Primitive identifier or path.
@@ -672,7 +735,7 @@ const defaultValues = {
             const tmpNode = new DRef(new SceneNode(parent.scene));
             tmpNode.get().remove();
             tmpNode.get().prefabId = this._vfs.normalizePath(path);
-            const node = await this.deserializeObject(tmpNode.get(), json.data);
+            const node = await this.deserializeObject(tmpNode.get(), json['data']);
             node.prefabId = tmpNode.get().prefabId;
             node.parent = parent;
             node.persistentId = randomUUID();
@@ -878,6 +941,9 @@ const defaultValues = {
    */ findAnimationTarget(node, track) {
         const target = track.target ?? '';
         const value = {
+            num: [],
+            bool: [],
+            str: [],
             object: []
         };
         const parts = target.split('/').filter((val)=>!!val);
@@ -936,7 +1002,7 @@ const defaultValues = {
         }
         return v;
     }
-    async deserializeObjectProps(obj, cls, json) {
+    async deserializeObjectPropsForCls(obj, cls, json) {
         const props = (this.getPropertiesByClass(cls) ?? []).sort((a, b)=>(a.phase ?? 0) - (b.phase ?? 0));
         let currentPhase = undefined;
         const promises = [];
@@ -1042,7 +1108,7 @@ const defaultValues = {
             await Promise.all(promises);
         }
     }
-    async serializeObjectProps(obj, cls, json, asyncTasks) {
+    async serializeObjectPropsForCls(obj, cls, json, asyncTasks) {
         const props = this.getPropertiesByClass(cls) ?? [];
         for (const prop of props){
             if (prop.isValid && !prop.isValid.call(obj)) {
@@ -1085,10 +1151,11 @@ const defaultValues = {
                     }
                 case 'object_array':
                     if (tmpVal.object.length > 0) {
-                        json[k] = [];
+                        const arr = [];
                         for (const p of tmpVal.object){
-                            json[k].push(await this.serializeObject(p, {}, asyncTasks));
+                            arr.push(await this.serializeObject(p, {}, asyncTasks));
                         }
+                        json[k] = arr;
                     }
                     break;
                 case 'embedded':