@dreamcomposer/engine-types 0.0.15 → 0.0.17

package/SkeletonState.d.ts

@@ -0,0 +1,38 @@
+/**
+ * State of a single skeleton
+ */
+export interface SkeletonState {
+  /**
+   * The states of all bones inside the skeleton
+   * Missing bone states or empty value will result in default (rest-pose) values
+   */
+  boneStates?: BoneState[];
+}
+
+export interface BoneState {
+  /**
+   * The index of the bone inside the skeleton definition
+   */
+  boneIndex: number;
+  /**
+   * The local position of the bone. If empty the default (rest-pose) values is taken
+   */
+  localPosition?: [number, number, number];
+  /**
+   * The local rotation of the bone in euler angles or as an angle axis representation
+   */
+  localRotation?: EulerAngles | AngleAxisRotation;
+}
+
+export interface EulerAngles {
+  x: number;
+  y: number;
+  z: number;
+}
+
+export interface AngleAxisRotation {
+  /** Normalized rotation axis */
+  axis: [number, number, number];
+  /** Angle in degree */
+  angle: number;
+}

package/from-engine/DisplayLoadingUiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever the loading ui should be displayed.
+ */
+export interface DisplayLoadingUiMessage
+  extends FromEngineMessage<"display-loading-ui"> {
+  payload: {};
+}

package/from-engine/HideLoadingUiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever the loading ui should be hidden.
+ */
+export interface HideLoadingUiMessage
+  extends FromEngineMessage<"hide-loading-ui"> {
+  payload: {};
+}

package/package.json

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

package/post-messages.d.ts

@@ -35,6 +35,11 @@ import { ToggleVrMessage } from "./to-engine/ToggleVrMessage";
 import { PointerEventMessage } from "./from-engine/PointerEventMessage";
 import { HideGuiMessage } from "./from-engine/HideGuiMessage";
 import { SetUseFramingAnimation } from "./to-engine/SetUseFramingAnimation";
+import { SetSkeletonStatesMessage } from "./to-engine/SetSkeletonStatesMessage";
+import { RecenterSkeletonObjectsMessage } from "./to-engine/RecenterSkeletonObjectsMessage";
+import { SetShadowPlaneVisibilityMessage } from "./to-engine/SetShadowPlaneVisibilityMessage";
+import { DisplayLoadingUiMessage } from "./from-engine/DisplayLoadingUiMessage";
+import { HideLoadingUiMessage } from "./from-engine/HideLoadingUiMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -60,8 +65,10 @@ export interface ToEngineMessage<Channel> {
 export type FromEnginePostMessage =
   | AckMessage
   | CanvasImageUrlMessage
+  | DisplayLoadingUiMessage
   | EngineReadyMessage
   | HideGuiMessage
+  | HideLoadingUiMessage
   | KeyDownMessage
   | PointerEventMessage
   | SetEffectsSettingsAckMessage
@@ -96,6 +103,9 @@ export type ToEnginePostMessage =
   | ToggleFullscreenMessage
   | ToggleInspectorMessage
   | ToggleVrMessage
-  | UnhighlightLayerMessage;
+  | UnhighlightLayerMessage
+  | RecenterSkeletonObjectsMessage
+  | SetSkeletonStatesMessage
+  | SetShadowPlaneVisibilityMessage;
 
 export type PostMessage = FromEnginePostMessage | ToEnginePostMessage;

package/to-engine/RecenterSkeletonObjectsMessage.ts

@@ -0,0 +1,9 @@
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * A message to set the mesh skeleton states
+ */
+export interface RecenterSkeletonObjectsMessage
+  extends ToEngineMessage<"recenter-skeleton-objects"> {
+  payload: void;
+}

package/to-engine/SetGeometryAnglesMessage.d.ts

@@ -0,0 +1,6 @@
+import { ToEngineMessage } from "../post-messages";
+
+export interface SetGeometryAngles
+  extends ToEngineMessage<"set-geometry-angles"> {
+  payload: number[];
+}

package/to-engine/SetShadowPlaneVisibilityMessage.d.ts

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

package/to-engine/SetSkeletonStatesMessage.ts

@@ -0,0 +1,15 @@
+import { SkeletonState } from "../SkeletonState";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * A message to set the mesh skeleton states
+ */
+export interface SetSkeletonStatesMessage
+  extends ToEngineMessage<"set-skeleton-states"> {
+  payload: {
+    /**
+     * The skeleton states. The key is the name of the skeleton from the mesh.
+     */
+    [skeletonName: string]: SkeletonState;
+  };
+}