@dreamcomposer/engine-types 0.0.1

package/EngineState.d.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface EngineState {
+  // TODO Add content
+}

package/Layer.d.ts

@@ -0,0 +1,102 @@
+/**
+ * A 2D layer.
+ */
+export interface Layer {
+  /**
+   * The oder of the layer. A layer with a higher order overlays a layer with a
+   * lower order.
+   *
+   * 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").
+   */
+  material: string;
+  /**
+   * Whether or not the layer is visible.
+   *
+   * Defaults to `false`.
+   */
+  visible?: boolean;
+  /**
+   * A url that points to the texture of the layer.
+   *
+   * Must be in the PNG format.
+   */
+  textureUrl: string | Blob;
+  /**
+   * Whether or not the layer is overprinted with the texture.
+   *
+   * Defaults to `false`.
+   */
+  overprintContent?: boolean;
+  /**
+   * Either the spot color or the tint color, depending on the material used.
+   *
+   * The color is in HEX format with alpha (e.g., #FF0000FF).
+   */
+  overprintColor?: string;
+  /**
+   *
+   * Overprint mode. Can be either "tint" (for tintable foils) or "opaque" (for
+   * spot colors)
+   *
+   */
+  overprintMode?: "tint" | "opaque";
+  /**
+   * Whether or not the layer is a cut layer.
+   *
+   * The cut layer is not rendered by the engine.
+   *
+   * Defaults to `false`.
+   */
+  cut?: boolean;
+  /**
+   * Whether or not the layer is a fold layer.
+   *
+   * The fold layer is not rendered by the engine.
+   *
+   * Defaults to `false`.
+   */
+  fold?: boolean;
+  /**
+   * A pattern embossing that is applied to the layer.
+   */
+  patternEmbossing?: PatternEmbossing;
+}
+
+export interface PatternEmbossing {
+  /**
+   * The id of the pattern embossing preset (e.g., "M515_006").
+   */
+  preset: string;
+  /**
+   * Overwrites of the preset values.
+   */
+  configuration?: PatternEmbossingConfiguration;
+}
+
+export interface PatternEmbossingConfiguration {
+  /**
+   * I don't know.
+   */
+  overrides?: TextureOverride<unknown>[];
+  /**
+   * Scaling to scale the pixel size of the embossing to the real physical
+   * size.
+   */
+  scaling?: [number, number];
+  /**
+   * The offset of the embossing.
+   */
+  offset?: [number, number];
+}
+
+export type TextureOverride<T> = Record<
+  string,
+  Partial<T> | Record<string, Partial<T>>
+>;
+
+type Texture = unknown;

package/NoUndefinedField.d.ts

@@ -0,0 +1,3 @@
+export type NoUndefinedField<T> = {
+  [P in keyof T]-?: NoUndefinedField<NonNullable<T[P]>>;
+};

package/README.md

@@ -0,0 +1,17 @@
+# Engine Message Types
+
+This workspace contains the type definitions for the messages required to
+communicate with the engine.
+
+## Adding new messages
+
+There are two types of messages:
+
+- Messages **to** the engine and
+- Messages **from** the engine.
+
+To add a new message, you have to create a new file in the appropriate folder
+(either `/from-engine` or `/to-engine`) with the interface for the new message.
+After creating the interface, you must not forget to add it to the correct union
+(either `FromEnginePostMessage` or `ToEnginePostMessage`) in the
+`post-messages.d.ts` file.

package/from-engine/AckMessage.d.ts

@@ -0,0 +1,24 @@
+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;
+  };
+}

package/from-engine/CanvasImageUrlMessage.d.ts

@@ -0,0 +1,27 @@
+import { FromEngineMessage, ToEngineMessage } from "../post-messages";
+
+/**
+ * A screenshot of the canvas that is sent to the embedder when the heatmap
+ * collection is stopped.
+ *
+ * The screenshot is used by the embedder to draw the heatmap over it.
+ */
+// TODO: This should have another name to make it clear it's related to the
+//       heat map collection.
+export interface CanvasImageUrlMessage
+  extends FromEngineMessage<"canvas-image-url"> {
+  payload: {
+    /**
+     * The height of the image.
+     */
+    height: number;
+    /**
+     * The width of the image.
+     */
+    width: number;
+    /**
+     * The base64 encoded image in the PNG format.
+     */
+    data: string;
+  };
+}

