@xtctwins/tctwins-bimx-viewer 0.1.0

package/types/src/IFCObjectDefaults/ModelIFCObjectColors.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @desc Default initial properties for {@link Entity}s loaded from models accompanied by metadata.
+ *
+ * When loading a model, a loader plugins such as {@link GLTFLoaderPlugin} and {@link BIMServerLoaderPlugin} create
+ * a tree of {@link Entity}s that represent the model. These loaders can optionally load metadata, to create
+ * a {@link MetaModel} corresponding to the root {@link Entity}, with a {@link MetaObject} corresponding to each
+ * object {@link Entity} within the tree.
+ *
+ * @private
+ * @type {{String:Object}}
+ */
+declare const ModelIFCObjectColors: {
+    IfcSpace: {
+        opacity: number;
+    };
+    IfcWindow: {
+        opacity: number;
+    };
+    IfcOpeningElement: {
+        opacity: number;
+    };
+    IfcPlate: {
+        opacity: number;
+    };
+};
+export default ModelIFCObjectColors;

package/types/src/IFCObjectDefaults/ViewerIFCObjectColors.d.ts

@@ -0,0 +1,161 @@
+/**
+ * @desc Default initial properties for {@link Entity}s loaded from models accompanied by metadata.
+ *
+ * When loading a model, a loader plugins such as {@link GLTFLoaderPlugin} and {@link BIMServerLoaderPlugin} create
+ * a tree of {@link Entity}s that represent the model. These loaders can optionally load metadata, to create
+ * a {@link MetaModel} corresponding to the root {@link Entity}, with a {@link MetaObject} corresponding to each
+ * object {@link Entity} within the tree.
+ *
+ * @private
+ * @type {{String:Object}}
+ */
+declare const ViewerIFCObjectColors: {
+    IfcRoof: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcSlab: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcWall: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcWallStandardCase: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcCovering: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcDoor: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcStair: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcStairFlight: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcProxy: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcRamp: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcColumn: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcBeam: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcCurtainWall: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcPlate: {
+        colorize: number[];
+        opacity: number;
+        priority: number;
+    };
+    IfcTransportElement: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFooting: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcRailing: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFurnishingElement: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFurniture: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcSystemFurnitureElement: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFlowSegment: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFlowitting: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFlowTerminal: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFlowController: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcFlowFitting: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcDuctSegment: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcDistributionFlowElement: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcDuctFitting: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcLightFixture: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcAirTerminal: {
+        colorize: number[];
+        priority: number;
+    };
+    IfcOpeningElement: {
+        colorize: number[];
+        opacity: number;
+        priority: number;
+    };
+    IfcSpace: {
+        opacity: number;
+    };
+    IfcWindow: {
+        colorize: number[];
+        opacity: number;
+        priority: number;
+    };
+    IfcBuildingElementProxy: {
+        colorize: number[];
+    };
+    IfcSite: {
+        colorize: number[];
+    };
+    IfcMember: {
+        colorize: number[];
+    };
+    DEFAULT: {
+        colorize: number[];
+        priority: number;
+    };
+};
+export default ViewerIFCObjectColors;

package/types/src/TMap.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 表示一个map的类
+ * @class
+ */
+export default class TMap {
+    items: any;
+    protected _lastUniqueId: number;
+    /**
+     * 创建一个map实例。
+     * @constructor
+     * @param {any} items - map的成员。
+     * @param {number} baseId - map的成员ID。
+     */
+    constructor(items?: any, baseId?: number);
+    /**
+     * 添加成员。
+     * @param {any} args - 成员。
+     * @returns {number} - 成员ID。
+     */
+    addItem(...args: any): number;
+    /**
+     * 移除成员
+     * @param {number} id - 成员ID。
+     * @returns {any} - 移除的成员。
+     */
+    removeItem(id: number): any;
+}

package/types/src/collision/ObjectsKdTree3.d.ts

