@babylonjs/smart-filters 1.0.12 → 8.18.0

package/src/blockFoundation/disableableShaderBlock.ts

@@ -1,100 +1,91 @@
-import type { SmartFilter } from "../smartFilter.js";
-import type { ConnectionPoint } from "../connection/connectionPoint.js";
-
-import { ConnectionPointType } from "../connection/connectionPointType.js";
-import { createStrongRef } from "../runtime/strongRef.js";
-import { ShaderBlock } from "./shaderBlock.js";
-import { injectAutoSampleDisableCode } from "../utils/shaderCodeUtils.js";
-
-/**
- * The interface that describes the disableable block.
- */
-export interface IDisableableBlock {
-    /**
-     * The disabled connection point of the block.
-     */
-    disabled: ConnectionPoint<ConnectionPointType.Boolean>;
-}
-
-/**
- * The strategy to use for making a block disableable.
- */
-export enum BlockDisableStrategy {
-    /**
-     * The shader code is responsible for defining and consulting a uniform named disabled
-     * and no-oping (returning texture2D(mainInputTexture, vUV)) if the value is true.
-     */
-    Manual = 0,
-
-    /**
-     * The Smart Filter system will automatically add code to sample the mainInputTexture and return immediately if disabled,
-     * and otherwise use the value within the block's shader code. If you need to modify UVs before sampling the default input texture,
-     * you'll need to use the Manual strategy instead.
-     */
-    AutoSample = 1,
-}
-
-/**
- * A ShaderBlock that can be disabled. The optimizer can optionally remove disabled blocks from the graph,
- * or they can be controlled by the disabled connection point at runtime. If disabled, they pass the
- * mainInputTexture through to the output connection point.
- */
-export abstract class DisableableShaderBlock extends ShaderBlock implements IDisableableBlock {
-    /**
-     * The disabled connection point of the block.
-     */
-    public readonly disabled = this._registerOptionalInput(
-        "disabled",
-        ConnectionPointType.Boolean,
-        createStrongRef(false)
-    );
-
-    /**
-     * The strategy to use for making this block disableable.
-     */
-    public readonly blockDisableStrategy: BlockDisableStrategy;
-
-    // The shader code is a static per block type. When an instance of a block is created, we may need to alter
-    // that code based on the block's disable strategy. We only want to do this once per block type, or we could
-    // incorrectly modify the shader code multiple times (once per block instance). Here we use a static boolean
-    // which will be per block type to track if we've already modified the shader code for this block type.
-    // This is more memory efficient than the alternative of making a copy of the shader code for each block instance
-    // and modifying each copy.
-    private static _HasModifiedShaderCode = false;
-    private get _hasModifiedShaderCode() {
-        return (this.constructor as typeof DisableableShaderBlock)._HasModifiedShaderCode;
-    }
-    private set _hasModifiedShaderCode(value: boolean) {
-        (this.constructor as typeof DisableableShaderBlock)._HasModifiedShaderCode = value;
-    }
-
-    /**
-     * Instantiates a new block.
-     * @param smartFilter - Defines the smart filter the block belongs to
-     * @param name - Defines the name of the block
-     * @param disableOptimization - Defines if the block should not be optimized (default: false)
-     * @param disableStrategy - Defines the strategy to use for making this block disableable (default: BlockDisableStrategy.AutoSample)
-     */
-    constructor(
-        smartFilter: SmartFilter,
-        name: string,
-        disableOptimization = false,
-        disableStrategy = BlockDisableStrategy.AutoSample
-    ) {
-        super(smartFilter, name, disableOptimization);
-        this.blockDisableStrategy = disableStrategy;
-
-        // If we haven't already modified the shader code for this block type, do so now
-        if (!this._hasModifiedShaderCode) {
-            this._hasModifiedShaderCode = true;
-
-            // Apply the disable strategy
-            const shaderProgram = this.getShaderProgram();
-            switch (this.blockDisableStrategy) {
-                case BlockDisableStrategy.AutoSample:
-                    injectAutoSampleDisableCode(shaderProgram);
-                    break;
-            }
-        }
-    }
-}
+import type { SmartFilter } from "../smartFilter.js";
+import type { ConnectionPoint } from "../connection/connectionPoint.js";
+
+import { ConnectionPointType } from "../connection/connectionPointType.js";
+import { CreateStrongRef } from "../runtime/strongRef.js";
+import { ShaderBlock } from "./shaderBlock.js";
+import { InjectAutoSampleDisableCode } from "../utils/shaderCodeUtils.js";
+
+/**
+ * The interface that describes the disableable block.
+ */
+export interface IDisableableBlock {
+    /**
+     * The disabled connection point of the block.
+     */
+    disabled: ConnectionPoint<ConnectionPointType.Boolean>;
+}
+
+/**
+ * The strategy to use for making a block disableable.
+ */
+export enum BlockDisableStrategy {
+    /**
+     * The shader code is responsible for defining and consulting a uniform named disabled
+     * and no-oping (returning texture2D(mainInputTexture, vUV)) if the value is true.
+     */
+    Manual = 0,
+
+    /**
+     * The Smart Filter system will automatically add code to sample the mainInputTexture and return immediately if disabled,
+     * and otherwise use the value within the block's shader code. If you need to modify UVs before sampling the default input texture,
+     * you'll need to use the Manual strategy instead.
+     */
+    AutoSample = 1,
+}
+
+/**
+ * A ShaderBlock that can be disabled. The optimizer can optionally remove disabled blocks from the graph,
+ * or they can be controlled by the disabled connection point at runtime. If disabled, they pass the
+ * mainInputTexture through to the output connection point.
+ */
+export abstract class DisableableShaderBlock extends ShaderBlock implements IDisableableBlock {
+    /**
+     * The disabled connection point of the block.
+     */
+    public readonly disabled = this._registerOptionalInput("disabled", ConnectionPointType.Boolean, CreateStrongRef(false));
+
+    /**
+     * The strategy to use for making this block disableable.
+     */
+    public readonly blockDisableStrategy: BlockDisableStrategy;
+
+    // The shader code is a static per block type. When an instance of a block is created, we may need to alter
+    // that code based on the block's disable strategy. We only want to do this once per block type, or we could
+    // incorrectly modify the shader code multiple times (once per block instance). Here we use a static boolean
+    // which will be per block type to track if we've already modified the shader code for this block type.
+    // This is more memory efficient than the alternative of making a copy of the shader code for each block instance
+    // and modifying each copy.
+    private static _HasModifiedShaderCode = false;
+    private get _hasModifiedShaderCode() {
+        return (this.constructor as typeof DisableableShaderBlock)._HasModifiedShaderCode;
+    }
+    private set _hasModifiedShaderCode(value: boolean) {
+        (this.constructor as typeof DisableableShaderBlock)._HasModifiedShaderCode = value;
+    }
+
+    /**
+     * Instantiates a new block.
+     * @param smartFilter - Defines the smart filter the block belongs to
+     * @param name - Defines the name of the block
+     * @param disableOptimization - Defines if the block should not be optimized (default: false)
+     * @param disableStrategy - Defines the strategy to use for making this block disableable (default: BlockDisableStrategy.AutoSample)
+     */
+    constructor(smartFilter: SmartFilter, name: string, disableOptimization = false, disableStrategy = BlockDisableStrategy.AutoSample) {
+        super(smartFilter, name, disableOptimization);
+        this.blockDisableStrategy = disableStrategy;
+
+        // If we haven't already modified the shader code for this block type, do so now
+        if (!this._hasModifiedShaderCode) {
+            this._hasModifiedShaderCode = true;
+
+            // Apply the disable strategy
+            const shaderProgram = this.getShaderProgram();
+            switch (this.blockDisableStrategy) {
+                case BlockDisableStrategy.AutoSample:
+                    InjectAutoSampleDisableCode(shaderProgram);
+                    break;
+            }
+        }
+    }
+}