package/from-engine/EngineReadyMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * A message that gets send by the engine when it's ready to receive commands.
+ * You must not send any messages before receiving this message.
+ */
+export interface EngineReadyMessage extends FromEngineMessage<"engine-ready"> {
+  payload: boolean;
+}

package/from-engine/HideGuiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * A message that gets send by the engine when it's showing something that
+ * interferes with the GUI, e.g the inspector.
+ */
+export interface HideGuiMessage extends FromEngineMessage<"hide-gui"> {
+  payload: boolean;
+}

package/from-engine/KeyDownMessage.d.ts

@@ -0,0 +1,13 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Whenever a key is pressed while the iframe is focused, this event is
+ * dispatched. This can be useful since the embedder of the iframe does not
+ * receive key down events that happen inside the iframe.
+ */
+export interface KeyDownMessage extends FromEngineMessage<"key-down"> {
+  /**
+   * The pressed key.
+   */
+  payload: string;
+}

package/from-engine/PointerEventMessage.d.ts

@@ -0,0 +1,23 @@
+import { ToEngineMessage } from "../post-messages";
+import { Vector2 } from "@babylonjs/core/Maths/math";
+
+// Mouse events from engine to clients
+export interface PointerEvent {
+  x: number;
+  y: number;
+  drag: boolean;
+  type: string;
+  buttons: number;
+  pick?: Vector2;
+  shiftKey: boolean;
+}
+
+/**
+ * Sent when an edge gets deselected.
+ */
+export interface PointerEventMessage extends ToEngineMessage<"pointer-event"> {
+  /**
+   * The index of the edge.
+   */
+  payload: PointerEvent;
+}

package/from-engine/SetEffectsSettingsAckMessage.d.ts

@@ -0,0 +1,14 @@
+import { NoUndefinedField } from "../NoUndefinedField";
+import { FromEngineMessage } from "../post-messages";
+import { EffectsSettings } from "../to-engine/SetEffectsSettingsMessage";
+
+/**
+ * Sent after updating the effect settings with the new setting values.
+ */
+export interface SetEffectsSettingsAckMessage
+  extends FromEngineMessage<"set-effects-settings"> {
+  /**
+   * The settings.
+   */
+  payload: NoUndefinedField<EffectsSettings>;
+}

package/from-engine/SetLoadingProgressMessage.d.ts

@@ -0,0 +1,34 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever a file os loaded by the engine.
+ */
+export interface SetLoadingProgressMessage
+  extends FromEngineMessage<"set-loading-progress"> {
+  payload: {
+    /**
+     * Usually the URL of the file to load.
+     */
+    name: string;
+    /**
+     * The state of the loading progress.
+     */
+    state: "Created" | "In progress" | "Done";
+    /**
+     * The time at which the loading progress was updated.
+     */
+    timestamp: number;
+    /**
+     * The bytes loaded so far.
+     *
+     * `-1` if an error occured.
+     */
+    bytes: number;
+    /**
+     * The total bytes of the file (or `0` if not known yet).
+     *
+     * `-1` if an error occured.
+     */
+    total: number;
+  };
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@dreamcomposer/engine-types",
+  "version": "0.0.1",
+  "description": "The type definitions for messages from and to the engine",
+  "license": "UNLICENSED",
+  "private": false,
+  "files": [
+    "**/*.ts"
+  ],
+  "devDependencies": {
+    "@babylonjs/core": "5.0.0-alpha.58",
+    "prettier": "^2.5.1",
+    "typescript": "^4.4.4"
+  },
+  "scripts": {
+    "format": "prettier --write .",
+    "check-format": "prettier --check ."
+  },
+  "readme": "# Engine Message Types\n\nThis workspace contains the type definitions for the messages required to\ncommunicate with the engine.\n\n## Adding new messages\n\nThere are two types of messages:\n\n- Messages **to** the engine and\n- Messages **from** the engine.\n\nTo add a new message, you have to create a new file in the appropriate folder\n(either `/from-engine` or `/to-engine`) with the interface for the new message.\nAfter creating the interface, you must not forget to add it to the correct union\n(either `FromEnginePostMessage` or `ToEnginePostMessage`) in the\n`post-messages.d.ts` file.\n"
+}

