@babylonjs/smart-filters 0.1.0-alpha

package/dist/blocks/shaderBlock.js

@@ -0,0 +1,101 @@
+import "@babylonjs/core/Engines/Extensions/engine.renderTarget.js";
+import { ShaderRuntime } from "../runtime/shaderRuntime.js";
+import { ConnectionPointType } from "../connection/connectionPointType.js";
+import { createCommand } from "../command/command.js";
+import { DisableableBlock } from "./disableableBlock.js";
+import { undecorateSymbol } from "../utils/shaderCodeUtils.js";
+/**
+ * This is the base class for all shader blocks.
+ *
+ * It contains the redundant part of wrapping a shader for a full screen pass.
+ *
+ * The only required function to implement is the bind function.
+ */
+export class ShaderBlock extends DisableableBlock {
+    /**
+     * Gets the texture ratio of the output texture.
+     */
+    get textureRatio() {
+        return this._textureRatio;
+    }
+    /**
+     * Sets the texture ratio of the output texture.
+     */
+    set textureRatio(value) {
+        this._textureRatio = value;
+    }
+    /**
+     * Disconnects the block from the graph.
+     * @param disconnectedConnections - Stores the connections that have been broken in the process. You can reconnect them later if needed.
+     */
+    disconnectFromGraph(disconnectedConnections) {
+        const input = this._getConnectionForMainInputTexture();
+        for (const endpoint of this.output.endpoints) {
+            disconnectedConnections === null || disconnectedConnections === void 0 ? void 0 : disconnectedConnections.push([endpoint, this.output]);
+            input.connectTo(endpoint);
+        }
+    }
+    _getConnectionForMainInputTexture() {
+        const mainInputTextureName = this.getShaderProgram().fragment.mainInputTexture;
+        if (!mainInputTextureName) {
+            throw `The block named "${this.name}" does not have a main input texture defined!`;
+        }
+        const mainInputTexture = this.findInput(undecorateSymbol(mainInputTextureName));
+        if (!mainInputTexture || !mainInputTexture.connectedTo) {
+            throw `The main input texture "${mainInputTextureName}" of block named "${this.name}" is not connected!`;
+        }
+        return mainInputTexture.connectedTo;
+    }
+    /**
+     * 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)
+     */
+    constructor(smartFilter, name, disableOptimization = false) {
+        super(smartFilter, name, disableOptimization);
+        /**
+         * The output connection point of the block.
+         */
+        this.output = this._registerOutput("output", ConnectionPointType.Texture);
+        this._textureRatio = 1;
+    }
+    /**
+     * Gets the shader program to use to render the block.
+     * @returns The shader program to use to render the block
+     */
+    getShaderProgram() {
+        return this.constructor.ShaderCode;
+    }
+    /**
+     * Generates the commands needed to execute the block at runtime and gathers promises for initialization work
+     * @param initializationData - The initialization data to use
+     * @param finalOutput - Defines if the block is the final output of the smart filter
+     */
+    generateCommandsAndGatherInitPromises(initializationData, finalOutput) {
+        const runtime = initializationData.runtime;
+        const shaderBlockRuntime = new ShaderRuntime(runtime.effectRenderer, this.getShaderProgram(), this.getShaderBinding());
+        initializationData.initializationPromises.push(shaderBlockRuntime.onReadyAsync);
+        runtime.registerResource(shaderBlockRuntime);
+        if (finalOutput) {
+            runtime.registerCommand(createCommand(`${this.getClassName()}.renderToCanvas`, this, () => {
+                shaderBlockRuntime.renderToCanvas();
+            }));
+        }
+        else {
+            const rtt = this.output.runtimeData && this.output.runtimeData.value.renderTarget;
+            if (!rtt) {
+                throw new Error("ShaderBlock does not have a render target texture.");
+            }
+            runtime.registerCommand(createCommand(`${this.getClassName()}.render`, this, () => {
+                shaderBlockRuntime.renderToTexture(rtt);
+            }));
+        }
+        super.generateCommandsAndGatherInitPromises(initializationData, finalOutput);
+    }
+}
+/**
+ * The class name of the block.
+ */
+ShaderBlock.ClassName = "ShaderBlock";
+//# sourceMappingURL=shaderBlock.js.map