@@ -0,0 +1,37 @@
+/**
+ * A k-d tree for World-space 3D Entity collision detection with AABBs and frustums.
+ * @class
+ */
+export default class ObjectsKdTree3 {
+    viewer: any;
+    protected _maxTreeDepth: number;
+    protected _root: any;
+    protected _needsRebuild: boolean;
+    protected _onModelLoaded: any;
+    protected _onModelUnloaded: any;
+    /**
+     * 创建一个KdTree3。
+     * @param {any} cfg - 配置参数。
+     */
+    constructor(cfg: any);
+    /**
+     * 获取KdTree的根节点。
+     * @returns {any} - 根节点。
+     */
+    get root(): any;
+    /**
+     * 重新构建KdTree。
+     */
+    protected _rebuild(): void;
+    /**
+     * 插入实体到KdTree。
+     * @param {any} node - KdTree节点。
+     * @param {any} entity - 实体数据
+     * @param {number} depth - 深度。
+     */
+    protected _insertEntity(node: any, entity: any, depth: number): void;
+    /**
+     * 删除KdTree。
+     */
+    destroy(): void;
+}

package/types/src/contextMenus/CanvasContextMenu.d.ts

@@ -0,0 +1,12 @@
+import { ContextMenu } from "@xtctwins/tctwins-core";
+/**
+ * 表示Canvas的上下文菜单
+ * @class
+ */
+export default class CanvasContextMenu extends ContextMenu {
+    /**
+       * 创建一个Canvas上下文菜单
+       * @param {*} cfg 上下文菜单配置
+       */
+    constructor(cfg?: any);
+}

package/types/src/contextMenus/ModelsContextMenu.d.ts

@@ -0,0 +1,13 @@
+import { ContextMenu } from "@xtctwins/tctwins-core";
+/**
+ * 表示模型上下文菜单。
+ * @param {*} cfg Configs
+ * @param {Boolean} [cfg.enableEditModels=false] Set true to show Add/Edit/Delete options in the menu.
+ */
+export default class ModelsContextMenu extends ContextMenu {
+    /**
+       * 创建一个模型上下文菜单。
+       *
+       */
+    constructor(cfg?: any);
+}

package/types/src/contextMenus/ObjectContextMenu.d.ts

@@ -0,0 +1,20 @@
+import { ContextMenu } from "@xtctwins/tctwins-core";
+import BIMViewer from "../BIMViewer";
+/**
+ * 表示对象上下文菜单。
+ *
+ */
+export default class ObjectContextMenu extends ContextMenu {
+    protected _bimViewer: BIMViewer;
+    /**
+     * 创建一个对象上下文菜单
+     * @param {BIMViewer} bimViewer
+     * @param {*} cfg
+     */
+    constructor(bimViewer: BIMViewer, cfg?: any);
+    /**
+     * 创建菜单项
+     *
+     */
+    protected _buildMenu(): void;
+}

package/types/src/contextMenus/TreeViewContextMenu.d.ts

@@ -0,0 +1,20 @@
+import { ContextMenu } from "@xtctwins/tctwins-core";
+import BIMViewer from "../BIMViewer";
+/**
+ * 表示树状视图上下文菜单。
+ * @class
+ */
+export default class TreeViewContextMenu extends ContextMenu {
+    protected _bimViewer: BIMViewer;
+    /**
+     * 创建一个树状视图上下文菜单。
+     * @param {BIMViewer} bimViewer
+     * @param {*} cfg
+     */
+    constructor(bimViewer: BIMViewer, cfg?: any);
+    /**
+     * 创建菜单项
+     *
+     */
+    protected _buildMenu(): void;
+}

package/types/src/explorer/ClassesExplorer.d.ts

@@ -0,0 +1,75 @@
+import { TreeViewPlugin } from "@xtctwins/tctwins-core";
+import Controller from "../Controller";
+import EventTrigger from "../EventTrigger";
+/**
+ *
+ * @class
+ */
+export default class ClassesExplorer extends Controller {
+    protected _treeView: TreeViewPlugin;
+    protected _onModelLoaded: any;
+    protected _onMetaDataLoaded: any;
+    protected _onModelUnloaded: any;
+    protected eventTrigger: EventTrigger;
+    protected _rootNode: any;
+    protected _nodeList: any;
+    protected _objectList: any;
+    /**
+     *
+     * @param {*} parent
+     * @param {*} cfg
+     */
+    constructor(parent: any, cfg?: any);
+    get rootNode(): any;
+    get nodesList(): any;
+    get objectList(): any;
+    getNodeIdByObjectId(objectId: string): any;
+    /**
+     * 获取指定id节点的children
+     * @param {*} nodeId
+     * @returns node
+     */
+    getNodeById(nodeId: string): any;
+    /**
+     * 获取指定id节点的children
+     * @param {*} nodeId
+     * @returns nodes
+     */
+    getChildrenById(nodeId: string): void;
+    /**
+     * 勾选框点击事件
+     * @param event
+     */
+    checkboxChangeHandler(nodeId: any, check: boolean): void;
+    /**
+     * 点击标题
+     * @param e 点击事件
+     */
+    nodeTitleClicked(nodeId: any): void;
+    /**
+     *
+     * @param {boolean} enabled
+     */
+    setEnabled(enabled: boolean): void;
+    /**
+     *
+     * @param {number} depth
+     */
+    expandTreeViewToDepth(depth: number): void;
+    /**
+     *
+     * @param {string} objectId
+     */
+    showNodeInTreeView(objectId: string): void;
+    /**
+     *
+     *
+     */
+    unShowNodeInTreeView(): void;
+    /**
+     *
+     *
+     */
+    destroy(): void;
+    get treeView(): TreeViewPlugin;
+}

