dxfview 0.0.2

package/dist/types/core/markup/TextMarkup.d.ts

@@ -0,0 +1,40 @@
+import * as THREE from "three";
+import { BaseMarkup } from "./BaseMarkup";
+import type { MarkupManager } from "./MarkupManager";
+import { DrawableData } from "../../core/canvas";
+import { MarkupType } from "../../core/markup/Constants";
+export interface TextShape extends DrawableData {
+    text: string;
+    fontSize: number;
+}
+export declare class TextMarkup extends BaseMarkup {
+    text: string;
+    fontSize: number;
+    type: MarkupType;
+    protected padding: number;
+    static readonly DEFAULT_INPUT_WIDTH = 50;
+    protected manager?: MarkupManager;
+    protected textInput?: HTMLTextAreaElement;
+    protected inputStatus: string;
+    isEditing: boolean;
+    constructor(id: string, points: THREE.Vector3[], text: string);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    protected drawText(ctx: CanvasRenderingContext2D, camera: THREE.Camera, text: string): void;
+    setFontSize(fontSize: number): void;
+    update(points: THREE.Vector3[]): this;
+    setData(data: TextShape): void;
+    updateText(text: string): void;
+    getData(): TextShape;
+    getClassType(): string;
+    addInput(manager: MarkupManager, x?: number, y?: number): void;
+    addInputEvents(): void;
+    handleClick: () => void;
+    handleKeydown: (e: KeyboardEvent) => void;
+    handleInput: () => void;
+    handleCompositionStart: () => void;
+    handleCompositionEnd: () => void;
+    handleBlur: () => void;
+    handleFoucs: () => void;
+    enterEditing(): void;
+    exitEditing(): void;
+}

package/dist/types/core/markup/XMarkup.d.ts

@@ -0,0 +1,10 @@
+import * as THREE from "three";
+import { BaseMarkup } from "../../core/markup/BaseMarkup";
+import { MarkupType } from "../../core/markup/Constants";
+export declare class XMarkup extends BaseMarkup {
+    type: MarkupType;
+    constructor(id: string, points: THREE.Vector3[]);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    isPointInPath(p: THREE.Vector3): boolean;
+    getClassType(): string;
+}

package/dist/types/core/markup/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./ArrowMarkup";
+export * from "./CircleMarkup";
+export * from "./CloudLineMarkup";
+export * from "./CloudRectMarkup";
+export * from "./DotMarkup";
+export * from "./EllipseMarkup";
+export * from "./LeaderLineMarkup";
+export * from "./PolylineMarkup";
+export * from "./RectMarkup";
+export * from "./TextMarkup";
+export * from "./XMarkup";
+export * from "./MarkupManager";
+export * from "./Constants";

package/dist/types/core/model/Constants.d.ts

@@ -0,0 +1,51 @@
+import * as THREE from "three";
+import type { DxfData } from "../../core/dxf";
+import type { PdfData } from "../../core/viewers";
+/**
+ * Loaded 3d model info for BimViewer.
+ */
+export interface ModelData3d {
+    /**
+     * modelId that is unique for loaded models
+     */
+    modelId: string;
+    /**
+     * Three.js object.
+     */
+    object: THREE.Object3D;
+    /**
+     * Bounding box of the model.
+     */
+    bbox?: THREE.Box3;
+    /**
+     * Edge objects of the model.
+     */
+    edges?: THREE.LineSegments[];
+    /**
+     * TilesRenderer for 3dTiles
+     * @internal
+     */
+    tilesRenderer?: any;
+}
+/**
+ * Loaded 2d model info for DxfViewer.
+ */
+export interface ModelData2d {
+    /**
+     * modelId that is unique for loaded models
+     */
+    modelId: string;
+    /**
+     * Used for dxf data.
+     */
+    dxfData?: DxfData;
+    /**
+     * Used for pdf data.
+     */
+    pdfData?: PdfData;
+    /**
+     * Model space transform matrix.
+     * @internal
+     */
+    msTransformMatrix?: THREE.Matrix4;
+}