package/src/blockFoundation/index.ts

@@ -1,9 +1,9 @@
-export { BaseBlock } from "./baseBlock.js";
-export { InputBlock, type InputBlockEditorData } from "./inputBlock.js";
-export { type AnyInputBlock } from "./inputBlock.js";
-export { ShaderBlock } from "./shaderBlock.js";
-export { CustomShaderBlock } from "./customShaderBlock.js";
-export { CustomAggregateBlock } from "./customAggregateBlock.js";
-export { DisableableShaderBlock, BlockDisableStrategy } from "./disableableShaderBlock.js";
-export { AggregateBlock } from "./aggregateBlock.js";
-export { type IDisableableBlock } from "./disableableShaderBlock.js";
+export { BaseBlock } from "./baseBlock.js";
+export { InputBlock, type InputBlockEditorData } from "./inputBlock.js";
+export { type AnyInputBlock } from "./inputBlock.js";
+export { ShaderBlock } from "./shaderBlock.js";
+export { CustomShaderBlock } from "./customShaderBlock.js";
+export { CustomAggregateBlock } from "./customAggregateBlock.js";
+export { DisableableShaderBlock, BlockDisableStrategy } from "./disableableShaderBlock.js";
+export { AggregateBlock } from "./aggregateBlock.js";
+export { type IDisableableBlock } from "./disableableShaderBlock.js";