package/dist/blocks/shaderBlock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shaderBlock.js","sourceRoot":"","sources":["../../src/blocks/shaderBlock.ts"],"names":[],"mappings":"AACA,OAAO,2DAA2D,CAAC;AAMnE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,OAAgB,WAAY,SAAQ,gBAAgB;IAyBtD;;OAEG;IACH,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,YAAY,CAAC,KAAa;QACjC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACa,mBAAmB,CAAC,uBAA8D;QAC9F,MAAM,KAAK,GAAG,IAAI,CAAC,iCAAiC,EAAE,CAAC;QAEvD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC3C,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACvD,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;IAES,iCAAiC;QACvC,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QAC/E,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACxB,MAAM,oBAAoB,IAAI,CAAC,IAAI,+CAA+C,CAAC;QACvF,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAChF,IAAI,CAAC,gBAAgB,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC;YACrD,MAAM,2BAA2B,oBAAoB,qBAAqB,IAAI,CAAC,IAAI,qBAAqB,CAAC;QAC7G,CAAC;QAED,OAAO,gBAAgB,CAAC,WAAW,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,YAAY,WAAwB,EAAE,IAAY,EAAE,mBAAmB,GAAG,KAAK;QAC3E,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC;QAvDlD;;WAEG;QACa,WAAM,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAE3E,kBAAa,GAAW,CAAC,CAAC;IAmDpC,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACnB,OAAQ,IAAI,CAAC,WAAkC,CAAC,UAAU,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACa,qCAAqC,CACjD,kBAAsC,EACtC,WAAoB;QAEpB,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC;QAC3C,MAAM,kBAAkB,GAAG,IAAI,aAAa,CACxC,OAAO,CAAC,cAAc,EACtB,IAAI,CAAC,gBAAgB,EAAE,EACvB,IAAI,CAAC,gBAAgB,EAAE,CAC1B,CAAC;QACF,kBAAkB,CAAC,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAE7C,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,eAAe,CACnB,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,iBAAiB,EAAE,IAAI,EAAE,GAAG,EAAE;gBAC9D,kBAAkB,CAAC,cAAc,EAAE,CAAC;YACxC,CAAC,CAAC,CACL,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,GACL,IAAI,CAAC,MAAM,CAAC,WAAW,IAAK,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAiC,CAAC,YAAY,CAAC;YACvG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YAC1E,CAAC;YAED,OAAO,CAAC,eAAe,CACnB,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE;gBACtD,kBAAkB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAC5C,CAAC,CAAC,CACL,CAAC;QACN,CAAC;QAED,KAAK,CAAC,qCAAqC,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;IACjF,CAAC;;AA1HD;;GAEG;AACoB,qBAAS,GAAG,aAAa,AAAhB,CAAiB"}

