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

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

@@ -51,9 +51,9 @@ export declare class MetaObject {
   external?: any;
 
   /**
-   * Gets the {@link MetaObject#id}s of the {@link MetaObject}s within the subtree.
+   * Gets the {@link MetaObject.id}s of the {@link MetaObject}s within the subtree.
    *
-   * @returns {String[]} Array of {@link MetaObject#id}s.
+   * @returns {String[]} Array of {@link MetaObject.id}s.
    */
   getObjectIDsInSubtree(): string[];
 
@@ -65,10 +65,10 @@ export declare class 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.
+   * 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.
+   * @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

@@ -23,28 +23,28 @@ export declare class MetaScene {
   scene: Scene;
 
   /**
-     * The {@link MetaModel}s belonging to this MetaScene, each mapped to its {@link MetaModel#modelId}.
+     * 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}.
+     * 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}.
+     * 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}.
+     * The {@link MetaObject}s belonging to this MetaScene, each mapped to its {@link MetaObject.type}.
      *
      * @type {{String:MetaObject}}
      */
@@ -84,12 +84,12 @@ export declare class MetaScene {
      * 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 {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.
+     * @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?: {
@@ -101,27 +101,27 @@ export declare class MetaScene {
   /**
      * Removes a {@link MetaModel} from this MetaScene.
      *
-     * Fires a "metaModelDestroyed" event with the value of the {@link MetaModel#id}.
+     * 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}.
+     * 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.
+     * @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.
+     * 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.
+     * @returns {String[]} Array of {@link MetaObject.id}s.
      */
   getObjectIDsInSubtree(id: string, includeTypes?: string[], excludeTypes?: string[]): string[];
 

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

@@ -1,4 +1,4 @@
-export * from "./Metamodel";
+export * from "./MetaModel";
 export * from "./MetaObject";
 export * from "./MetaScene";
 export * from "./Property";

package/types/viewer/scene/CameraControl/CameraControl.d.ts

@@ -23,6 +23,14 @@ export declare class CameraControl extends Component {
   AXIS_VIEW_TOP: number;
   AXIS_VIEW_BOTTOM: number;
 
+  /**
+   * Fires when the model is loaded
+   * @param event The loaded event
+   * @param callback Called fired on the event
+   * @param scope  Scope for the callback
+   */
+  on(event: "rightClick", callback: (e: {event: MouseEvent; pagePos: number[]; canvasPos: number[]; }) => void, scope?: any): string
+
   /**
    * Sets the current navigation mode.
    *
@@ -48,9 +56,9 @@ export declare class CameraControl extends Component {
   /**
    * Sets whether to vertically constrain the {@link Camera} position for first-person navigation.
    *
-   * When set ````true````, this constrains {@link Camera#eye} to its current vertical position.
+   * When set ````true````, this constrains {@link Camera.eye} to its current vertical position.
    *
-   * Only applies when {@link CameraControl#navMode} is ````"firstPerson"````.
+   * Only applies when {@link CameraControl.navMode} is ````"firstPerson"````.
    *
    * Default is ````false````.
    *
@@ -61,9 +69,9 @@ export declare class CameraControl extends Component {
   /**
    * Gets whether to vertically constrain the {@link Camera} position for first-person navigation.
    *
-   * When set ````true````, this constrains {@link Camera#eye} to its current vertical position.
+   * When set ````true````, this constrains {@link Camera.eye} to its current vertical position.
    *
-   * Only applies when {@link CameraControl#navMode} is ````"firstPerson"````.
+   * Only applies when {@link CameraControl.navMode} is ````"firstPerson"````.
    *
    * Default is ````false````.
    *
@@ -196,7 +204,7 @@ export declare class CameraControl extends Component {
    *
    * Default is ````0.0````.
    *
-   * Does not apply when {@link CameraControl#navMode} is ````"planView"````, which disallows rotation.
+   * Does not apply when {@link CameraControl.navMode} is ````"planView"````, which disallows rotation.
    *
    * @param {Number} rotationInertia New inertial factor.
    */
@@ -207,7 +215,7 @@ export declare class CameraControl extends Component {
    *
    * Default is ````0.0````.
    *
-   * Does not apply when {@link CameraControl#navMode} is ````"planView"````, which disallows rotation.
+   * Does not apply when {@link CameraControl.navMode} is ````"planView"````, which disallows rotation.
    *
    * @returns {Number} The inertia factor.
    */
@@ -483,7 +491,7 @@ export declare class CameraControl extends Component {
   private _isKeyDownForAction;
 
   /**
-   * Sets the HTMl element to represent the pivot point when {@link CameraControl#followPointer} is true.
+   * Sets the HTMl element to represent the pivot point when {@link CameraControl.followPointer} is true.
    *
    * See class comments for an example.
    *
@@ -494,7 +502,7 @@ export declare class CameraControl extends Component {
   /**
    * Sets the current World-space 3D target position.
    *
-   * Only applies when {@link CameraControl#followPointer} is ````true````.
+   * Only applies when {@link CameraControl.followPointer} is ````true````.
    *
    * @param {Number[]} worldPos The new World-space 3D target position.
    */
@@ -503,7 +511,7 @@ export declare class CameraControl extends Component {
   /**
    * Gets the current World-space 3D pivot position.
    *
-   * Only applies when {@link CameraControl#followPointer} is ````true````.
+   * Only applies when {@link CameraControl.followPointer} is ````true````.
    *
    * @return {Number[]} worldPos The current World-space 3D pivot position.
    */
@@ -536,11 +544,11 @@ export declare class CameraControl extends Component {
   /**
    * Sets whether this ````CameraControl```` is in first-person mode.
    *
-   * In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise,  {@link Camera#eye} rotates about {@link Camera#look}.
+   * In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise,  {@link Camera.eye} rotates about {@link Camera.look}.
    *
    * Default is ````false````.
    *
-   * Deprecated - use {@link CameraControl#navMode} instead.
+   * Deprecated - use {@link CameraControl.navMode} instead.
    *
    * @param {Boolean} value Set ````true```` to enable first-person mode.
    * @deprecated
@@ -550,11 +558,11 @@ export declare class CameraControl extends Component {
   /**
    * Gets whether this ````CameraControl```` is in first-person mode.
    *
-   * In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise,  {@link Camera#eye} rotates about {@link Camera#look}.
+   * In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise,  {@link Camera.eye} rotates about {@link Camera.look}.
    *
    * Default is ````false````.
    *
-   * Deprecated - use {@link CameraControl#navMode} instead.
+   * Deprecated - use {@link CameraControl.navMode} instead.
    *
    * @returns {Boolean} Returns ````true```` if first-person mode is enabled.
    * @deprecated
@@ -565,13 +573,13 @@ export declare class CameraControl extends Component {
    * Sets whether smart default pivoting is enabled.
    *
    * When ````true````, we'll pivot by default about the 3D position of the mouse/touch pointer on an
-   * imaginary sphere that's centered at {@link Camera#eye} and sized to the {@link Scene} boundary.
+   * imaginary sphere that's centered at {@link Camera.eye} and sized to the {@link Scene} boundary.
    *
-   * When ````false````, we'll pivot by default about {@link Camera#look}.
+   * When ````false````, we'll pivot by default about {@link Camera.look}.
    *
    * Default is ````false````.
    *
-   * @param {Boolean} enabled Set ````true```` to pivot by default about the selected point on the virtual sphere, or ````false```` to pivot by default about {@link Camera#look}.
+   * @param {Boolean} enabled Set ````true```` to pivot by default about the selected point on the virtual sphere, or ````false```` to pivot by default about {@link Camera.look}.
    */
   set smartPivot(arg: boolean);
 
@@ -579,13 +587,13 @@ export declare class CameraControl extends Component {
    * Gets whether smart default pivoting is enabled.
    *
    * When ````true````, we'll pivot by default about the 3D position of the mouse/touch pointer on an
-   * imaginary sphere that's centered at {@link Camera#eye} and sized to the {@link Scene} boundary.
+   * imaginary sphere that's centered at {@link Camera.eye} and sized to the {@link Scene} boundary.
    *
-   * When ````false````, we'll pivot by default about {@link Camera#look}.
+   * When ````false````, we'll pivot by default about {@link Camera.look}.
    *
    * Default is ````false````.
    *
-   * @returns {Boolean} Returns ````true```` when pivoting by default about the selected point on the virtual sphere, or ````false```` when pivoting by default about {@link Camera#look}.
+   * @returns {Boolean} Returns ````true```` when pivoting by default about the selected point on the virtual sphere, or ````false```` when pivoting by default about {@link Camera.look}.
    */
   get smartPivot(): boolean;
 }

package/types/viewer/scene/Component.d.ts

@@ -34,12 +34,12 @@ export abstract class Component {
     /**
      * ID of this Component, unique within the {@link Scene}.
      *
-     * Components are mapped by this ID in {@link Scene#components}.
+     * Components are mapped by this ID in {@link Scene.components}.
      *
      * @property id
-     * @type {String|Number}
+     * @type {String}
      */
-    id: string | number;
+    id: string;
 
     /**
      * The {@link Component} that owns the lifecycle of this Component, if any.
@@ -79,12 +79,12 @@ export abstract class Component {
      * @param {String} event The event
      * @param {Function} callback Called fired on the event
      * @param {Object} [scope=this] Scope for the callback
-     * @return {String} Handle to the subscription, which may be used to unsubscribe with {@link #off}.
+     * @return {String} Handle to the subscription, which may be used to unsubscribe with {@link .off}.
      */
     on(event: string, callback: Function, scope?: any): string;
 
     /**
-     * Cancels an event subscription that was previously made with {@link Component#on} or {@link Component#once}.
+     * Cancels an event subscription that was previously made with {@link Component.on} or {@link Component.once}.
      *
      * @param {String} subId Subscription ID
      */
@@ -93,7 +93,7 @@ export abstract class Component {
     /**
      * Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.
      *
-     * This is equivalent to calling {@link Component#on}, and then calling {@link Component#off} inside the callback function.
+     * This is equivalent to calling {@link Component.on}, and then calling {@link Component.off} inside the callback function.
      *
      * @param {String} event Data event to listen to
      * @param {Function} callback Called when fresh data is available at the event

package/types/viewer/scene/Entity.d.ts

@@ -17,9 +17,9 @@ export declare abstract class Entity {
   /**
    * ID of the corresponding object within the originating system, if any.
    *
-   * By default, this has the same value as {@link Entity#id}. When we load a model using {@link XKTLoaderPlugin#load},
-   * with {@link XKTLoaderPlugin#globalizeObjectIds} set ````true````, then that plugin will prefix {@link Entity#id}
-   * with the model ID, while leaving this property holding the original value of {@link Entity#id}. When loading an
+   * By default, this has the same value as {@link Entity.id}. When we load a model using {@link XKTLoaderPlugin.load},
+   * with {@link XKTLoaderPlugin.globalizeObjectIds} set ````true````, then that plugin will prefix {@link Entity.id}
+   * with the model ID, while leaving this property holding the original value of {@link Entity.id}. When loading an
    * IFC model, this property will hold the IFC product ID of the corresponding IFC element.
    *
    * @type {String}
@@ -36,7 +36,7 @@ export declare abstract class Entity {
   /**
    * Returns ````true```` if this Entity represents a model.
    *
-   * When this is ````true````, the Entity will be registered by {@link Entity#id} in {@link Scene#models} and
+   * When this is ````true````, the Entity will be registered by {@link Entity.id} in {@link Scene.models} and
    * may also have a corresponding {@link MetaModel}.
    *
    * @type {Boolean}
@@ -47,7 +47,7 @@ export declare abstract class Entity {
   /**
    * Returns ````true```` if this Entity represents an object.
    *
-   * When this is ````true````, the Entity will be registered by {@link Entity#id} in {@link Scene#objects} and
+   * When this is ````true````, the Entity will be registered by {@link Entity.id} in {@link Scene.objects} and
    * may also have a corresponding {@link MetaObject}.
    *
    * @type {Boolean}
@@ -96,10 +96,10 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is visible.
    *
-   * Only rendered when {@link Entity#visible} is ````true```` and {@link Entity#culled} is ````false````.
+   * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
    *
-   * When {@link Entity#isObject} and {@link Entity#visible} are both ````true```` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#visibleObjects}.
+   * When {@link Entity.isObject} and {@link Entity.visible} are both ````true```` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.visibleObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -109,10 +109,10 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is visible.
    *
-   * Only rendered when {@link Entity#visible} is ````true```` and {@link Entity#culled} is ````false````.
+   * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
    *
-   * When {@link Entity#isObject} and {@link Entity#visible} are both ````true```` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#visibleObjects}.
+   * When {@link Entity.isObject} and {@link Entity.visible} are both ````true```` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.visibleObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -122,8 +122,8 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is xrayed.
    *
-   * When {@link Entity#isObject} and {@link Entity#xrayed} are both ````true``` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#xrayedObjects}.
+   * When {@link Entity.isObject} and {@link Entity.xrayed} are both ````true``` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.xrayedObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -133,8 +133,8 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is xrayed.
    *
-   * When {@link Entity#isObject} and {@link Entity#xrayed} are both ````true``` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#xrayedObjects}.
+   * When {@link Entity.isObject} and {@link Entity.xrayed} are both ````true``` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.xrayedObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -144,8 +144,8 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is highlighted.
    *
-   * When {@link Entity#isObject} and {@link Entity#highlighted} are both ````true```` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#highlightedObjects}.
+   * When {@link Entity.isObject} and {@link Entity.highlighted} are both ````true```` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.highlightedObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -155,8 +155,8 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is highlighted.
    *
-   * When {@link Entity#isObject} and {@link Entity#highlighted} are both ````true```` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#highlightedObjects}.
+   * When {@link Entity.isObject} and {@link Entity.highlighted} are both ````true```` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.highlightedObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -166,8 +166,8 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is selected.
    *
-   * When {@link Entity#isObject} and {@link Entity#selected} are both ````true``` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#selectedObjects}.
+   * When {@link Entity.isObject} and {@link Entity.selected} are both ````true``` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.selectedObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -177,8 +177,8 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is selected.
    *
-   * When {@link Entity#isObject} and {@link Entity#selected} are both ````true``` the Entity will be
-   * registered by {@link Entity#id} in {@link Scene#selectedObjects}.
+   * When {@link Entity.isObject} and {@link Entity.selected} are both ````true``` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.selectedObjects}.
    *
    * @type {Boolean}
    * @abstract
@@ -204,7 +204,7 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is culled.
    *
-   * Only rendered when {@link Entity#visible} is ````true```` and {@link Entity#culled} is ````false````.
+   * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
    *
    * @type {Boolean}
    * @abstract
@@ -214,7 +214,7 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is culled.
    *
-   * Only rendered when {@link Entity#visible} is ````true```` and {@link Entity#culled} is ````false````.
+   * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
    *
    * @type {Boolean}
    * @abstract
@@ -224,7 +224,7 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is clippable.
    *
-   * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
    *
    * @type {Boolean}
    * @abstract
@@ -234,7 +234,7 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is clippable.
    *
-   * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
    *
    * @type {Boolean}
    * @abstract
@@ -260,7 +260,7 @@ export declare abstract class Entity {
   /**
    * Sets if this Entity is pickable.
    *
-   * Picking is done via calls to {@link Scene#pick}.
+   * Picking is done via calls to {@link Scene.pick}.
    *
    * @type {Boolean}
    * @abstract
@@ -270,7 +270,7 @@ export declare abstract class Entity {
   /**
    * Gets if this Entity is pickable.
    *
-   * Picking is done via calls to {@link Scene#pick}.
+   * Picking is done via calls to {@link Scene.pick}.
    *
    * @type {Boolean}
    * @abstract