@dreamcomposer/engine-types 0.0.6 → 0.0.9

package/Layer.d.ts

@@ -1,3 +1,5 @@
+import { MaterialDefinition } from "./Material";
+
 /**
  * A 2D layer.
  */
@@ -8,12 +10,11 @@ export interface Layer {
    *
    * Should start at `0`.
    */
-  // TODO: The order should be dynamically set by the engine
   order: number;
   /**
-   * The name of the material of the layer (e.g., "print_diffuse").
+   * The name of the material of the layer (e.g., "print_diffuse") or a complete material definition
    */
-  material: string;
+  material: string | MaterialDefinition;
   /**
    * Whether or not the layer is visible.
    *
@@ -39,10 +40,8 @@ export interface Layer {
    */
   overprintColor?: string;
   /**
-   *
    * Overprint mode. Can be either "tint" (for tintable foils) or "opaque" (for
    * spot colors)
-   *
    */
   overprintMode?: "tint" | "opaque";
   /**

package/Material.d.ts

@@ -0,0 +1,14 @@
+export interface MaterialDefinition {
+  materialBase: string;
+  materialPBRShaderInjections?: string[];
+  materialExtensions: string[];
+  materialOverrides: Record<string, unknown> | Record<string, unknown>[];
+}
+
+export interface MaterialExtension {
+  metadata: {
+    name: string;
+    description: string;
+  };
+  materialsOverrides: Record<string, unknown> | Record<string, unknown>[];
+}

package/from-engine/SetLoadingProgressMessage.d.ts

@@ -1,7 +1,7 @@
 import { FromEngineMessage } from "../post-messages";
 
 /**
- * Sent whenever a file os loaded by the engine.
+ * Sent whenever a file is loaded by the engine.
  */
 export interface SetLoadingProgressMessage
   extends FromEngineMessage<"set-loading-progress"> {
@@ -21,13 +21,13 @@ export interface SetLoadingProgressMessage
     /**
      * The bytes loaded so far.
      *
-     * `-1` if an error occured.
+     * `-1` if an error occurred.
      */
     bytes: number;
     /**
      * The total bytes of the file (or `0` if not known yet).
      *
-     * `-1` if an error occured.
+     * `-1` if an error occurred.
      */
     total: number;
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamcomposer/engine-types",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "description": "The type definitions for messages from and to the engine",
   "license": "UNLICENSED",
   "private": false,

package/post-messages.d.ts

@@ -34,6 +34,7 @@ import { SetGeometryUrlMessage } from "./to-engine/SetGeometryUrlMessage";
 import { ToggleVrMessage } from "./to-engine/ToggleVrMessage";
 import { PointerEventMessage } from "./from-engine/PointerEventMessage";
 import { HideGuiMessage } from "./from-engine/HideGuiMessage";
+import { SetUseFramingAnimation } from "./to-engine/SetUseFramingAnimation";
 
 /**
  * A message sent from the engine to the embedder.
@@ -91,6 +92,7 @@ export type ToEnginePostMessage =
   | SetStageMappingsMessage
   | SetStageRotationsMessage
   | SetSurfaceMaterialIdMessage
+  | SetUseFramingAnimation
   | ToggleFullscreenMessage
   | ToggleInspectorMessage
   | ToggleVrMessage

package/to-engine/SetUseFramingAnimation.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Enable/disable framing animations
+ */
+export interface SetUseFramingAnimation
+  extends ToEngineMessage<"set-use-framing-animation"> {
+  /**
+   * A boolean, setting current engine mode for framing animations
+   */
+  payload: boolean;
+}