package/dist/command/command.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Represents the owner of a command.
+ * In practice, it will mostly be a block, the smart filter or a tool injecting commands.
+ */
+export interface ICommandOwner {
+    /**
+     * The friendly name of the owner.
+     */
+    readonly name: string;
+    /**
+     * Gets the class name of the owner.
+     */
+    getClassName(): 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 declare function createCommand(name: string, owner: ICommandOwner, action: CommandAction): Command;
+//# sourceMappingURL=command.d.ts.map

package/dist/command/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../src/command/command.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,IAAI,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAMhG"}

package/dist/command/command.js

@@ -0,0 +1,15 @@
+/**
+ * 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, owner, action) {
+    return {
+        name,
+        owner,
+        action,
+    };
+}
+//# sourceMappingURL=command.js.map

package/dist/command/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/command/command.ts"],"names":[],"mappings":"AA8CA;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,KAAoB,EAAE,MAAqB;IACnF,OAAO;QACH,IAAI;QACJ,KAAK;QACL,MAAM;KACT,CAAC;AACN,CAAC"}

package/dist/command/commandBuffer.d.ts

@@ -0,0 +1,40 @@
+import type { Command } from "./command";
+/**
+ * Represents the action to run when calling `visitCommands` on a @see CommandBuffer.
+ */
+export type CommandsVisitor = (command: Command) => void;
+/**
+ * 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 declare class CommandBuffer {
+    private readonly _commands;
+    /**
+     * Creates a new command buffer.
+     * @param args - the list of commands to add to the command buffer
+     */
+    constructor(...args: Command[]);
+    /**
+     * Adds a command to the command buffer.
+     * @param command - the command to add
+     */
+    push(command: Command): void;
+    /**
+     * Clears the command buffer and empty the list of commands.
+     */
+    clear(): void;
+    /**
+     * Visits all the commands in the command buffer.
+     * @param commandVisitor - The action to execute on each command
+     */
+    visitCommands(commandVisitor: CommandsVisitor): void;
+    /**
+     * Execute all the commands in the command buffer.
+     */
+    execute(): void;
+    /**
+     * Dispose the resources associated to the command buffer.
+     */
+    dispose(): void;
+}
+//# sourceMappingURL=commandBuffer.d.ts.map

package/dist/command/commandBuffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandBuffer.d.ts","sourceRoot":"","sources":["../../src/command/commandBuffer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAUzD;;;GAGG;AACH,qBAAa,aAAa;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAE3C;;;OAGG;gBACS,GAAG,IAAI,EAAE,OAAO,EAAE;IAM9B;;;OAGG;IACI,IAAI,CAAC,OAAO,EAAE,OAAO;IAI5B;;OAEG;IACI,KAAK;IAIZ;;;OAGG;IACI,aAAa,CAAC,cAAc,EAAE,eAAe,GAAG,IAAI;IAM3D;;OAEG;IACI,OAAO;IAId;;OAEG;IACI,OAAO;CAGjB"}

package/dist/command/commandBuffer.js

