@babylonjs/smart-filters 1.0.13 → 8.19.0

package/src/blockFoundation/textureOptions.ts

@@ -1,57 +1,57 @@
-/**
- * The format of a texture - corresponds to the Babylon.js TextureFormat constants
- */
-export enum TextureFormat {
-    /** Babylon Constants.TEXTUREFORMAT_RGBA */
-    RGBA = 5,
-    /** Babylon Constants.TEXTUREFORMAT_R */
-    R = 6,
-    /** Babylon Constants.TEXTUREFORMAT_RG */
-    RG = 7,
-}
-
-/**
- * The type of a texture - corresponds to the Babylon.js TextureType constants
- */
-export enum TextureType {
-    /** Babylon Constants.TEXTURETYPE_UNSIGNED_BYTE */
-    UNSIGNED_BYTE = 0,
-    /** Babylon Constants.TEXTURETYPE_FLOAT */
-    FLOAT = 1,
-    /** Babylon Constants.TEXTURETYPE_HALF_FLOAT */
-    HALF_FLOAT = 2,
-}
-
-// IMPORTANT: Update textureOptionsMatch() if you add more fields to OutputTextureOptions
-/**
- * Describes the requirements for the output texture of a shader block.
- */
-export type OutputTextureOptions = {
-    /**
-     * The texture size ratio (output size of this block / size of the Smart Filter output)
-     */
-    ratio: number;
-
-    /**
-     * The format of the texture
-     */
-    format: TextureFormat;
-
-    /**
-     * The type of the texture
-     */
-    type: TextureType;
-};
-
-/**
- * Compares two OutputTextureOptions to see if they match.
- * @param a - The first OutputTextureOptions
- * @param b - The second OutputTextureOptions
- * @returns True if the two options match, false otherwise
- */
-export function textureOptionsMatch(a: OutputTextureOptions | undefined, b: OutputTextureOptions | undefined): boolean {
-    if (a === undefined || b === undefined) {
-        return false;
-    }
-    return a.ratio === b.ratio && a.format === b.format && a.type === b.type;
-}
+/**
+ * The format of a texture - corresponds to the Babylon.js TextureFormat constants
+ */
+export enum TextureFormat {
+    /** Babylon Constants.TEXTUREFORMAT_RGBA */
+    RGBA = 5,
+    /** Babylon Constants.TEXTUREFORMAT_R */
+    R = 6,
+    /** Babylon Constants.TEXTUREFORMAT_RG */
+    RG = 7,
+}
+
+/**
+ * The type of a texture - corresponds to the Babylon.js TextureType constants
+ */
+export enum TextureType {
+    /** Babylon Constants.TEXTURETYPE_UNSIGNED_BYTE */
+    UNSIGNED_BYTE = 0,
+    /** Babylon Constants.TEXTURETYPE_FLOAT */
+    FLOAT = 1,
+    /** Babylon Constants.TEXTURETYPE_HALF_FLOAT */
+    HALF_FLOAT = 2,
+}
+
+// IMPORTANT: Update textureOptionsMatch() if you add more fields to OutputTextureOptions
+/**
+ * Describes the requirements for the output texture of a shader block.
+ */
+export type OutputTextureOptions = {
+    /**
+     * The texture size ratio (output size of this block / size of the Smart Filter output)
+     */
+    ratio: number;
+
+    /**
+     * The format of the texture
+     */
+    format: TextureFormat;
+
+    /**
+     * The type of the texture
+     */
+    type: TextureType;
+};
+
+/**
+ * Compares two OutputTextureOptions to see if they match.
+ * @param a - The first OutputTextureOptions
+ * @param b - The second OutputTextureOptions
+ * @returns True if the two options match, false otherwise
+ */
+export function TextureOptionsMatch(a: OutputTextureOptions | undefined, b: OutputTextureOptions | undefined): boolean {
+    if (a === undefined || b === undefined) {
+        return false;
+    }
+    return a.ratio === b.ratio && a.format === b.format && a.type === b.type;
+}

package/src/command/command.ts

