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

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

@@ -0,0 +1,155 @@
+import { Viewer } from "../Viewer";
+import { Scene } from "./scene/Scene";
+
+/**
+ * Base class for all xeokit components.
+ */
+export abstract class Component {
+    constructor(owner?: any, cfg?: {});
+
+    /**
+     * The parent {@link Scene} that contains this Component.
+     *
+     * @property scene
+     * @type {Scene}
+     * @final
+     */
+    scene: Scene;
+
+    /**
+     * The viewer that contains this Scene.
+     * @property viewer
+     * @type {Viewer}
+     */
+    viewer: Viewer;
+
+    /**
+     Arbitrary, user-defined metadata on this component.
+
+     @property metadata
+     @type Object
+     */
+    meta: any;
+
+    /**
+     * ID of this Component, unique within the {@link Scene}.
+     *
+     * Components are mapped by this ID in {@link Scene#components}.
+     *
+     * @property id
+     * @type {String|Number}
+     */
+    id: string | number;
+
+    /**
+     * The {@link Component} that owns the lifecycle of this Component, if any.
+     *
+     * When that component is destroyed, this component will be automatically destroyed also.
+     *
+     * Will be null if this Component has no owner.
+     *
+     * @property owner
+     * @type {Component}
+     */
+    get owner(): Component;
+
+    /**
+     * Tests if this component is of the given type, or is a subclass of the given type.
+     * @type {Boolean}
+     */
+    isType(type: any): boolean;
+
+    /**
+     * Fires an event on this component.
+     *
+     * Notifies existing subscribers to the event, optionally retains the event to give to
+     * any subsequent notifications on the event as they are made.
+     *
+     * @param {String} event The event type name
+     * @param {Object} value The event parameters
+     * @param {Boolean} [forget=false] When true, does not retain for subsequent subscribers
+     */
+    fire(event: string, value: any, forget?: boolean): void;
+
+    /**
+     * Subscribes to an event on this component.
+     *
+     * The callback is be called with this component as scope.
+     *
+     * @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}.
+     */
+    on(event: string, callback: Function, scope?: any): string;
+
+    /**
+     * Cancels an event subscription that was previously made with {@link Component#on} or {@link Component#once}.
+     *
+     * @param {String} subId Subscription ID
+     */
+    off(subId: string): void;
+
+    /**
+     * 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.
+     *
+     * @param {String} event Data event to listen to
+     * @param {Function} callback Called when fresh data is available at the event
+     * @param {Object} [scope=this] Scope for the callback
+     */
+    once(event: string, callback: Function, scope?: any): void;
+
+    /**
+     * Returns true if there are any subscribers to the given event on this component.
+     *
+     * @param {String} event The event
+     * @return {Boolean} True if there are any subscribers to the given event on this component.
+     */
+    hasSubs(event: string): boolean;
+
+    /**
+     * Logs a console debugging message for this component.
+     *
+     * The console message will have this format: *````[LOG] [<component type> <component id>: <message>````*
+     *
+     * Also fires the message as a "log" event on the parent {@link Scene}.
+     *
+     * @param {String} message The message to log
+     */
+    log(message: string): void;
+
+    /**
+     * Logs a warning for this component to the JavaScript console.
+     *
+     * The console message will have this format: *````[WARN] [<component type> =<component id>: <message>````*
+     *
+     * Also fires the message as a "warn" event on the parent {@link Scene}.
+     *
+     * @param {String} message The message to log
+     */
+    warn(message: string): void;
+
+    /**
+     * Logs an error for this component to the JavaScript console.
+     *
+     * The console message will have this format: *````[ERROR] [<component type> =<component id>: <message>````*
+     *
+     * Also fires the message as an "error" event on the parent {@link Scene}.
+     *
+     * @param {String} message The message to log
+     */
+    error(message: string): void;
+
+    /**
+     * Destroys all {@link Component}s that are owned by this. These are Components that were instantiated with
+     * this Component as their first constructor argument.
+     */
+    clear(): void;
+
+    /**
+     * Destroys this component.
+     */
+    destroy(): void;
+}

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

