@dreamcomposer/engine-types 0.0.79 → 0.0.81

package/Label.d.ts

@@ -0,0 +1,19 @@
+export type Label = {
+  /**
+   * Unique identifier for the label.
+   */
+  id: string;
+  /**
+   * Normalized coordinates within the layer texture. The origin is the top left corner of the texture. The bottom right corner is `(1, 1)`.
+   *
+   * If the coordinates are outside of the texture, or that part of the texture is not mapped to the geometry, the label will not be displayed.
+   */
+  textureCoordinates: {
+    /** Normalized x-position. `0` represents the left edge of the image. `1` the right edge */
+    x: number;
+    /** Normalized y-position. `0` represents teh top edge of the image. `1` the bottom edge */
+    y: number;
+  };
+  /** The color of the connector lines in HEX format without alpha (e.g., #AD86A3). If `undefined` black is used */
+  lineColor?: string;
+};

package/from-engine/LabelPositionChangedMessage.ts

@@ -0,0 +1,25 @@
+import { Label } from "../Label";
+import { FromEngineMessage } from "../post-messages";
+
+export type AnchorPosition = {
+  /** 3D world position in meters */
+  worldPosition: { x: number; y: number; z: number };
+  /** Normalized screen position, where top left corner is `(0,0)` and bottom right `(1,1)` */
+  screenPosition: { x: number; y: number };
+};
+
+/**
+ * Is fired every frame to notify the embedder of the new screen position of the label.
+ */
+export interface LabelPositionChangedMessage
+  extends FromEngineMessage<"label-position-changed"> {
+  payload: {
+    label: Label;
+    /** The anchor position that is directly attached to the object */
+    objectAnchorPosition: AnchorPosition;
+    /** The floating anchor position where the text label will be displayed */
+    labelAnchorPosition: AnchorPosition;
+    /** Normalized value where `0` is directly in front of the camera and `1` at the far end */
+    depth: number;
+  }[];
+}

package/package.json

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

package/post-messages.d.ts

@@ -49,6 +49,8 @@ import { ResetGeometryTransformMessage } from "./to-engine/ResetGeometryTransfor
 import { PlaceGeometryOnGroundMessage } from "./to-engine/MoveGeometryToGroundMessage";
 import { MouseEventMessage } from "./to-engine/MouseEventMessage";
 import { SetBackgroundImageMessage } from "./to-engine/SetBackgroundImageMessage";
+import { LabelPositionChangedMessage } from "./from-engine/LabelPositionChangedMessage";
+import { SetLabelsMessage } from "./to-engine/SetLabelsMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -85,7 +87,8 @@ export type FromEnginePostMessage =
   | SetLoadingProgressMessage
   | CameraPositionChangeMessage
   | EnvironmentRotationChangedMessage
-  | GeometryTransformChangeMessage;
+  | GeometryTransformChangeMessage
+  | LabelPositionChangedMessage;
 
 export type ToEnginePostMessage =
   | DownloadScreenshotMessage
@@ -124,6 +127,7 @@ export type ToEnginePostMessage =
   | UpdateGeometryTransformMessage
   | SetInitialGeometryTransformMessage
   | ResetGeometryTransformMessage
-  | PlaceGeometryOnGroundMessage;
+  | PlaceGeometryOnGroundMessage
+  | SetLabelsMessage;
 
 export type PostMessage = FromEnginePostMessage | ToEnginePostMessage;

package/to-engine/SetLabelsMessage.ts

@@ -0,0 +1,13 @@
+import { Label } from "../Label";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets the labels that should be displayed in the scene.
+ *
+ * The engine only renders the label connector lines and sends the label screen positions to the
+ * embedder via `label-position-changed` message. The embedder is responsible for rendering the
+ * labels.
+ */
+export interface SetLabelsMessage extends ToEngineMessage<"set-labels"> {
+  payload: Label[];
+}