package/dist/types/core/model/Model.d.ts

@@ -0,0 +1,18 @@
+import * as THREE from "three";
+/**
+ * Base model class.
+ */
+export declare abstract class Model {
+    /**
+     * The model id, it should be unique in the lifecycle of a viewer.
+     */
+    abstract modelId: string;
+    /**
+     * Gets the THREE.Object3D of this model.
+     */
+    abstract getModelObject(): THREE.Object3D;
+    /**
+     * Gets the bounding box of this model.
+     */
+    abstract getBBox(): THREE.Box3;
+}

package/dist/types/core/model/Model2d.d.ts

@@ -0,0 +1,115 @@
+import * as THREE from "three";
+import { ModelData2d } from "./Constants";
+import { Units } from "../../core/Units";
+import { DxfData } from "../../core/dxf";
+import { ILayer, ILayoutObject, IPoint, IViewport, IViewportEntity } from "../../core/dxf-parser";
+import { Model } from "../../core/model/Model";
+import type { PdfData, PdfLayer } from "../../core/viewers/DxfViewer";
+/**
+ * Loaded 2d model info for DxfViewer.
+ */
+export declare class Model2d extends Model {
+    modelId: string;
+    private modelData;
+    private bbox?;
+    constructor(modelData: ModelData2d);
+    get pdfData(): PdfData | undefined;
+    get dxfData(): DxfData | undefined;
+    /**
+     * @internal
+     */
+    get msTransformMatrix(): THREE.Matrix4 | undefined;
+    /**
+     * @internal
+     */
+    set msTransformMatrix(matrix: THREE.Matrix4 | undefined);
+    /**
+     * @internal
+     */
+    get loadedEntityCount(): number;
+    /**
+     * Gets dxf data header.
+     */
+    get header(): Record<string, number | IPoint> | undefined;
+    /**
+     * Gets dxf data viewports.
+     */
+    get viewports(): IViewport[] | undefined;
+    /**
+     * Gets layers.
+     */
+    get layers(): Record<string, ILayer | PdfLayer> | undefined;
+    /**
+     * Gets dxf data layoutViewportsMap.
+     * @internal
+     */
+    get layoutViewportsMap(): Record<string, IViewportEntity[]> | undefined;
+    /**
+     * Gets three.js object of the model.
+     */
+    getModelObject(): THREE.Object3D;
+    /**
+     * Gets model bounding box.
+     */
+    getBBox(): THREE.Box3;
+    /**
+     * Gets dxf units.
+     * @internal
+     */
+    getUnits(): Units;
+    /**
+     * Gets dxf model space extent.
+     * @internal
+     */
+    getModelSpaceExtent(): THREE.Box3 | undefined;
+    /**
+     * Gets layer by layer name.
+     */
+    getLayer(layerName: string): ILayer | PdfLayer | undefined;
+    /**
+     * Gets layer object and three.js object by layer name.
+     */
+    getObjectsByLayer(layerName: string): THREE.Object3D[] | undefined;
+    /**
+     * Gets layout of dxf data.
+     */
+    getLayouts(): ILayoutObject[];
+    /**
+     * Gets layout extent of dxf data.
+     * @internal
+     */
+    getLayoutExtent(layout: ILayoutObject): THREE.Box3;
+    /**
+     * Gets layout viewports.
+     * @internal
+     */
+    getLayoutViewports(layout: ILayoutObject): IViewportEntity[];
+    /**
+     * Gets the layout level three.js object.
+     */
+    getLayoutLevelObject(layoutName: string): THREE.Object3D | undefined;
+    /**
+     * Sets model visibility.
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * Sets layer visibility.
+     */
+    setLayerVisible(layerName: string, visible: boolean, enableHideVisuallySmallObjects?: boolean, cameraZoom?: number): void;
+    /**
+     * Sets layer opacity.
+     */
+    setLayerOpacity(layerName: string, opacity: number): void;
+    /**
+     * Sets layer color.
+     */
+    setLayerColor(layerName: string, color: number): void;
+    /**
+     * Resets layer color.
+     */
+    resetLayerColor(layerName: string): void;
+    /**
+     * @internal
+     */
+    switchTransformMs(layoutName: string): void;
+}

