@babylonjs/smart-filters 0.6.2-alpha → 0.7.0-alpha

package/src/serialization/{importCustomShaderBlockDefinition.ts → importCustomBlockDefinition.ts}

@@ -1,22 +1,34 @@
 import { ConnectionPointType } from "../connection/connectionPointType.js";
 import { hasGlslHeader, parseFragmentShader } from "../utils/buildTools/shaderConverter.js";
 import type { SerializedBlockDefinition } from "./serializedBlockDefinition.js";
-import type { SerializedInputConnectionPointV1 } from "./v1/blockSerialization.types.js";
+import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition.js";
+import type { InputAutoBindV1, SerializedInputConnectionPointV1 } from "./v1/shaderBlockSerialization.types.js";
 
 /**
- * Imports a serialized custom shader block definition. Supports importing a JSON string
- * of an SerializedBlockDefinition object, or a glsl shader with the required annotations
- * so it can be converted to a SerializedBlockDefinition object.
- * See readme.md for more information.
- * @param serializedBlockDefinition - The serialized block definition - either a SerializedBlockDefinition object in a JSON string, or an annotated glsl shader
+ * Imports a serialized custom block definition. Supports either serialized CustomShaderBlock definitions or
+ * CustomAggregateBlock definitions.
+ *
+ * CustomShaderBlock definitions can be supplied either as serialized SerializedBlockDefinition object
+ * or a glsl shader with the required annotations (see readme.md for details).
+ *
+ * CustomAggregateBlock definitions must be supplied as serialized SerializedBlockDefinition object.
+ *
+ * @param serializedData - The serialized data
  * @returns The serialized block definition
  */
