dxfview 0.0.2

package/dist/types/components/dxf-layout-bar/DxfLayoutBar.d.ts

@@ -0,0 +1,26 @@
+import type { DxfViewer } from "../../core/viewers";
+export declare class DxfLayoutBar {
+    protected readonly viewer: DxfViewer;
+    private element?;
+    private content?;
+    private itemList;
+    constructor(viewer: DxfViewer);
+    init(): void;
+    private handleMouseWheel;
+    private createItem;
+    destroy(): void;
+    show(): void;
+    hide(): void;
+}
+export declare class ModelLayoutSwitchItem {
+    protected readonly viewer: DxfViewer;
+    private eventBus;
+    element: HTMLElement;
+    resetActivate?: () => void;
+    active: boolean;
+    constructor(viewer: DxfViewer, name: string);
+    private createItem;
+    setActive(active: boolean): void;
+    resetActive(): void;
+    destroy(): void;
+}

package/dist/types/components/dxf-layout-bar/index.d.ts

@@ -0,0 +1 @@
+export * from "./DxfLayoutBar";

package/dist/types/components/pop-panel/PopPanel.d.ts

@@ -0,0 +1,14 @@
+export declare class PopPanel {
+    private readonly container;
+    private element;
+    header: HTMLElement;
+    body: HTMLElement;
+    private isFollowing;
+    private diffX;
+    private diffY;
+    constructor(id: string, content: string | HTMLElement, container?: HTMLElement);
+    start: (event: MouseEvent) => void;
+    stop: () => void;
+    follow: (event: MouseEvent) => void;
+    destroy(): void;
+}

package/dist/types/components/pop-panel/index.d.ts

@@ -0,0 +1 @@
+export * from "./PopPanel";

package/dist/types/components/progress-bar/ProgressBar.d.ts

@@ -0,0 +1,34 @@
+export interface ProgressItem {
+    id: string;
+    div: HTMLDivElement;
+}
+export declare class ProgressBar {
+    private element;
+    private progresseItems;
+    constructor(parentElement: HTMLElement);
+    setVisible(visible: boolean): void;
+    /**
+     * Adds a progress item
+     * @param progressItemId
+     * @param message Initial message
+     * @param progress number between 0-100
+     */
+    addProgressItem(progressItemId: string, message?: string): void;
+    /**
+     * Updates a progress item
+     * @param progressItemId
+     * @param message
+     * @param progress number between 0-100
+     */
+    updateProgress(progressItemId: string, message?: string, progress?: number): void;
+    /**
+     * Removes a progress item
+     * @param progressItemId
+     */
+    removeProgressItem(progressItemId: string): void;
+    /**
+     * Removes a progress item after some time
+     * @param progressItemId
+     */
+    delayRemoveProgressItem(progressItemId: string, delayInMs?: number): void;
+}

package/dist/types/components/progress-bar/index.d.ts

@@ -0,0 +1 @@
+export * from "./ProgressBar";

package/dist/types/components/settings/ProjectSettingsDef.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Perspective and Orthographic camera share the same settings
+ * @internal
+ */
+export interface CameraSettings {
+    near: number;
+    far: number;
+}
+/**
+ * @internal
+ */
+export interface MouseSetting {
+    sensitivity: number;
+}
+/**
+ * @internal
+ */
+export interface KeyboardSetting {
+    sensitivity: number;
+}
+/**
+ * @internal
+ */
+export interface Settings {
+    unit: string;
+    decimalPrecision: number;
+    camera: CameraSettings;
+    mouse: MouseSetting;
+    keyboard: KeyboardSetting;
+}
+/**
+ * @internal
+ */
+export declare const defaultSettings: Settings;
+export declare const cameraNearRange: number[];
+export declare const cameraFarRange: number[];
+export declare const unitRange: {
+    [key: string]: string;
+};
+export declare const sensitivityRange: number[];
+export declare const decimalPrecisionRange: {
+    [key: string]: number;
+};
+export declare const settingStoreKeyName = "THREE_RENDER_SETTING";

package/dist/types/components/settings/index.d.ts

