@xeokit/xeokit-sdk 2.4.2-beta-8 → 2.4.2-beta-9

package/types/viewer/scene/models/SceneModelEntity.d.ts

@@ -0,0 +1,418 @@
+import {Entity} from "../Entity";
+import {SceneModelMesh} from "./SceneModelMesh";
+import {SceneModel} from "./SceneModel";
+
+/**
+ * An abstract 3D scene element that can be individually shown, hidden, selected,
+ * highlighted, xrayed, culled, picked, clipped and bounded.
+ *
+ * @abstract
+ */
+export declare abstract class SceneModelEntity implements Entity {
+
+    /**
+     * Component ID, unique within the {@link Scene}.
+     *
+     * @type {number|string}
+     * @abstract
+     */
+    get id(): string;
+
+    /**
+     * ID of the corresponding object within the originating system, if any.
+     *
+     * By default, this has the same value as {@link SceneModelEntity.id}. When we load a model using {@link XKTLoaderPlugin.load},
+     * with {@link XKTLoaderPlugin.globalizeObjectIds} set ````true````, then that plugin will prefix {@link SceneModelEntity.id}
+     * with the model ID, while leaving this property holding the original value of {@link SceneModelEntity.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 SceneModelEntity.
+     *
+     * @returns {Boolean}
+     */
+    get isEntity(): boolean;
+
+    /**
+     * Returns ````true```` if this SceneModelEntity represents a model.
+     *
+     * When this is ````true````, the SceneModelEntity will be registered by {@link SceneModelEntity.id} in {@link Scene.models} and
+     * may also have a corresponding {@link MetaModel}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get isModel(): boolean;
+
+    /**
+     * Returns ````true```` if this SceneModelEntity represents an object.
+     *
+     * When this is ````true````, the SceneModelEntity will be registered by {@link SceneModelEntity.id} in {@link Scene.objects} and
+     * may also have a corresponding {@link MetaObject}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get isObject(): boolean;
+
+    /** Returns the parent SceneModelEntity, if any. */
+    get parent(): void;
+
+    /**
+     * Sets the 3D World-space origin for this SceneModelEntity.
+     *
+     * @type {Float64Array}
+     * @abstract
+     */
+    set origin(arg: Float64Array);
+
+    /**
+     * Gets the 3D World-space origin for this SceneModelEntity.
+     *
+     * @type {Float64Array}
+     * @abstract
+     */
+    get origin(): Float64Array;
+
+    /**
+     * World-space 3D axis-aligned bounding box (AABB) of this SceneModelEntity.
+     *
+     * 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 SceneModelEntity.
+     *
+     * @type {number}
+     * @abstract
+     */
+    get numTriangles(): number;
+
+    /**
+     * Sets if this SceneModelEntity is visible.
+     *
+     * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.visible} are both ````true```` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.visibleObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set visible(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is visible.
+     *
+     * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.visible} are both ````true```` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.visibleObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get visible(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is xrayed.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.xrayed} are both ````true``` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.xrayedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set xrayed(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is xrayed.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.xrayed} are both ````true``` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.xrayedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get xrayed(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is highlighted.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.highlighted} are both ````true```` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.highlightedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set highlighted(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is highlighted.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.highlighted} are both ````true```` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.highlightedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get highlighted(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is selected.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.selected} are both ````true``` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.selectedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set selected(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is selected.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.selected} are both ````true``` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.selectedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get selected(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity's edges are enhanced.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set edges(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity's edges are enhanced.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get edges(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is culled.
+     *
+     * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set culled(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is culled.
+     *
+     * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get culled(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is clippable.
+     *
+     * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set clippable(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is clippable.
+     *
+     * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get clippable(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is included in boundary calculations.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set collidable(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is included in boundary calculations.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get collidable(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is pickable.
+     *
+     * Picking is done via calls to {@link Scene.pick}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set pickable(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is pickable.
+     *
+     * Picking is done via calls to {@link Scene.pick}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get pickable(): boolean;
+
+    /**
+     * Sets the SceneModelEntity's RGB colorize color, multiplies by the SceneModelEntity's rendered fragment colors.
+     *
+     * Each element of the color is in range ````[0..1]````.
+     *
+     * @type {number[]}
+     * @abstract
+     */
+    set colorize(arg: number[]);
+
+    /**
+     * Gets the SceneModelEntity's RGB colorize color, multiplies by the SceneModelEntity's rendered fragment colors.
+     *
+     * Each element of the color is in range ````[0..1]````.
+     *
+     * @type {number[]}
+     * @abstract
+     */
+    get colorize(): number[];
+
+    /**
+     * Sets the SceneModelEntity's opacity factor, multiplies by the SceneModelEntity's rendered fragment alphas.
+     *
+     * This is a factor in range ````[0..1]````.
+     *
+     * @type {number}
+     * @abstract
+     */
+    set opacity(arg: number);
+
+    /**
+     * Gets the SceneModelEntity'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 SceneModelEntity casts shadows.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set castsShadow(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity casts shadows.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get castsShadow(): boolean;
+
+    /**
+     * Sets if to this SceneModelEntity can have shadows cast upon it
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set receivesShadow(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity can have shadows cast upon it
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get receivesShadow(): boolean;
+
+    /**
+     * Gets if this SceneModelEntity can have Scalable Ambient Obscurance (SAO) applied to it.
+     *
+     * SAO is configured by {@link SAO}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get saoEnabled(): boolean;
+
+    /**
+     * Sets the SceneModelEntity'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 SceneModelEntity 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 SceneModelEntity's 3D World-space offset.
+     *
+     * Default value is ````[0,0,0]````.
+     *
+     * @abstract
+     * @type {number[]}
+     */
+    get offset(): number[];
+
+    /**
+     * Gets the World, View and Canvas-space positions of each vertex in a callback.
+     *
+     * @param callback
+     */
+    getEachVertex(callback: any): void;
+
+    /**
+     * The {@link SceneModel} to which this SceneModelEntity belongs.
+     */
+    model :SceneModel;
+
+    /**
+     * The {@link SceneModelMesh}es belonging to this SceneModelEntity.
+     *
+     * * These are created with {@link SceneModel#createMesh} and registered in {@ilnk SceneModel#meshes}
+     * * Each SceneModelMesh belongs to one SceneModelEntity
+     */
+    meshes : SceneModelMesh[];
+
+    /**
+     * Destroys this SceneModelEntity.
+     */
+    destroy(): void;
+}