-export function importCustomShaderBlockDefinition(serializedBlockDefinition: string): SerializedBlockDefinition {
-    if (hasGlslHeader(serializedBlockDefinition)) {
-        return importAnnotatedGlsl(serializedBlockDefinition);
+export function importCustomBlockDefinition(serializedData: string): SerializedBlockDefinition {
+    if (hasGlslHeader(serializedData)) {
+        return importAnnotatedGlsl(serializedData);
     } else {
-        // Assume this is a serialized SerializedBlockDefinition object
-        return JSON.parse(serializedBlockDefinition);
+        // Assume this is a serialized JSON object
+        const blockDefinition = JSON.parse(serializedData);
+
+        // SmartFilters can be serialized without a blockType
+        // By convention, we use the SmartFilter name as the blockType when importing them as SerializedBlockDefinitions
+        if (blockDefinition.format === "smartFilter" && blockDefinition.name && !blockDefinition.blockType) {
+            blockDefinition.blockType = blockDefinition.name;
+        }
+        return blockDefinition;
     }
 }
 
@@ -27,7 +39,7 @@ export function importCustomShaderBlockDefinition(serializedBlockDefinition: str
  * @param fragmentShader - The contents of the .glsl fragment shader file
  * @returns The serialized block definition
  */
-function importAnnotatedGlsl(fragmentShader: string): SerializedBlockDefinition {
+function importAnnotatedGlsl(fragmentShader: string): SerializedShaderBlockDefinition {
     const fragmentShaderInfo = parseFragmentShader(fragmentShader);
 
     if (!fragmentShaderInfo.blockType) {
@@ -66,6 +78,7 @@ function importAnnotatedGlsl(fragmentShader: string): SerializedBlockDefinition
         const inputConnectionPoint: SerializedInputConnectionPointV1 = {
             name: uniform.name,
             type,
+            autoBind: uniform.properties?.autoBind as InputAutoBindV1,
         };
         if (inputConnectionPoint.type !== ConnectionPointType.Texture && uniform.properties?.default !== undefined) {
             inputConnectionPoint.defaultValue = uniform.properties.default;
@@ -74,6 +87,7 @@ function importAnnotatedGlsl(fragmentShader: string): SerializedBlockDefinition
     }
 
     return {
+        format: "shaderBlockDefinition",
         formatVersion: 1,
         blockType: fragmentShaderInfo.blockType,
         shaderProgram: {

package/src/serialization/index.ts

@@ -2,4 +2,5 @@ export * from "./v1/index.js";
 export * from "./serializedSmartFilter.js";
 export * from "./smartFilterDeserializer.js";
 export * from "./smartFilterSerializer.js";
+export * from "./serializedShaderBlockDefinition.js";
 export * from "./serializedBlockDefinition.js";

package/src/serialization/serializedBlockDefinition.ts

@@ -1,7 +1,12 @@
-import type { SerializedBlockDefinitionV1 } from "./v1/blockSerialization.types";
+import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition";
+import type { SerializedSmartFilter } from "./serializedSmartFilter";
 
 /**
- * Type union of all versions of serialized SmartFilter block definitions
- * A block definition is an object which is used to create a CustomShaderBlock instance.
+ * Type that represents any type of serialized block definition - shader or aggregate.
  */
-export type SerializedBlockDefinition = SerializedBlockDefinitionV1;
+export type SerializedBlockDefinition = (SerializedShaderBlockDefinition | SerializedSmartFilter) & {
+    /**
+     * The type of block this is.
+     */
+    blockType: string;
+};

package/src/serialization/serializedShaderBlockDefinition.ts

@@ -0,0 +1,7 @@
+import type { SerializedShaderBlockDefinitionV1 } from "./v1/shaderBlockSerialization.types";
+
+/**
+ * Type union of all versions of serialized SmartFilter block definitions
+ * A block definition is an object which is used to create a CustomShaderBlock instance.
+ */
+export type SerializedShaderBlockDefinition = SerializedShaderBlockDefinitionV1;

package/src/serialization/smartFilterDeserializer.ts

@@ -20,7 +20,8 @@ import type { Nullable } from "@babylonjs/core/types";
 export type BlockFactory = (
     smartFilter: SmartFilter,
     engine: ThinEngine,
-    serializedBlock: ISerializedBlockV1
+    serializedBlock: ISerializedBlockV1,
+    smartFilterDeserializer: SmartFilterDeserializer
 ) => Promise<Nullable<BaseBlock>>;
 
 /**
@@ -182,7 +183,7 @@ export class SmartFilterDeserializer {
                 break;
             default: {
                 // If it's not an input or output block, use the provided block factory
-                newBlock = await this._blockFactory(smartFilter, engine, serializedBlock);
+                newBlock = await this._blockFactory(smartFilter, engine, serializedBlock, this);
                 if (!newBlock) {
                     blockTypesWhichCouldNotBeDeserialized.push(serializedBlock.blockType);
                     return;

package/src/serialization/smartFilterSerializer.ts

@@ -12,6 +12,7 @@ import type {
     SerializedSmartFilterV1,
 } from "./v1/smartFilterSerialization.types";
 import { CustomShaderBlock } from "../blocks/customShaderBlock.js";
+import { CustomAggregateBlock } from "../blocks/customAggregateBlock.js";
 
 /**
  * Determines if two serialized connection points are equivalent to each other
@@ -62,8 +63,9 @@ export class SmartFilterSerializer {
 
         const blocks = smartFilter.attachedBlocks.map((block: BaseBlock) => {
             // Serialize the block itself
+            const blockClassName = block.getClassName();
             const serializeFn =
-                block.getClassName() === CustomShaderBlock.ClassName
+                blockClassName === CustomShaderBlock.ClassName || blockClassName === CustomAggregateBlock.ClassName
                     ? defaultBlockSerializer
                     : this._blockSerializers.get(block.blockType);
             if (!serializeFn) {
@@ -106,6 +108,7 @@ export class SmartFilterSerializer {
         });
 
         return {
+            format: "smartFilter",
             formatVersion: 1,
             name: smartFilter.name,
             comments: smartFilter.comments,

package/src/serialization/v1/{blockSerialization.types.ts → shaderBlockSerialization.types.ts}

@@ -8,11 +8,16 @@ import type { AllConnectionPointTypes, ConnectionPointValue } from "../../connec
 import type { ShaderProgram } from "../../utils/shaderCodeUtils";
 
 /**
- * The V1 definition of a serialized block. A block definition is loaded by a CustomShaderBlock and defines how a
+ * The V1 definition of a serialized shader block. This block definition is loaded by a CustomShaderBlock and defines how a
  * blockType works. This should not be confused with an ISerializedBockV1, which is a serialized instance of a block in a
  * serialized SmartFilter graph. It is referenced by blockType in a serialized SmartFilter.
  */
-export type SerializedBlockDefinitionV1 = {
+export type SerializedShaderBlockDefinitionV1 = {
+    /**
+     * Which type of serialized data this is.
+     */
+    format: "shaderBlockDefinition";
+
     /**
      * The version of the block definition format (format of the serialized data, not the version of the block definition itself).
      */
@@ -42,6 +47,11 @@ export type SerializedBlockDefinitionV1 = {
     disableOptimization: boolean;
 };
 
+/**
+ * Possible V1 auto bind values for input connection points.
+ */
+export type InputAutoBindV1 = "outputResolution";
+
 /**
  * A V1 input connection point of a serialized block definition.
  */
@@ -60,4 +70,9 @@ export type SerializedInputConnectionPointV1<U extends AllConnectionPointTypes =
      * The optional default value of the connection point.
      */
     defaultValue?: ConnectionPointValue<U>;
+
+    /**
+     * If supplied, the input will be automatically bound to this value, instead of creating an input connection point.
+     */
+    autoBind?: InputAutoBindV1;
 };

package/src/serialization/v1/smartFilterSerialization.types.ts

@@ -3,6 +3,7 @@ import type { BaseBlock } from "../../blocks/baseBlock.js";
 import type { SmartFilter } from "../../smartFilter.js";
 import type { ThinEngine } from "@babylonjs/core/Engines/thinEngine";
 import type { IEditorData } from "@babylonjs/shared-ui-components/nodeGraphSystem/interfaces/nodeLocationInfo.js";
+import type { SmartFilterDeserializer } from "../smartFilterDeserializer.js";
 
 /**
  * ----------------------------------------------------------------------------
@@ -14,6 +15,9 @@ import type { IEditorData } from "@babylonjs/shared-ui-components/nodeGraphSyste
  * V1 Serialized Smart Filter
  */
 export type SerializedSmartFilterV1 = {
+    /** Which type of serialized data this is. */
+    format: "smartFilter";
+
     /** The format version of the serialized data (not the version of the SmartFilter itself).*/
     formatVersion: 1;
 
@@ -105,7 +109,8 @@ export interface IBlockSerializerV1 {
 export type DeserializeBlockV1 = (
     smartFilter: SmartFilter,
     serializedBlock: ISerializedBlockV1,
-    engine: ThinEngine
+    engine: ThinEngine,
+    smartFilterDeserializer: SmartFilterDeserializer
 ) => Promise<BaseBlock>;
 
 /**

package/src/utils/buildTools/shaderConverter.ts

@@ -11,6 +11,12 @@ export type UniformMetadataProperties = {
      * If supplied, the default value to use for the corresponding input connection point
      */
     default?: any;
+
+    /**
+     * If supplied, the input will be automatically bound to this value, instead of creating an input connection point
+     * @see InputAutoBindV1 for possible values.
+     */
+    autoBind?: string;
 };
 
 /**

package/dist/serialization/importCustomShaderBlockDefinition.d.ts

@@ -1,11 +0,0 @@
-import type { SerializedBlockDefinition } from "./serializedBlockDefinition.js";
-/**
- * Imports a serialized custom shader block definition. Supports importing a JSON string
- * of an SerializedBlockDefinition object, or a glsl shader with the required annotations
- * so it can be converted to a SerializedBlockDefinition object.
- * See readme.md for more information.
- * @param serializedBlockDefinition - The serialized block definition - either a SerializedBlockDefinition object in a JSON string, or an annotated glsl shader
- * @returns The serialized block definition
- */
-export declare function importCustomShaderBlockDefinition(serializedBlockDefinition: string): SerializedBlockDefinition;
-//# sourceMappingURL=importCustomShaderBlockDefinition.d.ts.map

package/dist/serialization/importCustomShaderBlockDefinition.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"importCustomShaderBlockDefinition.d.ts","sourceRoot":"","sources":["../../src/serialization/importCustomShaderBlockDefinition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAGhF;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAAC,yBAAyB,EAAE,MAAM,GAAG,yBAAyB,CAO9G"}

package/dist/serialization/importCustomShaderBlockDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"importCustomShaderBlockDefinition.js","sourceRoot":"","sources":["../../src/serialization/importCustomShaderBlockDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAI5F;;;;;;;GAOG;AACH,MAAM,UAAU,iCAAiC,CAAC,yBAAiC;IAC/E,IAAI,aAAa,CAAC,yBAAyB,CAAC,EAAE,CAAC;QAC3C,OAAO,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;IAC1D,CAAC;SAAM,CAAC;QACJ,+DAA+D;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACjD,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,cAAsB;;IAC/C,MAAM,kBAAkB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAE/D,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;IAED,wCAAwC;IACxC,MAAM,qBAAqB,GAAuC,EAAE,CAAC;IACrE,KAAK,MAAM,OAAO,IAAI,kBAAkB,CAAC,QAAQ,EAAE,CAAC;QAChD,iCAAiC;QACjC,IAAI,IAAyB,CAAC;QAC9B,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,OAAO;gBACR,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC;gBACjC,MAAM;YACV,KAAK,WAAW;gBACZ,IAAI,GAAG,mBAAmB,CAAC,OAAO,CAAC;gBACnC,MAAM;YACV,KAAK,MAAM;gBACP,IAAI,GAAG,mBAAmB,CAAC,MAAM,CAAC;gBAClC,MAAM;YACV,KAAK,MAAM;gBACP,IAAI,GAAG,mBAAmB,CAAC,MAAM,CAAC;gBAClC,MAAM;YACV,KAAK,MAAM;gBACP,IAAI,GAAG,mBAAmB,CAAC,OAAO,CAAC;gBACnC,MAAM;YACV,KAAK,MAAM;gBACP,IAAI,GAAG,mBAAmB,CAAC,OAAO,CAAC;gBACnC,MAAM;YACV;gBACI,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;QACvE,CAAC;QAED,qCAAqC;QACrC,MAAM,oBAAoB,GAAqC;YAC3D,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI;SACP,CAAC;QACF,IAAI,oBAAoB,CAAC,IAAI,KAAK,mBAAmB,CAAC,OAAO,IAAI,CAAA,MAAA,OAAO,CAAC,UAAU,0CAAE,OAAO,MAAK,SAAS,EAAE,CAAC;YACzG,oBAAoB,CAAC,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QACnE,CAAC;QACD,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACrD,CAAC;IAED,OAAO;QACH,aAAa,EAAE,CAAC;QAChB,SAAS,EAAE,kBAAkB,CAAC,SAAS;QACvC,aAAa,EAAE;YACX,QAAQ,EAAE,kBAAkB,CAAC,UAAU;SAC1C;QACD,qBAAqB;QACrB,mBAAmB,EAAE,CAAC,CAAC,kBAAkB,CAAC,mBAAmB;KAChE,CAAC;AACN,CAAC"}

package/dist/serialization/v1/blockSerialization.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"blockSerialization.types.d.ts","sourceRoot":"","sources":["../../../src/serialization/v1/blockSerialization.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC1G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACtC;;OAEG;IACH,aAAa,EAAE,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,gCAAgC,EAAE,CAAC;IAE1D;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,CAAC,CAAC,SAAS,uBAAuB,GAAG,uBAAuB,IAAI;IACxG;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IAER;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;CAC1C,CAAC"}

package/dist/serialization/v1/blockSerialization.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"blockSerialization.types.js","sourceRoot":"","sources":["../../../src/serialization/v1/blockSerialization.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}