@inweb/viewer-visualize 25.7.0 → 25.7.2

package/src/Viewer/Draggers/OdZoomWindowDragger/OdSelectionFrame.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Draggers/OdZoomWindowDragger/index.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Draggers/OdaLineDragger.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Draggers/OdaTextDragger.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Draggers/OdaWalkDragger.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Draggers/OrbitAroundBuildingDragger.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Loaders/BaseLoader.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Loaders/LoaderFactory.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Loaders/TCSLoader.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Loaders/VsfXLoader.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Loaders/VsfXPartialLoader.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Loaders/VsfXStreamingLoader.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Viewer/Markup/Api/IMarkupLine.ts

@@ -23,6 +23,11 @@
 
 import { IMarkupObject } from "./IMarkupObject";
 
+/**
+ * Type of the markup line.
+ */
+export type MarkupLineType = "solid" | "dot" | "dash";
+
 /**
  * Line Markup object
  */

package/src/Viewer/Markup/Api/Impl/Konva/KonvaArrow.ts

@@ -82,7 +82,7 @@ export class KonvaArrow implements IMarkupArrow, IMarkupColorable {
   }
 
   getColor(): string {
-    return this._ref.stroke();
+    return this._ref.stroke() as string;
   }
 
   setColor(hex: string) {

package/src/Viewer/Markup/Api/Impl/Konva/KonvaCloud.ts

@@ -151,7 +151,7 @@ export class KonvaCloud implements IMarkupCloud, IMarkupColorable {
   }
 
   getColor(): string {
-    return this._ref.stroke();
+    return this._ref.stroke() as string;
   }
 
   setColor(hex: string) {

package/src/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.ts

@@ -120,7 +120,7 @@ export class KonvaEllipse implements IMarkupEllipse, IMarkupColorable {
   }
 
   getColor(): string {
-    return this._ref.stroke();
+    return this._ref.stroke() as string;
   }
 
   setColor(hex: string) {

package/src/Viewer/Markup/Api/Impl/Konva/KonvaLine.ts

@@ -1,6 +1,5 @@
 import Konva from "konva";
-import { LineType } from "@inweb/viewer-core";
-import { IMarkupLine } from "../../IMarkupLine";
+import { IMarkupLine, MarkupLineType } from "../../IMarkupLine";
 import { IMarkupColorable } from "../../IMarkupColorable";
 
 const LineTypeSpecs = new Map<string, number[]>([
@@ -13,7 +12,7 @@ export class KonvaLine implements IMarkupLine, IMarkupColorable {
   private _ref: Konva.Line;
 
   constructor(
-    params: { points: { x: number; y: number }[]; type?: LineType; width?: number; color?: string; id?: string },
+    params: { points: { x: number; y: number }[]; type?: MarkupLineType; width?: number; color?: string; id?: string },
     ref = null
   ) {
     if (ref) {
@@ -64,7 +63,7 @@ export class KonvaLine implements IMarkupLine, IMarkupColorable {
   }
 
   getColor(): string {
-    return this._ref.stroke();
+    return this._ref.stroke() as string;
   }
 
   setColor(hex: string) {
@@ -106,7 +105,7 @@ export class KonvaLine implements IMarkupLine, IMarkupColorable {
 
   getLineType(): string {
     const typeSpecs = this._ref.dash() || [];
-    let type: LineType;
+    let type: MarkupLineType;
     switch (typeSpecs) {
       case LineTypeSpecs.get("dot"):
         type = "dot";

package/src/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.ts

@@ -111,7 +111,7 @@ export class KonvaRectangle implements IMarkupRectangle, IMarkupColorable {
   }
 
   getColor(): string {
-    return this._ref.stroke();
+    return this._ref.stroke() as string;
   }
 
   setColor(hex: string): void {

package/src/Viewer/Markup/Api/Impl/Konva/KonvaText.ts

@@ -87,7 +87,7 @@ export class KonvaText implements IMarkupText, IMarkupColorable {
   }
 
   getColor(): string {
-    return this._ref.fill();
+    return this._ref.fill() as string;
   }
 
   setColor(hex: string) {

package/src/Viewer/Markup/IMarkup.ts

@@ -21,24 +21,14 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
+import { IEventEmitter } from "@inweb/eventemitter2";
 import { IViewpoint } from "@inweb/viewer-core";
-
-import { OdBaseDragger } from "../Draggers/Common/OdBaseDragger";
-import { Viewer } from "../Viewer";
+import { IWorldTransform } from "./IWorldTransform";
 import { IMarkupObject } from "./Api/IMarkupObject";
 
 /**
- * Version of the markup support. Old = "Visualize", New = "Konva"
- */
-export enum MarkupType {
-  Unknown,
-  Konva = "Konva",
-  Visualize = "Visualize",
-}
-
-/**
- * Defines type of markup object. For old Visualize markup ({@link MarkupType}) only "Line" and
- * "Text" markup objects are supported.
+ * Defines type of markup object. For `VisualizeJS` markup only the `Line` and `Text` markup
+ * objects are supported.
  */
 export enum MarkupMode {
   SelectMarkup = "SelectMarkup",
@@ -52,32 +42,42 @@ export enum MarkupMode {
 }
 
 /**
- * Specifies parameters and methods of the Markup object
+ * 2D markup core interface.
  */
 export interface IMarkup {
   /**
-   * Width of the markup object line. Default is 4.
+   * Line width of the markup objects. Default is 4.
    */
   lineWidth: number;
 
   /**
-   * Type of the Line markup object. Available types: "solid", "dot", "dash". Default is "solid".
+   * Type of the markup line. Available types: `solid`, `dot`, `dash`. Default is `solid`.
    */
   lineType: string;
 
   /**
-   * Font size of the markup text. Default is 34.
+   * Font size of the markup text. Default is 34 px.
    */
   fontSize: number;
 
   /**
    * Start method to init Markup support for the Viewer instance.
    *
-   * @param {Viewer} viewer - current {@link Viewer} object
-   * @param canvas - {@link HTMLCanvasElement} of the Viewer
-   * @param canvasEvents - list of used events of the Viewer
-   */
-  initialize(viewer: Viewer, canvas: HTMLCanvasElement, canvasEvents: string[]): void;
+   * @param canvas -
+   *   {@link https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement | HTMLCanvasElement}
+   *   used to operate on.
+   * @param canvasEvents - List of `canvas` events that the markup should redirect to the `viewer`.
+   * @param viewer - `Viewer` instance viewer that receives `canvas` events.
+   * @param worldTransformer - Transformer of screen space into world space and vice versa. If
+   *   a transformer is defined, viewpoint objects will be stored in world coordinates,
+   *   otherwise in screen coordinates.
+   */
+  initialize(
+    canvas: HTMLCanvasElement,
+    canvasEvents: string[],
+    viewer?: IEventEmitter,
+    worldTransformer?: IWorldTransform
+  ): void;
 
   /**
    * Releases all resources allocated by this `Markup` instance. Call this method before
@@ -86,13 +86,12 @@ export interface IMarkup {
   dispose(): void;
 
   /**
-   * Provide Javascript Map with all {@link OdBaseDragger} draggers used by Markup. We need this
-   * map to register in {@link Viewer.registerDragger}
+   * Create markup overlay.
    */
-  getDraggers(): Map<string, typeof OdBaseDragger>;
+  syncOverlay(): void;
 
   /**
-   * Remove markup overlay.
+   * Clear markup overlay.
    */
   clearOverlay(): void;
 
@@ -138,37 +137,37 @@ export interface IMarkup {
   setViewpoint(viewpoint: IViewpoint): void;
 
   /**
-   * Create a {@link IViewpoint} viewpoint
+   * Create a viewpoint.
    */
   getViewpoint(): IViewpoint;
 
   /**
-   * Create a Markup object
+   * Create a Markup object.
    *
-   * @param type - string identificator of Markup type
-   * @param params - object with parameters of Markup
+   * @param type - string identificator of Markup object type.
+   * @param params - Markup object parameters.
    */
   createObject(type: string, params: any): IMarkupObject;
 
   /**
-   * Get array of all existed Markup objects
+   * Get Markup objects.
    */
   getObjects(): IMarkupObject[];
 
   /**
-   * Get array of currently selected Markup objects
+   * Get selected Markup objects.
    */
   getSelectedObjects(): IMarkupObject[];
 
   /**
-   * Select list of Markup objects
+   * Select Markup objects.
    *
    * @param objects
    */
   selectObjects(objects: IMarkupObject[]): void;
 
   /**
-   * Clear list of currently selected Markup objects
+   * Clear Markup objects selection.
    */
   clearSelected(): void;
 }

package/src/Viewer/Markup/IWorldTransform.ts

@@ -0,0 +1,46 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
+// All rights reserved.
+//
+// This software and its documentation and related materials are owned by
+// the Alliance. The software may only be incorporated into application
+// programs owned by members of the Alliance, subject to a signed
+// Membership Agreement and Supplemental Software License Agreement with the
+// Alliance. The structure and organization of this software are the valuable
+// trade secrets of the Alliance and its suppliers. The software is also
+// protected by copyright law and international treaty provisions. Application
+// programs incorporating this software must include the following statement
+// with their copyright notices:
+//
+//   This application incorporates Open Design Alliance software pursuant to a
+//   license agreement with Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Viewer coordiate system transformer.
+ */
+export interface IWorldTransform {
+  /**
+   * Transforms `position` from screen space into world space.
+   *
+   * @param position - screen position in pixels.
+   */
+  screenToWorld(position: { x: number; y: number }): { x: number; y: number; z: number };
+
+  /**
+   * Transforms `position` from world space into screen space.
+   *
+   * @param position - position in world space coordinates.
+   */
+  worldToScreen(position: { x: number; y: number; z: number }): { x: number; y: number };
+
+  /**
+   * Returns the scaling factors for each axis in world space.
+   */
+  getScale(): { x: number; y: number; z: number };
+}