@dreamcomposer/engine-types 0.0.59 → 0.0.61

package/GeometryTransform.d.ts

@@ -0,0 +1,12 @@
+export interface GeometryTransform {
+  /**
+   * 3D world position of the origin of the object
+   * The origin of the object is always the bottom center
+   */
+  position: [number, number, number];
+  /**
+   * Euler angles in degree of the of the object.
+   * The rotation is around the object center.
+   */
+  rotation: [number, number, number];
+}

package/from-engine/GeometryTransformChangeMessage.ts

@@ -0,0 +1,10 @@
+import { GeometryTransform } from "../GeometryTransform";
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Event object if the position or rotation of the geometry changed
+ */
+export interface GeometryTransformChangeMessage
+  extends FromEngineMessage<"geometry-transform-change"> {
+  payload: GeometryTransform;
+}

package/package.json

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

package/post-messages.d.ts

@@ -42,6 +42,11 @@ import { UpdateCameraPositionMessage } from "./to-engine/UpdateCameraPositionMes
 import { CameraPositionChangeMessage } from "./from-engine/CameraPositionChangeMessage";
 import { UpdateEnvironmentRotationMessage } from "./to-engine/UpdateEnvironmentRotationMessage";
 import { EnvironmentRotationChangedMessage } from "./from-engine/EnvironmentRotationChangedMessage";
+import { UpdateGeometryTransformMessage } from "./to-engine/UpdateGeometryTransformMessage";
+import { GeometryTransformChangeMessage } from "./from-engine/GeometryTransformChangeMessage";
+import { SetInitialGeometryTransformMessage } from "./to-engine/SetInitialGeometryTransformMessage";
+import { ResetGeometryTransformMessage } from "./to-engine/ResetGeometryTransformMessage";
+import { PlaceGeometryOnGroundMessage } from "./to-engine/MoveGeometryToGroundMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -77,7 +82,8 @@ export type FromEnginePostMessage =
   | PointerEventMessage
   | SetLoadingProgressMessage
   | CameraPositionChangeMessage
-  | EnvironmentRotationChangedMessage;
+  | EnvironmentRotationChangedMessage
+  | GeometryTransformChangeMessage;
 
 export type ToEnginePostMessage =
   | DownloadScreenshotMessage
@@ -110,6 +116,10 @@ export type ToEnginePostMessage =
   | RecenterSkeletonObjectsMessage
   | SetSkeletonStatesMessage
   | SetShadowPlaneVisibilityMessage
-  | UpdateEnvironmentRotationMessage;
+  | UpdateEnvironmentRotationMessage
+  | UpdateGeometryTransformMessage
+  | SetInitialGeometryTransformMessage
+  | ResetGeometryTransformMessage
+  | PlaceGeometryOnGroundMessage;
 
 export type PostMessage = FromEnginePostMessage | ToEnginePostMessage;

package/to-engine/MoveGeometryToGroundMessage.ts

@@ -0,0 +1,10 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Translates the geometry so its lowest part touches the ground.
+ * The current rotation of the object is not affected.
+ */
+export interface PlaceGeometryOnGroundMessage
+  extends ToEngineMessage<"place-geometry-on-ground"> {
+  payload: { transitionDuration?: number };
+}

package/to-engine/ResetGeometryTransformMessage.ts

@@ -0,0 +1,13 @@
+import { GeometryTransform } from "../GeometryTransform";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Sets the geometry rotation and position to the initial transform values.
+ *
+ * If no initial transform was defined `{position: [0,0,0], rotation: [0,0,0]}`
+ * is used
+ */
+export interface ResetGeometryTransformMessage
+  extends ToEngineMessage<"reset-geometry-transform"> {
+  payload: { transitionDuration?: number };
+}

package/to-engine/SetInitialGeometryTransformMessage.ts

@@ -0,0 +1,12 @@
+import { GeometryTransform } from "../GeometryTransform";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Defines the initial geometry rotation and position.
+ *
+ * The initial transform is used if the transform is reseted.
+ */
+export interface SetInitialGeometryTransformMessage
+  extends ToEngineMessage<"set-initial-geometry-transform"> {
+  payload: { transform: GeometryTransform };
+}

package/to-engine/UpdateGeometryTransformMessage.ts

@@ -0,0 +1,12 @@
+import { GeometryTransform } from "../GeometryTransform";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * Translates and rotates the camera to a given values.
+ *
+ * The transform data can be partial information. In that case the other transform values are kept as is.
+ */
+export interface UpdateGeometryTransformMessage
+  extends ToEngineMessage<"update-geometry-transform"> {
+  payload: { changes: Partial<GeometryTransform>; transitionDuration?: number };
+}