@@ -0,0 +1 @@
+export * from "./ProjectSettingsDef";

package/dist/types/components/tool-tip/Tooltip.d.ts

@@ -0,0 +1,20 @@
+interface TooltipConfig {
+    showOnCreate?: boolean;
+    followPointer?: boolean;
+    parentNode?: HTMLElement;
+    target?: HTMLElement;
+}
+export declare class Tooltip {
+    private node;
+    private parentNode;
+    private target;
+    private childNode;
+    constructor(id: string, content?: string | HTMLElement | null, cfg?: TooltipConfig);
+    setContent(content: string | HTMLElement): void;
+    updateChildContent(content: string | HTMLElement): void;
+    follow: (event: MouseEvent) => void;
+    show: () => false | void;
+    hide: () => false | void;
+    destroy: () => void;
+}
+export {};

package/dist/types/components/tool-tip/index.d.ts

@@ -0,0 +1 @@
+export * from "./Tooltip";

package/dist/types/core/Configs.d.ts

@@ -0,0 +1,238 @@
+/**
+ * Camera config
+ */
+export interface CameraConfig {
+    /**
+     * The camera location
+     */
+    eye: number[];
+    /**
+     * The location that the camera looks to
+     */
+    look: number[];
+    /**
+     * @internal
+     */
+    up?: number[];
+    /**
+     * The camera's near clip plane
+     */
+    near?: number;
+    /**
+     * The camera's far clip plane
+     */
+    far?: number;
+}
+/**
+ * Model config
+ */
+export interface ModelConfig {
+    /**
+     * Unique id of the model
+     */
+    modelId?: string;
+    /**
+     * Model name
+     */
+    name?: string;
+    /**
+     * Source url of the model
+     */
+    src: string;
+    /**
+     * Used to distinguish format, because it may be hard to know the format by src!
+     * @internal
+     */
+    fileFormat?: string;
+    /**
+     * File encoding, can be used by dxf. Common encoding include "UTF-8", "gb2312", etc.
+     * @internal
+     */
+    encoding?: string;
+    /**
+     * A float array of length 16, definds model's position, rotation and scale
+     */
+    matrix?: number[];
+    /**
+     * If we want to merge meshes/lines/points with the same material
+     * @internal
+     * @default false
+     */
+    merge?: boolean;
+    /**
+     * If we want to generate and show edges/outlines to the modle.
+     * It is useful for BimViewer.
+     * @internal
+     */
+    edges?: boolean;
+    /**
+     * If this model is visible by default.
+     * @internal
+     */
+    visible?: boolean;
+}
+/**
+ * Dxf model config
+ */
+export interface DxfModelConfig extends ModelConfig {
+    /**
+     * If to ignore anything of paper space.
+     * There are some scenarios to ignore paper space by default, includes:
+     * - Dxf overlay, aka, loading more than one dxf files into a viewer. We'll only load model space for the first file.
+     * - Dxf compare. Since we'll only compare model space, it won't load paper space at all.
+     *
+     * This option is useful when user want to explicitly ignore paper space.
+     * @default false
+     */
+    ignorePaperSpace?: boolean;
+    /**
+     * Applies this color to everything in this model.
+     * This allows user to show a drawing with a pure color (black, white, etc.).
+     * Color value is between 0 and 1, e.g., [1, 0, 0] means 'red'.
+     */
+    overrideColor?: number[];
+}
+/**
+ * Common viewer config
+ */
+export interface BaseViewerConfig {
+    /**
+     * @description canvas id to contain the viewer.
+     */
+    containerId: string;
+    /**
+     * @internal
+     */
+    language?: "cn" | "en";
+    /**
+     * @internal
+     */
+    logLevel?: "debug" | "info" | "warn" | "error" | "silent";
+    /**
+     * @internal
+     */
+    enableSpinner?: boolean;
+    /**
+     * @internal
+     */
+    enableProgressBar?: boolean;
+    /**
+     * @description just for react native
+     * @internal
+     */
+    context?: WebGLRenderingContext | WebGL2RenderingContext;
+    /**
+     * @description just for react native
+     * @internal
+     */
+    context2d?: CanvasRenderingContext2D;
+}
+/**
+ * This wrappers most config for BimViewer
+ */
+export interface BimViewerConfig extends BaseViewerConfig {
+    /**
+     * If user can select an entity by mouse click
+     * @internal
+     * @default true
+     */
+    enableSelection?: boolean;
+    /**
+     * Default is `meters`
+     * @internal
+     */
+    units?: string;
+    /**
+     * Sets the default locale
+     * @internal
+     */
+    locale?: "cn" | "en";
+}
+/**
+ * This wrappers most config for DxfViewer
+ */
+export interface DxfViewerConfig extends BaseViewerConfig {
+    /**
+     * Enables layout bar so we can switch to other layouts.
+     * The default layout bar is an example UI of the viewer, since plenty of APIs are exposed,
+     * you are recommended to create your own layout bar with customized style, location, etc.
+     */
+    enableLayoutBar?: boolean;
+    /**
+     * If to cache model into indexeddb (or maybe local storage in future).
+     * If enabled, it will get model data from cache the next time model is loaded.
+     * @internal
+     * @default true
+     */
+    enableLocalCache?: boolean;
+    /**
+     * If user can select an entity by mouse click
+     * @internal
+     * @default false
+     */
+    enableSelection?: boolean;
+}
+/**
+ * Dxf compare config.
+ */
+export interface DxfCompareConfig {
+    /**
+     * Enables to compare properties (color, linetype, line width, etc.)
+     */
+    enableDetailComparision: boolean;
+}
+/**
+ * VR Viewpoint's hotpoint, which can be a user defined html element.
+ * A hotpoint can be clicked, then caller can do their own operation,
+ * e.g. open a description panel, jump to another viewpoint, etc.
+ */
+export interface Hotpoint {
+    hotpointId: string;
+    anchorPosition: number[];
+    visible?: boolean;
+    html: string;
+}
+/**
+ * A default BimViewerConfig as a template, which enables most plugins.
+ * @internal
+ */
+export declare const DEFAULT_BIM_VIEWER_CONFIG: BimViewerConfig;
+/**
+ * @internal
+ */
+export interface IsolateObjectsParam {
+    id: string;
+    modelId: string;
+}
+/**
+ * @internal
+ */
+export interface IsolateObjectsParams {
+    familyInstanceIds: IsolateObjectsParam[];
+}
+/**
+ * @internal
+ */
+export interface ScreenshotConfig {
+    type: string;
+    quality: number;
+    includeOverlay: boolean;
+}
+/**
+ * Icon class.
+ * Used by toolbar and bottom bar icons, etc.
+ */
+export interface IconClass {
+    /**
+     * The default icon.
+     */
+    default: string;
+    /**
+     * The icon when item is actived.
+     */
+    active?: string;
+    /**
+     * The icon font class name.
+     */
+    iconFont?: string;
+}

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

