@inweb/markup 25.7.4

package/src/markup/IMarkupObject.ts

@@ -0,0 +1,78 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 object
+ */
+export interface IMarkupObject {
+  /**
+   * Link to Library object (Konva, VisualizeJS)
+   */
+  ref(): any;
+
+  /**
+   * Get an internal identificator of the object. Not unique
+   */
+  id(): string;
+
+  /**
+   * Set Mouse editing feature
+   *
+   * @param value true / false
+   */
+  enableMouseEditing(value: boolean);
+
+  /**
+   * Get type of the Markup object
+   */
+  type(): string;
+
+  /**
+   * Get rotation of the Markup object
+   */
+  getRotation(): number;
+
+  /**
+   * Set rotation of the Markup object
+   *
+   * @param degrees number of degress to rotate
+   */
+  setRotation(degrees: number): void;
+
+  /**
+   * Get Z-Index of the Markup object
+   */
+  getZIndex(): number;
+
+  /**
+   * Set Z-Index of the Markup object
+   *
+   * @param zIndex integer value of Z-Index
+   */
+  setZIndex(zIndex: number): void;
+
+  /**
+   * Delete current Markup object
+   */
+  delete(): void;
+}

package/src/markup/IMarkupRectangle.ts

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

package/src/markup/IMarkupText.ts

@@ -0,0 +1,66 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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";
+
+/**
+ * Text Markup object
+ */
+export interface IMarkupText extends IMarkupObject {
+  /**
+   * Get Text value
+   */
+  getText(): string;
+
+  /**
+   * Set Text value
+   *
+   * @param text - string value
+   */
+  setText(text: string): void;
+
+  /**
+   * Get position of the Text
+   */
+  getPosition(): { x: number; y: number };
+
+  /**
+   * Set position of the Text
+   *
+   * @param x - value of X coordinate
+   * @param y - value of Y coordinate
+   */
+  setPosition(x: number, y: number);
+
+  /**
+   * Get font size. Default value is 34
+   */
+  getFontSize();
+
+  /**
+   * Set font size. Default value is 34
+   *
+   * @param size
+   */
+  setFontSize(size: number);
+}

package/src/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 };
+}

package/src/markup/Konva/KonvaArrow.ts

@@ -0,0 +1,147 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 Konva from "konva";
+import { IMarkupArrow } from "../IMarkupArrow";
+import { IMarkupColorable } from "../IMarkupColorable";
+
+export class KonvaArrow implements IMarkupArrow, IMarkupColorable {
+  private _ref: Konva.Arrow;
+
+  constructor(
+    params: {
+      start: { x: number; y: number };
+      end: { x: number; y: number };
+      color?: string;
+      id?: string;
+    },
+    ref = null
+  ) {
+    if (ref) {
+      this._ref = ref;
+      return;
+    }
+
+    if (!params.start || !params.end) return;
+
+    this._ref = new Konva.Arrow({
+      stroke: params.color ?? "#ff0000",
+      fill: params.color ?? "#ff0000",
+      strokeWidth: 4,
+      globalCompositeOperation: "source-over",
+      lineCap: "round",
+      lineJoin: "round",
+      points: [params.start.x, params.start.y, params.end.x, params.end.y],
+      draggable: true,
+      strokeScaleEnabled: false,
+    });
+
+    this._ref.on("transform", (e) => {
+      const attrs = e.target.attrs;
+
+      if (attrs.rotation !== this._ref.rotation()) this._ref.rotation(attrs.rotation);
+    });
+
+    this._ref.id(this._ref._id.toString());
+  }
+
+  ref() {
+    return this._ref;
+  }
+
+  id(): string {
+    return this._ref.id();
+  }
+
+  enableMouseEditing(value: boolean) {
+    this._ref.draggable(value);
+  }
+
+  type(): string {
+    return "arrow";
+  }
+
+  getColor(): string {
+    return this._ref.stroke() as string;
+  }
+
+  setColor(hex: string) {
+    this._ref.stroke(hex);
+    this._ref.fill(hex);
+  }
+
+  getRotation(): number {
+    return this._ref.rotation();
+  }
+
+  setRotation(degrees: number): void {
+    this._ref.rotation(degrees);
+  }
+
+  getZIndex(): number {
+    return this._ref.zIndex();
+  }
+
+  setZIndex(zIndex: number): void {
+    this._ref.zIndex(zIndex);
+  }
+
+  delete() {
+    this._ref.destroy();
+    this._ref = null;
+  }
+
+  getPoints(): { x: number; y: number }[] {
+    const points = this._ref.points();
+    return [
+      { x: points[0], y: points[1] },
+      { x: points[2], y: points[3] },
+    ];
+  }
+
+  setPoints(points: { x: number; y: number }[]) {
+    if (points.length === 2) {
+      this._ref.points([points[0].x, points[0].y, points[1].x, points[1].y]);
+    }
+  }
+
+  getStartPoint(): { x: number; y: number } {
+    const points = this._ref.points();
+    return { x: points[0], y: points[1] };
+  }
+
+  setStartPoint(x: number, y: number) {
+    const points = this._ref.points();
+    this._ref.points([x, y, points[2], points[3]]);
+  }
+
+  getEndPoint(): { x: number; y: number } {
+    const points = this._ref.points();
+    return { x: points[2], y: points[3] };
+  }
+
+  setEndPoint(x: number, y: number) {
+    const points = this._ref.points();
+    this._ref.points([points[0], points[1], x, y]);
+  }
+}