@@ -1,59 +1,59 @@
-/**
- * Represents the owner of a command.
- */
-export interface ICommandOwner {
-    /**
-     * The friendly name of the owner.
-     */
-    readonly name: string;
-
-    /**
-     * The blockType of the owner;
-     */
-    readonly blockType: string;
-}
-
-/**
- * Represents a the action of a @see Command. This is what will be executed during a command buffer execution.
- */
-export type CommandAction = () => void;
-
-/**
- * Represents a command to execute.
- *
- * A command contains a function that will be executed at runtime by the smart filter.
- *
- * It also contains the owner of the command for debugging purposes.
- */
-export type Command = {
-    /**
-     * The friendly name of the command.
-     */
-    readonly name: string;
-
-    /**
-     * The owner of the command.
-     * In practice, it will mostly be a block, the smart filter or a tool injecting commands.
-     */
-    readonly owner: ICommandOwner;
-
-    /**
-     * Defines the action to execute.
-     */
-    readonly action: CommandAction;
-};
-
-/**
- * Creates a new command.
- * @param name - The friendly name of the command
- * @param owner - The owner of the command
- * @param action - The action to execute when the command is executed
- * @returns The new command
- */
-export function createCommand(name: string, owner: ICommandOwner, action: CommandAction): Command {
-    return {
-        name,
-        owner,
-        action,
-    };
-}
+/**
+ * Represents the owner of a command.
+ */
+export interface ICommandOwner {
+    /**
+     * The friendly name of the owner.
+     */
+    readonly name: string;
+
+    /**
+     * The blockType of the owner;
+     */
+    readonly blockType: string;
+}
+
+/**
+ * Represents a the action of a @see Command. This is what will be executed during a command buffer execution.
+ */
+export type CommandAction = () => void;
+
+/**
+ * Represents a command to execute.
+ *
+ * A command contains a function that will be executed at runtime by the smart filter.
+ *
+ * It also contains the owner of the command for debugging purposes.
+ */
+export type Command = {
+    /**
+     * The friendly name of the command.
+     */
+    readonly name: string;
+
+    /**
+     * The owner of the command.
+     * In practice, it will mostly be a block, the smart filter or a tool injecting commands.
+     */
+    readonly owner: ICommandOwner;
+
+    /**
+     * Defines the action to execute.
+     */
+    readonly action: CommandAction;
+};
+
+/**
+ * Creates a new command.
+ * @param name - The friendly name of the command
+ * @param owner - The owner of the command
+ * @param action - The action to execute when the command is executed
+ * @returns The new command
+ */
+export function CreateCommand(name: string, owner: ICommandOwner, action: CommandAction): Command {
+    return {
+        name,
+        owner,
+        action,
+    };
+}

package/src/command/commandBuffer.ts

