dxfview 0.0.2

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

@@ -0,0 +1,87 @@
+import * as THREE from "three";
+import { DxfObject } from "../dxf/DxfObject";
+/**
+ * @internal
+ */
+export interface MaterialInfo {
+    id: number;
+    material?: THREE.Material;
+    clonedMaterial?: THREE.Material;
+    opacity: number;
+    transparent: boolean;
+    side: THREE.Side;
+}
+/**
+ * Util class for Threejs Object
+ * @internal
+ */
+export declare class ObjectUtils {
+    /**
+     * Outline default material
+     */
+    private static OUTLINE_MATERIAL;
+    /**
+     * Creates outlines for given object and children
+     */
+    static createOutlines(object: THREE.Object3D, options?: {
+        onlyVisible: boolean;
+        meshOnly: boolean;
+    }, onProgress?: (event: ProgressEvent) => void): Promise<THREE.LineSegments[]>;
+    /**
+     * Recursively removes outlines for given object and children
+     */
+    static removeOutlines(object: THREE.Object3D): void;
+    /**
+     * Checks if an object has outline already
+     * @param checkChildren If it checks children recursively.
+     */
+    static hasOutline(object: THREE.Object3D, checkChildren?: boolean): boolean;
+    /**
+     * Sets outline visiblility for given object and children
+     */
+    static setOutlinesVisibility(object: THREE.Object3D, visible: boolean): void;
+    /**
+     * Creates outline for given geometry
+     */
+    static createOutline(geometry: THREE.BufferGeometry, material?: THREE.LineBasicMaterial, matrix?: THREE.Matrix4): THREE.LineSegments;
+    /**
+     * Clones object
+     * @param object target object to be cloned
+     * @param cloneMaterial if it needs to clone material or not
+     * @returns cloned object
+     */
+    static cloneObject(object: THREE.Object3D, cloneMaterial?: boolean): THREE.Object3D;
+    private static BOX_FACE_MATERIAL;
+    /**
+     * Creates box mesh
+     */
+    static createBox(sizeX: number, sizeY: number, sizeZ: number, faceMaterial?: THREE.Material, withBottom?: boolean): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material>;
+    /**
+     * TODO: Relative to center
+     */
+    static rebaseObjectOnRTC(object: THREE.Object3D): THREE.Object3D;
+    static isEmptyObject(object: THREE.Object3D | DxfObject): boolean;
+    static removeEmptyObjects(object: THREE.Object3D | DxfObject): boolean;
+    /**
+     * From bottom to top, removes child objects first,
+     * and then removes empty parent objects
+     */
+    static removeEmptyObjectsFromRemovingObjects(removingObjects: THREE.Object3D[], levelObject: THREE.Object3D): void;
+    /**
+     * To save memory, object3d shares some variables
+     */
+    static setSharedVariablesOfObject(object: THREE.Object3D): void;
+    /**
+     * Checks if an object is a drawable leaf object
+     */
+    static isLeafObject(obj: THREE.Object3D): boolean;
+    /**
+     * object layers related setting functions
+     */
+    static enableLayerChannels(obj: THREE.Object3D, channels: number[], recursive?: boolean): void;
+    static disableLayerChannels(obj: THREE.Object3D, channels: number[], recursive?: boolean): void;
+    static setLayerChannels(obj: THREE.Object3D, channels: number[], recursive?: boolean): void;
+    static isObjectHittable(obj: THREE.Object3D): boolean;
+    static isObjectSnapable(obj: THREE.Object3D): boolean;
+    static isObjectSelectable(obj: THREE.Object3D): boolean;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export declare class PolygonUtils {
+    static getFaces(points: THREE.Vector3[]): number[];
+    static arePointsCoplanar(points: THREE.Vector3[]): boolean;
+    static isSelfIntersecting(points: THREE.Vector3[]): boolean;
+}

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

@@ -0,0 +1,16 @@
+import { SVGObject } from "three/examples/jsm/renderers/SVGRenderer.js";
+export declare const SNAP_ICON_SIZE = 10;
+export declare enum OSnapMarkerType {
+    TripleCross = "TripleCross",
+    Square = "Square",
+    Triangle = "Triangle",
+    CircleWithCross = "CircleWithCross",
+    Cross = "Cross",
+    Perpendicular = "Perpendicular"
+}
+/**
+ * @internal
+ */
+export declare class SVGObjectUtils {
+    static createSVGObject(node: SVGPathElement | SVGTextElement | SVGLineElement): SVGObject;
+}

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

@@ -0,0 +1,26 @@
+import * as THREE from "three";
+/**
+ * Util methods about Scene
+ * @internal
+ */
+export declare class SceneUtils {
+    /**
+     * Get all visible objects' bounding box in a scene.
+     * @param scene
+     */
+    static getVisibleObjectBoundingBox(scene: THREE.Scene): THREE.Box3;
+    static getObjectsBoundingBox(scene: THREE.Scene, objectIds: number[], sampling?: boolean): THREE.Box3;
+    /**
+     * Box3.expandByObject() doesn't work well in some case.
+     * E.g. when object's position is far away from object's center?
+     * When objects are instanced?
+     * That's why we need a method to find bounding box by object's children!
+     * And, better to do sampling in case there are too many children.
+     */
+    static getBoundingBox(object: THREE.Object3D, sampling?: boolean): THREE.Box3;
+    /**
+     * InstancedMesh is different, we need to get its child meshes in order to get the bounding box
+     */
+    static getInstancedMeshBoundingBox(mesh: THREE.InstancedMesh): THREE.Box3;
+    static getObjectCenter(object: THREE.Object3D, center: THREE.Vector3): void;
+}

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

@@ -0,0 +1,11 @@
+import * as THREE from "three";
+/**
+ * @internal
+ */
+export declare class SectionUtils {
+    static setMaterialSection(mat: THREE.Material, planes: THREE.Plane[], bAppend?: boolean, bClipIntersection?: boolean): void;
+    static removeSection(object: THREE.Object3D): void;
+    static addSection(object: THREE.Object3D, planes: THREE.Plane[], bAppend?: boolean, bClipIntersection?: boolean): void;
+    static generateSectionPlanesByBox(sectionBox: THREE.Box2): THREE.Plane[];
+    static generateSectionPlanesByPoints(points: THREE.Vector2[], bLeftSideOfForwadDirection?: boolean): THREE.Plane[] | undefined;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * @internal
+ */
+export declare const unitConversionByMeter: {
+    [key: string]: number;
+};
+/**
+ * @internal
+ */
+export declare const unitLabel: {
+    [key: string]: string;
+};
+/**
+ * @internal
+ */
+export declare const getUnitStr: (unit: string, power?: number) => string;
+/**
+ * Gets unit
+ * value
+ * sourceUnit
+ * targetUnit
+ * @internal
+ */
+export interface valueWithUnit {
+    value: number;
+    unit: string;
+}
+/**
+ * @internal
+ */
+export declare const getLengthValueByUnit: (value: number, sourceUnit: string, targetUnit: string, power?: number) => valueWithUnit;

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

@@ -0,0 +1,21 @@
+export * from "./CommonUtils";
+export * from "./ColorUtils";
+export * from "./CoordinateUtils";
+export * from "./CSS2DObjectUtils";
+export * from "./DecimalPrecisionUtils";
+export * from "./DeviceUtils";
+export * from "./EdgeUtils";
+export * from "./Event";
+export * from "./FpsUtils";
+export * from "./GeometryUtils";
+export * from "./Locale";
+export * from "./LogUtils";
+export * from "./MaterialUtils";
+export * from "./MathUtils";
+export * from "./MergeUtils";
+export * from "./ObjectUtils";
+export * from "./PolygonUtils";
+export * from "./SceneUtils";
+export * from "./SectionUtils";
+export * from "./SVGObjectUtils";
+export * from "./UnitConversionUtils";

package/dist/types/core/viewers/BaseViewer.d.ts

@@ -0,0 +1,265 @@
+import type { TFunction } from "i18next";
+import * as THREE from "three";
+import { Box2 } from "../Constants";
+import { ViewerEvent } from "./ViewerEvent";
+import type { BaseViewerConfig, CameraConfig } from "../../core/Configs";
+import type { CanvasRender } from "../../core/canvas";
+import type { CameraControlsEx } from "../../core/controls";
+import { EventInfo, InputManager } from "../../core/input/InputManager";
+import type { MarkupManager } from "../../core/markup";
+import { UndoRedoManager } from "../../core/undo-redo/UndoRedoManager";
+import { Event } from "../../core/utils";
+import { Plugin } from "../../core/viewers/Plugin";
+import type { MeasurementPlugin } from "../../plugins";
+/**
+ * 截图结果，包含结果图像和，
+ * 对于 DxfViewer，还包含截图时的视图范围，
+ * 对于 BimViewer，包含相机的位置和目标。
+ */
+export interface ScreenshotResult {
+    /**
+     * 截图时的视图范围。
+     * 注意，这不是图像的范围。
+     * 这仅适用于 DxfViewer。
+     */
+    viewExtent?: Box2;
+    /**
+     * 用于 BimViewer
+     * @internal
+     */
+    /**
+     * 用于 BimViewer
+     * @internal
+     */
+    /**
+     * 图像类型，默认为 "image/png"
+     * @internal
+     */
+    imageType: string;
+    /**
+     * 图像，base64 格式。
+     */
+    base64Image: string;
+}
+/**
+ * @internal
+ */
+export declare enum ViewerName {
+    BaseViewer = "BaseViewer",
+    BimViewer = "BimViewer",
+    DxfViewer = "DxfViewer",
+    VRViewer = "VRViewer"
+}
+declare type ViewerEvents = {
+    [K in ViewerEvent]: any;
+};
+/**
+ * DxfViewer、BimViewer 等的抽象基类。
+ */
+export declare abstract class BaseViewer extends Event<ViewerEvents> {
+    /**
+     * @internal
+     */
+    name: ViewerName;
+    /**
+     * @internal
+     */
+    translate: TFunction;
+    /**
+     * @internal
+     */
+    parentContainer?: HTMLElement;
+    /**
+     * @internal
+     */
+    viewerContainer?: HTMLElement;
+    container?: HTMLElement;
+    protected inputManager?: InputManager;
+    /**
+     * @internal
+     */
+    scene?: THREE.Scene;
+    /**
+     * @internal
+     */
+    renderer?: THREE.WebGLRenderer;
+    /**
+     * @internal
+     */
+    camera?: THREE.PerspectiveCamera | THREE.OrthographicCamera;
+    /**
+     * @internal
+     */
+    controls?: CameraControlsEx;
+    protected height: number;
+    protected width: number;
+    /**
+     * @internal
+     */
+    widgetContainer?: HTMLElement;
+    private spinner?;
+    protected jobCount: number;
+    protected viewerCfg: BaseViewerConfig;
+    /**
+     * @internal
+     */
+    cameraCfg?: CameraConfig;
+    /**
+     * @internal
+     */
+    groundPlane?: THREE.Mesh;
+    /**
+     * @describe overlay canvas
+     * @internal
+     */
+    overlayRender?: CanvasRender;
+    /**
+     * @internal
+     */
+    loadedModels?: any;
+    /**
+     * @internal
+     */
+    undoRedoManager?: UndoRedoManager;
+    protected enableOverlayRenderer: boolean;
+    /**
+     * @internal
+     */
+    protected requestAnimationFrameHandle?: number;
+    /**
+     * @internal
+     */
+    protected frustumSize: number;
+    /**
+     * @internal
+     */
+    protected loadingProgressBar?: any;
+    protected lastFrameExecuteTime: number;
+    protected minFrameInterval: number;
+    protected plugins: Plugin[];
+    constructor(viewerCfg: BaseViewerConfig);
+    private initLogLevel;
+    private initLocalization;
+    private initContainer;
+    /**
+     * 在用户传入的容器下创建一个 viewerContainer。
+     * 创建一个新的有一些好处。例如，它的样式不会影响
+     * 用户传入的容器 div。
+     */
+    private initViewerContainer;
+    /**
+     *
+     * @description 为ui组件创建一个div，如果组件需要位置，只需相对容器，可能会在后面移除。
+     */
+    private initWidgetContainer;
+    protected initSpinner(): void;
+    /**
+     * 设置加载动画的可见性
+     */
+    protected setSpinnerVisibility(visible: boolean): void;
+    /**
+     * 增加作业数量，并相应地显示加载动画
+     */
+    protected increaseJobCount(): void;
+    /**
+     * 减少作业数量，并相应地隐藏加载动画
+     */
+    protected decreaseJobCount(): void;
+    protected resize(width: number, height: number): void;
+    destroy(): void;
+    /**
+     * @internal
+     * @description 全局事件输入管理器。例如：mousedown、mouseup、keydown。
+     */
+    getInputManager(): InputManager | undefined;
+    /**
+     * @internal
+     */
+    getViewConfig(): BaseViewerConfig;
+    /**
+     * @internal
+     */
+    enableRender(): void;
+    /**
+     * @internal
+     */
+    getRaycaster(): THREE.Raycaster | undefined;
+    /**
+     * @internal
+     */
+    getRaycastableObjectsByMouse(event?: EventInfo): THREE.Object3D[];
+    /**
+     * 带事件级缓存的射线相交辅助函数。默认：无缓存。
+     * 派生视图类可通过 `event.raycastCache` 重写此方法提供缓存功能。
+     * @internal
+     */
+    intersectObjectsCached(event: EventInfo, objects: THREE.Object3D[], recursive: boolean, cacheKey: string): THREE.Intersection[];
+    /**
+     * 获取视图中所有对象的包围盒。
+     * @internal
+     */
+    getBBox(): THREE.Box3 | undefined;
+    flyTo(position: THREE.Vector3, lookAt: THREE.Vector3): void;
+    /**
+     * 是否为3d视图器。
+     * DxfViewer 是2d的，因此返回 false。
+     * @default true
+     * @internal
+     */
+    is3d(): boolean;
+    /**
+     * @description 兼容旧版本，请使用 MeasurePlugin 代替
+     * @internal
+     */
+    get measurePlugin(): MeasurementPlugin | undefined;
+    /**
+     * @internal
+     */
+    getMarkupManager(): MarkupManager | undefined;
+    /**
+     * @deprecated
+     */
+    deactivateMeasurement(): void;
+    /**
+     * @deprecated
+     */
+    deactivateAnnotation(): void;
+    /**
+     * @deprecated
+     */
+    setMeasurementVisibility(id: string, visible: boolean): boolean;
+    /**
+     * @internal
+     */
+    screenshot(config: any): Promise<undefined | string>;
+    /**
+     * 获取一个像素在世界坐标中代表的长度。
+     * 这对正交相机有效。
+     * 对于透视相机，一个像素在不同位置代表不同的大小，
+     * 取决于相机的距离和其视野等。我们简单地以相机目标作为位置来计算。
+     * @internal
+     */
+    getPixelSizeInWorldCoord(): number;
+    /**
+     * 在预期的id重复的情况下获取一个唯一的modelId。
+     */
+    protected getUniqueModelId(expectedModelId: string): string;
+    /**
+     * 安装一个插件。
+     */
+    addPlugin(plugin: Plugin): void;
+    /**
+     * 卸载一个插件，首先清除其内容。
+     */
+    removePlugin(plugin: Plugin): void;
+    /**
+     * 清除所有插件。
+     * 插件不是由视图器创建的，因此不会被视图器销毁。
+     */
+    clearPlugins(): void;
+    /**
+     * 查找一个插件。
+     */
+    findPlugin(id: string): Plugin | undefined;
+}
+export {};