package/post-messages.d.ts

@@ -0,0 +1,97 @@
+import { AckMessage } from "./from-engine/AckMessage";
+import { CanvasImageUrlMessage } from "./from-engine/CanvasImageUrlMessage";
+import { EngineReadyMessage } from "./from-engine/EngineReadyMessage";
+import { KeyDownMessage } from "./from-engine/KeyDownMessage";
+import { SetLoadingProgressMessage } from "./from-engine/SetLoadingProgressMessage";
+import { DownloadScreenshotMessage } from "./to-engine/DownloadScreenshotMessage";
+import { HighlightLayerMessage } from "./to-engine/HighlightLayerMessage";
+import { ResetCameraPositionMessage } from "./to-engine/ResetCameraPositionMessage";
+import { RotateToVectorMessage } from "./to-engine/RotateToVectorMessage";
+import { SelectedEdgesMessage } from "./to-engine/SelectedEdgesMessage";
+import { SetClearColorMessage } from "./to-engine/SetClearColorMessage";
+import { SetConnectionInfosMessage } from "./to-engine/SetConnectionInfosMessage";
+import { SetCutoutTextureMessage } from "./to-engine/SetCutoutTextureMessage";
+import { SetEdgeSelectorEnabledMessage } from "./to-engine/SetEdgeSelectorEnabledMessage";
+import { SetEffectsSettingsMessage } from "./to-engine/SetEffectsSettingsMessage";
+import { SetEffectsSettingsAckMessage } from "./from-engine/SetEffectsSettingsAckMessage";
+import { SetEmbossingHeightTextureMessage } from "./to-engine/SetEmbossingHeightTextureMessage";
+import { SetEnvironmentMessage } from "./to-engine/SetEnvironmentMessage";
+import { SetEnvironmentVisibleMessage } from "./to-engine/SetEnvironmentVisibleMessage";
+import { SetGeometryBlobMessage } from "./to-engine/SetGeometryBlobMessage";
+import { SetGeometryMessage } from "./to-engine/SetGeometryMessage";
+import { SetGridVisibilityMessage } from "./to-engine/SetGridVisibilityMessage";
+import { SetHardwareScalingLevelMessage } from "./to-engine/SetHardwareScalingLevelMessage";
+import { SetLayersMessage } from "./to-engine/SetLayersMessage";
+import { SetPpiMessage } from "./to-engine/SetPpiMessage";
+import { SetStageMappingsMessage } from "./to-engine/SetStageMappingsMessage";
+import { SetStageRotationsMessage } from "./to-engine/SetStageRotationsMessage";
+import { SetSurfaceMaterialIdMessage } from "./to-engine/SetSurfaceMaterialIdMessage";
+import { ToggleFullscreenMessage } from "./to-engine/ToggleFullscreenMessage";
+import { ToggleInspectorMessage } from "./to-engine/ToggleInspectorMessage";
+import { UnhighlightLayerMessage } from "./to-engine/UnhighlightLayerMessage";
+import { SetGeometryUrlMessage } from "./to-engine/SetGeometryUrlMessage";
+import { ToggleVrMessage } from "./to-engine/ToggleVrMessage";
+import { PointerEventMessage } from "./from-engine/PointerEventMessage";
+import { HideGuiMessage } from "./from-engine/HideGuiMessage";
+
+/**
+ * A message sent from the engine to the embedder.
+ */
+export interface FromEngineMessage<Channel> {
+  channel: Channel;
+  payload: unknown;
+}
+
+/**
+ * A message sent from the embedder to the engine.
+ */
+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
+  | EngineReadyMessage
+  | HideGuiMessage
+  | KeyDownMessage
+  | PointerEventMessage
+  | SetEffectsSettingsAckMessage
+  | SetLoadingProgressMessage;
+
+export type ToEnginePostMessage =
+  | DownloadScreenshotMessage
+  | HighlightLayerMessage
+  | ResetCameraPositionMessage
+  | RotateToVectorMessage
+  | SelectedEdgesMessage
+  | SetClearColorMessage
+  | SetConnectionInfosMessage
+  | SetCutoutTextureMessage
+  | SetEdgeSelectorEnabledMessage
+  | SetEffectsSettingsMessage
+  | SetEmbossingHeightTextureMessage
+  | SetEnvironmentMessage
+  | SetEnvironmentVisibleMessage
+  | SetGeometryBlobMessage
+  | SetGeometryMessage
+  | SetGeometryUrlMessage
+  | SetGridVisibilityMessage
+  | SetHardwareScalingLevelMessage
+  | SetLayersMessage
+  | SetPpiMessage
+  | SetStageMappingsMessage
+  | SetStageRotationsMessage
+  | SetSurfaceMaterialIdMessage
+  | ToggleFullscreenMessage
+  | ToggleInspectorMessage
+  | ToggleVrMessage
+  | UnhighlightLayerMessage;
+
+export type PostMessage = FromEnginePostMessage | ToEnginePostMessage;

