@x-viewer/plugins 0.9.0

package/dist/types/markups/undo/RemoveMarkupCommand.d.ts

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

package/dist/types/markups/undo/UpdateMarkupCommand.d.ts

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

package/dist/types/measurements/AngleMeasureDrawable.d.ts

@@ -0,0 +1,12 @@
+import { THREE } from "@x-viewer/core";
+import { BaseMeasureDrawable } from "./BaseMeasureDrawable";
+import { MeasurementType } from "./BaseMeasurement";
+export declare class AngleMeasureDrawable extends BaseMeasureDrawable {
+    type: MeasurementType;
+    constructor(id: string, points: THREE.Vector3[]);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawText(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    getAngleBisector(startPoint: THREE.Vector3, middlePoint: THREE.Vector3, endPoint: THREE.Vector3): THREE.Vector3;
+    calculateAngle(startPoint: THREE.Vector3, middlePoint: THREE.Vector3, endPoint: THREE.Vector3): number;
+    getClassType(): string;
+}

package/dist/types/measurements/AngleMeasurement.d.ts

@@ -0,0 +1,13 @@
+import { BaseViewer, DrawableList, type OSnapHelper, EventInfo, InputManager } from "@x-viewer/core";
+import { AngleMeasureDrawable } from "./AngleMeasureDrawable";
+import { BaseMeasurement } from "./BaseMeasurement";
+export declare class AngleMeasurement extends BaseMeasurement {
+    constructor(viewer: BaseViewer, input: InputManager, drawList: DrawableList, osnapHelper: OSnapHelper);
+    protected createMeasureDrawable(): AngleMeasureDrawable | undefined;
+    protected onMouseClick(e: EventInfo): void;
+    exitDrawing(): void;
+    protected complete(): void;
+    cancel(): void;
+    deactivate(): void;
+    protected setTooltipContent(): void;
+}

package/dist/types/measurements/AreaMeasureDrawable.d.ts

@@ -0,0 +1,14 @@
+import { THREE } from "@x-viewer/core";
+import { BaseMeasureDrawable } from "./BaseMeasureDrawable";
+import { MeasurementType } from "./BaseMeasurement";
+export declare class AreaMeasureDrawable extends BaseMeasureDrawable {
+    type: MeasurementType;
+    scale?: number;
+    constructor(id: string, points: THREE.Vector3[], scale?: number);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawText(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    calculateArea(points: THREE.Vector3[]): number;
+    getBarycenter(points: THREE.Vector3[]): THREE.Vector3;
+    isPointInPath(p: THREE.Vector3, raycaster?: THREE.Raycaster): boolean;
+    getClassType(): string;
+}

package/dist/types/measurements/AreaMeasurement.d.ts

@@ -0,0 +1,28 @@
+import { THREE } from "@x-viewer/core";
+import { type BaseViewer, EventInfo, InputManager, OSnapHelper, DrawableList } from "@x-viewer/core";
+import { AreaMeasureDrawable } from "./AreaMeasureDrawable";
+import { BaseMeasurement } from "./BaseMeasurement";
+export declare class AreaMeasurement extends BaseMeasurement {
+    /**
+     * The ratio of real world value and the value in three.js(pdf, a map, etc.).
+     */
+    private scale?;
+    constructor(viewer: BaseViewer, input: InputManager, drawList: DrawableList, osnapHelper: OSnapHelper);
+    activate(): void;
+    deactivate(): void;
+    protected createMeasureDrawable(): AreaMeasureDrawable | undefined;
+    protected onMouseMove(position: THREE.Vector3): void;
+    protected onMouseClick(e: EventInfo): void;
+    exitDrawing(): void;
+    protected complete(): void;
+    cancel(): void;
+    protected setTooltipContent(): void;
+    /**
+     * Gets the scale value.
+     */
+    getScale(): number | undefined;
+    /**
+     * Sets the scale value.
+     */
+    setScale(scale: number): void;
+}

package/dist/types/measurements/BaseMeasureDrawable.d.ts

@@ -0,0 +1,28 @@
+import { THREE, Drawable } from "@x-viewer/core";
+import { MeasurementType } from "./BaseMeasurement";
+import type { MeasurementData } from "./BaseMeasurement";
+export declare abstract class BaseMeasureDrawable extends Drawable {
+    type: MeasurementType;
+    static readonly MAJOR_COLOR = "rgba(249, 157, 11, 0.9)";
+    static readonly MINOR_COLOR = "rgb(255, 255, 255)";
+    static readonly AREA_FILL_COLOR = "rgba(249, 157, 11, 0.3)";
+    static readonly LINE_WIDTH = 2;
+    static readonly POINT_RADIUS = 5;
+    static readonly LABEL_FONT_SIZE = 14;
+    label?: string;
+    labelPositon?: THREE.Vector2;
+    labelBounds: THREE.Box2;
+    drawing: boolean;
+    constructor(id: string, points: THREE.Vector3[]);
+    setDrawingState(isDrawing: boolean): void;
+    drawSelect(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawPoints(ctx: CanvasRenderingContext2D, camera: THREE.Camera, points: THREE.Vector3[]): void;
+    drawText(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawRoundRect(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, radius: number): void;
+    getVertexes(): THREE.Vector3[];
+    update(points: THREE.Vector3[]): this;
+    getData(): MeasurementData;
+    setData(data: MeasurementData): void;
+    isPointInPath(p: THREE.Vector3, raycaster?: THREE.Raycaster): boolean;
+    getUnitString(): string;
+}

package/dist/types/measurements/BaseMeasurement.d.ts

@@ -0,0 +1,124 @@
+import { THREE, type BaseViewer, DrawableData, DrawableList, type MobileTouchHelperDrawable, type OSnapHelper, EventInfo, InputManager, Event } from "@x-viewer/core";
+import { Tooltip } from "@x-viewer/ui";
+import { type BaseMeasureDrawable } from "./BaseMeasureDrawable";
+/**
+ * Measurement type. e.g. distance measurement, area measurement, etc.
+ */
+export declare enum MeasurementType {
+    Distance = "Distance",
+    Area = "Area",
+    Angle = "Angle",
+    /**
+     * @internal
+     */
+    Coordinate = "Coordinate"
+}
+/**
+ * Serializable measurement data
+ */
+export type MeasurementData = DrawableData;
+/**
+ * Measurement events.
+ */
+type MeasurementEvents = {
+    /**
+     * Triggered when clicked on a measurement drawable.
+     */
+    onclick: BaseMeasureDrawable;
+    /**
+     * Triggered when a measurement is completed.
+     * At this time, user may continue to do another measurement.
+     */
+    complete: BaseMeasureDrawable;
+    /**
+     * Triggered when measurement is deactivated.
+     */
+    deactivate: MeasurementType;
+    /**
+     * Triggered when the first point is drawn.
+     * We need this event to unselect a selected drawable, etc.
+     */
+    firstpointpicked: BaseMeasureDrawable;
+    /**
+     * Triggered before a drawable is added.
+     */
+    beforeadd: BaseMeasureDrawable;
+    /**
+     * Triggered when a drawable is updated.
+     */
+    update: BaseMeasureDrawable;
+    /**
+     * Triggered before a drawable is removed.
+     */
+    beforeremove: BaseMeasureDrawable;
+};
+/**
+ * BaseMeasurement class
+ */
+export declare abstract class BaseMeasurement extends Event<MeasurementEvents> {
+    protected type: MeasurementType;
+    protected viewer: BaseViewer;
+    private inputManager;
+    protected drawList: DrawableList;
+    protected osnapHelper: OSnapHelper;
+    protected actived: boolean;
+    protected mouseMoved: boolean;
+    protected mouseDowned: boolean;
+    protected touchDowned: boolean;
+    protected lastMoveEvent?: EventInfo;
+    protected lastMouseDownPosition?: THREE.Vector3;
+    protected mouseDownPositionX: number;
+    protected mouseDownPositionY: number;
+    protected currentMeasureDrawable?: BaseMeasureDrawable;
+    protected drawingPoints?: THREE.Vector3[];
+    protected lastClickTime?: number;
+    protected tooltip?: Tooltip;
+    protected snapPoint?: THREE.Vector3 | undefined;
+    protected completed?: boolean;
+    protected clickedOnMeasurementDrawable?: BaseMeasureDrawable;
+    protected mobileTouchHelper?: MobileTouchHelperDrawable;
+    protected exitButton?: HTMLButtonElement;
+    protected firstPickedListener?: () => void;
+    protected completedListener?: () => void;
+    constructor(type: MeasurementType, viewer: BaseViewer, input: InputManager, drawList: DrawableList, osnapHelper: OSnapHelper);
+    get overlayRender(): import("@x-viewer/core").CanvasRender;
+    get renderer(): THREE.WebGLRenderer;
+    /**
+     * If measurement is active.
+     * Here let's use raycaster to identify whether this measurement is active.
+     */
+    get isActive(): boolean;
+    /**
+     * If it started to measure, but a measruement action is not completed yet.
+     */
+    get isMeasuring(): boolean;
+    setTouchHelper(mobileTouchHelper: MobileTouchHelperDrawable): void;
+    protected createMobileExitButton(): HTMLButtonElement;
+    activate(): void;
+    deactivate(): void;
+    protected removeDrawable(drawable: BaseMeasureDrawable): void;
+    clearClickedDrawable(): void;
+    touchstart: (e: EventInfo) => void;
+    touchmove: (e: EventInfo) => void;
+    touchend: (e: EventInfo) => void;
+    mousedown: (e: EventInfo) => void;
+    mousemove: (e: EventInfo) => void;
+    mouseup: (e: EventInfo) => void;
+    dblclick: () => void;
+    protected onMouseClick(e: EventInfo): void;
+    protected selectMeasurementByEvent(e: EventInfo): void;
+    keydown: (e: EventInfo) => void;
+    abstract exitDrawing(): void;
+    abstract cancel(): void;
+    protected abstract complete(): void;
+    protected abstract setTooltipContent(): void;
+    protected abstract createMeasureDrawable(): BaseMeasureDrawable | undefined;
+    protected onMouseMove(position: THREE.Vector3): void;
+    protected createOrUpdateMeasureDrawable(position?: THREE.Vector3): void;
+    /**
+     * The closest intersection
+     * @param e
+     */
+    getIntersections: (e: EventInfo) => THREE.Intersection[];
+}
+export {};

package/dist/types/measurements/CoordinateMeasureDrawable.d.ts

@@ -0,0 +1,10 @@
+import { THREE } from "@x-viewer/core";
+import { BaseMeasureDrawable } from "./BaseMeasureDrawable";
+import { MeasurementType } from "./BaseMeasurement";
+export declare class CoordinateMeasureDrawable extends BaseMeasureDrawable {
+    type: MeasurementType;
+    constructor(id: string, points: THREE.Vector3[]);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawText(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    getClassType(): string;
+}

package/dist/types/measurements/CoordinateMeasurement.d.ts

@@ -0,0 +1,12 @@
+import { type BaseViewer, DrawableList, OSnapHelper, EventInfo, InputManager } from "@x-viewer/core";
+import { BaseMeasurement } from "./BaseMeasurement";
+import { CoordinateMeasureDrawable } from "./CoordinateMeasureDrawable";
+export declare class CoordinateMeasurement extends BaseMeasurement {
+    constructor(viewer: BaseViewer, input: InputManager, drawList: DrawableList, osnapHelper: OSnapHelper);
+    protected createMeasureDrawable(): CoordinateMeasureDrawable | undefined;
+    protected onMouseClick(e: EventInfo): void;
+    exitDrawing(): void;
+    protected complete(): void;
+    cancel(): void;
+    protected setTooltipContent(): void;
+}

package/dist/types/measurements/DistanceMeasureDrawable.d.ts

@@ -0,0 +1,15 @@
+import { THREE } from "@x-viewer/core";
+import { BaseMeasureDrawable } from "./BaseMeasureDrawable";
+import { MeasurementType } from "./BaseMeasurement";
+export declare class DistanceMeasureDrawable extends BaseMeasureDrawable {
+    static readonly SHORT_LINE_LENGTH = 12;
+    scale?: number;
+    type: MeasurementType;
+    constructor(id: string, points: THREE.Vector3[], scale?: number);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawText(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    private drawVerticalLine;
+    private getShortLineBySegments;
+    getClassType(): string;
+    setScale(scale: number): void;
+}

package/dist/types/measurements/DistanceMeasurement.d.ts

@@ -0,0 +1,25 @@
+import { type BaseViewer, EventInfo, InputManager, OSnapHelper, DrawableList } from "@x-viewer/core";
+import { BaseMeasurement } from "./BaseMeasurement";
+import { DistanceMeasureDrawable } from "./DistanceMeasureDrawable";
+export declare class DistanceMeasurement extends BaseMeasurement {
+    /**
+     * The ratio of real world value and the value in three.js(pdf, a map, etc.).
+     */
+    private scale?;
+    constructor(viewer: BaseViewer, input: InputManager, drawList: DrawableList, osnapHelper: OSnapHelper);
+    protected createMeasureDrawable(): DistanceMeasureDrawable | undefined;
+    protected onMouseClick(e: EventInfo): void;
+    exitDrawing(): void;
+    protected complete(): void;
+    cancel(): void;
+    deactivate(): void;
+    protected setTooltipContent(): void;
+    /**
+     * Gets the scale value.
+     */
+    getScale(): number | undefined;
+    /**
+     * Sets the scale value.
+     */
+    setScale(scale: number): void;
+}

package/dist/types/measurements/Locale.d.ts

@@ -0,0 +1,10 @@
+import { i18next } from "@x-viewer/core";
+export declare const en: {
+    measure: string;
+    areaMeasurement: string;
+};
+export declare const cn: {
+    measure: string;
+    areaMeasurement: string;
+};
+export declare const i18n: i18next.i18n;

package/dist/types/measurements/MeasurementPlugin.d.ts

@@ -0,0 +1,140 @@
+import { PluginConfig, THREE } from "@x-viewer/core";
+import { type BaseViewer, Plugin } from "@x-viewer/core";
+import { BaseMeasureDrawable } from "./BaseMeasureDrawable";
+import { MeasurementData, MeasurementType } from "./BaseMeasurement";
+/**
+ * Measurement plugin config.
+ */
+export interface MeasurementPluginConfig extends Partial<PluginConfig> {
+    language?: "cn" | "en";
+}
+export declare class MeasurementPlugin extends Plugin {
+    static readonly DEFAULT_ID = "MeasurementPlugin";
+    private cfg;
+    selectedDrawable: BaseMeasureDrawable | undefined;
+    private overlayRender?;
+    private drawableList;
+    private drawableHelperList;
+    private inputManager;
+    private osnapHelper;
+    private snapToleranceInPixel;
+    private measurements;
+    private activeMeasurementType;
+    private mobileTouchHelper?;
+    private enableSelection?;
+    constructor(viewer: BaseViewer, cfg?: MeasurementPluginConfig);
+    private initLocalization;
+    private initEvents;
+    protected get canvas(): HTMLCanvasElement;
+    protected get raycaster(): THREE.Raycaster;
+    add(drawable: BaseMeasureDrawable, needFireEvent?: boolean): void;
+    create(data: MeasurementData): BaseMeasureDrawable;
+    remove(drawable: BaseMeasureDrawable, needFireEvent?: boolean): void;
+    /**
+     * Set osnap tolerance in pixcel size. The pixcel size will be converted to a size in world coordinate and pass to OSnapHelper.
+     */
+    setSnapTolerance(toleranceInPixel: number): void;
+    /**
+     * Updates osnap tolerance.
+     * We should call this once camera's zoom, fov or position/target changed, etc.
+     */
+    private updateSnapTolerance;
+    /**
+     *
+     * @param {MeasurementType} type
+     * @description {en} Activates one of "Distance", "Area" or "Angle" measurement
+     * @description {zh} 激活"距离", "面积" 或者 "角度"测量
+     */
+    activate(type: MeasurementType): void;
+    /**
+     * @description {en} Deactivates measurement.
+     * @description {zh} 退出测量。
+     */
+    deactivate(): void;
+    getActiveMeasurementType(): MeasurementType | undefined;
+    /**
+     *
+     * @returns {boolean}
+     * @description Is measure plugin active
+     */
+    isActive(): boolean;
+    /**
+     *
+     * @returns {boolean} Is measuring now
+     */
+    isMeasuring(): boolean;
+    /**
+     *
+     * @returns {MeasurementData[]}
+     * @description {en} Gets all measurements.
+     * @description {zh} 获取所有测量数据。
+     */
+    getData(): MeasurementData[];
+    /**
+     * @description {en} Cancels current measurement. This won't deactivate measurement, rather, you can start a new measurement.
+     * @description {zh} 取消当前的测量绘制。这并不会退出测量，用户可以开始一个新的测量。
+     */
+    cancel(): void;
+    /**
+     *
+     * @param {MeasurementData[]} dataArray
+     * @description {en} Sets measurement data.
+     * @description {zh} 设置测量数据。
+     */
+    setData(dataArray: MeasurementData[]): void;
+    /**
+     * Sets a measurement drawable's visibility by id.
+     * @param id
+     * @param visible
+     * @returns
+     * @description Sets a measurement's visibility.
+     */
+    setVisibleById(id: string, visible: boolean): boolean;
+    /**
+     * Sets all measurement drawables' visibilities.
+     */
+    setVisibilities(visible: boolean): void;
+    /**
+     * @description {en} Clears measurement results.
+     * @description {zh} 清除测量结果。
+     */
+    clear(): void;
+    /**
+     * Gets a measurement drawable by id.
+     */
+    getById(id: string): BaseMeasureDrawable;
+    removeById(id: string): void;
+    /**
+     * Selects a measurement drawable by id.
+     * @param {string} id
+     * @description Selects a measurement by id
+     */
+    selectById(id: string): void;
+    /**
+     * Selects a measurement drawable.
+     */
+    select(drawable: BaseMeasureDrawable): void;
+    /**
+     *
+     * @param renderEnabled If need render measurement
+     * @description Unselects a measurement.
+     */
+    unselect(renderEnabled?: boolean): void;
+    /**
+     * Gets the scale value.
+     * Scale is the ratio of real world value and the value in three.js(pdf, a map, etc.).
+     * e.g., Real world distance is 1000, and the value in three.js is 1, then scale is 1000.
+     * We should display 1000 rather than 1 while measuring.
+     */
+    getScale(): number | undefined;
+    /**
+     * Sets the scale value.
+     */
+    setScale(scale: number | undefined): void;
+    /**
+     * @description Destroy measure plugin
+     */
+    destroy(): void;
+    private keydown;
+    private render;
+}

package/dist/types/measurements/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./BaseMeasureDrawable";
+export * from "./BaseMeasurement";
+export * from "./MeasurementPlugin";

package/dist/types/measurements/undo/AddMeasurementCommand.d.ts

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

package/dist/types/measurements/undo/RemoveMeasurementCommand.d.ts

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

package/dist/types/nav-cube/Locale.d.ts

@@ -0,0 +1,18 @@
+import { i18next } from "@x-viewer/core";
+export declare const en: {
+    front: string;
+    back: string;
+    top: string;
+    bottom: string;
+    left: string;
+    right: string;
+};
+export declare const cn: {
+    front: string;
+    back: string;
+    top: string;
+    bottom: string;
+    left: string;
+    right: string;
+};
+export declare const i18n: i18next.i18n;

package/dist/types/nav-cube/NavCube.d.ts

@@ -0,0 +1,12 @@
+import { THREE } from "@x-viewer/core";
+export interface NavCubeConfig {
+    onClick?: (direction: THREE.Vector3, rotation: THREE.Euler) => void;
+}
+export declare class NavCube extends THREE.Object3D {
+    NAVCUBE_SIZE: number;
+    private clickHandler;
+    constructor(cfg?: NavCubeConfig);
+    private createPlane;
+    private createEdge;
+    private createCorner;
+}

package/dist/types/nav-cube/NavCubePlugin.d.ts

@@ -0,0 +1,36 @@
+import { type BaseViewer, Plugin, PluginConfig, THREE, THREEAddons } from "@x-viewer/core";
+import { NavCube } from "./NavCube";
+/**
+ * ViewCube plugin config.
+ */
+export interface NavCubePluginConfig extends Partial<PluginConfig> {
+    containerId: string;
+    language?: "cn" | "en";
+}
+/**
+ * This renderer monitors the host renderer's camera, and keeps a NavCube
+ * the same direction as host renderer's
+ */
+export declare class NavCubePlugin extends Plugin {
+    static readonly DEFAULT_ID = "NavCubePlugin";
+    protected cfg: NavCubePluginConfig;
+    protected renderer?: THREEAddons.CSS3DRenderer;
+    protected navCube?: NavCube;
+    protected camera?: THREE.OrthographicCamera;
+    protected scene?: THREE.Scene;
+    constructor(viewer: BaseViewer, cfg?: NavCubePluginConfig);
+    protected init(): void;
+    private initLocalization;
+    protected initRenderer(): void;
+    protected initScene(): void;
+    protected render(): void;
+    protected animate(): void;
+    protected update(): void;
+    /**
+     * Update navCube according to camera direction.
+     * Camera's direction is the only input factor for this class. It always look at the origin.
+     * @param direction
+     */
+    protected updateCameraDirection(direction: THREE.Vector3, up: THREE.Vector3): void;
+    destroy(): void;
+}

package/dist/types/nav-cube/index.d.ts

@@ -0,0 +1,2 @@
+import "./navcube.scss";
+export * from "./NavCubePlugin";

package/dist/types/overview-map/ImageDrawable.d.ts

@@ -0,0 +1,28 @@
+import { Drawable, THREE } from "@x-viewer/core";
+export interface ImageConfig {
+    image: HTMLImageElement;
+    hoverImage: HTMLImageElement;
+    offset: THREE.Vector2;
+    rotationPoint: THREE.Vector2;
+    width?: number;
+    height?: number;
+}
+export declare class ImageDrawable extends Drawable {
+    imageConfig: ImageConfig;
+    isHover: boolean;
+    rotation: number;
+    position: THREE.Vector3;
+    protected x: number;
+    protected y: number;
+    protected width: number;
+    protected height: number;
+    constructor(id: string, imageConfig: ImageConfig);
+    draw(ctx: CanvasRenderingContext2D, camera: THREE.Camera): void;
+    drawSelect(ctx: CanvasRenderingContext2D): void;
+    drawImage(ctx: CanvasRenderingContext2D, camera: THREE.Camera, imageConfig: ImageConfig): void;
+    setRotation(rotation: number): void;
+    setPosition(position: THREE.Vector3): void;
+    isPointInPath(p: THREE.Vector3, raycaster: THREE.Raycaster): boolean;
+    getVertexes(): THREE.Vector3[];
+    getClassType(): string;
+}

package/dist/types/overview-map/OverviewMapPlugin.d.ts

@@ -0,0 +1,16 @@
+import { THREE, ViewerEvent, Plugin, PluginConfig, BaseViewer } from "@x-viewer/core";
+import { OverviewMapViewer } from "./OverviewMapViewer";
+export interface OverviewMapPluginConfig extends Partial<PluginConfig> {
+    containerId: string;
+    image: string;
+    min: THREE.Vector3;
+    max: THREE.Vector3;
+}
+export declare class OverviewMapPlugin extends Plugin<Record<ViewerEvent, any>> {
+    static readonly DEFAULT_ID = "OverviewMapPlugin";
+    private cfg;
+    mapViewer: OverviewMapViewer;
+    constructor(viewer: BaseViewer, cfg: OverviewMapPluginConfig);
+    get inputManager(): import("@x-viewer/core").InputManager;
+    private initEvents;
+}

package/dist/types/overview-map/OverviewMapViewer.d.ts

@@ -0,0 +1,50 @@
+import { BaseViewer, BaseViewerConfig, Drawable, EventInfo, Model, ModelConfig, THREE, ViewerEvent } from "@x-viewer/core";
+import { ImageDrawable } from "./ImageDrawable";
+interface OverviewMapModelConfig extends ModelConfig {
+    min: THREE.Vector3;
+    max: THREE.Vector3;
+}
+export declare enum OverviewMapPluginEvent {
+    RotateCamera = "rotatecamera",
+    TranslateCamera = "translatecamera"
+}
+export declare class OverviewModel extends Model {
+    modelId: string;
+    modelObject: THREE.Object3D;
+    bbox: THREE.Box3;
+    constructor(modelId: string, object: THREE.Object3D, bbox: THREE.Box3);
+    getModelObject(): THREE.Object3D<THREE.Object3DEventMap>;
+    getBBox(): THREE.Box3;
+}
+export declare class OverviewMapViewer extends BaseViewer<Record<OverviewMapPluginEvent | ViewerEvent, any>> {
+    selectedObject?: THREE.Object3D | Drawable;
+    private drawableList;
+    cameraDrawable?: ImageDrawable;
+    cameraDirectonDrawable?: ImageDrawable;
+    groundPlane?: THREE.Mesh;
+    constructor(viewerCfg: BaseViewerConfig);
+    createCameraDrawable(): Promise<void>;
+    /**
+     * Gets if selection is enabled.
+     */
+    get enableSelection(): boolean;
+    /**
+     * Sets if selection is enabled.
+     */
+    set enableSelection(enable: boolean);
+    private setupDefaultEvents;
+    protected handleRotateCamera(current: THREE.Vector2, mouseStart: THREE.Vector2): void;
+    protected handleTranslateCamera(e: EventInfo): void;
+    loadModel(modelCfg: OverviewMapModelConfig, onProgress?: ((event: ProgressEvent<EventTarget>) => void) | undefined): Promise<void>;
+    asyncMainCameraToDrawable(eye: THREE.Vector3, look: THREE.Vector3): void;
+    getImageBySrc(src: string): Promise<HTMLImageElement>;
+    pickPosition(e: EventInfo): THREE.Vector3 | undefined;
+    is3d(): boolean;
+    setObjectHighlight(object: THREE.Object3D): void;
+    clearHighlight(): void;
+    /**
+     * Updates raycaster threshold to a proper value, so user can easily pick points and lines
+     */
+    private updateRaycasterThreshold;
+}
+export {};