package/src/blockFoundation/inputBlock.deserializer.ts

@@ -1,97 +1,72 @@
-import { InputBlock } from "./inputBlock.js";
-import type { SerializedInputBlockData } from "./inputBlock.serialization.types.js";
-import { ConnectionPointType } from "../connection/connectionPointType.js";
-import type { SmartFilter } from "../smartFilter.js";
-import type { ISerializedBlockV1 } from "../serialization/v1/smartFilterSerialization.types.js";
-
-/**
- * V1 Input Block Deserializer
- * @param smartFilter - The SmartFilter to deserialize the block into
- * @param serializedBlock - The serialized block data
- * @returns A deserialized InputBlock
- */
-export function inputBlockDeserializer(smartFilter: SmartFilter, serializedBlock: ISerializedBlockV1) {
-    const blockData = serializedBlock.data as SerializedInputBlockData;
-    let inputBlock;
-
-    switch (blockData.inputType) {
-        case ConnectionPointType.Boolean:
-            {
-                inputBlock = new InputBlock(
-                    smartFilter,
-                    serializedBlock.name,
-                    ConnectionPointType.Boolean,
-                    blockData.value
-                );
-            }
-            break;
-        case ConnectionPointType.Float:
-            {
-                inputBlock = new InputBlock(
-                    smartFilter,
-                    serializedBlock.name,
-                    ConnectionPointType.Float,
-                    blockData.value
-                );
-                inputBlock.editorData = {
-                    animationType: blockData.animationType,
-                    valueDeltaPerMs: blockData.valueDeltaPerMs,
-                    min: blockData.min,
-                    max: blockData.max,
-                };
-            }
-            break;
-        case ConnectionPointType.Texture:
-            {
-                // Create the input block
-                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Texture, null);
-
-                // If editor data was serialized, set it on the deserialized block
-                inputBlock.editorData = {
-                    url: blockData.url,
-                    urlTypeHint: blockData.urlTypeHint,
-                    anisotropicFilteringLevel: blockData.anisotropicFilteringLevel,
-                    flipY: blockData.flipY,
-                    forcedExtension: blockData.forcedExtension,
-                };
-            }
-            break;
-        case ConnectionPointType.Color3:
-            {
-                inputBlock = new InputBlock(
-                    smartFilter,
-                    serializedBlock.name,
-                    ConnectionPointType.Color3,
-                    blockData.value
-                );
-            }
-            break;
-        case ConnectionPointType.Color4:
-            {
-                inputBlock = new InputBlock(
-                    smartFilter,
-                    serializedBlock.name,
-                    ConnectionPointType.Color4,
-                    blockData.value
-                );
-            }
-            break;
-        case ConnectionPointType.Vector2:
-            {
-                inputBlock = new InputBlock(
-                    smartFilter,
-                    serializedBlock.name,
-                    ConnectionPointType.Vector2,
-                    blockData.value
-                );
-            }
-            break;
-    }
-    if (inputBlock) {
-        inputBlock.appMetadata = blockData.appMetadata;
-
-        return inputBlock;
-    }
-
-    throw new Error("Could not deserialize input block, unknown input type");
-}
+import { InputBlock } from "./inputBlock.js";
+import type { SerializedInputBlockData } from "./inputBlock.serialization.types.js";
+import { ConnectionPointType } from "../connection/connectionPointType.js";
+import type { SmartFilter } from "../smartFilter.js";
+import type { ISerializedBlockV1 } from "../serialization/v1/smartFilterSerialization.types.js";
+
+/**
+ * V1 Input Block Deserializer
+ * @param smartFilter - The SmartFilter to deserialize the block into
+ * @param serializedBlock - The serialized block data
+ * @returns A deserialized InputBlock
+ */
+export function InputBlockDeserializer(smartFilter: SmartFilter, serializedBlock: ISerializedBlockV1) {
+    const blockData = serializedBlock.data as SerializedInputBlockData;
+    let inputBlock;
+
+    switch (blockData.inputType) {
+        case ConnectionPointType.Boolean:
+            {
+                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Boolean, blockData.value);
+            }
+            break;
+        case ConnectionPointType.Float:
+            {
+                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Float, blockData.value);
+                inputBlock.editorData = {
+                    animationType: blockData.animationType,
+                    valueDeltaPerMs: blockData.valueDeltaPerMs,
+                    min: blockData.min,
+                    max: blockData.max,
+                };
+            }
+            break;
+        case ConnectionPointType.Texture:
+            {
+                // Create the input block
+                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Texture, null);
+
+                // If editor data was serialized, set it on the deserialized block
+                inputBlock.editorData = {
+                    url: blockData.url,
+                    urlTypeHint: blockData.urlTypeHint,
+                    anisotropicFilteringLevel: blockData.anisotropicFilteringLevel,
+                    flipY: blockData.flipY,
+                    forcedExtension: blockData.forcedExtension,
+                };
+            }
+            break;
+        case ConnectionPointType.Color3:
+            {
+                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Color3, blockData.value);
+            }
+            break;
+        case ConnectionPointType.Color4:
+            {
+                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Color4, blockData.value);
+            }
+            break;
+        case ConnectionPointType.Vector2:
+            {
+                inputBlock = new InputBlock(smartFilter, serializedBlock.name, ConnectionPointType.Vector2, blockData.value);
+            }
+            break;
+    }
+    if (inputBlock) {
+        inputBlock.appMetadata = blockData.appMetadata;
+
+        return inputBlock;
+    }
+
+    throw new Error("Could not deserialize input block, unknown input type");
+}

