@xeokit/xeokit-sdk 2.2.4 → 2.2.5-beta-2

package/types/viewer/metadata/MetaObject.d.ts

@@ -0,0 +1,74 @@
+import { MetaModel } from "./MetaModel";
+import { PropertySet } from "./PropertySet";
+
+/**
+ * Metadata corresponding to an {@link Entity} that represents an object.
+ */
+export declare class MetaObject {
+  /**
+   * Model metadata.
+   */
+  metaModel: MetaModel;
+
+  /**
+   * Globally-unique ID.
+   */
+  id: string;
+
+  /**
+   * ID of the corresponding object within the originating system, if any.
+   */
+  originalSystemId: string;
+
+  /**
+   * Human-readable name.
+   */
+  name: string;
+
+  /**
+   * Type - often an IFC product type.
+   */
+  type: string;
+
+  /**
+   * Optional {@link PropertySet}s used by this MetaObject.
+   */
+  propertySets: PropertySet[];
+
+  /**
+   * The parent MetaObject within the structure hierarchy.
+   */
+  parent?: MetaObject;
+
+  /**
+   * Child ObjectMeta instances within the structure hierarchy.
+   */
+  children: MetaObject[];
+
+  /**
+   * External application-specific metadata
+   */
+  external?: any;
+
+  /**
+   * Gets the {@link MetaObject#id}s of the {@link MetaObject}s within the subtree.
+   *
+   * @returns {String[]} Array of {@link MetaObject#id}s.
+   */
+  getObjectIDsInSubtree(): string[];
+
+  /**
+   * Iterates over the {@link MetaObject}s within the subtree.
+   *
+   * @param {Function} callback Callback fired at each {@link MetaObject}.
+   */
+  withMetaObjectsInSubtree(callback: (metaobect: MetaObject)=> void): void;
+
+  /**
+   * Gets the {@link MetaObject#id}s of the {@link MetaObject}s within the subtree that have the given {@link MetaObject#type}s.
+   *
+   * @param {String[]} types {@link MetaObject#type} values.
+   * @returns {String[]} Array of {@link MetaObject#id}s.
+   */
+  getObjectIDsInSubtreeByType(types: string[]): string[];
+}

package/types/viewer/metadata/MetaScene.d.ts