package/src/markup/Konva/KonvaCloud.ts

@@ -0,0 +1,213 @@
+import Konva from "konva";
+import { IMarkupColorable } from "../IMarkupColorable";
+import { IMarkupCloud } from "../IMarkupCloud";
+
+export class KonvaCloud implements IMarkupCloud, IMarkupColorable {
+  private _ref: Konva.Shape;
+
+  constructor(
+    params: {
+      position: { x: number; y: number };
+      width?: number;
+      height?: number;
+      lineWidth?: number;
+      color?: string;
+      id?: string;
+    },
+    ref = null
+  ) {
+    if (ref) {
+      this._ref = ref;
+      return;
+    }
+
+    if (!params.position || !params.width || !params.height) return;
+
+    const arcRadius = 16;
+
+    this._ref = new Konva.Shape({
+      x: params.position.x,
+      y: params.position.y,
+      width: params.width ?? 200,
+      height: params.height ?? 200,
+      stroke: params.color ?? "#ff0000",
+      strokeWidth: params.lineWidth ?? 4,
+      draggable: true,
+      strokeScaleEnabled: false,
+      globalCompositeOperation: "source-over",
+      sceneFunc: (context, shape) => {
+        function calculateMidpoint(position, width, height) {
+          const midX = position.x + width / 2;
+          const midY = position.y + height / 2;
+          return { x: midX, y: midY };
+        }
+
+        const points = [
+          { x: 0, y: 0 },
+          { x: 0 + this._ref.width(), y: 0 },
+          { x: 0 + this._ref.width(), y: 0 + this._ref.height() },
+          { x: 0, y: 0 + this._ref.height() },
+          { x: 0, y: 0 },
+        ];
+
+        const midPoint = calculateMidpoint({ x: 0, y: 0 }, this._ref.width(), this._ref.height());
+
+        const baseArcLength = 30;
+        context.beginPath();
+        for (let iPoint = 0; iPoint < points.length - 1; iPoint++) {
+          let approxArcLength = baseArcLength;
+          const dx = points[iPoint + 1].x - points[iPoint].x;
+          const dy = points[iPoint + 1].y - points[iPoint].y;
+          const length = Math.sqrt(dx * dx + dy * dy);
+
+          const arcCount = Math.floor(length / approxArcLength);
+          const lengthMod = length % approxArcLength;
+          approxArcLength = baseArcLength + arcCount / lengthMod;
+
+          let pX = points[iPoint].x + dx / arcCount / 2;
+          let pY = points[iPoint].y + dy / arcCount / 2;
+          const pEndX = points[iPoint + 1].x;
+          const pEndY = points[iPoint + 1].y;
+          const endAngle = Math.atan((pEndY - pY) / (pEndX - pX));
+          const startAngle = endAngle + Math.PI;
+          const counterClockwise = pX > midPoint.x && pY > midPoint.y;
+          for (let iArc = 0; iArc < arcCount; iArc++) {
+            if (counterClockwise) {
+              context.arc(pX, pY, arcRadius, endAngle, startAngle);
+            } else {
+              context.arc(pX, pY, arcRadius, startAngle, endAngle);
+            }
+
+            pX += dx / arcCount;
+            pY += dy / arcCount;
+          }
+        }
+
+        context.closePath();
+        // (!) Konva specific method, it is very important
+        // it will apply are required styles
+        context.fillStrokeShape(shape);
+      },
+    });
+
+    this._ref.className = "Cloud";
+
+    this._ref.on("transform", (e) => {
+      const attrs = e.target.attrs;
+
+      if (attrs.rotation !== this._ref.rotation()) this._ref.rotation(attrs.rotation);
+
+      const scaleByX = Math.abs(attrs.scaleX - 1) > 10e-6;
+      const scaleByY = Math.abs(attrs.scaleY - 1) > 10e-6;
+
+      let newWidth = this._ref.width();
+      if (scaleByX) newWidth *= attrs.scaleX;
+      let newHeight = this._ref.height();
+      if (scaleByY) newHeight *= attrs.scaleY;
+
+      const minWidth = 100;
+      const minHeight = 100;
+
+      if (newWidth < minWidth) newWidth = minWidth;
+      if (newHeight < minHeight) newHeight = minHeight;
+
+      if (scaleByX) {
+        this._ref.width(newWidth);
+      }
+
+      if (scaleByY) {
+        this._ref.height(newHeight);
+      }
+
+      this._ref.scale({ x: 1, y: 1 });
+    });
+
+    this._ref.getSelfRect = () => {
+      return {
+        x: 0 - arcRadius,
+        y: 0 - arcRadius,
+        width: this._ref.width() + 2 * arcRadius,
+        height: this._ref.height() + 2 * arcRadius,
+      };
+    };
+
+    this._ref.id(this._ref._id.toString());
+  }
+
+  ref() {
+    return this._ref;
+  }
+
+  id(): string {
+    return this._ref.id();
+  }
+
+  enableMouseEditing(value: boolean) {
+    this._ref.draggable(value);
+  }
+
+  type(): string {
+    return "cloud";
+  }
+
+  getColor(): string {
+    return this._ref.stroke() as string;
+  }
+
+  setColor(hex: string) {
+    this._ref.stroke(hex);
+  }
+
+  getRotation(): number {
+    return this._ref.rotation();
+  }
+
+  setRotation(degrees: number): void {
+    this._ref.rotation(degrees);
+  }
+
+  getZIndex(): number {
+    return this._ref.zIndex();
+  }
+
+  setZIndex(zIndex: number): void {
+    this._ref.zIndex(zIndex);
+  }
+
+  delete() {
+    this._ref.destroy();
+    this._ref = null;
+  }
+
+  getPosition() {
+    return this._ref.position();
+  }
+
+  setPosition(x: number, y: number) {
+    this._ref.position({ x, y });
+  }
+
+  getWidth(): number {
+    return this._ref.width();
+  }
+
+  setWidth(w: number) {
+    this._ref.width(w);
+  }
+
+  getHeigth(): number {
+    return this._ref.height();
+  }
+
+  setHeight(h: number) {
+    this._ref.height(h);
+  }
+
+  getLineWidth(): number {
+    return this._ref.strokeWidth();
+  }
+
+  setLineWidth(size: number) {
+    this._ref.strokeWidth(size);
+  }
+}