@@ -0,0 +1,58 @@
+/**
+ * @see CommandsVisitor used to execute the commands of a @see CommandBuffer.
+ * @param command - The command to execute.
+ */
+function executeCommandsVisitor(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 {
+    /**
+     * Creates a new command buffer.
+     * @param args - the list of commands to add to the command buffer
+     */
+    constructor(...args) {
+        this._commands = [];
+        for (const command of args) {
+            this.push(command);
+        }
+    }
+    /**
+     * Adds a command to the command buffer.
+     * @param command - the command to add
+     */
+    push(command) {
+        this._commands.push(command);
+    }
+    /**
+     * Clears the command buffer and empty the list of commands.
+     */
+    clear() {
+        this._commands.length = 0;
+    }
+    /**
+     * Visits all the commands in the command buffer.
+     * @param commandVisitor - The action to execute on each command
+     */
+    visitCommands(commandVisitor) {
+        for (const command of this._commands) {
+            commandVisitor(command);
+        }
+    }
+    /**
+     * Execute all the commands in the command buffer.
+     */
+    execute() {
+        this.visitCommands(executeCommandsVisitor);
+    }
+    /**
+     * Dispose the resources associated to the command buffer.
+     */
+    dispose() {
+        this.clear();
+    }
+}
+//# sourceMappingURL=commandBuffer.js.map

package/dist/command/commandBuffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandBuffer.js","sourceRoot":"","sources":["../../src/command/commandBuffer.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,SAAS,sBAAsB,CAAC,OAAgB;IAC5C,OAAO,CAAC,MAAM,EAAE,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,aAAa;IAGtB;;;OAGG;IACH,YAAY,GAAG,IAAe;QANb,cAAS,GAAc,EAAE,CAAC;QAOvC,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,OAAgB;QACxB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK;QACR,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,cAA+B;QAChD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;IACL,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;CACJ"}

package/dist/command/commandBufferDebugger.d.ts

@@ -0,0 +1,7 @@
+import type { CommandBuffer } from "./commandBuffer";
+/**
+ * Logs all the commands associated to a command buffer.
+ * @param commandBuffer - The command buffer to log
+ */
+export declare function logCommands(commandBuffer: Readonly<CommandBuffer>): void;
+//# sourceMappingURL=commandBufferDebugger.d.ts.map

package/dist/command/commandBufferDebugger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandBufferDebugger.d.ts","sourceRoot":"","sources":["../../src/command/commandBufferDebugger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,QAMjE"}

package/dist/command/commandBufferDebugger.js

@@ -0,0 +1,12 @@
+/**
+ * Logs all the commands associated to a command buffer.
+ * @param commandBuffer - The command buffer to log
+ */
+export function logCommands(commandBuffer) {
+    console.log("----- Command buffer commands -----");
+    commandBuffer.visitCommands((command) => {
+        console.log(`  Owner: ${command.owner.getClassName()} (${command.owner.name}) - Command: ${command.name}`);
+    });
+    console.log("-----------------------------------");
+}
+//# sourceMappingURL=commandBufferDebugger.js.map

package/dist/command/commandBufferDebugger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandBufferDebugger.js","sourceRoot":"","sources":["../../src/command/commandBufferDebugger.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,aAAsC;IAC9D,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;IACnD,aAAa,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,EAAE;QACpC,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,gBAAgB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/G,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;AACvD,CAAC"}

package/dist/connection/connectionPoint.d.ts

@@ -0,0 +1,110 @@
+import type { Nullable } from "@babylonjs/core/types";
+import { ConnectionPointCompatibilityState } from "./connectionPointCompatibilityState.js";
+import { ConnectionPointDirection } from "./connectionPointDirection.js";
+import type { BaseBlock } from "../blocks/baseBlock";
+import type { ConnectionPointType, ConnectionPointValue } from "./connectionPointType";
+import type { StrongRef } from "../runtime/strongRef";
+/**
+ * This represents a strong reference to the data being passed through a connection point.
+ */
+export type RuntimeData<U extends ConnectionPointType> = StrongRef<ConnectionPointValue<U>>;
+/**
+ * This defines a connection point.
+ *
+ * A connection point is any input/output of a block.
+ * It can be linked to another connection point following some rules:
+ *  - The type of the connection point must be compatible with the other one.
+ *  - The direction of the connection point must be different from the other one.
+ *  - The connection cannot create a cycle in the list of blocks.
+ * The relationship is always 1:N for input:output
+ */
+export declare class ConnectionPoint<U extends ConnectionPointType = ConnectionPointType> {
+    /**
+     * The name of the connection point.
+     * This is used to identify the connection point inside a block.
+     */
+    readonly name: string;
+    /**
+     * The type of the connection point (float, texture, etc.)
+     */
+    readonly type: U;
+    /**
+     * The direction of the connection point (input or output)
+     */
+    readonly direction: ConnectionPointDirection;
+    /**
+     * The smart filter block the connection point belongs to.
+     */
+    readonly ownerBlock: BaseBlock;
+    /**
+     * User provided name for the connection point.
+     */
+    displayName: Nullable<string>;
+    /**
+     * The @see RunTimeData used during the init phase to reference the result of the previous block.
+     * Those are only used for input connection points.
+     * The previous block are "pushing" this in during the init stage.
+     */
+    runtimeData: Nullable<RuntimeData<U>>;
+    /**
+     * The default runtimeData used when no connection is made to the connection point.
+     */
+    readonly defaultRuntimeData: Nullable<RuntimeData<U>>;
+    private _connectedTo;
+    private _endpoints;
+    /**
+     * Create a new connection point.
+     * @param name - The name the connection point has in the block
+     * @param ownerBlock - The block the connection point belongs to
+     * @param type - The type of the connection point
+     * @param direction - The direction of the connection point
+     * @param defaultRuntimeData - The default runtime data to use when no connection is made to the connection point
+     */
+    constructor(name: string, ownerBlock: BaseBlock, type: U, direction: ConnectionPointDirection, defaultRuntimeData?: Nullable<RuntimeData<U>>);
+    /**
+     * @returns the connection point this connection point is connected to.
+     * (the one on the other side of the connection)
+     * Only input connection points have a connected point which they received their value from.
+     * (Relation is always 1:N for input:output)
+     */
+    get connectedTo(): Nullable<ConnectionPoint<U>>;
+    /**
+     * @returns the connection point this connection point is to.
+     * (the one on the other side of the connection)
+     * Only output connection points have a list of endpoints which they provide their value to.
+     * (Relation is always 1:N for input:output)
+     */
+    get endpoints(): ReadonlyArray<ConnectionPoint<U>>;
+    /**
+     * Gets a state indicating if the current point can be connected to another point
+     * @param other - defines the other connection point
+     * @returns the compatibility state
+     */
+    checkCompatibilityState(other: ConnectionPoint<U>): ConnectionPointCompatibilityState;
+    /**
+     * Checks if the connection point can be connected to another one.
+     * @param connectionPoint - The other connection point to check compatibility with
+     * @returns true if the connection point can be connected to the other one
+     */
+    canConnectTo(connectionPoint: ConnectionPoint<U>): boolean;
+    /**
+     * Connect this connection point to another one.
+     * @param other - The other connection point to connect to
+     * @throws if the connection point cannot be connected to the other one
+     */
+    connectTo(other: ConnectionPoint<U>): void;
+    /**
+     * Disconnects this point from one of his endpoint
+     * @param endpoint - defines the other connection point
+     */
+    disconnectFrom(endpoint: ConnectionPoint<U>): void;
+    /**
+     * Disconnects this point from all its endpoints.
+     */
+    disconnectAllEndpoints(): void;
+    /**
+     * Propagates the current runtime data to all endpoints.
+     */
+    propagateRuntimeData(): void;
+}
+//# sourceMappingURL=connectionPoint.d.ts.map

package/dist/connection/connectionPoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionPoint.d.ts","sourceRoot":"","sources":["../../src/connection/connectionPoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EACH,iCAAiC,EAEpC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACvF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,mBAAmB,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5F;;;;;;;;;GASG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB;IAC5E;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,IAAI,EAAE,CAAC,CAAC;IAExB;;OAEG;IACH,SAAgB,SAAS,EAAE,wBAAwB,CAAC;IAEpD;;OAEG;IACH,SAAgB,UAAU,EAAE,SAAS,CAAC;IAEtC;;OAEG;IACI,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAE5C;;;;OAIG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAQ;IAEpD;;OAEG;IACH,SAAgB,kBAAkB,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAQ;IAEpE,OAAO,CAAC,YAAY,CAAsC;IAC1D,OAAO,CAAC,UAAU,CAAiC;IAEnD;;;;;;;OAOG;gBAEC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,SAAS,EACrB,IAAI,EAAE,CAAC,EACP,SAAS,EAAE,wBAAwB,EACnC,kBAAkB,GAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAQ;IAUvD;;;;;OAKG;IACH,IAAW,WAAW,IAAI,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAErD;IAED;;;;;OAKG;IACH,IAAW,SAAS,IAAI,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAExD;IAED;;;;OAIG;IACI,uBAAuB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,iCAAiC;IAwB5F;;;;OAIG;IACI,YAAY,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC;IAIvD;;;;OAIG;IACI,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI;IAmBjD;;;OAGG;IACI,cAAc,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI;IAYzD;;OAEG;IACI,sBAAsB,IAAI,IAAI;IAQrC;;OAEG;IACI,oBAAoB,IAAI,IAAI;CAStC"}

package/dist/connection/connectionPoint.js

@@ -0,0 +1,153 @@
+import { ConnectionPointCompatibilityState, getCompatibilityIssueMessage, } from "./connectionPointCompatibilityState.js";
+import { ConnectionPointDirection } from "./connectionPointDirection.js";
+/**
+ * This defines a connection point.
+ *
+ * A connection point is any input/output of a block.
+ * It can be linked to another connection point following some rules:
+ *  - The type of the connection point must be compatible with the other one.
+ *  - The direction of the connection point must be different from the other one.
+ *  - The connection cannot create a cycle in the list of blocks.
+ * The relationship is always 1:N for input:output
+ */
+export class ConnectionPoint {
+    /**
+     * Create a new connection point.
+     * @param name - The name the connection point has in the block
+     * @param ownerBlock - The block the connection point belongs to
+     * @param type - The type of the connection point
+     * @param direction - The direction of the connection point
+     * @param defaultRuntimeData - The default runtime data to use when no connection is made to the connection point
+     */
+    constructor(name, ownerBlock, type, direction, defaultRuntimeData = null) {
+        /**
+         * User provided name for the connection point.
+         */
+        this.displayName = null;
+        /**
+         * The @see RunTimeData used during the init phase to reference the result of the previous block.
+         * Those are only used for input connection points.
+         * The previous block are "pushing" this in during the init stage.
+         */
+        this.runtimeData = null;
+        /**
+         * The default runtimeData used when no connection is made to the connection point.
+         */
+        this.defaultRuntimeData = null;
+        this._connectedTo = null;
+        this._endpoints = [];
+        this.name = name;
+        this.ownerBlock = ownerBlock;
+        this.type = type;
+        this.direction = direction;
+        this.defaultRuntimeData = defaultRuntimeData;
+        this.runtimeData = defaultRuntimeData;
+    }
+    /**
+     * @returns the connection point this connection point is connected to.
+     * (the one on the other side of the connection)
+     * Only input connection points have a connected point which they received their value from.
+     * (Relation is always 1:N for input:output)
+     */
+    get connectedTo() {
+        return this._connectedTo;
+    }
+    /**
+     * @returns the connection point this connection point is to.
+     * (the one on the other side of the connection)
+     * Only output connection points have a list of endpoints which they provide their value to.
+     * (Relation is always 1:N for input:output)
+     */
+    get endpoints() {
+        return this._endpoints;
+    }
+    /**
+     * Gets a state indicating if the current point can be connected to another point
+     * @param other - defines the other connection point
+     * @returns the compatibility state
+     */
+    checkCompatibilityState(other) {
+        // Only connects output to input
+        if (this.direction === ConnectionPointDirection.Input) {
+            return other.checkCompatibilityState(this);
+        }
+        // Check types
+        if (this.type !== other.type) {
+            return ConnectionPointCompatibilityState.TypeIncompatible;
+        }
+        // Check directions
+        if (this.direction === other.direction) {
+            return ConnectionPointCompatibilityState.DirectionIncompatible;
+        }
+        // Check hierarchy
+        if (other.ownerBlock.isAnAncestorOf(this.ownerBlock)) {
+            return ConnectionPointCompatibilityState.HierarchyIssue;
+        }
+        return ConnectionPointCompatibilityState.Compatible;
+    }
+    /**
+     * Checks if the connection point can be connected to another one.
+     * @param connectionPoint - The other connection point to check compatibility with
+     * @returns true if the connection point can be connected to the other one
+     */
+    canConnectTo(connectionPoint) {
+        return this.checkCompatibilityState(connectionPoint) === ConnectionPointCompatibilityState.Compatible;
+    }
+    /**
+     * Connect this connection point to another one.
+     * @param other - The other connection point to connect to
+     * @throws if the connection point cannot be connected to the other one
+     */
+    connectTo(other) {
+        // Only connects output to input
+        if (this.direction === ConnectionPointDirection.Input) {
+            other.connectTo(this);
+            return;
+        }
+        // Check compatibility
+        const compatibility = this.checkCompatibilityState(other);
+        if (compatibility !== ConnectionPointCompatibilityState.Compatible) {
+            throw getCompatibilityIssueMessage(compatibility);
+        }
+        // Adds the connection point to the list of endpoints
+        this._endpoints.push(other);
+        // Fill at the same time the connectedTo property of the other connection point
+        other._connectedTo = this;
+    }
+    /**
+     * Disconnects this point from one of his endpoint
+     * @param endpoint - defines the other connection point
+     */
+    disconnectFrom(endpoint) {
+        const index = this._endpoints.indexOf(endpoint);
+        if (index === -1) {
+            return;
+        }
+        // Remove the connection point from the list of endpoints
+        this._endpoints.splice(index, 1);
+        // Empty at the same time the connectedTo property of the other connection point
+        endpoint._connectedTo = null;
+    }
+    /**
+     * Disconnects this point from all its endpoints.
+     */
+    disconnectAllEndpoints() {
+        // Detach outputs
+        let endpoint;
+        while ((endpoint = this._endpoints[0])) {
+            this.disconnectFrom(endpoint);
+        }
+    }
+    /**
+     * Propagates the current runtime data to all endpoints.
+     */
+    propagateRuntimeData() {
+        if (!this.runtimeData) {
+            this.runtimeData = {};
+        }
+        for (const endpoint of this.endpoints) {
+            endpoint.runtimeData = this.runtimeData;
+        }
+    }
+}
+//# sourceMappingURL=connectionPoint.js.map

package/dist/connection/connectionPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionPoint.js","sourceRoot":"","sources":["../../src/connection/connectionPoint.ts"],"names":[],"mappings":"AACA,OAAO,EACH,iCAAiC,EACjC,4BAA4B,GAC/B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAUzE;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAe;IA0CxB;;;;;;;OAOG;IACH,YACI,IAAY,EACZ,UAAqB,EACrB,IAAO,EACP,SAAmC,EACnC,qBAA+C,IAAI;QAjCvD;;WAEG;QACI,gBAAW,GAAqB,IAAI,CAAC;QAE5C;;;;WAIG;QACI,gBAAW,GAA6B,IAAI,CAAC;QAEpD;;WAEG;QACa,uBAAkB,GAA6B,IAAI,CAAC;QAE5D,iBAAY,GAAiC,IAAI,CAAC;QAClD,eAAU,GAA8B,EAAE,CAAC;QAiB/C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,KAAyB;QACpD,gCAAgC;QAChC,IAAI,IAAI,CAAC,SAAS,KAAK,wBAAwB,CAAC,KAAK,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;QAED,cAAc;QACd,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;YAC3B,OAAO,iCAAiC,CAAC,gBAAgB,CAAC;QAC9D,CAAC;QAED,mBAAmB;QACnB,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,EAAE,CAAC;YACrC,OAAO,iCAAiC,CAAC,qBAAqB,CAAC;QACnE,CAAC;QAED,kBAAkB;QAClB,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACnD,OAAO,iCAAiC,CAAC,cAAc,CAAC;QAC5D,CAAC;QAED,OAAO,iCAAiC,CAAC,UAAU,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,eAAmC;QACnD,OAAO,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,KAAK,iCAAiC,CAAC,UAAU,CAAC;IAC1G,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,KAAyB;QACtC,gCAAgC;QAChC,IAAI,IAAI,CAAC,SAAS,KAAK,wBAAwB,CAAC,KAAK,EAAE,CAAC;YACpD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO;QACX,CAAC;QAED,sBAAsB;QACtB,MAAM,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,aAAa,KAAK,iCAAiC,CAAC,UAAU,EAAE,CAAC;YACjE,MAAM,4BAA4B,CAAC,aAAa,CAAC,CAAC;QACtD,CAAC;QAED,qDAAqD;QACrD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,+EAA+E;QAC/E,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,QAA4B;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO;QACX,CAAC;QAED,yDAAyD;QACzD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACjC,gFAAgF;QAChF,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,sBAAsB;QACzB,iBAAiB;QACjB,IAAI,QAAwC,CAAC;QAC7C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,oBAAoB;QACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,EAAoB,CAAC;QAC5C,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,CAAC;IACL,CAAC;CACJ"}

package/dist/connection/connectionPointCompatibilityState.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Defines how compatible connection points are.
+ */
+export declare enum ConnectionPointCompatibilityState {
+    /** Points are compatibles */
+    Compatible = 0,
+    /** Points are incompatible because of their types */
+    TypeIncompatible = 1,
+    /** Points are incompatible because of their directions */
+    DirectionIncompatible = 2,
+    /** Points are incompatible because they are in the same hierarchy **/
+    HierarchyIssue = 3
+}
+/**
+ * Gets a user friendly message for the given compatibility state.
+ * @param state - Defines the compatibility state
+ * @returns the message associated with a compatibility state.
+ */
+export declare function getCompatibilityIssueMessage(state: ConnectionPointCompatibilityState): string;
+//# sourceMappingURL=connectionPointCompatibilityState.d.ts.map

package/dist/connection/connectionPointCompatibilityState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionPointCompatibilityState.d.ts","sourceRoot":"","sources":["../../src/connection/connectionPointCompatibilityState.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,iCAAiC;IACzC,6BAA6B;IAC7B,UAAU,IAAA;IACV,qDAAqD;IACrD,gBAAgB,IAAA;IAChB,0DAA0D;IAC1D,qBAAqB,IAAA;IACrB,sEAAsE;IACtE,cAAc,IAAA;CACjB;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,iCAAiC,GAAG,MAAM,CAW7F"}

package/dist/connection/connectionPointCompatibilityState.js

@@ -0,0 +1,32 @@
+/**
+ * Defines how compatible connection points are.
+ */
+export var ConnectionPointCompatibilityState;
+(function (ConnectionPointCompatibilityState) {
+    /** Points are compatibles */
+    ConnectionPointCompatibilityState[ConnectionPointCompatibilityState["Compatible"] = 0] = "Compatible";
+    /** Points are incompatible because of their types */
+    ConnectionPointCompatibilityState[ConnectionPointCompatibilityState["TypeIncompatible"] = 1] = "TypeIncompatible";
+    /** Points are incompatible because of their directions */
+    ConnectionPointCompatibilityState[ConnectionPointCompatibilityState["DirectionIncompatible"] = 2] = "DirectionIncompatible";
+    /** Points are incompatible because they are in the same hierarchy **/
+    ConnectionPointCompatibilityState[ConnectionPointCompatibilityState["HierarchyIssue"] = 3] = "HierarchyIssue";
+})(ConnectionPointCompatibilityState || (ConnectionPointCompatibilityState = {}));
+/**
+ * Gets a user friendly message for the given compatibility state.
+ * @param state - Defines the compatibility state
+ * @returns the message associated with a compatibility state.
+ */
+export function getCompatibilityIssueMessage(state) {
+    switch (state) {
+        case ConnectionPointCompatibilityState.TypeIncompatible:
+            return "Cannot connect two different connection types";
+        case ConnectionPointCompatibilityState.DirectionIncompatible:
+            return "Cannot connect with the same direction";
+        case ConnectionPointCompatibilityState.HierarchyIssue:
+            return "Source block cannot be connected with one of its ancestors";
+        default:
+            return "";
+    }
+}
+//# sourceMappingURL=connectionPointCompatibilityState.js.map

package/dist/connection/connectionPointCompatibilityState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionPointCompatibilityState.js","sourceRoot":"","sources":["../../src/connection/connectionPointCompatibilityState.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,iCASX;AATD,WAAY,iCAAiC;IACzC,6BAA6B;IAC7B,qGAAU,CAAA;IACV,qDAAqD;IACrD,iHAAgB,CAAA;IAChB,0DAA0D;IAC1D,2HAAqB,CAAA;IACrB,sEAAsE;IACtE,6GAAc,CAAA;AAClB,CAAC,EATW,iCAAiC,KAAjC,iCAAiC,QAS5C;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAwC;IACjF,QAAQ,KAAK,EAAE,CAAC;QACZ,KAAK,iCAAiC,CAAC,gBAAgB;YACnD,OAAO,+CAA+C,CAAC;QAC3D,KAAK,iCAAiC,CAAC,qBAAqB;YACxD,OAAO,wCAAwC,CAAC;QACpD,KAAK,iCAAiC,CAAC,cAAc;YACjD,OAAO,4DAA4D,CAAC;QACxE;YACI,OAAO,EAAE,CAAC;IAClB,CAAC;AACL,CAAC"}