@@ -0,0 +1,135 @@
+import { Viewer } from "../Viewer";
+import { Scene } from "../scene/scene/Scene";
+import { MetaModel } from "./MetaModel";
+import { PropertySet } from "./PropertySet";
+import { MetaObject } from "./MetaObject";
+
+/**
+ * Metadata corresponding to a {@link Scene}.
+ */
+export declare class MetaScene {
+  /**
+     * The {@link Viewer}.
+     * @property viewer
+     * @type {Viewer}
+     */
+  viewer: Viewer;
+
+  /**
+     * The {@link Scene}.
+     * @property scene
+     * @type {Scene}
+     */
+  scene: Scene;
+
+  /**
+     * The {@link MetaModel}s belonging to this MetaScene, each mapped to its {@link MetaModel#modelId}.
+     *
+     * @type {{String:MetaModel}}
+     */
+  metaModels: {[key: string]: MetaModel};
+
+  /**
+     * The {@link PropertySet}s belonging to this MetaScene, each mapped to its {@link PropertySet#id}.
+     *
+     * @type {{String:PropertySet}}
+     */
+  propertySets: {[key: string]: PropertySet};
+
+  /**
+     * The {@link MetaObject}s belonging to this MetaScene, each mapped to its {@link MetaObject#id}.
+     *
+     * @type {{String:MetaObject}}
+     */
+  metaObjects: {[key: string]: MetaObject};
+
+  /**
+     * The {@link MetaObject}s belonging to this MetaScene, each mapped to its {@link MetaObject#type}.
+     *
+     * @type {{String:MetaObject}}
+     */
+  metaObjectsByType: {[key: string]: MetaObject};
+
+  /**
+     * Subscribes to an event fired at this Viewer.
+     *
+     * @param {String} event The event
+     * @param {Function} callback Callback fired on the event
+     */
+  on(event: string, callback: ()=> void): void;
+
+  /**
+     * Fires an event at this Viewer.
+     *
+     * @param {String} event Event name
+     * @param {Object} value Event parameters
+     */
+  fire(event: string, value: any): void;
+
+  /**
+     * Unsubscribes from an event fired at this Viewer.
+     * @param event
+     */
+  off(event: any): void;
+
+  /**
+     * Creates a {@link MetaModel} in this MetaScene.
+     *
+     * The MetaModel will contain a hierarchy of {@link MetaObject}s, created from the
+     * meta objects in ````metaModelData````.
+     *
+     * The meta object hierarchy in ````metaModelData```` is expected to be non-cyclic, with a single root. If the meta
+     * objects are cyclic, then this method will log an error and attempt to recover by creating a dummy root MetaObject
+     * of type "Model" and connecting all other MetaObjects as its direct children. If the meta objects contain multiple
+     * roots, then this method similarly attempts to recover by creating a dummy root MetaObject of type "Model" and
+     * connecting all the root MetaObjects as its children.
+     *
+     * @param {String} modelId ID for the new {@link MetaModel}, which will have {@link MetaModel#id} set to this value.
+     * @param {Object} metaModelData Data for the {@link MetaModel}.
+     * @param {Object} [options] Options for creating the {@link MetaModel}.
+     * @param {String[]} [options.includeTypes] When provided, only create {@link MetaObject}s with types in this list.
+     * @param {String[]} [options.excludeTypes] When provided, never create {@link MetaObject}s with types in this list.
+     * @param {Boolean} [options.globalizeObjectIds=false] Whether to globalize each {@link MetaObject#id}. Set this ````true```` when you need to load multiple instances of the same meta model, to avoid ID clashes between the meta objects in the different instances.
+     * @returns {MetaModel} The new MetaModel.
+     */
+  createMetaModel(modelId: string, metaModelData: any, options?: {
+    includeTypes?: string[];
+    excludeTypes?: string[];
+    globalizeObjectIds?: boolean;
+  }): MetaModel;
+
+  /**
+     * Removes a {@link MetaModel} from this MetaScene.
+     *
+     * Fires a "metaModelDestroyed" event with the value of the {@link MetaModel#id}.
+     *
+     * @param {String} id ID of the target {@link MetaModel}.
+     */
+  destroyMetaModel(id: string): void;
+
+  /**
+     * Gets the {@link MetaObject#id}s of the {@link MetaObject}s that have the given {@link MetaObject#type}.
+     *
+     * @param {String} type The type.
+     * @returns {String[]} Array of {@link MetaObject#id}s.
+     */
+  getObjectIDsByType(type: string): string[];
+
+  /**
+     * Gets the {@link MetaObject#id}s of the {@link MetaObject}s within the given subtree.
+     *
+     * @param {String} id  ID of the root {@link MetaObject} of the given subtree.
+     * @param {String[]} [includeTypes] Optional list of types to include.
+     * @param {String[]} [excludeTypes] Optional list of types to exclude.
+     * @returns {String[]} Array of {@link MetaObject#id}s.
+     */
+  getObjectIDsInSubtree(id: string, includeTypes?: string[], excludeTypes?: string[]): string[];
+
+  /**
+     * Iterates over the {@link MetaObject}s within the subtree.
+     *
+     * @param {String} id ID of root {@link MetaObject}.
+     * @param {Function} callback Callback fired at each {@link MetaObject}.
+     */
+  withMetaObjectsInSubtree(id: string, callback: ()=> void): void;
+}

package/types/viewer/metadata/Property.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A property within a {@link PropertySet}.
+ */
+export declare class Property {
+  /**
+   * The name of this property.
+   */
+  name: string;
+
+  /**
+   * The type of this property.
+   */
+  type: number | string;
+
+  /**
+   * The value of this property.
+   */
+  value: any;
+
+  /**
+   * The type of this property's value.
+   */
+  valueType: number | string;
+
+  /**
+   * Informative text to explain the property.
+   */
+  description: string;
+}

package/types/viewer/metadata/PropertySet.d.ts

@@ -0,0 +1,31 @@
+import { Property } from "./Property";
+
+/**
+ * A set of properties associated with one or more {@link MetaObject}s.
+ */
+export declare class PropertySet {
+  /**
+   * Globally-unique ID for this PropertySet.
+   */
+  id: string;
+
+  /**
+   * ID of the corresponding object within the originating system, if any.
+   */
+  originalSystemId: string;
+
+  /**
+   * Human-readable name of this PropertySet.
+   */
+  name: string;
+
+  /**
+   * Type of this PropertySet.
+   */
+  type: string;
+
+  /**
+   * Properties within this PropertySet.
+   */
+  properties: Property[];
+}

package/types/viewer/metadata/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./Metamodel";
+export * from "./MetaObject";
+export * from "./MetaScene";
+export * from "./Property";
+export * from "./PropertySet";
+export * from "./IFCObjectDefaults";