@babylonjs/loaders 9.26.1 → 9.26.2

package/glTF/2.0/Extensions/KHR_interactivity/declarationMapper.d.ts

@@ -3,11 +3,21 @@ import { FlowGraphBlockNames } from "@babylonjs/core/FlowGraph/Blocks/flowGraphB
 import { type ISerializedFlowGraphBlock, type ISerializedFlowGraphContext } from "@babylonjs/core/FlowGraph/typeDefinitions.js";
 import { type InteractivityGraphToFlowGraphParser } from "./interactivityGraphParser.js";
 import { type IGLTF } from "../../glTFLoaderInterfaces.js";
-interface IGLTFToFlowGraphMappingObject {
+/**
+ * Describes how one KHR_interactivity configuration or socket property maps to FlowGraph.
+ *
+ * The same contract is used for fixed sockets, wildcard sockets, configuration validation,
+ * defaulting, and multi-block routing during strict graph lowering.
+ */
+export interface IGLTFToFlowGraphMappingObject {
     /**
      * The name of the property in the FlowGraph block.
      */
     name: string;
+    /**
+     * Whether this socket mapping exists only for pre-ratification compatibility input.
+     */
+    compatibilityOnly?: boolean;
     /**
      * The type of the property in the glTF specs.
      * If not provided will be inferred.
@@ -40,7 +50,7 @@ interface IGLTFToFlowGraphMappingObject {
      * This is used if we generate more than one block for a single glTF node.
      * Defaults to the first block in the mapping.
      */
-    toBlock?: FlowGraphBlockNames;
+    toBlock?: FlowGraphBlockNames | string;
     /**
      * Used in configuration values. If defined, this will be the default value, if no value is provided.
      */
@@ -54,6 +64,75 @@ interface IGLTFToFlowGraphMappingObject {
      * be fed by a `pointer/get` (e.g. the read-only `maxTime` animation pointer).
      */
     convertConnectedTimeToFrames?: boolean;
+    /**
+     * KHR configuration value type used by canonical validation.
+     */
+    configurationType?: "bool" | "int" | "int[]" | "string";
+    /**
+     * Whether this configuration entry exists only for canonical validation.
+     */
+    validationOnly?: boolean;
+    /**
+     * Whether an operation without a complete default configuration requires this property.
+     */
+    required?: boolean;
+    /**
+     * Graph array referenced by an integer configuration value.
+     */
+    indexSource?: "types" | "variables" | "events" | "nodes" | "assetNodes";
+    /**
+     * Minimum number of values required for an array configuration.
+     */
+    minItems?: number;
+    /**
+     * Whether the configured indices generate required input value sockets.
+     */
+    generatesInputValueSockets?: boolean;
+    /**
+     * Whether integer case values generate required input value sockets.
+     */
+    generatesCaseInputValueSockets?: boolean;
+    /**
+     * Whether this string configuration generates JSON Pointer Template sockets.
+     */
+    pointerTemplate?: boolean;
+    /**
+     * Whether an invalid value falls back to the operation's default configuration.
+     */
+    invalidUsesDefault?: boolean;
+    /**
+     * Allowed KHR type signatures for a type-index configuration.
+     */
+    allowedSignatures?: readonly ("bool" | "float" | "float2" | "float3" | "float4" | "float2x2" | "float3x3" | "float4x4" | "int" | "ref" | "custom")[];
+    /**
+     * Input socket whose effective type determines this output socket type.
+     */
+    typeSourceInput?: string;
+    /** Inclusive minimum for an integer configuration value. */
+    minimum?: number;
+    /** Inclusive maximum for an integer configuration value. */
+    maximum?: number;
+    /**
+     * Whether this configuration value generates numbered input flow sockets.
+     */
+    generatesInputFlowSockets?: boolean;
+    /**
+     * Whether this configuration array generates output flow sockets.
+     */
+    generatesOutputFlowSockets?: boolean;
+    /**
+     * Properties in the same group fall back to their defaults together when any member is
+     * missing or invalid.
+     */
+    configurationGroup?: string;
+    /**
+     * Whether duplicate array values are removed from the effective configuration.
+     */
+    uniqueValues?: boolean;
+    /**
+     * Whether a string configuration value is a `debug/log` message template.
+     */
+    debugLogTemplate?: boolean;
 }
 /**
  * Description of how a KHR_interactivity declaration (op such as
@@ -68,6 +147,13 @@ export interface IGLTFToFlowGraphMapping {
      * When adding blocks defined in this module use the KHR_interactivity prefix.
      */
     blocks: (FlowGraphBlockNames | string)[];
+    /**
+     * Exact value socket contract for an operation supplied by another extension.
+     */
+    declarationSchema?: {
+        inputValueSockets: Record<string, "bool" | "float" | "float2" | "float3" | "float4" | "float2x2" | "float3x3" | "float4x4" | "int" | "ref" | "custom">;
+        outputValueSockets: Record<string, "bool" | "float" | "float2" | "float3" | "float4" | "float2x2" | "float3x3" | "float4x4" | "int" | "ref" | "custom">;
+    };
     /**
      * The inputs of the glTF node mapped to the FlowGraph block.
      */
@@ -176,6 +262,12 @@ export interface IGLTFToFlowGraphMapping {
 }
 export declare function getMappingForFullOperationName(fullOperationName: string): IGLTFToFlowGraphMapping | undefined;
 export declare function getMappingForDeclaration(declaration: IKHRInteractivity_Declaration, returnNoOpIfNotAvailable?: boolean): IGLTFToFlowGraphMapping | undefined;
+/**
+ * Creates the typed no-op mapping required for an unsupported extension declaration.
+ * @param declaration unsupported extension declaration
+ * @returns a mapping that preserves the declared value sockets
+ */
+export declare function getNoOpMappingForDeclaration(declaration: IKHRInteractivity_Declaration): IGLTFToFlowGraphMapping;
 /**
  * This function will add new mapping to glTF interactivity.
  * Other extensions can define new types of blocks, this is the way to let interactivity know how to parse them.
@@ -184,8 +276,23 @@ export declare function getMappingForDeclaration(declaration: IKHRInteractivity_
  * @param mapping The mapping object. See documentation or examples below.
  */
 export declare function addNewInteractivityFlowGraphMapping(key: string, extension: string, mapping: IGLTFToFlowGraphMapping): void;
+/**
+ * Result of parsing a ratified `debug/log` message template.
+ */
+export interface IDebugLogTemplateParseResult {
+    /** Whether all literal braces are doubled and every parameter is well formed. */
+    valid: boolean;
+    /** Unique parameter socket ids in first-occurrence order. */
+    sockets: string[];
+}
+/**
+ * Parses a ratified `debug/log` message template.
+ * Literal braces must be doubled; non-empty text inside a single brace pair defines a socket id.
+ * @param message message template to parse
+ * @returns template validity and its exact dynamic socket ids
+ */
+export declare function ParseDebugLogTemplate(message: string): IDebugLogTemplateParseResult;
 export declare function getAllSupportedNativeNodeTypes(): string[];
-export {};
 /**
  *
  * These are the nodes from the specs: