@xtctwins/tctwins-bimx-viewer 0.1.0

package/types/src/messages.d.ts

@@ -0,0 +1,373 @@
+/**
+ * Locale translations for BIMViewer
+ */
+declare const messages: {
+    ch: {
+        NavCube: {
+            front: string;
+            back: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        modelsExplorer: {
+            title: string;
+            loadAll: string;
+            loadAllTip: string;
+            unloadAll: string;
+            unloadAllTip: string;
+            add: string;
+            addTip: string;
+        };
+        objectsExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        classesExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        storeysExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        propertiesInspector: {
+            title: string;
+            noObjectSelectedWarning: string;
+            noPropSetWarning: string;
+        };
+        toolbar: {
+            toggleExplorer: string;
+            toggleProperties: string;
+            resetViewTip: string;
+            toggle2d3dTip: string;
+            togglePerspectiveTip: string;
+            viewFitTip: string;
+            firstPersonTip: string;
+            hideObjectsTip: string;
+            annotationObjectsTip: string;
+            selectObjectsTip: string;
+            queryObjectsTip: string;
+            sliceObjectsTip: string;
+            slicesMenuTip: string;
+            showSpacesTip: string;
+            numSlicesTip: string;
+        };
+    };
+    en: {
+        NavCube: {
+            front: string;
+            back: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        modelsExplorer: {
+            title: string;
+            loadAll: string;
+            loadAllTip: string;
+            unloadAll: string;
+            unloadAllTip: string;
+            add: string;
+            addTip: string;
+        };
+        objectsExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        classesExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        storeysExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        propertiesInspector: {
+            title: string;
+            noObjectSelectedWarning: string;
+            noPropSetWarning: string;
+        };
+        toolbar: {
+            toggleExplorer: string;
+            toggleProperties: string;
+            resetViewTip: string;
+            toggle2d3dTip: string;
+            togglePerspectiveTip: string;
+            viewFitTip: string;
+            firstPersonTip: string;
+            hideObjectsTip: string;
+            selectObjectsTip: string;
+            queryObjectsTip: string;
+            sliceObjectsTip: string;
+            slicesMenuTip: string;
+            showSpacesTip: string;
+            numSlicesTip: string;
+        };
+    };
+    de: {
+        NavCube: {
+            front: string;
+            back: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        modelsExplorer: {
+            title: string;
+            loadAll: string;
+            loadAllTip: string;
+            unloadAll: string;
+            unloadAllTip: string;
+            add: string;
+            addTip: string;
+        };
+        objectsExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        classesExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        storeysExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        propertiesInspector: {
+            title: string;
+            noObjectSelectedWarning: string;
+            noPropSetWarning: string;
+        };
+        toolbar: {
+            toggleExplorer: string;
+            toggleProperties: string;
+            resetViewTip: string;
+            toggle2d3dTip: string;
+            togglePerspectiveTip: string;
+            viewFitTip: string;
+            firstPersonTip: string;
+            hideObjectsTip: string;
+            selectObjectsTip: string;
+            queryObjectsTip: string;
+            sliceObjectsTip: string;
+            slicesMenuTip: string;
+            showSpacesTip: string;
+            numSlicesTip: string;
+        };
+    };
+    fr: {
+        NavCube: {
+            front: string;
+            back: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        modelsExplorer: {
+            title: string;
+            loadAll: string;
+            loadAllTip: string;
+            unloadAll: string;
+            unloadAllTip: string;
+            add: string;
+            addTip: string;
+        };
+        objectsExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        classesExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        storeysExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        propertiesInspector: {
+            title: string;
+            noObjectSelectedWarning: string;
+            noPropSetWarning: string;
+        };
+        toolbar: {
+            toggleExplorer: string;
+            toggleProperties: string;
+            resetViewTip: string;
+            toggle2d3dTip: string;
+            togglePerspectiveTip: string;
+            viewFitTip: string;
+            firstPersonTip: string;
+            hideObjectsTip: string;
+            selectObjectsTip: string;
+            queryObjectsTip: string;
+            sliceObjectsTip: string;
+            slicesMenuTip: string;
+            showSpacesTip: string;
+            numSlicesTip: string;
+        };
+    };
+    pl: {
+        NavCube: {
+            front: string;
+            back: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        modelsExplorer: {
+            title: string;
+            loadAll: string;
+            loadAllTip: string;
+            unloadAll: string;
+            unloadAllTip: string;
+            add: string;
+            addTip: string;
+        };
+        objectsExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        classesExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        storeysExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        propertiesInspector: {
+            title: string;
+            noObjectSelectedWarning: string;
+            noPropSetWarning: string;
+        };
+        toolbar: {
+            toggleExplorer: string;
+            toggleProperties: string;
+            resetViewTip: string;
+            toggle2d3dTip: string;
+            togglePerspectiveTip: string;
+            viewFitTip: string;
+            firstPersonTip: string;
+            hideObjectsTip: string;
+            selectObjectsTip: string;
+            queryObjectsTip: string;
+            sliceObjectsTip: string;
+            slicesMenuTip: string;
+            showSpacesTip: string;
+            numSlicesTip: string;
+        };
+    };
+    ru: {
+        NavCube: {
+            front: string;
+            back: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        modelsExplorer: {
+            title: string;
+            loadAll: string;
+            loadAllTip: string;
+            unloadAll: string;
+            unloadAllTip: string;
+            add: string;
+            addTip: string;
+        };
+        objectsExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        classesExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        storeysExplorer: {
+            title: string;
+            showAll: string;
+            showAllTip: string;
+            hideAll: string;
+            hideAllTip: string;
+        };
+        propertiesInspector: {
+            title: string;
+            noObjectSelectedWarning: string;
+            noPropSetWarning: string;
+        };
+        toolbar: {
+            toggleExplorer: string;
+            toggleProperties: string;
+            resetViewTip: string;
+            toggle2d3dTip: string;
+            togglePerspectiveTip: string;
+            viewFitTip: string;
+            firstPersonTip: string;
+            hideObjectsTip: string;
+            selectObjectsTip: string;
+            queryObjectsTip: string;
+            sliceObjectsTip: string;
+            slicesMenuTip: string;
+            showSpacesTip: string;
+            numSlicesTip: string;
+        };
+    };
+};
+export default messages;

package/types/src/server/OSSHelper.d.ts

@@ -0,0 +1,4 @@
+export default class OSSHelper {
+    static getBuffer(filePath: string, region_url: string, bucket_name: string, done: Function, error: Function): Promise<void>;
+    static requestFileFromOSS(filePath: string, region_url: string, bucket_name: string, isFile: boolean, done: Function, error: Function): Promise<void>;
+}

package/types/src/server/Server.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Default server client which loads content for a {@link BIMViewer} via HTTP from the file system.
+ * A BIMViewer is instantiated with an instance of this class.
+ * To load content from an alternative source, instantiate BIMViewer
+ * with your own custom implementation of this class.
+ * @class
+ */
+export default class Server {
+    protected _dataDir: string;
+    protected _filePath: string;
+    /**
+     * Constructs a Server.
+     *
+     * @param {*} [cfg] Server configuration.
+     * @param {String} [cfg.dataDir] Base directory for content.
+     * @param {String} [cfg.filePath] Base directory for content.
+     */
+    constructor(cfg?: any);
+    /**
+     * Gets information on all available projects.
+     *
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getProjects(done: Function, error: Function): void;
+    /**
+     * Gets information for a project.
+     * @param {String} projectId ID of the project.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getProject(projectId: string, done: Function, error: Function): void;
+    /**
+     * Gets metadata for a model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getMetadata(projectId: string, modelId: string, done: Function, error: Function): void;
+    /**
+     * Gets information for a project.
+     * @param {String} projectId ID of the project.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getModelProject(region_url: string, bucket_name: string, done: Function, error: Function): Promise<void>;
+    /**
+     * Gets metadata for a model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} FileId path of the model.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getModelMetadata(region_url: string, bucket_name: string, done: Function, error: Function): Promise<void>;
+    /**
+     * Gets geometry for a model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} FileId ID of the model.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getModelGeometry(region_url: string, bucket_name: string, done: Function, error: Function): Promise<void>;
+    /**
+     * Gets geometry for a model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getGeometry(projectId: string, modelId: string, done: Function, error: Function): void;
+    /**
+     * Gets geometry for a model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getObjectInfo(projectId: string, modelId: string, objectId: string, done: Function, error: Function): void;
+    /**
+     * Gets existing issues for a model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getIssues(projectId: string, modelId: string, done: Function, error: Function): void;
+    /**
+     * Gets a JSON manifest file for a model that's split into multiple XTC files
+     * (and maybe also JSON metadata files).
+     *
+     * The manifest can have an arbitrary name, and will list all the XTC
+     * (and maybe separate JSON metada files)
+     * that comprise the model.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {String} manifestName Filename of the manifest.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getSplitModelManifest(projectId: string, modelId: string, manifestName: string, done: Function, error: Function): void;
+    /**
+     * Gets one of the metadata files within a split model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {String} metadataFileName Filename of the metadata file.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getSplitModelMetadata(projectId: string, modelId: string, metadataFileName: string, done: Function, error: Function): void;
+    /**
+     * Gets one of the XTC geometry files within a split model within a project.
+     *
+     * @param {String} projectId ID of the project.
+     * @param {String} modelId ID of the model.
+     * @param {String} geometryFileName Filename of the XTC geometry file.
+     * @param {Function} done Callback through which the JSON result is returned.
+     * @param {Function} error Callback through which an error message is returned on error.
+     */
+    getSplitModelGeometry(projectId: string, modelId: string, geometryFileName: string, done: Function, error: Function): void;
+}

package/types/src/toolbar/AnnotationTool.d.ts

@@ -0,0 +1,71 @@
+import { Annotation } from "@xtctwins/tctwins-core";
+import Controller from "../Controller";
+import EventTrigger from "../EventTrigger";
+export declare type AnnotationContent = {
+    /** 当前标注所在模型ID */
+    modelId: string;
+    /** 当前标注ID */
+    entityId: string;
+    /** 当前标注类型 */
+    type: string;
+    /** 当前标注内容 */
+    content: object;
+    /** 当前标注坐标 */
+    worldPos: [];
+};
+/**
+ * 标注工具
+ * @class
+ */
+export default class AnnotationTool extends Controller {
+    private annotationsPlugin;
+    private _AnnotationList;
+    currentAnnotation: any;
+    _currentType: string;
+    protected _modelId: string;
+    protected eventTrigger: EventTrigger;
+    protected annotationWrapper: HTMLElement;
+    imageSrc: Map<string, any>;
+    /**
+         创建一个标注工具对象
+         @param {*} parent
+         @param {*} cfg
+      */
+    constructor(parent: any, cfg: any);
+    setAllVisible(visible: boolean): void;
+    clickToCreateAnno(event: any): void;
+    private getTime;
+    /**
+     * @ignore
+     * 获取鼠标或者屏幕点击事件对应坐标
+     * @param event
+     * @returns
+     */
+    getCanvasPos(event: any | undefined | null): any;
+    /**
+     * 设置当前标注类型
+     * @param {string} type
+     */
+    setCurrentType(type: string): void;
+    private initCreateAnnotation;
+    showAnnotationList(): void;
+    addAnnotation(id: string, worldPos: number[], type: string): void;
+    private clear;
+    get AnnotationList(): any;
+    set AnnotationList(value: any);
+    private getTypeImage;
+    setTypeImage(urls: any): void;
+    destroyAnnotationById(entityid: string): void;
+    /**
+     * 获取指定id的标注对象
+     * @param {string} entityid
+     * @return {} annotationsPlugin.annotations[entityid]
+     * */
+    getAnnotationById(entityid: string): Annotation;
+    /**
+     * 获取标注插件标注列表
+     * @return {} annotationsPlugin.annotations
+     */
+    get annotationPluginList(): any;
+    destroy(): void;
+}