package/to-engine/DownloadScreenshotMessage.d.ts

@@ -0,0 +1,23 @@
+import { ToEngineMessage } from "../post-messages";
+
+export interface ScreenshotPayload {
+  fileName: string;
+  overlayPNG?: ImageBitmap;
+  width?: number;
+  height?: number;
+}
+
+/**
+ * Downloads a high-resolution screenshot of the current scene.
+ *
+ * The download starts automatically once the screenshot has been rendered.
+ *
+ * TODO: What resolution does the screenshot have? What is the file name?
+ */
+export interface DownloadScreenshotMessage
+  extends ToEngineMessage<"download-screenshot"> {
+  /**
+   * An empty object.
+   */
+  payload: ScreenshotPayload;
+}

package/to-engine/HighlightLayerMessage.d.ts

@@ -0,0 +1,13 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Highlights the given layer.
+ */
+export interface HighlightLayerMessage
+  extends ToEngineMessage<"highlight-layer"> {
+  /**
+   * The name of the layer to highlight (i.e., the key used in the
+   * SetLayerMessage payload).
+   */
+  payload: string;
+}

package/to-engine/ResetCameraPositionMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Resets the camera to its initial position.
+ */
+export interface ResetCameraPositionMessage
+  extends ToEngineMessage<"reset-camera-position"> {
+  /**
+   * An empty object.
+   */
+  payload: Record<string, never>;
+}

package/to-engine/RotateToVectorMessage.d.ts

@@ -0,0 +1,14 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Rotates the camera to a given vector.
+ */
+export interface RotateToVectorMessage
+  extends ToEngineMessage<"rotate-to-vector"> {
+  /**
+   * The vector to rotate to.
+   *
+   * Example: `[0, 0, 1]`
+   */
+  payload: [number, number, number];
+}

package/to-engine/SelectedEdgesMessage.d.ts

@@ -0,0 +1,16 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Selectes an array of edges.
+ *
+ * TODO: Where do edges come from? Are they part of the texture?
+ */
+export interface SelectedEdgesMessage
+  extends ToEngineMessage<"selected-edges"> {
+  /**
+   * An array with the index of the edges to select.
+   *
+   * Example: `[8, 9, 13]`
+   */
+  payload: number[];
+}

package/to-engine/SetClearColorMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the scene's clear color (i.e., the background color).
+ */
+export interface SetClearColorMessage
+  extends ToEngineMessage<"set-clear-color"> {
+  /**
+   * The clear color in HEX format with alpha (e.g., #AD86A3FF).
+   */
+  payload: string;
+}

package/to-engine/SetConnectionInfosMessage.d.ts

@@ -0,0 +1,21 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the area connection infos for the folding edges.
+ */
+export interface SetConnectionInfosMessage
+  extends ToEngineMessage<"set-connection-infos"> {
+  /**
+   * An array with
+   *
+   * 1. The id of the source area.
+   * 2. The id of the target area.
+   * 3. The center of the folding edge as an array in the form [x, y].
+   * 4. The normal vector of the folding edge as an array in the form [x, y].
+   * 5. The length of the folding edge.
+   */
+  payload: ConnectionInfos;
+}
+
+export type ConnectionInfo = [number, number, number[], number[], number];
+export type ConnectionInfos = Array<ConnectionInfo>;

package/to-engine/SetCutoutTextureMessage.d.ts