package/types/viewer/scene/models/SceneModelMesh.d.ts

@@ -0,0 +1,68 @@
+import {SceneModelEntity} from "./SceneModelEntity";
+import {SceneModelTransform} from "./SceneModelTransform";
+import {SceneModelTextureSet} from "./SceneModelTextureSet";
+import {SceneModel} from "./SceneModel";
+
+/**
+ * A mesh within a {@link SceneModel}.
+ *
+ * * Created with {@link SceneModel#createMesh}
+ * * Belongs to exactly one {@link SceneModelEntity}
+ * * Stored by ID in {@link SceneModel#meshes}
+ * * Referenced by {@link SceneModelEntity#meshes}
+ * * Can have a {@link SceneModelTransform} to dynamically scale, rotate and translate it.
+ */
+export declare class SceneModelMesh {
+
+    /**
+     * The {@link SceneModel} that owns this SceneModelMesh.
+     *
+     * @type {SceneModel}
+     */
+    model: SceneModel;
+
+    /**
+     * The {@link SceneModelEntity} that owns this SceneModelMesh.
+     *
+     * @type {SceneModelEntity}
+     */
+    object: SceneModelEntity;
+
+    /**
+     * The {@link SceneModelTransform} that transforms this SceneModelMesh.
+     *
+     * * This only exists when the SceneModelMesh is instancing its geometry.
+     * * These are created with {@link SceneModel#createTransform}
+     * * Each of these is also registered in {@link SceneModel#transforms}.
+     *
+     * @type {SceneModelTransform}
+     */
+    transform: SceneModelTransform | null;
+
+
+    /**
+     * The {@link SceneModelTextureSet} that optionally textures this SceneModelMesh.
+     *
+     * * This only exists when the SceneModelMesh has texture.
+     * * These are created with {@link SceneModel#createTextureSet}
+     * * Each of these is also registered in {@link SceneModel#textureSets}.
+     *
+     * @type {SceneModelTextureSet}
+     */
+    textureSet: SceneModelTextureSet | null;
+
+    /**
+     * Unique ID of this SceneModelMesh.
+     *
+     * The SceneModelMesh is registered against this ID in {@link SceneModel#meshes}.
+     */
+    id: string | number;
+
+    /**
+     * The {@link SceneModelEntity} that owns this SceneModelMesh.
+     *
+     * @type {SceneModelEntity}
+     */
+    entity: SceneModelEntity;
+
+}

package/types/viewer/scene/models/SceneModelTexture.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A texture within a {@link SceneModelTextureSet}.
+ *
+ * * Created with {@link SceneModel#createTexture}
+ * * Belongs to many {@link SceneModelTextureSet}s
+ * * Stored by ID in {@link SceneModel#textures}}
+ */
+export declare class SceneModelTexture {
+
+    /**
+     * Unique ID of this SceneModelTexture.
+     *
+     * The SceneModelTexture is registered against this ID in {@link SceneModel#textures}.
+     */
+    id: string | number;
+}

package/types/viewer/scene/models/SceneModelTextureSet.d.ts

@@ -0,0 +1,51 @@
+import {SceneModelTexture} from "./SceneModelTexture";
+
+
+/**
+ * A texture set within a {@link SceneModel}.
+ *
+ * * Created with {@link SceneModel#createTextureSet}
+ * * Belongs to many {@link SceneModelMesh}es
+ * * Stored by ID in {@link SceneModel#textureSets}
+ * * Referenced by {@link SceneModelMesh#textureSet}
+ */
+
+export declare class SceneModelTextureSet {
+
+    /**
+     * Unique ID of this SceneModelTextureSet.
+     *
+     * The SceneModelTextureSet is registered against this ID in {@link SceneModel#textureSets}.
+     */
+    id: string | number;
+
+    /**
+     * The color texture.
+     * @type {SceneModelTexture|*}
+     */
+    colorTexture: SceneModelTexture | null;
+
+    /**
+     * The metallic-roughness texture.
+     * @type {SceneModelTexture|*}
+     */
+    metallicRoughnessTexture: SceneModelTexture | null;
+
+    /**
+     * The normal map texture.
+     * @type {SceneModelTexture|*}
+     */
+    normalsTexture: SceneModelTexture | null;
+
+    /**
+     * The emissive color texture.
+     * @type {SceneModelTexture|*}
+     */
+    emissiveTexture: SceneModelTexture | null;
+
+    /**
+     * The ambient occlusion texture.
+     * @type {SceneModelTexture|*}
+     */
+    occlusionTexture: SceneModelTexture | null;
+}