@inweb/viewer-visualize 25.7.2 → 25.7.4

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaImage.d.ts

@@ -1,36 +0,0 @@
-import { IMarkupImage } from "../../IMarkupImage";
-export declare class KonvaImage implements IMarkupImage {
-    private _ref;
-    private _canvasImage;
-    private _ratio;
-    constructor(params: {
-        position: {
-            x: number;
-            y: number;
-        };
-        src: string;
-        width: number;
-        height: number;
-        id?: string;
-    }, ref?: any);
-    getSrc(): string;
-    setSrc(src: any): void;
-    getWidth(): number;
-    setWidth(w: number): void;
-    getHeight(): number;
-    setHeight(h: number): void;
-    ref(): import("konva/lib/shapes/Image").Image;
-    id(): string;
-    enableMouseEditing(value: boolean): void;
-    type(): string;
-    getRotation(): number;
-    setRotation(degrees: number): void;
-    getZIndex(): number;
-    setZIndex(zIndex: number): void;
-    delete(): void;
-    getPosition(): {
-        x: number;
-        y: number;
-    };
-    setPosition(x: number, y: number): void;
-}

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaLine.d.ts

@@ -1,35 +0,0 @@
-import { IMarkupLine, MarkupLineType } from "../../IMarkupLine";
-import { IMarkupColorable } from "../../IMarkupColorable";
-export declare class KonvaLine implements IMarkupLine, IMarkupColorable {
-    private _ref;
-    constructor(params: {
-        points: {
-            x: number;
-            y: number;
-        }[];
-        type?: MarkupLineType;
-        width?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
-    ref(): import("konva/lib/shapes/Line").Line<import("konva/lib/shapes/Line").LineConfig>;
-    id(): string;
-    enableMouseEditing(value: boolean): void;
-    type(): string;
-    getColor(): string;
-    setColor(hex: string): void;
-    getRotation(): number;
-    setRotation(degrees: number): void;
-    getZIndex(): number;
-    setZIndex(zIndex: number): void;
-    delete(): void;
-    getPoints(): number[];
-    setLineWidth(size: number): void;
-    getLineWidth(): number;
-    getLineType(): string;
-    setLineType(type: string): void;
-    addPoints(points: [{
-        x: number;
-        y: number;
-    }]): void;
-}

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.d.ts

@@ -1,38 +0,0 @@
-import { IMarkupRectangle } from "../../IMarkupRectangle";
-import { IMarkupColorable } from "../../IMarkupColorable";
-export declare class KonvaRectangle implements IMarkupRectangle, IMarkupColorable {
-    private _ref;
-    constructor(params: {
-        position: {
-            x: number;
-            y: number;
-        };
-        width?: number;
-        height?: number;
-        lineWidth?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
-    getPosition(): {
-        x: number;
-        y: number;
-    };
-    getWidth(): number;
-    getHeigth(): number;
-    setWidth(w: number): void;
-    setHeight(h: number): void;
-    setPosition(x: number, y: number): void;
-    ref(): import("konva/lib/shapes/Rect").Rect;
-    id(): string;
-    enableMouseEditing(value: boolean): void;
-    type(): string;
-    getColor(): string;
-    setColor(hex: string): void;
-    getRotation(): number;
-    setRotation(degrees: number): void;
-    getZIndex(): number;
-    setZIndex(zIndex: number): void;
-    delete(): void;
-    setLineWidth(size: number): void;
-    getLineWidth(): number;
-}

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaText.d.ts

@@ -1,37 +0,0 @@
-import { IMarkupText } from "../../IMarkupText";
-import { IMarkupColorable } from "../../IMarkupColorable";
-export declare class KonvaText implements IMarkupText, IMarkupColorable {
-    private _ref;
-    private readonly TEXT_FONT_FAMILY;
-    constructor(params: {
-        position: {
-            x: number;
-            y: number;
-        };
-        text: string;
-        rotation?: number;
-        fontSize?: number;
-        color?: string;
-        id?: string;
-    }, ref?: any);
-    ref(): import("konva/lib/shapes/Text").Text;
-    id(): string;
-    enableMouseEditing(value: boolean): void;
-    type(): string;
-    getColor(): string;
-    setColor(hex: string): void;
-    getRotation(): number;
-    setRotation(degrees: number): void;
-    getZIndex(): number;
-    setZIndex(zIndex: number): void;
-    delete(): void;
-    getText(): string;
-    setText(text: string): void;
-    getPosition(): {
-        x: number;
-        y: number;
-    };
-    setPosition(x: number, y: number): void;
-    getFontSize(): number;
-    setFontSize(size: number): void;
-}

package/lib/Viewer/Markup/IMarkup.d.ts

@@ -1,130 +0,0 @@
-import { IEventEmitter } from "@inweb/eventemitter2";
-import { IViewpoint } from "@inweb/viewer-core";
-import { IWorldTransform } from "./IWorldTransform";
-import { IMarkupObject } from "./Api/IMarkupObject";
-/**
- * Defines type of markup object. For `VisualizeJS` markup only the `Line` and `Text` markup
- * objects are supported.
- */
-export declare enum MarkupMode {
-    SelectMarkup = "SelectMarkup",
-    Line = "Line",
-    Text = "Text",
-    Rectangle = "Rectangle",
-    Ellipse = "Ellipse",
-    Arrow = "Arrow",
-    Image = "Image",
-    Cloud = "Cloud"
-}
-/**
- * 2D markup core interface.
- */
-export interface IMarkup {
-    /**
-     * Line width of the markup objects. Default is 4.
-     */
-    lineWidth: number;
-    /**
-     * Type of the markup line. Available types: `solid`, `dot`, `dash`. Default is `solid`.
-     */
-    lineType: string;
-    /**
-     * Font size of the markup text. Default is 34 px.
-     */
-    fontSize: number;
-    /**
-     * Start method to init Markup support for the Viewer instance.
-     *
-     * @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
-     * release the `Markup` instance.
-     */
-    dispose(): void;
-    /**
-     * Create markup overlay.
-     */
-    syncOverlay(): void;
-    /**
-     * Clear markup overlay.
-     */
-    clearOverlay(): void;
-    /**
-     * Set markup color.
-     *
-     * @param r - `Red` part of color.
-     * @param g - `Green` part of color.
-     * @param b - `Blue` part of color.
-     */
-    setMarkupColor(r: number, g: number, b: number): void;
-    /**
-     * Get markup color.
-     *
-     * @returns Color with `RGB` values.
-     */
-    getMarkupColor(): {
-        r: number;
-        g: number;
-        b: number;
-    };
-    /**
-     * Colorize all markup entities with the specified color.
-     *
-     * @param r - `Red` part of color.
-     * @param g - `Green` part of color.
-     * @param b - `Blue` part of color.
-     */
-    colorizeAllMarkup(r: number, g: number, b: number): void;
-    /**
-     * Colorize all selected markup entities with the specified color.
-     *
-     * @param r - `Red` part of color.
-     * @param g - `Green` part of color.
-     * @param b - `Blue` part of color.
-     */
-    colorizeSelectedMarkups(r: number, g: number, b: number): void;
-    /**
-     * Draw a viewpoint. To get a list of available model viewpoints, use the
-     *
-     * @param viewpoint - Viewpoint data.
-     */
-    setViewpoint(viewpoint: IViewpoint): void;
-    /**
-     * Create a viewpoint.
-     */
-    getViewpoint(): IViewpoint;
-    /**
-     * Create a Markup object.
-     *
-     * @param type - string identificator of Markup object type.
-     * @param params - Markup object parameters.
-     */
-    createObject(type: string, params: any): IMarkupObject;
-    /**
-     * Get Markup objects.
-     */
-    getObjects(): IMarkupObject[];
-    /**
-     * Get selected Markup objects.
-     */
-    getSelectedObjects(): IMarkupObject[];
-    /**
-     * Select Markup objects.
-     *
-     * @param objects
-     */
-    selectObjects(objects: IMarkupObject[]): void;
-    /**
-     * Clear Markup objects selection.
-     */
-    clearSelected(): void;
-}

package/lib/Viewer/Markup/IWorldTransform.d.ts

@@ -1,39 +0,0 @@
-/**
- * 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;
-    };
-}

package/lib/Viewer/Markup/Impl/Konva/KonvaMarkup.d.ts

@@ -1,82 +0,0 @@
-import { IEventEmitter } from "@inweb/eventemitter2";
-import { ChangeActiveDraggerEvent, IViewpoint, PanEvent } from "@inweb/viewer-core";
-import { IMarkup } from "../../IMarkup";
-import { IWorldTransform } from "../../IWorldTransform";
-import { IMarkupObject } from "../../Api/IMarkupObject";
-import { MarkupLineType } from "../../Api/IMarkupLine";
-/**
- * 2D markup core.
- */
-export declare class KonvaMarkup implements IMarkup {
-    private _isInitialized;
-    private _viewer;
-    private _worldTransformer;
-    private _canvasOriginal;
-    private _canvasEvents;
-    private _markupIsActive;
-    private _markupMode;
-    private _markupColor;
-    private _konvaStage;
-    private _konvaLayer;
-    private _konvaTransformer;
-    private _textInputRef;
-    private _textInputPos;
-    private _textInputAngle;
-    private _imageInputRef;
-    private _imageInputPos;
-    private _markupContainer;
-    private _zIndex;
-    private readonly _markupContainerName;
-    lineWidth: number;
-    lineType: MarkupLineType;
-    fontSize: number;
-    initialize(canvas: HTMLCanvasElement, canvasEvents: string[], viewer?: IEventEmitter, worldTransformer?: IWorldTransform): void;
-    dispose(): void;
-    changeActiveDragger: (event: ChangeActiveDraggerEvent) => void;
-    resize: () => void;
-    pan: (event: PanEvent) => void;
-    redirectToViewer: (event: any) => void;
-    syncOverlay(): void;
-    clearOverlay(): void;
-    getMarkupColor(): {
-        r: number;
-        g: number;
-        b: number;
-    };
-    setMarkupColor(r: number, g: number, b: number): void;
-    colorizeAllMarkup(r?: number, g?: number, b?: number): void;
-    colorizeSelectedMarkups(r: number, g: number, b: number): void;
-    setViewpoint(viewpoint: IViewpoint): void;
-    getViewpoint(): IViewpoint;
-    createObject(type: string, params: any): IMarkupObject;
-    getObjects(): IMarkupObject[];
-    getSelectedObjects(): IMarkupObject[];
-    selectObjects(objects: IMarkupObject[]): void;
-    clearSelected(): void;
-    private getPoint3dFromArray;
-    private fillViewpointShapes;
-    private addObject;
-    private konvaLayerFind;
-    private initializeKonva;
-    private destroyKonva;
-    private getMarkupLines;
-    private getMarkupTexts;
-    private getMarkupRectangles;
-    private getMarkupEllipses;
-    private getMarkupArrows;
-    private getMarkupImages;
-    private getMarkupClouds;
-    private loadMarkup;
-    private combineMarkupWithDrawing;
-    private addLine;
-    private createTextInput;
-    private removeTextInput;
-    private createImageInput;
-    private removeImageInput;
-    private addText;
-    private addRectangle;
-    private addEllipse;
-    private addArrow;
-    private addCloud;
-    private addImage;
-}

package/lib/Viewer/Markup/Impl/Konva/MarkupColor.d.ts

@@ -1,38 +0,0 @@
-/**
- * Markup color.
- */
-export declare class MarkupColor {
-    R: number;
-    G: number;
-    B: number;
-    private _hex;
-    /**
-     * Color in #000000 format
-     */
-    get HexColor(): string;
-    /**
-     * Color as object with r,g,b properties
-     */
-    get RGB(): {
-        r: number;
-        g: number;
-        b: number;
-    };
-    /**
-     * Create an instance of Color
-     *
-     * @param r - Red color in [0,255] range
-     * @param g - Green color in [0,255] range
-     * @param b - Blue color in [0,255] range
-     */
-    constructor(r: number, g: number, b: number);
-    /**
-     * Set Color for current instance
-     *
-     * @param r - Red color in [0,255] range
-     * @param g - Green color in [0,255] range
-     * @param b - Blue color in [0,255] range
-     */
-    setColor(r: number, g: number, b: number): void;
-    private rgbToHex;
-}

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

@@ -1,69 +0,0 @@
-///////////////////////////////////////////////////////////////////////////////
-// 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.
-///////////////////////////////////////////////////////////////////////////////
-
-import { IMarkupObject } from "./IMarkupObject";
-
-/**
- * Arrow Markup object
- */
-export interface IMarkupArrow extends IMarkupObject {
-  /**
-   * Get points of current Arrow
-   *
-   * @returns {{ x: number; y: number }} array of points
-   */
-  getPoints(): { x: number; y: number }[];
-
-  /**
-   * Set points of the Arrow
-   *
-   * @param {{ x: number; y: number }} points - array of points
-   */
-  setPoints(points: { x: number; y: number }[]);
-
-  /**
-   * Get Start Point of the Arrow
-   */
-  getStartPoint(): { x: number; y: number };
-
-  /**
-   * Set Start point of the Arrow
-   *
-   * @param x - value of X coordinate
-   * @param y - value of Y coordinate
-   */
-  setStartPoint(x: number, y: number);
-
-  /**
-   * Get End point of the Arrow
-   */
-  getEndPoint(): { x: number; y: number };
-
-  /**
-   * Set End point of the Arrow
-   *
-   * @param x - value of X coordinate
-   * @param y - value of Y coordinate
-   */
-  setEndPoint(x: number, y: number);
-}

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

@@ -1,78 +0,0 @@
-///////////////////////////////////////////////////////////////////////////////
-// 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.
-///////////////////////////////////////////////////////////////////////////////
-
-import { IMarkupObject } from "./IMarkupObject";
-
-/**
- * Cloud Markup object
- */
-export interface IMarkupCloud extends IMarkupObject {
-  /**
-   * Get position of the Cloud
-   */
-  getPosition(): { x: number; y: number };
-
-  /**
-   * Set position of the Cloud
-   *
-   * @param x - value of X coordinate
-   * @param y - value of Y coordinate
-   */
-  setPosition(x: number, y: number);
-
-  /**
-   * Get width of the Cloud. Default value is 200
-   */
-  getWidth(): number;
-
-  /**
-   * Set width of the Cloud
-   *
-   * @param w - value of width. Default value is 200
-   */
-  setWidth(w: number);
-
-  /**
-   * Get height of the Cloud. Default value is 200
-   */
-  getHeigth(): number;
-
-  /**
-   * Set height of the Cloud
-   *
-   * @param h - value of height. Default value is 200
-   */
-  setHeight(h: number);
-
-  /**
-   * Get line width of the Cloud. Defailt value is 4
-   */
-  getLineWidth(): number;
-
-  /**
-   * Set line width of the Cloud
-   *
-   * @param size - value of width. Defailt value is 4
-   */
-  setLineWidth(size: number);
-}

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

@@ -1,39 +0,0 @@
-///////////////////////////////////////////////////////////////////////////////
-// 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.
-///////////////////////////////////////////////////////////////////////////////
-
-/**
- * Markup Colorable
- */
-export interface IMarkupColorable {
-  /**
-   * Get color of the Markup instance
-   */
-  getColor(): string;
-
-  /**
-   * Set color of the Markup instance
-   *
-   * @param hex - color in #hex format. Default: `#ff0000`
-   */
-  setColor(hex: string): void;
-}