@dreamcomposer/engine-types 0.0.82 → 0.0.84

package/{Label.d.ts → AnnotationTag.d.ts}

@@ -1,12 +1,16 @@
-export type Label = {
+/**
+ * Defines a visual object that is attached to the 3D object in the scene with a line.
+ * The tag is displayed in the 3D scene and is always facing the camera.
+ */
+export type AnnotationTag = {
   /**
-   * Unique identifier for the label.
+   * Unique identifier for the tag.
    */
   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.
+   * If the coordinates are outside of the texture, or that part of the texture is not mapped to the geometry, the tag  will not be displayed.
    */
   textureCoordinates: {
     /** Normalized x-position. `0` represents the left edge of the image. `1` the right edge */

package/from-engine/{LabelPositionChangedMessage.ts → AnnotationTagPositionChangedMessage.ts}

@@ -1,4 +1,4 @@
-import { Label } from "../Label";
+import { AnnotationTag } from "../AnnotationTag";
 import { FromEngineMessage } from "../post-messages";
 
 export type AnchorPosition = {
@@ -9,16 +9,16 @@ export type AnchorPosition = {
 };
 
 /**
- * Is fired every frame to notify the embedder of the new screen position of the label.
+ * Is fired every frame to notify the embedder of the new screen position of the annotation tag.
  */
-export interface LabelPositionChangedMessage
-  extends FromEngineMessage<"label-position-changed"> {
+export interface AnnotationTagPositionChangedMessage
+  extends FromEngineMessage<"annotation-tag-position-changed"> {
   payload: {
-    label: Label;
+    tag: AnnotationTag;
     /** 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;
+    tagAnchorPosition: 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.82",
+  "version": "0.0.84",
   "description": "The type definitions for messages from and to the engine",
   "license": "UNLICENSED",
   "private": false,

package/post-messages.d.ts

@@ -49,8 +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";
+import { AnnotationTagPositionChangedMessage } from "./from-engine/AnnotationTagPositionChangedMessage";
+import { SetAnnotationTagsMessage } from "./to-engine/SetAnnotationTagsMessage";
 import { SetCustomRequestHeaders } from "./to-engine/SetCustomRequestHeaders";
 
 /**
@@ -89,7 +89,7 @@ export type FromEnginePostMessage =
   | CameraPositionChangeMessage
   | EnvironmentRotationChangedMessage
   | GeometryTransformChangeMessage
-  | LabelPositionChangedMessage;
+  | AnnotationTagPositionChangedMessage;
 
 export type ToEnginePostMessage =
   | DownloadScreenshotMessage
@@ -129,7 +129,7 @@ export type ToEnginePostMessage =
   | SetInitialGeometryTransformMessage
   | ResetGeometryTransformMessage
   | PlaceGeometryOnGroundMessage
-  | SetLabelsMessage
+  | SetAnnotationTagsMessage
   | SetCustomRequestHeaders;
 
 export type PostMessage = FromEnginePostMessage | ToEnginePostMessage;

package/to-engine/SetAnnotationTagsMessage.ts

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

package/to-engine/SetLabelsMessage.ts

@@ -1,13 +0,0 @@
-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[];
-}