@dreamcomposer/engine-types 0.0.28 → 0.0.31-next.1

package/Layer.d.ts

@@ -24,9 +24,11 @@ export interface Layer {
   /**
    * The texture of the layer, either a url or a blob.
    *
-   * Must be in the PNG format.
+   * For non PNG images the file format must be specified:
+   * - in the URL itself
+   * - via a TextureUrl and TextureUrlCollection object
    */
-  texture: string | Blob;
+  texture: string | TextureUrl | Blob | TextureBlob;
   /**
    * Whether or not the layer is overprinted with the texture.
    *
@@ -71,10 +73,6 @@ export interface PatternEmbossingConfiguration {
    * I don't know.
    */
   overrides?: TextureOverride<unknown>[];
-  /**
-   * Size of the main texture in pixels
-   */
-  sizePx: [number, number];
   /**
    * The offset of the embossing.
    */
@@ -85,6 +83,31 @@ export interface PatternEmbossingConfiguration {
   rotation?: number;
 }
 
+export interface TextureUrl {
+  /**
+   * The public url of the texture
+   */
+  url: string;
+  /**
+   * Define the file extension of the texture. (e.g. ".png", ".jpg", ".basis")
+   *
+   * This is only necessary, if the url does not contain the extension itself
+   */
+  fileExtension?: string;
+}
+export interface TextureBlob {
+  /**
+   * The texture itself as an Blob
+   */
+  blob: Blob;
+  /**
+   * Define the file extension of the texture (e.g. ".png", ".jpg", ".ktx2")
+   *
+   * This is only necessary, if the blob is not a common image file (.png, .jpg)
+   */
+  fileExtension?: string;
+}
+
 export type TextureOverride<T> = Record<
   string,
   Partial<T> | Record<string, Partial<T>>

package/package.json

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

package/post-messages.d.ts

@@ -17,7 +17,6 @@ import { SetEmbossingHeightTextureMessage } from "./to-engine/SetEmbossingHeight
 import { SetEnvironmentMessage } from "./to-engine/SetEnvironmentMessage";
 import { SetEnvironmentVisibleMessage } from "./to-engine/SetEnvironmentVisibleMessage";
 import { SetFullscreenMessage } from "./to-engine/SetFullscreenMessage";
-import { SetGeometryBlobMessage } from "./to-engine/SetGeometryBlobMessage";
 import { SetGeometryMessage } from "./to-engine/SetGeometryMessage";
 import { SetGridVisibilityMessage } from "./to-engine/SetGridVisibilityMessage";
 import { SetHardwareScalingLevelMessage } from "./to-engine/SetHardwareScalingLevelMessage";
@@ -29,7 +28,6 @@ import { SetSurfaceMaterialMessage } from "./to-engine/SetSurfaceMaterialMessage
 import { ToggleFullscreenMessage } from "./to-engine/ToggleFullscreenMessage";
 import { ToggleInspectorMessage } from "./to-engine/ToggleInspectorMessage";
 import { UnhighlightLayerMessage } from "./to-engine/UnhighlightLayerMessage";
-import { SetGeometryUrlMessage } from "./to-engine/SetGeometryUrlMessage";
 import { ToggleVrMessage } from "./to-engine/ToggleVrMessage";
 import { PointerEventMessage } from "./from-engine/PointerEventMessage";
 import { HideGuiMessage } from "./from-engine/HideGuiMessage";
@@ -87,9 +85,7 @@ export type ToEnginePostMessage =
   | SetEnvironmentMessage
   | SetEnvironmentVisibleMessage
   | SetFullscreenMessage
-  | SetGeometryBlobMessage
   | SetGeometryMessage
-  | SetGeometryUrlMessage
   | SetGridVisibilityMessage
   | SetHardwareScalingLevelMessage
   | SetLayersMessage

package/to-engine/SetGeometryMessage.d.ts

@@ -6,73 +6,80 @@ import { ToEngineMessage } from "../post-messages";
 export interface SetGeometryMessage extends ToEngineMessage<"set-geometry"> {
   payload: {
     /**
-     * Sets the default scale of the geometry.
+     * The BLOB or URL of the geometry (i.e., the 3D model, for example a box or a
+     * bottle) in the GLTF/GLB format.
      */
-    defaultScale: [number, number, number];
-    /**
-     * Whether or not the geometry should automatically scale with the mappings
-     * defined by the SetStageMappingsMessage.
-     *
-     * When `true`, the `axes` field of the stages should be set.
-     */
-    scaleWithMapping: boolean;
-    /**
-     * Whether or not the cutout texture from SetCutoutTextureMessage should be
-     * used.
-     */
-    useCutoutTexture?: boolean;
-    /**
-     * A list with stages.
-     *
-     * A stage is an area on the geometry that a texture can be drawn on.
-     */
-    stages: {
+    model: string | Blob;
+    config: {
       /**
-       * The name of the stage is the key.
+       * Sets the default scale of the geometry.
        */
-      [stageName: string]: {
-        /**
-         * The display name of the stage. Does not need to match the name of the
-         * key.
-         */
-        // TODO: Maybe better call it displayName to make this distinction clear?
-        name: string;
-        /**
-         * The normal vector of the stage. This can for example be used to
-         * automatically rotate the geometry to face this stage.
-         *
-         * Example: `[0, 0, 1]`
-         */
-        // TODO: Remove.
-        normalVector: [number, number, number];
-        /**
-         * Not neccessary anymore must must still be send.
-         */
-        // TODO: Remove
-        tris: [];
-        /**
-         * The UV color of the stage.
-         *
-         * The UV color marks the area on the texture that the stage is drawn
-         * on. The array are normalized RGB colors (i.e., in the range from 0 to
-         * 1).
-         *
-         * Example: `[0.21586, 1, 0.21586]`
-         */
-        uvColor: [number, number, number];
+      defaultScale: [number, number, number];
+      /**
+       * Whether or not the geometry should automatically scale with the mappings
+       * defined by the SetStageMappingsMessage.
+       *
+       * When `true`, the `axes` field of the stages should be set.
+       */
+      scaleWithMapping: boolean;
+      /**
+       * Whether or not the cutout texture from SetCutoutTextureMessage should be
+       * used.
+       */
+      useCutoutTexture?: boolean;
+      /**
+       * A list with stages.
+       *
+       * A stage is an area on the geometry that a texture can be drawn on.
+       */
+      stages: {
         /**
-         * Maps the 2 axes of the 2D stage to the axes of the 3D geometry.
-         *
-         * Only relevant when `scaleWithMapping` is `true`.
-         *
-         * The number is the number of the axis (i.e., `0` for the x-axis, `1`
-         * for the y-axis, and `2` for the z-axis).
-         *
-         * Example: `[0, 1]` maps the width and height of the stage to the x and
-         * y-axis of the geometry.
-         *
+         * The name of the stage is the key.
          */
-        axes?: [number, number];
+        [stageName: string]: {
+          /**
+           * The display name of the stage. Does not need to match the name of the
+           * key.
+           */
+          // TODO: Maybe better call it displayName to make this distinction clear?
+          name: string;
+          /**
+           * The normal vector of the stage. This can for example be used to
+           * automatically rotate the geometry to face this stage.
+           *
+           * Example: `[0, 0, 1]`
+           */
+          // TODO: Remove.
+          normalVector: [number, number, number];
+          /**
+           * Not neccessary anymore must must still be send.
+           */
+          // TODO: Remove
+          tris: [];
+          /**
+           * The UV color of the stage.
+           *
+           * The UV color marks the area on the texture that the stage is drawn
+           * on. The array are normalized RGB colors (i.e., in the range from 0 to
+           * 1).
+           *
+           * Example: `[0.21586, 1, 0.21586]`
+           */
+          uvColor: [number, number, number];
+          /**
+           * Maps the 2 axes of the 2D stage to the axes of the 3D geometry.
+           *
+           * Only relevant when `scaleWithMapping` is `true`.
+           *
+           * The number is the number of the axis (i.e., `0` for the x-axis, `1`
+           * for the y-axis, and `2` for the z-axis).
+           *
+           * Example: `[0, 1]` maps the width and height of the stage to the x and
+           * y-axis of the geometry.
+           *
+           */
+          axes?: [number, number];
+        };
       };
     };
   };

package/to-engine/SetGeometryBlobMessage.d.ts

@@ -1,13 +0,0 @@
-import { ToEngineMessage } from "../post-messages";
-
-/**
- * Set the scene's geometry's model as a blob.
- */
-export interface SetGeometryBlobMessage
-  extends ToEngineMessage<"set-geometry-blob"> {
-  /**
-   * The data of the geometry (i.e., the 3D model, for example a box or a
-   * bottle) in the GLTF format.
-   */
-  payload: Blob;
-}

package/to-engine/SetGeometryUrlMessage.d.ts

@@ -1,13 +0,0 @@
-import { ToEngineMessage } from "../post-messages";
-
-/**
- * Set the url of the scene's geometry's model.
- */
-export interface SetGeometryUrlMessage
-  extends ToEngineMessage<"set-geometry-url"> {
-  /**
-   * A url to the geometry (i.e., the 3D model, for example a box or a bottle)
-   * in the GLTF format.
-   */
-  payload: string;
-}