@@ -0,0 +1,16 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets the cutout mask that is used to render holes the surface texture.
+ *
+ * The cutout mask is a mask in the PNG format with white and transparent
+ * colors.
+ */
+export interface SetCutoutTextureMessage
+  extends ToEngineMessage<"set-cutout-texture"> {
+  /**
+   * The cutout mask in the PNG format or an empty string to reset it (i.e.,
+   * setting a texture with no cutouts).
+   */
+  payload: Blob | "";
+}

package/to-engine/SetEdgeSelectorEnabledMessage.d.ts

@@ -0,0 +1,15 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets whether or not the edge selector should be enabled.
+ *
+ * When enabled, the edges are visible and when clicked on, a SelectEdgeMessage
+ * is received.
+ */
+export interface SetEdgeSelectorEnabledMessage
+  extends ToEngineMessage<"set-edge-selector-enabled"> {
+  /**
+   * Whether or not the edge selector should be enabled.
+   */
+  payload: boolean;
+}

package/to-engine/SetEffectsSettingsMessage.d.ts

@@ -0,0 +1,110 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the effect settings.
+ */
+export interface SetEffectsSettingsMessage
+  extends ToEngineMessage<"set-effects-settings"> {
+  /**
+   * The settings.
+   *
+   * When a field is not send, it is replaced with the default value for that
+   * field, overwriting potential previous changes.
+   */
+  payload: EffectsSettings;
+}
+
+export interface EffectsSettings {
+  /**
+   * The field of view in radians.
+   *
+   * Defaults to 0.75 (approx. 43 degrees).
+   */
+  fieldOfView?: number;
+  /**
+   * Whether or not the bloom effect should be enabled.
+   *
+   * Defaults to `true`.
+   */
+  bloomEnabled?: boolean;
+  /**
+   * The bloom threshold. A number between `0` and `1`.
+   *
+   * Defaults to `0.9`.
+   */
+  bloomThreshold?: number;
+  /**
+   * The bloom weight. A number between `0` and `1`.
+   *
+   * Defaults to `0.05`.
+   */
+  bloomWeight?: number;
+  /**
+   * Whether or not chromatic aberration should be enabled.
+   *
+   * Defaults to `false`.
+   */
+  chromaticAberrationEnabled?: boolean;
+  /**
+   * The amount of chromatic aberration. Can be any positive number but values
+   * between `0` and `100` yield the best results.
+   *
+   * Defaults to `0`.
+   */
+  chromaticAberrationAmount?: number;
+  /**
+   * Whether or not the grain effect should be enabled.
+   *
+   * Defaults to `false`.
+   */
+  grainEnabled?: boolean;
+  /**
+   * The grain intensity. Can be any positive number but values between `0`
+   * and `50` yield the best results.
+   *
+   * Defaults to `30`.
+   */
+  grainIntensity?: number;
+  /**
+   * The image processing brightness in percent.
+   *
+   * Defaults to `1`.
+   */
+  imageProcessingBrightness?: number;
+  /**
+   * The image processing contrast.
+   *
+   * Defaults to `1`.
+   */
+  imageProcessingContrast?: number;
+  /**
+   * Whether or not tone mapping should be enabled.
+   *
+   * Defaults to `false`.
+   */
+  toneMappingEnabled?: boolean;
+  /**
+   * Whether or not the vignette effect should be enabled.
+   *
+   * Defaults to `true`.
+   */
+  vignetteEnabled?: boolean;
+  /**
+   * The weight of the vingnette.
+   *
+   * Defaults to `1.5`.
+   */
+  vignetteWeight?: number;
+  /**
+   * Whether or not the image should be sharpened.
+   *
+   * Defaults to `false`.
+   */
+  sharpenEnabled?: boolean;
+  /**
+   * The sharpen amount.
+   *
+   * Defaults to `0.3`.
+   */
+  sharpenAmount?: number;
+}

package/to-engine/SetEmbossingHeightTextureMessage.d.ts

@@ -0,0 +1,17 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets the height texture for the embossing.
+ *
+ * The height texture is a grayscale PNG image that is used to calculate the
+ * height of the embossing.
+ */
+export interface SetEmbossingHeightTextureMessage
+  extends ToEngineMessage<"set-embossing-height-texture"> {
+  /**
+   * The height texture as a blob in the PNG format.
+   *
+   * If set to `undefined`, the height texture is removed.
+   */
+  payload: undefined | Blob;
+}