package/types/src/explorer/ModelsExplorer.d.ts

@@ -0,0 +1,106 @@
+import { XTCLoaderPlugin, WebIFCLoaderPlugin } from "@xtctwins/tctwins-core";
+import Controller from "../Controller";
+import EventTrigger from "../EventTrigger";
+/**
+ * Custom data access strategy for {@link XTCLoaderPlugin}.
+ * @class
+ */
+declare class BIMViewerDataSource {
+    protected _server: any;
+    protected _projectId: string;
+    protected _modelId: string;
+    /**
+     * @param {*} server
+     */
+    constructor(server: any, cfg: any);
+    /**
+     * 设置项目ID
+     * @param {string} _projectId
+     */
+    setProjectId(projectId: string): void;
+    /**
+     * 设置模型ID
+     * @param {string} modelId
+     */
+    setModelId(modelId: string): void;
+    /**
+     * 获取清单
+     * @param {*} src
+     * @param {Function} ok
+     * @param {Function} error
+     */
+    getManifest(src: any, ok: Function, error: Function): void;
+    /**
+     * 获取元模型数据
+     * @param {*} src
+     * @param {Function} ok
+     * @param {Function} error
+     */
+    getMetaModel(src: any, ok: Function, error: Function): void;
+    /**
+     * 获取XTC模型
+     * @param {*} src
+     * @param {Function} ok
+     * @param {Function} error
+     */
+    getXTC(src: any, ok: Function, error: Function): void;
+}
+/**
+ *
+ * @class
+ */
+export default class ModelsExplorer extends Controller {
+    protected _dataSource: BIMViewerDataSource;
+    _xtcLoader: XTCLoaderPlugin | null | undefined;
+    _ifcLoader: WebIFCLoaderPlugin | null | undefined;
+    protected _modelsInfo: any;
+    protected _numModels: number;
+    protected _numModelsLoaded: number;
+    protected _projectId: string | null;
+    protected _modelFromOutSide: boolean;
+    protected _modelType: string;
+    protected _modelArrayBuffer: ArrayBuffer;
+    protected _modelMetaData: any;
+    protected _modelSrc: string;
+    protected _modelConfig: any;
+    protected _eventTrigger: EventTrigger;
+    /**
+     *
+     * @param {*} parent
+     * @param {*} cfg
+     */
+    constructor(parent: any, cfg: any);
+    /**
+     *
+     */
+    getModelIds(): string[];
+    /**
+     * @param {string} modelId
+     * @param {Function} done
+     * @param {Function} error
+     */
+    loadModel(modelId: string, done?: Function, error?: Function): void;
+    /**
+     * 单独加载元数据
+     * @param metaModel
+     * @param deflatedMetadata
+     */
+    loadMetadata(metaModel: any, deflatedMetadata: any, done?: Function): void;
+    /**
+     * @param {string} modelId
+     * @param {*} modelInfo
+     * @param {*} json
+     * @param {Function} done
+     * @param {Function} error
+     */
+    protected _loadGeometry(modelId: string, modelInfo: any, json: any, done: Function, error: Function): void;
+    /**
+     *
+     */
+    _jumpToInitialCamera(): void;
+    /**
+     *
+     */
+    destroy(): void;
+}
+export {};

package/types/src/explorer/ObjectsExplorer.d.ts

