@inweb/client 25.3.3 → 25.3.5

package/lib/Viewer/IViewer.d.ts

@@ -5,6 +5,7 @@ import { Client } from "../Api/Client";
 import { File } from "../Api/File";
 import { Assembly } from "../Api/Assembly";
 import { Model } from "../Api/Model";
+import { IViewpoint } from "./Markup/IViewpoint";
 export interface IViewer extends IEventEmitter, ICommandService {
     client: Client | undefined;
     options: Options;
@@ -19,8 +20,8 @@ export interface IViewer extends IEventEmitter, ICommandService {
     setActiveDragger(name: string): any;
     resetActiveDragger(): void;
     is3D(): boolean;
-    drawViewpoint(viewpoint: object): void;
-    createViewpoint(): object;
+    drawViewpoint(viewpoint: IViewpoint): void;
+    createViewpoint(): IViewpoint;
     loadReferences(model: Model | File | Assembly): Promise<this>;
     open(model: Model | File | Assembly): Promise<this>;
     cancel(): this;

package/lib/Viewer/Markup/Api/IMarkupLine.d.ts

@@ -1,10 +1,4 @@
 import { IMarkupObject } from "./IMarkupObject";
-export declare enum LineType {
-    Unknown = 0,
-    Solid = "solid",
-    Dot = "dot",
-    Dash = "dash"
-}
 export interface IMarkupLine extends IMarkupObject {
     getPoints(): number[];
     getLineWidth(): number;

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

@@ -1,5 +1,6 @@
-import { IMarkupLine, LineType } from "../../IMarkupLine";
+import { IMarkupLine } from "../../IMarkupLine";
 import { IMarkupColorable } from "../../IMarkupColorable";
+import { LineType } from "../../../IViewpoint";
 export declare class KonvaLine implements IMarkupLine, IMarkupColorable {
     private _ref;
     constructor(params: {

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

@@ -1,6 +1,7 @@
 import { OdBaseDragger } from "../Draggers/Common/OdBaseDragger";
 import { Viewer } from "../Viewer";
 import { IMarkupObject } from "./Api/IMarkupObject";
+import { IViewpoint } from "./IViewpoint";
 export declare enum MarkupType {
     Unknown = 0,
     Konva = "Konva",
@@ -28,8 +29,8 @@ export interface IMarkup {
         b: number;
     };
     colorizeAllMarkup(r: number, g: number, b: number): void;
-    setViewpoint(viewpoint: object): void;
-    getViewpoint(): any;
+    setViewpoint(viewpoint: IViewpoint): void;
+    getViewpoint(): IViewpoint;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];

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

@@ -0,0 +1,130 @@
+export interface ILocation {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface IDirection {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface IPoint {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface IBitmap {
+    guid: string;
+    location: ILocation;
+    normal: IDirection;
+    up: IDirection;
+    height: number;
+}
+export interface IOrthogonalCamera {
+    view_point: IPoint;
+    direction: IDirection;
+    up_vector: IDirection;
+    field_width: number;
+    field_height: number;
+}
+export interface IClippingPlane {
+    location: ILocation;
+    direction: IDirection;
+}
+export interface IPerspectiveCamera {
+    view_point: IPoint;
+    direction: IDirection;
+    up_vector: IDirection;
+    field_of_view: number;
+}
+export declare enum LineType {
+    Unknown = 0,
+    Solid = "solid",
+    Dot = "dot",
+    Dash = "dash"
+}
+export interface ILine {
+    points: IPoint[];
+    color: string;
+    type: LineType;
+    width: number;
+    id: string;
+}
+export interface IText {
+    position: IPoint;
+    text: string;
+    angle: number;
+    text_size: number;
+    color: string;
+    id: string;
+    font_size: number;
+}
+export interface IArrow {
+    id: string;
+    start: IPoint;
+    end: IPoint;
+    color: string;
+}
+export interface ICloud {
+    id: string;
+    position: IPoint;
+    width: number;
+    height: number;
+    line_width: number;
+    color: string;
+}
+export interface IEllipse {
+    id: string;
+    position: IPoint;
+    radius: {
+        x: number;
+        y: number;
+    };
+    line_width: number;
+    color: string;
+}
+export interface IImage {
+    id: string;
+    position: IPoint;
+    src: string;
+    width: number;
+    height: number;
+}
+export interface IRectangle {
+    id: string;
+    position: IPoint;
+    width: number;
+    height: number;
+    line_width: number;
+    color: string;
+}
+export interface IColoring {
+    handle: string;
+    color: string;
+}
+export interface IEntity {
+    handle: string;
+}
+export interface IViewpoint {
+    bitmaps?: IBitmap[];
+    guid?: string;
+    file_id: string;
+    assembly_id?: string;
+    orthogonal_camera?: IOrthogonalCamera;
+    perspective_camera?: IPerspectiveCamera;
+    description?: string;
+    index?: number;
+    lines?: ILine[];
+    texts?: IText[];
+    clipping_planes?: IClippingPlane[];
+    selection?: IEntity[];
+    visibility?: IEntity[];
+    coloring?: IColoring[];
+    arrows?: IArrow[];
+    clouds?: ICloud[];
+    ellipses?: IEllipse[];
+    images?: IImage[];
+    rectangles?: IRectangle[];
+    custom_fields?: any;
+}
+//# sourceMappingURL=IViewpoint.d.ts.map

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

@@ -3,6 +3,7 @@ import { Viewer } from "../../../Viewer";
 import { ChangeActiveDraggerEvent, PanEvent } from "../../../ViewerEvents";
 import { OdBaseDragger } from "../../../Draggers/Common/OdBaseDragger";
 import { IMarkupObject } from "../../Api/IMarkupObject";
+import { IViewpoint } from "../../IViewpoint";
 export declare class KonvaMarkup implements IMarkup {
     private _isInitialized;
     private _viewer;
@@ -20,7 +21,6 @@ export declare class KonvaMarkup implements IMarkup {
     private _markupContainer;
     private _zIndex;
     private readonly _markupContainerName;
-    private readonly TEXT_FONT_FAMILY;
     lineWidth: number;
     initialize(viewer: Viewer, canvas: HTMLCanvasElement, canvasEvents?: string[]): void;
     dispose(): void;
@@ -37,8 +37,8 @@ export declare class KonvaMarkup implements IMarkup {
     };
     setMarkupColor(r: number, g: number, b: number): void;
     colorizeAllMarkup(r?: number, g?: number, b?: number): void;
-    setViewpoint(viewpoint: any): void;
-    getViewpoint(): object;
+    setViewpoint(viewpoint: IViewpoint): void;
+    getViewpoint(): IViewpoint;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];

package/lib/Viewer/Markup/Impl/Visualize/VisualizeMarkup.d.ts

@@ -2,6 +2,7 @@ import { IMarkup } from "../../IMarkup";
 import { Viewer } from "../../../Viewer";
 import { OdBaseDragger } from "../../../Draggers/Common/OdBaseDragger";
 import { IMarkupObject } from "../../Api/IMarkupObject";
+import { IViewpoint } from "../../IViewpoint";
 export declare class VisualizeMarkup implements IMarkup {
     private _viewer;
     protected _markupColor: {
@@ -21,14 +22,13 @@ export declare class VisualizeMarkup implements IMarkup {
     };
     setMarkupColor(r: number, g: number, b: number): void;
     colorizeAllMarkup(r?: number, g?: number, b?: number): void;
-    setViewpoint(viewpoint: any): void;
-    getViewpoint(): object;
+    setViewpoint(viewpoint: IViewpoint): void;
+    getViewpoint(): IViewpoint;
     getLayer(): any;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];
     selectObjects(objects: IMarkupObject[]): void;
     clearSelected(): void;
-    private getPoint3dFromArray;
 }
 //# sourceMappingURL=VisualizeMarkup.d.ts.map

package/lib/Viewer/Viewer.d.ts

@@ -9,6 +9,7 @@ import { Assembly } from "../Api/Assembly";
 import { Model } from "../Api/Model";
 import { Options, OptionsData } from "./Options";
 import { IMarkup, MarkupType } from "./Markup/IMarkup";
+import { IViewpoint } from "./Markup/IViewpoint";
 /**
  * The `Client.js` library class that provides methods to integrate with the
  * [VisualizeJS](https://cloud.opendesign.com/docs/index.html#/visualizejs) library.
@@ -334,13 +335,13 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
      *
      * @param viewpoint - Viewpoint.
      */
-    drawViewpoint(viewpoint: object): void;
+    drawViewpoint(viewpoint: IViewpoint): void;
     /**
      * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
      * {@link Model#saveViewpoint | Model.saveViewpoint()} or
      * {@link File#saveViewpoint | File.saveViewpoint()}.
      */
-    createViewpoint(): object;
+    createViewpoint(): IViewpoint;
     private getPoint3dFromArray;
     private getLogicalPoint3dAsArray;
     private getOrthogonalCameraSettings;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.3.3",
+  "version": "25.3.5",
   "description": "Client.js is a library for implementing BIM Project management applications.",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",

package/src/Viewer/IViewer.ts

@@ -28,6 +28,7 @@ import { Client } from "../Api/Client";
 import { File } from "../Api/File";
 import { Assembly } from "../Api/Assembly";
 import { Model } from "../Api/Model";
+import { IViewpoint } from "./Markup/IViewpoint";
 
 export interface IViewer extends IEventEmitter, ICommandService {
   client: Client | undefined;
@@ -48,8 +49,8 @@ export interface IViewer extends IEventEmitter, ICommandService {
 
   is3D(): boolean;
 
-  drawViewpoint(viewpoint: object): void;
-  createViewpoint(): object;
+  drawViewpoint(viewpoint: IViewpoint): void;
+  createViewpoint(): IViewpoint;
 
   loadReferences(model: Model | File | Assembly): Promise<this>;
   open(model: Model | File | Assembly): Promise<this>;

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

@@ -1,12 +1,5 @@
 import { IMarkupObject } from "./IMarkupObject";
 
-export enum LineType {
-  Unknown,
-  Solid = "solid",
-  Dot = "dot",
-  Dash = "dash",
-}
-
 export interface IMarkupLine extends IMarkupObject {
   getPoints(): number[];
 

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

@@ -1,6 +1,7 @@
 import Konva from "konva";
-import { IMarkupLine, LineType } from "../../IMarkupLine";
+import { IMarkupLine } from "../../IMarkupLine";
 import { IMarkupColorable } from "../../IMarkupColorable";
+import { LineType } from "../../../IViewpoint";
 
 const LineTypeSpecs = new Map<LineType, number[]>([
   [LineType.Solid, []],

package/src/Viewer/Markup/IMarkup.ts

@@ -1,6 +1,7 @@
 import { OdBaseDragger } from "../Draggers/Common/OdBaseDragger";
 import { Viewer } from "../Viewer";
 import { IMarkupObject } from "./Api/IMarkupObject";
+import { IViewpoint } from "./IViewpoint";
 
 export enum MarkupType {
   Unknown,
@@ -29,8 +30,8 @@ export interface IMarkup {
   setMarkupColor(r: number, g: number, b: number): void;
   getMarkupColor(): { r: number; g: number; b: number };
   colorizeAllMarkup(r: number, g: number, b: number): void;
-  setViewpoint(viewpoint: object): void;
-  getViewpoint(): any;
+  setViewpoint(viewpoint: IViewpoint): void;
+  getViewpoint(): IViewpoint;
 
   createObject(type: string, params: any): IMarkupObject;
   getObjects(): IMarkupObject[];

package/src/Viewer/Markup/IViewpoint.ts

@@ -0,0 +1,146 @@
+export interface ILocation {
+  x: number;
+  y: number;
+  z: number;
+}
+
+export interface IDirection {
+  x: number;
+  y: number;
+  z: number;
+}
+
+export interface IPoint {
+  x: number;
+  y: number;
+  z: number;
+}
+
+export interface IBitmap {
+  guid: string;
+  location: ILocation;
+  normal: IDirection;
+  up: IDirection;
+  height: number;
+}
+
+export interface IOrthogonalCamera {
+  view_point: IPoint;
+  direction: IDirection;
+  up_vector: IDirection;
+  field_width: number;
+  field_height: number;
+}
+
+export interface IClippingPlane {
+  location: ILocation;
+  direction: IDirection;
+}
+
+export interface IPerspectiveCamera {
+  view_point: IPoint;
+  direction: IDirection;
+  up_vector: IDirection;
+  field_of_view: number;
+}
+
+export enum LineType {
+  Unknown,
+  Solid = "solid",
+  Dot = "dot",
+  Dash = "dash",
+}
+
+export interface ILine {
+  points: IPoint[];
+  color: string;
+  type: LineType;
+  width: number;
+  id: string;
+}
+
+export interface IText {
+  position: IPoint;
+  text: string;
+  angle: number;
+  text_size: number;
+  color: string;
+  id: string;
+  font_size: number;
+}
+
+export interface IArrow {
+  id: string;
+  start: IPoint;
+  end: IPoint;
+  color: string;
+}
+
+export interface ICloud {
+  id: string;
+  position: IPoint;
+  width: number;
+  height: number;
+  line_width: number;
+  color: string;
+}
+
+export interface IEllipse {
+  id: string;
+  position: IPoint;
+  radius: {
+    x: number;
+    y: number;
+  };
+  line_width: number;
+  color: string;
+}
+
+export interface IImage {
+  id: string;
+  position: IPoint;
+  src: string;
+  width: number;
+  height: number;
+}
+
+export interface IRectangle {
+  id: string;
+  position: IPoint;
+  width: number;
+  height: number;
+  line_width: number;
+  color: string;
+}
+
+export interface IColoring {
+  handle: string;
+  color: string;
+}
+
+export interface IEntity {
+  handle: string;
+}
+
+export interface IViewpoint {
+  bitmaps?: IBitmap[];
+  guid?: string;
+  file_id: string;
+  assembly_id?: string;
+  orthogonal_camera?: IOrthogonalCamera;
+  perspective_camera?: IPerspectiveCamera;
+  description?: string;
+  index?: number;
+  lines?: ILine[];
+  texts?: IText[];
+  clipping_planes?: IClippingPlane[];
+  selection?: IEntity[];
+  visibility?: IEntity[];
+  coloring?: IColoring[];
+  arrows?: IArrow[];
+  clouds?: ICloud[];
+  ellipses?: IEllipse[];
+  images?: IImage[];
+  rectangles?: IRectangle[];
+  custom_fields?: any;
+}

package/src/Viewer/Markup/Impl/Konva/KonvaMarkup.ts

@@ -7,13 +7,13 @@ import * as utils from "../../../Draggers/MeasureLineDragger/MeasureUtils";
 import { OdBaseDragger } from "../../../Draggers/Common/OdBaseDragger";
 import { IMarkupObject } from "../../Api/IMarkupObject";
 import { KonvaLine } from "../../Api/Impl/Konva/KonvaLine";
-import { LineType } from "../../Api/IMarkupLine";
 import { KonvaText } from "../../Api/Impl/Konva/KonvaText";
 import { KonvaRectangle } from "../../Api/Impl/Konva/KonvaRectangle";
 import { KonvaEllipse } from "../../Api/Impl/Konva/KonvaEllipse";
 import { KonvaArrow } from "../../Api/Impl/Konva/KonvaArrow";
 import { KonvaImage } from "../../Api/Impl/Konva/KonvaImage";
 import { KonvaCloud } from "../../Api/Impl/Konva/KonvaCloud";
+import { IViewpoint, LineType } from "../../IViewpoint";
 
 class KonvaShape {
   name: string;
@@ -106,7 +106,6 @@ export class KonvaMarkup implements IMarkup {
   private _zIndex = 1;
 
   private readonly _markupContainerName = "markupContainer";
-  private readonly TEXT_FONT_FAMILY = "Calibri";
 
   public lineWidth = 4;
 
@@ -236,15 +235,16 @@ export class KonvaMarkup implements IMarkup {
     this._konvaLayer.draw();
   }
 
-  setViewpoint(viewpoint: any): void {
+  setViewpoint(viewpoint: IViewpoint): void {
     const markupColor = viewpoint.custom_fields.markup_color || { r: 255, g: 0, b: 0 };
     this.setMarkupColor(markupColor.r, markupColor.g, markupColor.b);
 
     this.loadMarkup(viewpoint);
   }
 
-  getViewpoint(): object {
-    if (!this._viewer.visualizeJs) return {};
+  getViewpoint(): IViewpoint {
+    // TODO: at the current 25.2 state we need VisualizeJS here and below. In the future we need to use it as an external interface
+    if (!this._viewer.visualizeJs) return { file_id: "" };
 
     const viewpoint = {
       lines: [],
@@ -799,7 +799,7 @@ export class KonvaMarkup implements IMarkup {
     return clouds;
   }
 
-  private loadMarkup(viewpoint) {
+  private loadMarkup(viewpoint: IViewpoint) {
     viewpoint.lines?.forEach((vpLine) => {
       const linePoints = [];
       vpLine.points.forEach((point) => {

package/src/Viewer/Markup/Impl/Visualize/VisualizeMarkup.ts

@@ -4,6 +4,7 @@ import { OdBaseDragger } from "../../../Draggers/Common/OdBaseDragger";
 import { MARKUP_ENTITY_LINE, OdaLineDragger } from "../../../Draggers/OdaLineDragger";
 import { MARKUP_ENTITY_TEXT, OdaTextDragger } from "../../../Draggers/OdaTextDragger";
 import { IMarkupObject } from "../../Api/IMarkupObject";
+import { IViewpoint } from "../../IViewpoint";
 
 export class VisualizeMarkup implements IMarkup {
   private _viewer: Viewer;
@@ -66,7 +67,7 @@ export class VisualizeMarkup implements IMarkup {
     this._viewer.update();
   }
 
-  setViewpoint(viewpoint: any): void {
+  setViewpoint(viewpoint: IViewpoint): void {
     function getLogicalPoint3dAsArray(point3d) {
       return [point3d.x, point3d.y, point3d.z];
     }
@@ -127,12 +128,12 @@ export class VisualizeMarkup implements IMarkup {
     this._viewer.update();
   }
 
-  getViewpoint(): object {
+  getViewpoint(): IViewpoint {
     function getLogicalPoint3dFromArray(array) {
       return { x: array[0], y: array[1], z: array[2] };
     }
 
-    if (!this._viewer.visualizeJs) return {};
+    if (!this._viewer.visualizeJs) return { file_id: "" };
 
     const visLib = this._viewer.visLib();
     const visViewer = visLib.getViewer();
@@ -224,8 +225,4 @@ export class VisualizeMarkup implements IMarkup {
   clearSelected(): void {
     throw new Error("Not implemented yet");
   }
-
-  private getPoint3dFromArray(array) {
-    return { x: array[0], y: array[1], z: array[2] };
-  }
 }

package/src/Viewer/Viewer.ts

@@ -52,6 +52,7 @@ import { Options, OptionsData } from "./Options";
 import { LoaderFactory } from "./Loaders/LoaderFactory";
 import { MarkupFactory } from "./Markup/MarkupFactory";
 import { IMarkup, MarkupType } from "./Markup/IMarkup";
+import { IClippingPlane, IOrthogonalCamera, IViewpoint } from "./Markup/IViewpoint";
 
 const OVERLAY_VIEW_NAME = "$OVERLAY_VIEW_NAME";
 
@@ -1083,9 +1084,9 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
    *
    * @param viewpoint - Viewpoint.
    */
-  drawViewpoint(viewpoint: object): void {
-    this.setOrthogonalCameraSettings(viewpoint);
-    this.setClippingPlanes(viewpoint);
+  drawViewpoint(viewpoint: IViewpoint): void {
+    this.setOrthogonalCameraSettings(viewpoint.orthogonal_camera);
+    this.setClippingPlanes(viewpoint.clipping_planes);
     this.markup.setViewpoint(viewpoint);
   }
 
@@ -1094,7 +1095,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
    * {@link Model#saveViewpoint | Model.saveViewpoint()} or
    * {@link File#saveViewpoint | File.saveViewpoint()}.
    */
-  createViewpoint(): object {
+  createViewpoint(): IViewpoint {
     const vp = this.markup.getViewpoint();
     vp.orthogonal_camera = this.getOrthogonalCameraSettings();
     vp.clipping_planes = this.getClippingPlanes();
@@ -1110,7 +1111,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     return [point3d.x, point3d.y, point3d.z];
   }
 
-  private getOrthogonalCameraSettings(): object {
+  private getOrthogonalCameraSettings(): IOrthogonalCamera {
     const visViewer = this.visViewer();
     const activeView = visViewer.activeView;
 
@@ -1123,7 +1124,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     };
   }
 
-  private setOrthogonalCameraSettings(viewpoint) {
+  private setOrthogonalCameraSettings(settings: IOrthogonalCamera) {
     const visViewer = this.visViewer();
     const activeView = visViewer.activeView;
 
@@ -1131,13 +1132,13 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     this.clearSlices();
     this.clearOverlay();
 
-    if (viewpoint.orthogonal_camera) {
+    if (settings) {
       activeView.setView(
-        this.getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.view_point),
-        this.getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.direction),
-        this.getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.up_vector),
-        viewpoint.orthogonal_camera.field_width,
-        viewpoint.orthogonal_camera.field_height,
+        this.getLogicalPoint3dAsArray(settings.view_point),
+        this.getLogicalPoint3dAsArray(settings.direction),
+        this.getLogicalPoint3dAsArray(settings.up_vector),
+        settings.field_width,
+        settings.field_height,
         true
       );
     }
@@ -1145,7 +1146,7 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     this.syncOverlay();
   }
 
-  private getClippingPlanes(): object {
+  private getClippingPlanes(): IClippingPlane[] {
     const visViewer = this.visViewer();
     const activeView = visViewer.activeView;
 
@@ -1164,12 +1165,12 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     return clipping_planes;
   }
 
-  private setClippingPlanes(viewpoint) {
-    if (viewpoint.clipping_planes) {
+  private setClippingPlanes(clippingPlanes: IClippingPlane[]) {
+    if (clippingPlanes) {
       const visViewer = this.visViewer();
       const activeView = visViewer.activeView;
 
-      for (const plane of viewpoint.clipping_planes) {
+      for (const plane of clippingPlanes) {
         const cuttingPlane = new (this.visLib().OdTvPlane)();
         cuttingPlane.set(this.getLogicalPoint3dAsArray(plane.location), this.getLogicalPoint3dAsArray(plane.direction));