@@ -0,0 +1,394 @@
+/**
+ * An abstract 3D scene element that can be individually shown, hidden, selected,
+ * highlighted, xrayed, culled, picked, clipped and bounded.
+ *
+ * @abstract
+ */
+
+export declare abstract class Entity {
+  /**
+   * Component ID, unique within the {@link Scene}.
+   *
+   * @type {Number|String}
+   * @abstract
+   */
+  get id(): string | number;
+
+  /**
+   * 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
+   * IFC model, this property will hold the IFC product ID of the corresponding IFC element.
+   *
+   * @type {String}
+   */
+  get originalSystemId(): string;
+
+  /**
+   * Returns true to indicate that this is an Entity.
+   *
+   * @returns {Boolean}
+   */
+  get isEntity(): boolean;
+
+  /**
+   * 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
+   * may also have a corresponding {@link MetaModel}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get isModel(): boolean;
+
+  /**
+   * 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
+   * may also have a corresponding {@link MetaObject}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get isObject(): boolean;
+
+  /** Returns the parent Entity, if any. */
+  get parent(): void;
+
+  /**
+   * Sets the 3D World-space origin for this Entity.
+   *
+   * @type {Float64Array}
+   * @abstract
+   */
+  set origin(arg: Float64Array);
+
+  /**
+   * Gets the 3D World-space origin for this Entity.
+   *
+   * @type {Float64Array}
+   * @abstract
+   */
+  get origin(): Float64Array;
+
+  /**
+   * World-space 3D axis-aligned bounding box (AABB) of this Entity.
+   *
+   * Represented by a six-element Float64Array containing the min/max extents of the
+   * axis-aligned volume, ie. ````[xmin, ymin,zmin,xmax,ymax, zmax]````.
+   *
+   * @type {Float64Array}
+   * @abstract
+   */
+  get aabb(): number[];
+
+  /**
+   * The approximate number of triangles in this Entity.
+   *
+   * @type {Number}
+   * @abstract
+   */
+  get numTriangles(): number;
+
+  /**
+   * Sets if this Entity is visible.
+   *
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set visible(arg: boolean);
+
+  /**
+   * Gets if this Entity is visible.
+   *
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get visible(): boolean;
+
+  /**
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set xrayed(arg: boolean);
+
+  /**
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get xrayed(): boolean;
+
+  /**
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set highlighted(arg: boolean);
+
+  /**
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get highlighted(): boolean;
+
+  /**
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set selected(arg: boolean);
+
+  /**
+   * 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}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get selected(): boolean;
+
+  /**
+   * Sets if this Entity's edges are enhanced.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set edges(arg: boolean);
+
+  /**
+   * Gets if this Entity's edges are enhanced.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get edges(): boolean;
+
+  /**
+   * Sets if this Entity is culled.
+   *
+   * Only rendered when {@link Entity#visible} is ````true```` and {@link Entity#culled} is ````false````.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set culled(arg: boolean);
+
+  /**
+   * Gets if this Entity is culled.
+   *
+   * Only rendered when {@link Entity#visible} is ````true```` and {@link Entity#culled} is ````false````.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get culled(): boolean;
+
+  /**
+   * Sets if this Entity is clippable.
+   *
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set clippable(arg: boolean);
+
+  /**
+   * Gets if this Entity is clippable.
+   *
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get clippable(): boolean;
+
+  /**
+   * Sets if this Entity is included in boundary calculations.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set collidable(arg: boolean);
+
+  /**
+   * Gets if this Entity is included in boundary calculations.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get collidable(): boolean;
+
+  /**
+   * Sets if this Entity is pickable.
+   *
+   * Picking is done via calls to {@link Scene#pick}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set pickable(arg: boolean);
+
+  /**
+   * Gets if this Entity is pickable.
+   *
+   * Picking is done via calls to {@link Scene#pick}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get pickable(): boolean;
+
+  /**
+   * Sets the Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
+   *
+   * Each element of the color is in range ````[0..1]````.
+   *
+   * @type {Number[]}
+   * @abstract
+   */
+  set colorize(arg: number[]);
+
+  /**
+   * Gets the Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
+   *
+   * Each element of the color is in range ````[0..1]````.
+   *
+   * @type {Number[]}
+   * @abstract
+   */
+  get colorize(): number[];
+
+  /**
+   * Sets the Entity's opacity factor, multiplies by the Entity's rendered fragment alphas.
+   *
+   * This is a factor in range ````[0..1]````.
+   *
+   * @type {Number}
+   * @abstract
+   */
+  set opacity(arg: number);
+
+  /**
+   * Gets the Entity's opacity factor.
+   *
+   * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+   *
+   * @type {Number}
+   * @abstract
+   */
+  get opacity(): number;
+
+  /**
+   * Sets if this Entity casts shadows.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set castsShadow(arg: boolean);
+
+  /**
+   * Gets if this Entity casts shadows.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get castsShadow(): boolean;
+
+  /**
+   * Sets if to this Entity can have shadows cast upon it
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set receivesShadow(arg: boolean);
+
+  /**
+   * Gets if this Entity can have shadows cast upon it
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get receivesShadow(): boolean;
+
+  /**
+   * Gets if this Entity can have Scalable Ambient Obscurance (SAO) applied to it.
+   *
+   * SAO is configured by {@link SAO}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get saoEnabled(): boolean;
+
+  /**
+   * Sets the Entity's 3D World-space offset.
+   *
+   * Since offsetting Entities comes with memory and rendering overhead on some systems, this feature
+   * only works when {@link Viewer} is configured with ````entityOffsetsEnabled: true````.
+   *
+   * The offset dynamically translates the Entity in World-space, which  is useful for creating
+   * effects like exploding parts assemblies etc.
+   *
+   * Default value is ````[0,0,0]````.
+   *
+   * Provide a null or undefined value to reset to the default value.
+   *
+   * @abstract
+   * @type {Number[]}
+   */
+  set offset(arg: number[]);
+
+  /**
+   * Gets the Entity's 3D World-space offset.
+   *
+   * Default value is ````[0,0,0]````.
+   *
+   * @abstract
+   * @type {Number[]}
+   */
+  get offset(): number[];
+
+  /**
+   * Destroys this Entity.
+   */
+  destroy(): void;
+}