@dreamcomposer/engine-types 0.0.42-next.1 → 0.0.43

package/Camera.d.ts

@@ -0,0 +1,36 @@
+export interface CameraPosition {
+  /**
+   * 3D world position where the camera is focused on.
+   *
+   * Fallback is [0,0,0]
+   */
+  target: [number, number, number];
+  /**
+   * The camera pitch angle in degree.
+   *
+   * The value defines the rotation around the local x-axis of the camera.
+   *
+   * Example:
+   * -90° = top view |
+   * 0° = frontal view |
+   * 90° = bottom view
+   */
+  pitch: number;
+  /**
+   * The camera yaw angle in degree.
+   *
+   * The value defines the rotation around the world y-axis at the target position.
+   *
+   * Example:
+   * 0° = front view |
+   * 90° = right view |
+   * 180° = back view |
+   * 270° = left view
+   *
+   */
+  yaw: number;
+  /**
+   * Defines the distance of the camera to the target position in meters
+   */
+  distance: number;
+}

package/from-engine/CameraPositionChangeMessage.ts

@@ -0,0 +1,10 @@
+import { CameraPosition } from "../Camera";
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Rotates the camera to a given vector.
+ */
+export interface CameraPositionChangeMessage
+  extends FromEngineMessage<"camera-position-change"> {
+  payload: CameraPosition;
+}

package/package.json

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

package/post-messages.d.ts

@@ -38,6 +38,8 @@ import { DisplayLoadingUiMessage } from "./from-engine/DisplayLoadingUiMessage";
 import { HideLoadingUiMessage } from "./from-engine/HideLoadingUiMessage";
 import { KeyDownEventMessage } from "./from-engine/KeyDownEventMessage";
 import { KeyUpEventMessage } from "./from-engine/KeyUpEventMessage";
+import { UpdateCameraPositionMessage } from "./to-engine/UpdateCameraPositionMessage";
+import { CameraPositionChangeMessage } from "./from-engine/CameraPositionChangeMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -71,13 +73,15 @@ export type FromEnginePostMessage =
   | KeyDownEventMessage
   | KeyUpEventMessage
   | PointerEventMessage
-  | SetLoadingProgressMessage;
+  | SetLoadingProgressMessage
+  | CameraPositionChangeMessage;
 
 export type ToEnginePostMessage =
   | DownloadScreenshotMessage
   | HighlightLayerMessage
   | ResetCameraPositionMessage
   | RotateToVectorMessage
+  | UpdateCameraPositionMessage
   | SelectedEdgesMessage
   | SetClearColorMessage
   | SetConnectionInfosMessage

package/to-engine/UpdateCameraPositionMessage.ts

@@ -0,0 +1,12 @@
+import { CameraPosition } from "../Camera";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Rotates the camera to a given position.
+ *
+ * The position can be partial information. In that case the other position values are kept as is.
+ */
+export interface UpdateCameraPositionMessage
+  extends ToEngineMessage<"update-camera-position"> {
+  payload: { changes: Partial<CameraPosition>; transitionDuration?: number };
+}