@@ -0,0 +1,164 @@
+/**
+ * To improve performance, we can set object.matrixAutoUpdate = false for static or rarely moving objects and
+ * manually call object.updateMatrix() whenever their position/rotation/quaternion/scale are updated.
+ * Add a constrant here, so developer can change it here easily for debugging.
+ * @internal
+ */
+export declare const matrixAutoUpdate = false;
+/**
+ * @internal
+ */
+export declare const sceneAutoUpdate = false;
+/**
+ * These concept can be complex: hitable, snapable, selectable, visible
+ * Mesh                            Y        Y         Y           Y
+ * text in DxfViewer               Y        N         Y           Y
+ * ground plan                     Y        Y         N           Y
+ * outline                         N        Y         N           Y
+ * OSnap auxiliary object          N        Y         N           N
+ *
+ * So, we must handle them properly. We'll try to put them into different layers.
+ *
+ * For each created object with geometry and material, the default layer is set to enableAll.
+ * If the object is only displayed, it is not necessary to call enableAll. For example, some auxiliary display objects.
+ * For objects that cannot be hitable, snapable, selectable, etc., call ObjectUtils.disableLayerChannels to exclude the corresponding channel.
+ * @example
+ * ``` typescript
+ *   this.groundPlane.layers.enableAll();
+ *   ObjectUtils.disableLayerChannels(this.groundPlane, [layerForSelectableObjects]);
+ * ```
+ */
+/**
+ * @internal
+ */
+export declare const layerForHitableObjects = 10;
+/**
+ * @internal
+ */
+export declare const layerForSnapableObjects = 11;
+/**
+ * @internal
+ */
+export declare const layerForSelectableObjects = 12;
+/**
+ * @internal
+ */
+export declare const ICON_FONT_CLASS = "iconfont";
+/**
+ * @internal
+ */
+export declare const KEYDOWN_EVENT = "keydown";
+/**
+ * @internal
+ */
+export declare const KEYUP_EVENT = "keyup";
+/**
+ * @internal
+ */
+export declare const MOUSEMOVE_EVENT = "mousemove";
+/**
+ * @internal
+ */
+export declare const MOUSEUP_EVENT = "mouseup";
+/**
+ * @internal
+ */
+export declare const MOUSEDOWN_EVENT = "mousedown";
+/**
+ * @internal
+ */
+export declare const ESC_KEY = "Escape";
+/**
+ * @internal
+ */
+export declare const ENTER_KEY = "Enter";
+/**
+ * @internal
+ */
+export declare const AXIS_SECTION_PLANE_ID = "axis-section-plane";
+/**
+ * @internal
+ */
+export declare const AXIS_SECTION_PLANE_CONTROL_ID = "axis-section-plane-control";
+/**
+ * @internal
+ */
+export declare const SECTION_PLANE_ID = "section-plane";
+/**
+ * @internal
+ */
+export declare const SECTION_PLANE_CONTROL_ID = "section-plane-control";
+/**
+ * @internal
+ */
+export declare const SECTION_BOX_ID = "section-box";
+/**
+ * @internal
+ */
+export declare const SECTION_PLANE_NAME = "plane-section-boxface";
+/**
+ * @internal
+ */
+export declare const GROUND_PLANE_RENDER_ORDER = -1000;
+/**
+ * @internal
+ * Angle threshold at which two plane normals are parallel. Used to calculate edges.
+ */
+export declare const ANGLE_THRESHOLD_FOR_EDGE = 10;
+/**
+ * Section type
+ */
+export declare enum SectionType {
+    ObjectsBoxSection = "ObjectsBoxSection",
+    PickPlaneSection = "PickPlaneSection",
+    AxisPlaneSection = "AxisPlaneSection"
+}
+/**
+ * Screenshot mode.
+ */
+export declare enum ScreenshotMode {
+    /**
+     * Take screenshot of the whole canvas.
+     */
+    Default = "Default",
+    /**
+     * Take screenshot by box selecting an area.
+     */
+    BoxSelection = "BoxSelection",
+    /**
+     * Take screenshot by picking a markup.
+     */
+    PickMarkup = "PickMarkup"
+}
+export interface Vector2 {
+    x: number;
+    y: number;
+}
+export interface Vector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+export declare type Box = [number, number, number, number, number, number];
+export declare type Mat4 = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+] | Float32Array;
+export interface Box2 {
+    min: Vector2;
+    max: Vector2;
+}

package/dist/types/core/Units.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Units are defined the same order as to Dxf format
+ */
+export declare enum Units {
+    Unitless = "Unitless",
+    Inches = "Inches",
+    Feet = "Feet",
+    Millimeters = "Millimeters",
+    Centimeters = "Centimeters",
+    Meters = "Meters"
+}
+/**
+ * Gets the unit scale when converting to meter
+ */
+export declare const unitScaleToMeter: (srcUnit: Units) => number;
+export declare const unitScaleConversion: (srcUnit: Units, destUnit: Units) => number;

package/dist/types/core/VersionManager.d.ts

@@ -0,0 +1,3 @@
+export declare const getVersionFromLocalStorage: () => string | null;
+export declare const setVersionToLocalStorage: () => void;
+export declare const checkIsNewVersion: () => boolean;