package/to-engine/SetEnvironmentMessage.d.ts

@@ -0,0 +1,43 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the environment.
+ *
+ * TODO: Why is this one called "set-environment" and not "set-environment-url"?
+ */
+export interface SetEnvironmentMessage
+  extends ToEngineMessage<"set-environment"> {
+  /**
+   * Supports all supported formats of BabylonJS. It is recommended to use
+   * BabylonJS' own format (either DDS or ENV) for faster loading.
+   */
+  payload: Environment;
+}
+
+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;
+  /**
+   * The data of the HDR. If set, the data is not loaded from the URL provided
+   * with the `filenameHDR` field.
+   */
+  blobHDR?: Blob;
+  /**
+   * The exposure of the HDR.
+   *
+   * Defaults to `1`.
+   */
+  exposureHDR?: number;
+  /**
+   * The default rotation of the environment in radians.
+   *
+   * Defaults to `0`.
+   */
+  defaultRotation?: number;
+}

package/to-engine/SetEnvironmentVisibleMessage.d.ts

@@ -0,0 +1,13 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets whether or not the environment is visible.
+ *
+ * When the environment is not visible, you don't see it directly as the
+ * background but it still appears in the reflections and is responsible for
+ * the lighting.
+ */
+export interface SetEnvironmentVisibleMessage
+  extends ToEngineMessage<"set-environment-visible"> {
+  payload: boolean;
+}

package/to-engine/SetGeometryBlobMessage.d.ts

@@ -0,0 +1,13 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the scene's geometry's model as a blob.
+ */
+export interface SetGeometryBlobMessage
+  extends ToEngineMessage<"set-geometry-blob"> {
+  /**
+   * The data of the geometry (i.e., the 3D model, for example a box or a
+   * bottle) in the GLTF format.
+   */
+  payload: Blob;
+}

package/to-engine/SetGeometryMessage.d.ts

@@ -0,0 +1,79 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the geometry.
+ */
+export interface SetGeometryMessage extends ToEngineMessage<"set-geometry"> {
+  payload: {
+    /**
+     * Sets the default scale of the geometry.
+     */
+    defaultScale: [number, number, number];
+    /**
+     * Whether or not the geometry should automatically scale with the mappings
+     * defined by the SetStageMappingsMessage.
+     *
+     * When `true`, the `axes` field of the stages should be set.
+     */
+    scaleWithMapping: boolean;
+    /**
+     * Whether or not the cutout texture from SetCutoutTextureMessage should be
+     * used.
+     */
+    useCutoutTexture?: boolean;
+    /**
+     * A list with stages.
+     *
+     * A stage is an area on the geometry that a texture can be drawn on.
+     */
+    stages: {
+      /**
+       * The name of the stage is the key.
+       */
+      [stageName: string]: {
+        /**
+         * The display name of the stage. Does not need to match the name of the
+         * key.
+         */
+        // TODO: Maybe better call it displayName to make this distinction clear?
+        name: string;
+        /**
+         * The normal vector of the stage. This can for example be used to
+         * automatically rotate the geometry to face this stage.
+         *
+         * Example: `[0, 0, 1]`
+         */
+        // TODO: Remove.
+        normalVector: [number, number, number];
+        /**
+         * Not neccessary anymore must must still be send.
+         */
+        // TODO: Remove
+        tris: [];
+        /**
+         * The UV color of the stage.
+         *
+         * The UV color marks the area on the texture that the stage is drawn
+         * on. The array are normalized RGB colors (i.e., in the range from 0 to
+         * 1).
+         *
+         * Example: `[0.21586, 1, 0.21586]`
+         */
+        uvColor: [number, number, number];
+        /**
+         * Maps the 2 axes of the 2D stage to the axes of the 3D geometry.
+         *
+         * Only relevant when `scaleWithMapping` is `true`.
+         *
+         * The number is the number of the axis (i.e., `0` for the x-axis, `1`
+         * for the y-axis, and `2` for the z-axis).
+         *
+         * Example: `[0, 1]` maps the width and height of the stage to the x and
+         * y-axis of the geometry.
+         *
+         */
+        axes?: [number, number];
+      };
+    };
+  };
+}

package/to-engine/SetGeometryUrlMessage.d.ts

