@dreamcomposer/engine-types 0.0.61 → 0.0.63

package/package.json

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

package/post-messages.d.ts

@@ -1,4 +1,3 @@
-import { AckMessage } from "./from-engine/AckMessage";
 import { CanvasImageUrlMessage } from "./from-engine/CanvasImageUrlMessage";
 import { EngineReadyMessage } from "./from-engine/EngineReadyMessage";
 import { KeyDownMessage } from "./from-engine/KeyDownMessage";
@@ -47,6 +46,7 @@ import { GeometryTransformChangeMessage } from "./from-engine/GeometryTransformC
 import { SetInitialGeometryTransformMessage } from "./to-engine/SetInitialGeometryTransformMessage";
 import { ResetGeometryTransformMessage } from "./to-engine/ResetGeometryTransformMessage";
 import { PlaceGeometryOnGroundMessage } from "./to-engine/MoveGeometryToGroundMessage";
+import { MouseEventMessage } from "./to-engine/MouseEventMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -61,16 +61,10 @@ export interface FromEngineMessage<Channel> {
  */
 export interface ToEngineMessage<Channel> {
   channel: Channel;
-  // /**
-  //  * The nonce is a randomly generated string that is re-send by the engine in
-  //  * the ack message.
-  //  */
-  // nonce: string;
   payload?: unknown;
 }
 
 export type FromEnginePostMessage =
-  | AckMessage
   | CanvasImageUrlMessage
   | DisplayLoadingUiMessage
   | EngineReadyMessage
@@ -88,6 +82,7 @@ export type FromEnginePostMessage =
 export type ToEnginePostMessage =
   | DownloadScreenshotMessage
   | HighlightLayerMessage
+  | MouseEventMessage
   | ResetCameraPositionMessage
   | RotateToVectorMessage
   | UpdateCameraPositionMessage

package/to-engine/MouseEventMessage.d.ts

@@ -0,0 +1,25 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Global mouse events from the embedder are sent to the engine to make sure
+ * that the engine can react to the correctly.
+ *
+ * E.g. when the user clicks and holds the mouse inside the iframe to rotate the
+ * model and then leaves the iframe with the mouse still pressed, the engine
+ * will not receive the corresponding mouseup event. This code will make sure
+ * that global mouse events are sent to the engine so that it can react
+ * accordingly.
+ */
+export interface MouseEventMessage extends ToEngineMessage<"mouse-events"> {
+  payload: {
+    type: "mousedown" | "mouseup" | "mousemove";
+    /**
+     * The clientX coordinate, adjusted to the iframe's position.
+     */
+    clientX: number;
+    /**
+     * The clientY coordinate, adjusted to the iframe's position.
+     */
+    clientY: number;
+  };
+}

package/to-engine/SetStageMappingsMessage.d.ts

@@ -1,98 +1,102 @@
 import { ToEngineMessage } from "../post-messages";
 
+export interface StageMapping {
+  /**
+   * The layer texture mapping
+   *
+   * If not provided only the surface material is visible by defaulting to `{x: -1, y: -1, width: 1, height: 1}`.
+   */
+  uvMapping?: {
+    /**
+     * The x position where the mapping begings.
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    x: number;
+    /**
+     * The y position where the mapping begings.
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    y: number;
+    /**
+     * The with of the mapping.
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    width: number;
+    /**
+     * The height of the mapping.
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    height: number;
+  };
+  /**
+   * The rotation of the mapping in degrees.
+   *
+   * Defaults to `0`.
+   */
+  rotation?: 0 | 90 | 180 | 270;
+  /**
+   * Defines if the stage should be visible or not.
+   *
+   * Defaults to `true`.
+   */
+  visible?: boolean;
+  /**
+   * Defines a sub area of the target geometry, where the stage will be displayed
+   *
+   * If no subMeshUVArea is defined, the whole area is used.
+   */
+  subMeshUVArea?: {
+    /**
+     * The x position where the target uv box begins.
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    x: number;
+    /**
+     * The y position where the target uv box begins.
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    y: number;
+    /**
+     * The width of target uv box
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    width: number;
+    /**
+     * The height of target uv box
+     *
+     * This is not a pixel value but a percentage (i.e., a value between `0`
+     * and `1`).
+     */
+    height: number;
+  };
+}
+
+export interface StageMappings {
+  /**
+   * The name of the stage is the key and defined in the SetGeometryMessage.
+   */
+  [stageName: string]: StageMapping;
+}
+
 /**
  * A message to set the stage mappings (i.e., how a texture is mapped to the
  * geometry).
  */
 export interface SetStageMappingsMessage
   extends ToEngineMessage<"set-stage-mappings"> {
-  payload: {
-    /**
-     * The name of the stage is the key and defined in the SetGeometryMessage.
-     */
-    [stageName: string]: {
-      /**
-       * The layer texture mapping
-       *
-       * If not provided only the surface material is visible by defaulting to `{x: -1, y: -1, width: 1, height: 1}`.
-       */
-      uvMapping?: {
-        /**
-         * The x position where the mapping begings.
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        x: number;
-        /**
-         * The y position where the mapping begings.
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        y: number;
-        /**
-         * The with of the mapping.
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        width: number;
-        /**
-         * The height of the mapping.
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        height: number;
-      };
-      /**
-       * The rotation of the mapping in degrees.
-       *
-       * Defaults to `0`.
-       */
-      rotation?: 0 | 90 | 180 | 270;
-      /**
-       * Defines if the stage should be visible or not.
-       *
-       * Defaults to `true`.
-       */
-      visible?: boolean;
-      /**
-       * Defines a sub area of the target geometry, where the stage will be displayed
-       *
-       * If no subMeshUVArea is defined, the whole area is used.
-       */
-      subMeshUVArea?: {
-        /**
-         * The x position where the target uv box begins.
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        x: number;
-        /**
-         * The y position where the target uv box begins.
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        y: number;
-        /**
-         * The width of target uv box
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        width: number;
-        /**
-         * The height of target uv box
-         *
-         * This is not a pixel value but a percentage (i.e., a value between `0`
-         * and `1`).
-         */
-        height: number;
-      };
-    };
-  };
+  payload: StageMappings;
 }

package/from-engine/AckMessage.d.ts

@@ -1,24 +0,0 @@
-import { EngineState } from "../EngineState";
-import { FromEngineMessage } from "../post-messages";
-
-/**
- * Sent as a response for every message to the engine,
- */
-export interface AckMessage extends FromEngineMessage<"ack"> {
-  /**
-   * The state of the engine.
-   */
-  payload: EngineState;
-  /**
-   * The nonce that was sent with the message to the engine.
-   *
-   * Used to identify to what message the ack belongs.
-   */
-  nonce: string;
-  /**
-   * An error if the message to the engine could not be processed by the engine.
-   */
-  error?: {
-    message: string;
-  };
-}