@@ -0,0 +1,44 @@
+import { TreeViewPlugin } from "@xtctwins/tctwins-core";
+import Controller from "../Controller";
+import EventTrigger from "../EventTrigger";
+/**
+ *
+ * @class
+ */
+export default class ObjectsExplorer extends Controller {
+    protected _treeView: TreeViewPlugin;
+    protected _onModelLoaded: any;
+    protected _onMetaDataLoaded: any;
+    protected _onModelUnloaded: any;
+    protected eventTrigger: EventTrigger;
+    protected _rootNode: any;
+    protected _nodeList: any;
+    protected _objectList: any;
+    /**
+     * @param {*} parent
+     * @param {*} cfg
+     */
+    constructor(parent: any, cfg?: any);
+    get rootNode(): any;
+    get nodesList(): any;
+    get objectList(): any;
+    get treeView(): TreeViewPlugin;
+    getNodeIdByObjectId(objectId: string): null | undefined;
+    /**
+     * 获取指定id节点的children
+     * @param {*} nodeId
+     * @returns node
+     */
+    getNodeById(nodeId: string): any;
+    /**
+     * 获取指定id节点的children
+     * @param {*} nodeId
+     * @returns nodes
+     */
+    getChildrenById(nodeId: string): void;
+    /**
+     * @param {boolean} enabled
+     */
+    setEnabled(enabled: boolean): void;
+    destroy(): void;
+}

package/types/src/explorer/StoreysExplorer.d.ts

@@ -0,0 +1,58 @@
+import { TreeViewPlugin } from "@xtctwins/tctwins-core";
+import Controller from "../Controller";
+import EventTrigger from "../EventTrigger";
+/**
+ *
+ * @class
+ */
+export default class StoreysExplorer extends Controller {
+    protected _treeView: TreeViewPlugin;
+    protected _onModelLoaded: any;
+    protected _onMetaDataLoaded: any;
+    protected _onModelUnloaded: any;
+    protected eventTrigger: EventTrigger;
+    protected _rootNode: any;
+    protected _nodeList: any;
+    protected _objectList: any;
+    /**
+     * @param {*} parent
+     * @param {*} cfg
+     */
+    constructor(parent: any, cfg?: any);
+    get rootNode(): any;
+    get nodesList(): any;
+    get objectList(): any;
+    getNodeIdByObjectId(objectId: string): null | undefined;
+    /**
+     * 获取指定id节点的children
+     * @param {*} nodeId
+     * @returns node
+     */
+    getNodeById(nodeId: string): any;
+    /**
+     * 获取指定id节点的children
+     * @param {*} nodeId
+     * @returns nodes
+     */
+    getChildrenById(nodeId: string): void;
+    /**
+     * 勾选框点击事件
+     * @param event
+     */
+    checkboxChangeHandler(nodeId: any, check: boolean): void;
+    /**
+     * 点击标题
+     * @param e 点击事件
+     */
+    nodeTitleClicked(nodeId: any): void;
+    /**
+     * @param {boolean} enabled
+     */
+    setEnabled(enabled: boolean): void;
+    protected _selectObjects(objectIds: string, done: Function): void;
+    destroy(): void;
+    expandTreeViewToDepth(depth: number): void;
+    showNodeInTreeView(objectId: string): void;
+    unShowNodeInTreeView(): void;
+    selectStorey(storeyObjectId: string, done: Function): void;
+}

package/types/src/inspector/PropertiesInspector.d.ts

@@ -0,0 +1,39 @@
+import Controller from "../Controller";
+/**
+ * @class
+ */
+export default class PropertiesInspector extends Controller {
+    protected _metaObject: any;
+    protected _onModelUnloaded: any;
+    /**
+     * 创建一个PropertiesInspector.
+     * @param {*} parent -
+     * @param {*} cfg - PropertiesInspector configuration.
+     */
+    constructor(parent: any, cfg?: any);
+    getEntityInfo(objectId: string): {
+        id: any;
+        name: any;
+        type: any;
+        propertySets: any;
+    } | null;
+    /**
+     * 显示属性集。
+     * @param {string} objectId 对象ID
+     */
+    showObjectPropertySets(objectId: string): void;
+    /**
+     * 清除。
+     */
+    clear(): void;
+    /**
+     * 设置属性集。
+     * @para {*} metaObject
+     * @para {*} propertySets
+     */
+    protected _setPropertySets(metaObject: any, propertySets?: any): void;
+    /**
+     *
+     */
+    destroy(): void;
+}