package/src/blockFoundation/inputBlock.serialization.types.ts

@@ -1,132 +1,126 @@
-import type { Nullable } from "@babylonjs/core/types.js";
-import type { ConnectionPointType } from "../connection/connectionPointType.js";
-import type { IColor3Like, IColor4Like, IVector2Like } from "@babylonjs/core/Maths/math.like.js";
-
-/**
- * Data that all serialized InputBlocks share
- */
-export type CommonInputBlockData = {
-    /**
-     * Metadata the hosting app wants to track for this input. For example, a hint for what data to
-     * assign to this input, or hints about how to draw dynamic UI to allow users to control this value.
-     */
-    appMetadata: unknown;
-};
-
-/**
- * The data for an InputBlock for ConnectionPointType.Texture inputs
- */
-export type TextureInputBlockData = CommonInputBlockData & {
-    /** The type of the input block */
-    inputType: ConnectionPointType.Texture;
-
-    /** The URL, if available, of the texture */
-    url: Nullable<string>;
-
-    /**
-     * If supplied, gives a hint as to which type of texture the URL points to.
-     * Default is assumed to be "image"
-     */
-    urlTypeHint: Nullable<"image" | "video">;
-
-    /**
-     * Defines the anisotropic level to use, or default if null
-     */
-    anisotropicFilteringLevel: Nullable<number>;
-
-    /**
-     * Indicates if the Y axis should be flipped, or default if null
-     */
-    flipY: Nullable<boolean>;
-
-    /**
-     * The file extension to use, or default if null.
-     */
-    forcedExtension: Nullable<string>;
-};
-
-/**
- * The data for an InputBlock for ConnectionPointType.Boolean inputs
- */
-export type BooleanInputBlockData = CommonInputBlockData & {
-    /** The type of the input block */
-    inputType: ConnectionPointType.Boolean;
-
-    /** The value of the input block */
-    value: boolean;
-};
-
-/**
- * The data for an InputBlock for ConnectionPointType.Float inputs
- */
-export type FloatInputBlockData = CommonInputBlockData & {
-    /** The type of the input block */
-    inputType: ConnectionPointType.Float;
-
-    /** The value of the input block */
-    value: number;
-
-    /**
-     * If supplied, how this should be animated by the editor.  Will not affect runtime behavior.
-     */
-    animationType: Nullable<"time">;
-
-    /**
-     * If supplied, the amount to change the value per millisecond when animating.
-     */
-    valueDeltaPerMs: Nullable<number>;
-
-    /**
-     * The minimum value of the float, used for slider control.
-     */
-    min: Nullable<number>;
-
-    /**
-     * The maximum value of the float, used for slider control.
-     */
-    max: Nullable<number>;
-};
-
-/**
- * The data for an InputBlock for ConnectionPointType.Color3 inputs
- */
-export type Color3InputBlockData = CommonInputBlockData & {
-    /** The type of the input block */
-    inputType: ConnectionPointType.Color3;
-
-    /** The value of the input block */
-    value: IColor3Like;
-};
-
-/**
- * The data for an InputBlock for ConnectionPointType.Color4 inputs
- */
-export type Color4InputBlockData = CommonInputBlockData & {
-    /** The type of the input block */
-    inputType: ConnectionPointType.Color4;
-
-    /** The value of the input block */
-    value: IColor4Like;
-};
-
-/**
- * The data for an InputBlock for ConnectionPointType.Vector2 inputs
- */
-export type Vector2InputBlockData = CommonInputBlockData & {
-    /** The type of the input block */
-    inputType: ConnectionPointType.Vector2;
-
-    /** The value of the input block */
-    value: IVector2Like;
-};
-
-/**
- * Type union of all possible InputBlock data types
- */
-export type SerializedInputBlockData =
-    | TextureInputBlockData
-    | BooleanInputBlockData
-    | FloatInputBlockData
-    | Color3InputBlockData
-    | Color4InputBlockData
-    | Vector2InputBlockData;
+import type { Nullable } from "core/types.js";
+import type { ConnectionPointType } from "../connection/connectionPointType.js";
+import type { IColor3Like, IColor4Like, IVector2Like } from "core/Maths/math.like.js";
+
+/**
+ * Data that all serialized InputBlocks share
+ */
+export type CommonInputBlockData = {
+    /**
+     * Metadata the hosting app wants to track for this input. For example, a hint for what data to
+     * assign to this input, or hints about how to draw dynamic UI to allow users to control this value.
+     */
+    appMetadata: unknown;
+};
+
+/**
+ * The data for an InputBlock for ConnectionPointType.Texture inputs
+ */
+export type TextureInputBlockData = CommonInputBlockData & {
+    /** The type of the input block */
+    inputType: ConnectionPointType.Texture;
+
+    /** The URL, if available, of the texture */
+    url: Nullable<string>;
+
+    /**
+     * If supplied, gives a hint as to which type of texture the URL points to.
+     * Default is assumed to be "image"
+     */
+    urlTypeHint: Nullable<"image" | "video">;
+
+    /**
+     * Defines the anisotropic level to use, or default if null
+     */
+    anisotropicFilteringLevel: Nullable<number>;
+
+    /**
+     * Indicates if the Y axis should be flipped, or default if null
+     */
+    flipY: Nullable<boolean>;
+
+    /**
+     * The file extension to use, or default if null.
+     */
+    forcedExtension: Nullable<string>;
+};
+
+/**
+ * The data for an InputBlock for ConnectionPointType.Boolean inputs
+ */
+export type BooleanInputBlockData = CommonInputBlockData & {
+    /** The type of the input block */
+    inputType: ConnectionPointType.Boolean;
+
+    /** The value of the input block */
+    value: boolean;
+};
+
+/**
+ * The data for an InputBlock for ConnectionPointType.Float inputs
+ */
+export type FloatInputBlockData = CommonInputBlockData & {
+    /** The type of the input block */
+    inputType: ConnectionPointType.Float;
+
+    /** The value of the input block */
+    value: number;
+
+    /**
+     * If supplied, how this should be animated by the editor.  Will not affect runtime behavior.
+     */
+    animationType: Nullable<"time">;
+
+    /**
+     * If supplied, the amount to change the value per millisecond when animating.
+     */
+    valueDeltaPerMs: Nullable<number>;
+
+    /**
+     * The minimum value of the float, used for slider control.
+     */
+    min: Nullable<number>;
+
+    /**
+     * The maximum value of the float, used for slider control.
+     */
+    max: Nullable<number>;
+};
+
+/**
+ * The data for an InputBlock for ConnectionPointType.Color3 inputs
+ */
+export type Color3InputBlockData = CommonInputBlockData & {
+    /** The type of the input block */
+    inputType: ConnectionPointType.Color3;
+
+    /** The value of the input block */
+    value: IColor3Like;
+};
+
+/**
+ * The data for an InputBlock for ConnectionPointType.Color4 inputs
+ */
+export type Color4InputBlockData = CommonInputBlockData & {
+    /** The type of the input block */
+    inputType: ConnectionPointType.Color4;
+
+    /** The value of the input block */
+    value: IColor4Like;
+};
+
+/**
+ * The data for an InputBlock for ConnectionPointType.Vector2 inputs
+ */
+export type Vector2InputBlockData = CommonInputBlockData & {
+    /** The type of the input block */
+    inputType: ConnectionPointType.Vector2;
+
+    /** The value of the input block */
+    value: IVector2Like;
+};
+
+/**
+ * Type union of all possible InputBlock data types
+ */
+export type SerializedInputBlockData = TextureInputBlockData | BooleanInputBlockData | FloatInputBlockData | Color3InputBlockData | Color4InputBlockData | Vector2InputBlockData;