@@ -1,71 +1,71 @@
-import type { Command } from "./command";
-
-/**
- * Represents the action to run when calling `visitCommands` on a @see CommandBuffer.
- */
-export type CommandsVisitor = (command: Command) => void;
-
-/**
- * @see CommandsVisitor used to execute the commands of a @see CommandBuffer.
- * @param command - The command to execute.
- */
-function executeCommandsVisitor(command: Command) {
-    command.action();
-}
-
-/**
- * A command buffer is a list of commands to execute.
- * This is used to store the list of tasks the current smart filter needs to execute.
- */
-export class CommandBuffer {
-    private readonly _commands: Command[] = [];
-
-    /**
-     * Creates a new command buffer.
-     * @param args - the list of commands to add to the command buffer
-     */
-    constructor(...args: Command[]) {
-        for (const command of args) {
-            this.push(command);
-        }
-    }
-
-    /**
-     * Adds a command to the command buffer.
-     * @param command - the command to add
-     */
-    public push(command: Command) {
-        this._commands.push(command);
-    }
-
-    /**
-     * Clears the command buffer and empty the list of commands.
-     */
-    public clear() {
-        this._commands.length = 0;
-    }
-
-    /**
-     * Visits all the commands in the command buffer.
-     * @param commandVisitor - The action to execute on each command
-     */
-    public visitCommands(commandVisitor: CommandsVisitor): void {
-        for (const command of this._commands) {
-            commandVisitor(command);
-        }
-    }
-
-    /**
-     * Execute all the commands in the command buffer.
-     */
-    public execute() {
-        this.visitCommands(executeCommandsVisitor);
-    }
-
-    /**
-     * Dispose the resources associated to the command buffer.
-     */
-    public dispose() {
-        this.clear();
-    }
-}
+import type { Command } from "./command.js";
+
+/**
+ * Represents the action to run when calling `visitCommands` on a @see CommandBuffer.
+ */
+export type CommandsVisitor = (command: Command) => void;
+
+/**
+ * @see CommandsVisitor used to execute the commands of a @see CommandBuffer.
+ * @param command - The command to execute.
+ */
+function ExecuteCommandsVisitor(command: Command) {
+    command.action();
+}
+
+/**
+ * A command buffer is a list of commands to execute.
+ * This is used to store the list of tasks the current smart filter needs to execute.
+ */
+export class CommandBuffer {
+    private readonly _commands: Command[] = [];
+
+    /**
+     * Creates a new command buffer.
+     * @param args - the list of commands to add to the command buffer
+     */
+    constructor(...args: Command[]) {
+        for (const command of args) {
+            this.push(command);
+        }
+    }
+
+    /**
+     * Adds a command to the command buffer.
+     * @param command - the command to add
+     */
+    public push(command: Command) {
+        this._commands.push(command);
+    }
+
+    /**
+     * Clears the command buffer and empty the list of commands.
+     */
+    public clear() {
+        this._commands.length = 0;
+    }
+
+    /**
+     * Visits all the commands in the command buffer.
+     * @param commandVisitor - The action to execute on each command
+     */
+    public visitCommands(commandVisitor: CommandsVisitor): void {
+        for (const command of this._commands) {
+            commandVisitor(command);
+        }
+    }
+
+    /**
+     * Execute all the commands in the command buffer.
+     */
+    public execute() {
+        this.visitCommands(ExecuteCommandsVisitor);
+    }
+
+    /**
+     * Dispose the resources associated to the command buffer.
+     */
+    public dispose() {
+        this.clear();
+    }
+}

package/src/command/commandBufferDebugger.ts

@@ -1,14 +1,14 @@
-import { Logger } from "@babylonjs/core/Misc/logger.js";
-import type { CommandBuffer } from "./commandBuffer";
-
-/**
- * Logs all the commands associated to a command buffer.
- * @param commandBuffer - The command buffer to log
- */
-export function logCommands(commandBuffer: Readonly<CommandBuffer>) {
-    Logger.Log("----- Command buffer commands -----");
-    commandBuffer.visitCommands((command) => {
-        Logger.Log(`  Owner: ${command.owner.blockType} (${command.owner.name}) - Command: ${command.name}`);
-    });
-    Logger.Log("-----------------------------------");
-}
+import { Logger } from "core/Misc/logger.js";
+import type { CommandBuffer } from "./commandBuffer.js";
+
+/**
+ * Logs all the commands associated to a command buffer.
+ * @param commandBuffer - The command buffer to log
+ */
+export function LogCommands(commandBuffer: Readonly<CommandBuffer>) {
+    Logger.Log("----- Command buffer commands -----");
+    commandBuffer.visitCommands((command) => {
+        Logger.Log(`  Owner: ${command.owner.blockType} (${command.owner.name}) - Command: ${command.name}`);
+    });
+    Logger.Log("-----------------------------------");
+}

package/src/command/index.ts

@@ -1,3 +1,7 @@
-export * from "./command.js";
-export * from "./commandBuffer.js";
-export { logCommands } from "./commandBufferDebugger.js";
+export * from "./command.js";
+// Back compat for when camelCase was used
+export { CreateCommand as createCommand } from "./command.js";
+export * from "./commandBuffer.js";
+export { LogCommands } from "./commandBufferDebugger.js";
+// Back compat for when camelCase was used
+export { LogCommands as logCommands } from "./commandBufferDebugger.js";