@dreamcomposer/engine-types 0.0.5 → 0.0.8

package/Layer.d.ts

@@ -1,3 +1,5 @@
+import { MaterialDefinition } from "./Material";
+
 /**
  * A 2D layer.
  */
@@ -11,9 +13,9 @@ export interface Layer {
   // 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.
    *

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/package.json

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

package/post-messages.d.ts

@@ -17,6 +17,7 @@ import { SetEffectsSettingsAckMessage } from "./from-engine/SetEffectsSettingsAc
 import { SetEmbossingHeightTextureMessage } from "./to-engine/SetEmbossingHeightTextureMessage";
 import { SetEnvironmentMessage } from "./to-engine/SetEnvironmentMessage";
 import { SetEnvironmentVisibleMessage } from "./to-engine/SetEnvironmentVisibleMessage";
+import { SetFullscreenMessage } from "./to-engine/SetFullscreenMessage";
 import { SetGeometryBlobMessage } from "./to-engine/SetGeometryBlobMessage";
 import { SetGeometryMessage } from "./to-engine/SetGeometryMessage";
 import { SetGridVisibilityMessage } from "./to-engine/SetGridVisibilityMessage";
@@ -33,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.
@@ -79,6 +81,7 @@ export type ToEnginePostMessage =
   | SetEmbossingHeightTextureMessage
   | SetEnvironmentMessage
   | SetEnvironmentVisibleMessage
+  | SetFullscreenMessage
   | SetGeometryBlobMessage
   | SetGeometryMessage
   | SetGeometryUrlMessage
@@ -89,6 +92,7 @@ export type ToEnginePostMessage =
   | SetStageMappingsMessage
   | SetStageRotationsMessage
   | SetSurfaceMaterialIdMessage
+  | SetUseFramingAnimation
   | ToggleFullscreenMessage
   | ToggleInspectorMessage
   | ToggleVrMessage

package/to-engine/SetEnvironmentMessage.d.ts

@@ -17,12 +17,8 @@ export interface SetEnvironmentMessage
 export interface Environment {
   /**
    * An url to the environment file.
-   *
-   * When `blobHDR` is set, this field is still necessary to get the extension
-   * (i.e., the type) of the HDR but is not loaded from the URL. In this case
-   * it can be a name instead of a URL.
    */
-  filenameHDR: string;
+  filenameHDR?: string;
   /**
    * The data of the HDR. If set, the data is not loaded from the URL provided
    * with the `filenameHDR` field.

package/to-engine/SetFullscreenMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Explicitely sets full screen mode for the IFrame
+ */
+export interface SetFullscreenMessage
+  extends ToEngineMessage<"set-fullscreen"> {
+  /**
+   * A boolean, describing the desired full screen state
+   */
+  payload: boolean;
+}

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;
+}