@@ -0,0 +1,13 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the url of the scene's geometry's model.
+ */
+export interface SetGeometryUrlMessage
+  extends ToEngineMessage<"set-geometry-url"> {
+  /**
+   * A url to the geometry (i.e., the 3D model, for example a box or a bottle)
+   * in the GLTF format.
+   */
+  payload: string;
+}

package/to-engine/SetGridVisibilityMessage.d.ts

@@ -0,0 +1,9 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * A message to toggle the visibility of the grid.
+ */
+export interface SetGridVisibilityMessage
+  extends ToEngineMessage<"set-grid-visible"> {
+  payload: boolean;
+}

package/to-engine/SetHardwareScalingLevelMessage.d.ts

@@ -0,0 +1,19 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets the hardware scaling level.
+ */
+export interface SetHardwareScalingLevelMessage
+  extends ToEngineMessage<"set-hardware-scaling-level"> {
+  /**
+   * The hardware scaling level.
+   *
+   * A smaller value means a higher quality, a larger value means a lower
+   * quality.
+   *
+   * The default value is `1` which means no scaling. If the value is for
+   * example `0.5`, the image will be rendered with twice the screen resolution,
+   * resulting in a higher quality image.
+   */
+  payload: number;
+}

package/to-engine/SetLayersMessage.d.ts

@@ -0,0 +1,14 @@
+import { Layer } from "../Layer";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * A message to set the scene's layers.
+ */
+export interface SetLayersMessage extends ToEngineMessage<"set-layers"> {
+  payload: {
+    /**
+     * The layers. The key is the id of the layer.
+     */
+    [layerName: string]: Layer;
+  };
+}

package/to-engine/SetPpiMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Set the ppi.
+ */
+export interface SetPpiMessage extends ToEngineMessage<"set-ppi"> {
+  /**
+   * The PPI. The PPI value is required to properly render textures that have a
+   * fixed size (e.g., a micro-embossing with a 5x5mm pattern).
+   */
+  payload: number;
+}

package/to-engine/SetStageMappingsMessage.d.ts

@@ -0,0 +1,44 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * 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 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;
+    };
+  };
+}

package/to-engine/SetStageRotationsMessage.d.ts

@@ -0,0 +1,14 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets how the engine should rotate the stages.
+ */
+export interface SetStageRotationsMessage
+  extends ToEngineMessage<"set-stage-rotations"> {
+  payload: {
+    /**
+     * The name of the stage with its rotation in degrees.
+     */
+    [stageName: string]: 0 | 90 | 180 | 270;
+  };
+}

package/to-engine/SetSurfaceMaterialIdMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Loads and sets the surface material by its id.
+ */
+export interface SetSurfaceMaterialIdMessage
+  extends ToEngineMessage<"set-surface-material-id"> {
+  /**
+   * The id of the surface material (e.g., "paper_blanko_rough").
+   */
+  payload: string;
+}

package/to-engine/ToggleFullscreenMessage.d.ts

@@ -0,0 +1,13 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Toggles whether or not the iframe should be fullscreen.
+ */
+export interface ToggleFullscreenMessage
+  extends ToEngineMessage<"toggle-fullscreen"> {
+  /**
+   * An empty object.
+   */
+  // TODO: Add way to explicitly set it (i.e., a boolean)
+  payload: Record<string, never>;
+}

package/to-engine/ToggleInspectorMessage.d.ts

@@ -0,0 +1,7 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Toggles whether or not the BabylonJS inspector is shown.
+ */
+export interface ToggleInspectorMessage
+  extends ToEngineMessage<"toggle-inspector"> {}

package/to-engine/ToggleVrMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Toggles VR.
+ */
+export interface ToggleVrMessage extends ToEngineMessage<"toggle-vr"> {
+  /**
+   * An empty object.
+   */
+  // TODO: Add way to explicitly set it (i.e., a boolean)
+  payload: Record<string, never>;
+}

package/to-engine/UnhighlightLayerMessage.d.ts

@@ -0,0 +1,12 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Removes previously highlighting of a layer.
+ */
+export interface UnhighlightLayerMessage
+  extends ToEngineMessage<"unhighlight-layer"> {
+  /**
+   * The name of the layer to remove highlighting.
+   */
+  payload: string;
+}