package/dist/types/core/model/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Constants";
+export * from "./Model";
+export * from "./Model2d";

package/dist/types/core/patches/Constants.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export declare const MAX_RAYCAST_INTERSECTION_COUNT = 1;

package/dist/types/core/patches/Line.d.ts

@@ -0,0 +1,2 @@
+import { Line } from "three";
+export { Line };

package/dist/types/core/patches/Mesh.d.ts

@@ -0,0 +1,2 @@
+import { Mesh } from "three";
+export { Mesh };

package/dist/types/core/patches/Points.d.ts

@@ -0,0 +1,2 @@
+import { Points } from "three";
+export { Points };

package/dist/types/core/patches/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./Line";
+export * from "./Mesh";
+export * from "./Points";
+export * from "./SVGRenderer.js";

package/dist/types/core/undo-redo/AddAnnotationCommand.d.ts

@@ -0,0 +1,11 @@
+import { Command } from "./Command";
+import type { AnnotationPlugin } from "../../plugins/annotation/AnnotationPlugin";
+import type { AnnotationData } from "../../plugins/annotation/BaseAnnotationDrawable";
+export declare class AddAnnotationCommand extends Command {
+    private plugin;
+    private data;
+    constructor(plugin: AnnotationPlugin, data: AnnotationData);
+    execute(): void;
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/AddMarkupCommand.d.ts

@@ -0,0 +1,10 @@
+import { Command } from "./Command";
+import type { MarkupManager } from "../../core/markup";
+import type { MarkupData } from "../../core/viewers";
+export declare class AddMarkupCommand extends Command {
+    private manager;
+    private data;
+    constructor(manager: MarkupManager, data: MarkupData);
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/AddMeasurementCommand.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "./Command";
+import type { MeasurementPlugin, MeasurementData } from "../../plugins/measure";
+export declare class AddMeasurementCommand extends Command {
+    private manager;
+    private data;
+    constructor(manager: MeasurementPlugin, data: MeasurementData);
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/Command.d.ts

@@ -0,0 +1,6 @@
+export declare abstract class Command {
+    protected name: string;
+    constructor(name: string);
+    abstract undo(): boolean;
+    abstract redo(): boolean;
+}

package/dist/types/core/undo-redo/RemoveAnnotationCommand.d.ts

@@ -0,0 +1,11 @@
+import { Command } from "./Command";
+import type { AnnotationPlugin } from "../../plugins/annotation/AnnotationPlugin";
+import type { AnnotationData } from "../../plugins/annotation/BaseAnnotationDrawable";
+export declare class RemoveAnnotationCommand extends Command {
+    private plugin;
+    private data;
+    constructor(plugin: AnnotationPlugin, data: AnnotationData);
+    execute(): void;
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/RemoveMarkupCommand.d.ts

@@ -0,0 +1,10 @@
+import { Command } from "./Command";
+import type { MarkupManager } from "../../core/markup";
+import type { MarkupData } from "../../core/viewers";
+export declare class RemoveMarkupCommand extends Command {
+    private manager;
+    private data;
+    constructor(manager: MarkupManager, data: MarkupData);
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/RemoveMeasurementCommand.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "./Command";
+import type { MeasurementPlugin, MeasurementData } from "../../plugins/measure";
+export declare class RemoveMeasurementCommand extends Command {
+    private manager;
+    private data;
+    constructor(manager: MeasurementPlugin, data: MeasurementData);
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/UndoRedoManager.d.ts

@@ -0,0 +1,21 @@
+import { Command } from "./Command";
+declare type CommandData = Command | Command[];
+export declare class UndoRedoManager {
+    private history;
+    private step;
+    private maxCount;
+    private isBatchCommand;
+    private batchCommands;
+    constructor(maxCount?: number);
+    addCommand(command: Command): void;
+    startTransaction(): void;
+    endTransaction(): void;
+    undo(): boolean;
+    redo(): boolean;
+    getCommands(): CommandData[];
+    canUndo(): boolean;
+    canRedo(): boolean;
+    clear(): void;
+    destroy(): void;
+}
+export {};

package/dist/types/core/undo-redo/UpdateMarkupCommand.d.ts

@@ -0,0 +1,11 @@
+import { Command } from "./Command";
+import type { MarkupManager } from "../../core/markup";
+import type { MarkupData } from "../../core/viewers";
+export declare class UpdateMarkupCommand extends Command {
+    private manager;
+    private oldData;
+    private newData;
+    constructor(manager: MarkupManager, oldData: MarkupData, newData: MarkupData);
+    undo(): boolean;
+    redo(): boolean;
+}

package/dist/types/core/undo-redo/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./UndoRedoManager";
+export * from "./Command";
+export * from "./AddMarkupCommand";
+export * from "./UpdateMarkupCommand";
+export * from "./RemoveMarkupCommand";
+export * from "./AddMeasurementCommand";
+export * from "./RemoveMeasurementCommand";
+export * from "./AddAnnotationCommand";
+export * from "./RemoveAnnotationCommand";

package/dist/types/core/utils/CSS2DObjectUtils.d.ts

@@ -0,0 +1,14 @@
+import { CSS2DObject } from "three/examples/jsm/renderers/CSS2DRenderer.js";
+export declare class CSS2DObjectUtils {
+    /**
+     * Creates CSS2DObject with HTMLElement
+     */
+    static createCSS2DObject(element: HTMLElement): CSS2DObject;
+    static createDefaultHotpoint(size?: number): CSS2DObject;
+    static createHotpoint(html?: string): CSS2DObject;
+    static createLabel(label: string, cssClass?: string): CSS2DObject;
+    /**
+     * Recursively find "dataset.objectId" of a HTMLElement
+     */
+    static tryFindObjectId(element: HTMLElement): number | undefined;
+}

package/dist/types/core/utils/ColorUtils.d.ts

@@ -0,0 +1,21 @@
+export declare class ColorUtils {
+    static color2rgba(style: string): [number, number, number, number];
+    static rgba2Color(rgba: number[]): string;
+    /**
+     * Converts color string in format "rgba(255, 255, 255, 1)" to rgba number array.
+     */
+    static colorStr2Rgba(colorStr: string): number[];
+    /**
+     * Converts rgb or rgba to hex number.
+     * @param rgba Color value is between 0 and 1.
+     */
+    static rgb2Hex(rgba: number[]): number;
+    /**
+     * Maps a value between 0 and 1 to 0 and 255.
+     */
+    private static to255;
+    /**
+     * Maps a value between 0 and 255 to 0 and 1.
+     */
+    private static to1;
+}

package/dist/types/core/utils/CommonUtils.d.ts

@@ -0,0 +1,125 @@
+import * as THREE from "three";
+import { IconClass } from "../Configs";
+/**
+ * @internal
+ */
+export declare class CommonUtils {
+    /**
+     * Checks full screen mode
+     */
+    static isFullScreen(): boolean;
+    /**
+     * Enters full screen mode
+     */
+    static fullScreen(element?: HTMLElement): void;
+    /**
+     * Exits full screen mode
+     */
+    static exitFullscreen(): void;
+    /**
+     * Displays a pointer marker in a period of time.
+     * @param duration display time in ms. 0/null/undefined means always display.
+     */
+    /**
+     * Join strings
+     * @param args
+     * @returns
+     */
+    static joinStrings(...args: string[]): string;
+    /**
+     * Converts a number to a string with proper fraction digits
+     */
+    static numberToString(num: number): string;
+    static hexToBase64(hexstring: string): string;
+    /**
+     * Converts vector to a string with proper fraction digits
+     */
+    static vectorToString(vec: THREE.Vector2 | THREE.Vector3): string;
+    /**
+     * Converts number array to THREE.Vector2
+     */
+    static arrayToVector2(arr: number[] | THREE.Vector2 | undefined): THREE.Vector2 | undefined;
+    /**
+     * Converts number array to THREE.Vector3
+     * If length of arr is 2, will assign z value to 0
+     */
+    static arrayToVector3(arr: number[] | THREE.Vector3 | undefined): THREE.Vector3 | undefined;
+    /**
+     * Converts number array to THREE.Euler
+     */
+    static arrayToEuler(arr: number[] | THREE.Euler | undefined): THREE.Euler | undefined;
+    /**
+     * Converts number array to THREE.Vector3
+     */
+    static arrayOrObjectToVector3(arrOrObj: number[] | THREE.Vector3 | undefined): THREE.Vector3 | undefined;
+    static isVectorValid(vec: THREE.Vector2 | THREE.Vector3): boolean;
+    static isBoxValid(box: THREE.Box2 | THREE.Box3): boolean;
+    static isMatrixValid(matrix: THREE.Matrix4): boolean;
+    static guid(): string;
+    /**
+     * Expands given box by a scale factor
+     */
+    static expandBoxByScale(box: THREE.Box3, scale: number): void;
+    /**
+     * Expands given box by a min size
+     */
+    static expandBoxByMinSize(box: THREE.Box3, minSize: number): void;
+    /**
+     * Generate random integers in the range [min, max]
+     */
+    static generateRandomInt(min: number, max: number): number;
+    /**
+     * Round to N decimal places
+     */
+    static roundNumber(value: number, n: number): number;
+    static convertDecimalToHex(decimal: number | string): string;
+    static canvasToImage(canvas: HTMLCanvasElement): Promise<HTMLImageElement>;
+    /**
+     * Takes screenshot to given rendering context and return base64 string in png/jpeg format.
+     * @param bbox If valid, takes screenshot of a sub image with given bounding box in screen coordinate.
+     */
+    static renderingContextToImage(context: CanvasRenderingContext2D, bbox?: THREE.Box2, type?: string, quality?: number): string;
+    /**
+     * Prints memory usage
+     */
+    static printMemory(title: string): void;
+    static printGpuInfo(webgl: WebGLRenderingContext): void;
+    /**
+     * Sleep a while
+     */
+    static sleep(ms: number): Promise<void>;
+    private static twinklingObjectIds;
+    /**
+     * Twinkle the object several times
+     */
+    static twinkle(obj: THREE.Object3D, ms?: number): Promise<void>;
+    /**
+     * Gets a function to update progress.
+     * @param onProgress onProgress callback.
+     */
+    static getUpdateProgressFunc(onProgress?: (e: ProgressEvent) => void): (progress: number) => void;
+    /**
+     * Gets an async function to update progress.
+     * The reason to use async function is, in order to give UI thread chance to update the progress!
+     * @param onProgress onProgress callback.
+     */
+    static getUpdateProgressFuncAsync(onProgress?: (e: ProgressEvent) => void): (progress: number) => Promise<void>;
+    /**
+     * Gets an async function to update progress for a for/while loop.
+     * @param total Total number of a for/while loop.
+     * @param onProgress onProgress callback.
+     */
+    static getUpdateProgressFuncForLoop(total: number, onProgress?: (e: ProgressEvent) => void): (i: number) => Promise<void>;
+    /**
+     * Gets a function to update sub progress, which has a progress range limitation according to its parent progress.
+     * @param min Min range number between 0-100
+     * @param max Max range number between 0-100
+     * @param onProgress onProgress callback.
+     * @returns
+     */
+    static getUpdateSubProgressFunc(min: number, max: number, onProgress?: (e: ProgressEvent) => void): (e: ProgressEvent) => void;
+}
+/**
+ * @internal
+ */
+export declare const setIcon: (classList: DOMTokenList, iconClass: IconClass, active: boolean) => void;

package/dist/types/core/utils/CoordinateUtils.d.ts

@@ -0,0 +1,81 @@
+import * as THREE from "three";
+import type { EventInfo, IPointerEvent } from "../../core/input/InputManager";
+/**
+ * @internal
+ * Some concepts:
+ *
+ * 1. Screen coordinate:
+ * (0, 0)
+ * ----------------------> x
+ * |                   |
+ * |                   |
+ * |                   |
+ * |                   |
+ * |___________________|
+ * y                   (1024, 768) e.g.
+ *
+ * 2. Normalized screen coordinate:
+ * (0, 0)
+ * ----------------------> x
+ * |                   |
+ * |                   |
+ * |                   |
+ * |                   |
+ * |___________________|
+ * y                   (1, 1)
+ *
+ * 3. NDC: Normalized Device Coordinates
+ *             ^ y       (1, 1)
+ *             |
+ * (-1, 0)     |(0, 0)   (1, 0)
+ * ----------------------> x
+ *             |
+ *             |
+ * (-1, -1)
+ *
+ * 4. World Coordinates
+ *      ^ y
+ *      |
+ *      |     / x
+ *      |   /
+ *      | /
+ * ---------------> z
+ *   (0, 0)
+ */
+export declare class CoordinateUtils {
+    /**
+     * Gets screen coordinate by pointer event.
+     */
+    static getScreenCoordinateByEvent(event: IPointerEvent | EventInfo | MouseEvent | PointerEvent, container: HTMLElement): THREE.Vector2;
+    /**
+     * Gets screen coordinate by touch event.
+     */
+    static getScreenCoordinateByTouchEvent(event: TouchEvent, container: HTMLElement): THREE.Vector2;
+    /**
+     * Converts world to screen coordinate.
+     */
+    static world2Screen(vector: THREE.Vector3, camera: THREE.Camera, container: HTMLElement): THREE.Vector2;
+    /**
+     * Converts a bbox under world coordinate to screen coordinate.
+     */
+    static worldBBox2Screen(bbox: THREE.Box3, camera: THREE.Camera, container: HTMLElement): THREE.Box2;
+    /**
+     * Converts screen to world coordinate.
+     */
+    static screen2World(vector: THREE.Vector2, camera: THREE.Camera, container: HTMLElement): THREE.Vector3;
+    /**
+     * Converts screen point to NDC coordinate.
+     * @description {en} Normalized screen coordinate: bottom-left(-1, -1), top-right(1, 1).
+     * @description {zh} 标准化屏幕坐标：左下角(-1, -1), 右上角(1, 1)。
+     * @description {en} World coordinate to normalized screen coordinate(0-1).
+     * @description {zh} 世界坐标转标准化屏幕坐标（0-1）。
+     */
+    static screen2Ndc(vector: THREE.Vector2, camera: THREE.Camera, container: HTMLElement): THREE.Vector2;
+    /**
+     * @description {en} Normalized screen coordinate: top-left(0, 0), bottom-right(1, 1).
+     * @description {zh} 标准化屏幕坐标：左上角(0, 0), 右下角(1, 1)。
+     * @description {en} World coordinate to normalized screen coordinate(0-1).
+     * @description {zh} 世界坐标转标准化屏幕坐标（0-1）。
+     */
+    static world2NormalizedScreen(worldCoord: THREE.Vector2 | THREE.Vector3, camera: THREE.Camera, container: HTMLElement): THREE.Vector2;
+}

package/dist/types/core/utils/DecimalPrecisionUtils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export declare const showPrecisionValue: (value: number, precistionType: number) => string;

package/dist/types/core/utils/DeviceUtils.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Device util class
+ * @internal
+ */
+export declare class DeviceUtils {
+    /**
+     * Checks if it is opened in touch screen device, like iphone, ipad, etc.
+     */
+    static isTouchScreenDevice(): boolean;
+    static printDeviceInfo(): void;
+    static isMobile: boolean;
+    static creatReactNativeCanvas(context: WebGLRenderingContext | WebGL2RenderingContext | CanvasRenderingContext2D): HTMLCanvasElement;
+    static isBrowser: boolean;
+    static isNode: boolean;
+}