csyjk 1.1.1 → 1.2.2

package/src/lib/gltf/assets/yjkkit-sdk/src/viewer/Viewer.js

@@ -0,0 +1,372 @@
+import {Scene} from "./scene/scene/Scene.js";
+import {CameraFlightAnimation} from "./scene/camera/CameraFlightAnimation.js";
+import {CameraControl} from "./scene/CameraControl/CameraControl.js";
+import {MetaScene} from "./metadata/MetaScene.js";
+import {WEBGL_INFO} from "./scene/webglInfo.js";
+
+/**
+ * The 3D Viewer at the heart of the yjkkit SDK.
+ *
+ * * A Viewer wraps a single {@link Scene}
+ * * Add {@link Plugin}s to a Viewer to extend its functionality.
+ * * {@link Viewer#metaScene} holds metadata about {@link Model}s in the
+ * Viewer's {@link MetaScene}.
+ * * Use {@link Viewer#cameraFlight} to fly or jump the {@link Scene}'s
+ * {@link Camera} to target positions, boundaries or {@link Entity}s.
+ *
+ * @public
+ */
+class Viewer {
+
+    /**
+     * @constructor
+     * @param {Object} cfg Viewer configuration.
+     * @param {String} [cfg.id] Optional ID for this Viewer, defaults to the ID of {@link Viewer#scene}, which yjkkit automatically generates.
+     * @param {String} [cfg.canvasId]  ID of an existing HTML canvas for the {@link Viewer#scene} - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID.
+     * @param {HTMLCanvasElement} [cfg.canvasElement] Reference of an existing HTML canvas for the {@link Viewer#scene} - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID.
+     * @param {String} [cfg.spinnerElementId]  ID of existing HTML element to show the {@link Spinner} - internally creates a default element automatically if this is omitted.
+     * @param {Number} [cfg.passes=1] The number of times the {@link Viewer#scene} renders per frame.
+     * @param {Boolean} [cfg.clearEachPass=false] When doing multiple passes per frame, specifies if to clear the canvas before each pass (true) or just before the first pass (false).
+     * @param {Boolean} [cfg.preserveDrawingBuffer=true]  Whether or not to preserve the WebGL drawing buffer. This needs to be ````true```` for {@link Viewer#getSnapshot} to work.
+     * @param {Boolean} [cfg.transparent=true]  Whether or not the canvas is transparent.
+     * @param {Boolean} [cfg.premultipliedAlpha=false]  Whether or not you want alpha composition with premultiplied alpha. Highlighting and selection works best when this is ````false````.
+     * @param {Boolean} [cfg.gammaInput=true]  When true, expects that all textures and colors are premultiplied gamma.
+     * @param {Boolean} [cfg.gammaOutput=false]  Whether or not to render with pre-multiplied gama.
+     * @param {Number} [cfg.gammaFactor=2.2] The gamma factor to use when rendering with pre-multiplied gamma.
+     * @param {Number[]} [cfg.backgroundColor=[1,1,1]] Sets the canvas background color to use when ````transparent```` is false.
+     * @param {Boolean} [cfg.backgroundColorFromAmbientLight=true] When ````transparent```` is false, set this ````true````
+     * to derive the canvas background color from {@link AmbientLight#color}, or ````false```` to set the canvas background to ````backgroundColor````.
+     * @param {String} [cfg.units="meters"] The measurement unit type. Accepted values are ````"meters"````, ````"metres"````, , ````"centimeters"````, ````"centimetres"````, ````"millimeters"````,  ````"millimetres"````, ````"yards"````, ````"feet"```` and ````"inches"````.
+     * @param {Number} [cfg.scale=1] The number of Real-space units in each World-space coordinate system unit.
+     * @param {Number[]} [cfg.origin=[0,0,0]] The Real-space 3D origin, in current measurement units, at which the World-space coordinate origin ````[0,0,0]```` sits.
+     * @param {Boolean} [cfg.saoEnabled=false] Whether to enable Scalable Ambient Obscurance (SAO) effect. See {@link SAO} for more info.
+     * @param {Boolean} [cfg.antialias=true] Whether to enable anti-aliasing.
+     * @throws {String} Throws an exception when both canvasId or canvasElement are missing or they aren't pointing to a valid HTMLCanvasElement.
+     * @param {Boolean} [cfg.alphaDepthMask=true] Whether writing into the depth buffer is enabled or disabled when rendering transparent objects.
+     * @param {Boolean} [cfg.entityOffsetsEnabled=false] Whether to enable {@link Entity#offset}. For best performance, only set this ````true```` when you need to use {@link Entity#offset}.
+     * @param {Boolean} [cfg.logarithmicDepthBufferEnabled=false] Whether to enable logarithmic depth buffer. When this is true,
+     * you can set huge values for {@link Perspective#far} and {@link Ortho#far}, to push the far clipping plane back so
+     * that it does not clip huge models.
+     * @param {Boolean} [cfg.pbrEnabled=false] Whether to enable physically-based rendering.
+     */
+    constructor(cfg) {
+
+        /**
+         * The Viewer's current language setting.
+         * @property language
+         * @type {String}
+         */
+        this.language = "en";
+
+        /**
+         * The Viewer's {@link Scene}.
+         * @property scene
+         * @type {Scene}
+         */
+        this.scene = new Scene(this, {
+            canvasId: cfg.canvasId,
+            canvasElement: cfg.canvasElement,
+            webgl2: false,
+            contextAttr: {
+                preserveDrawingBuffer: cfg.preserveDrawingBuffer !== false,
+                premultipliedAlpha: (!!cfg.premultipliedAlpha),
+                antialias: (cfg.antialias !== false)
+            },
+            spinnerElementId: cfg.spinnerElementId,
+            transparent: (cfg.transparent !== false),
+            gammaInput: true,
+            gammaOutput: false,
+            backgroundColor: cfg.backgroundColor,
+            backgroundColorFromAmbientLight: cfg.backgroundColorFromAmbientLight,
+            ticksPerRender: 1,
+            ticksPerOcclusionTest: 20,
+            units: cfg.units,
+            scale: cfg.scale,
+            origin: cfg.origin,
+            saoEnabled: cfg.saoEnabled,
+            alphaDepthMask: (cfg.alphaDepthMask !== false),
+            entityOffsetsEnabled: (!!cfg.entityOffsetsEnabled),
+            logarithmicDepthBufferEnabled: (!!cfg.logarithmicDepthBufferEnabled),
+            pbrEnabled: (!!cfg.pbrEnabled)
+        });
+
+        /**
+         * Metadata about the {@link Scene} and the models and objects within it.
+         * @property metaScene
+         * @type {MetaScene}
+         * @readonly
+         */
+        this.metaScene = new MetaScene(this, this.scene);
+
+        /**
+         * The Viewer's ID.
+         * @property id
+         *
+         * @type {String|Number}
+         */
+        this.id = cfg.id || this.scene.id;
+
+        /**
+         * The Viewer's {@link Camera}. This is also found on {@link Scene#camera}.
+         * @property camera
+         * @type {Camera}
+         */
+        this.camera = this.scene.camera;
+
+        /**
+         * The Viewer's {@link CameraFlightAnimation}, which
+         * is used to fly the {@link Scene}'s {@link Camera} to given targets.
+         * @property cameraFlight
+         * @type {CameraFlightAnimation}
+         */
+        this.cameraFlight = new CameraFlightAnimation(this.scene, {
+            duration: 0.5
+        });
+
+        /**
+         * The Viewer's {@link CameraControl}, which
+         * controls the {@link Scene}'s {@link Camera} with mouse,  touch and keyboard input.
+         * @property cameraControl
+         * @type {CameraControl}
+         */
+        this.cameraControl = new CameraControl(this.scene, {
+            // panToPointer: true,
+            doublePickFlyTo: true
+        });
+
+        this._plugins = [];
+
+        /**
+         * Subscriptions to events sent with {@link fire}.
+         * @private
+         */
+        this._eventSubs = {};
+    }
+
+    /**
+     * Subscribes to an event fired at this Viewer.
+     *
+     * @param {String} event The event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event, callback) {
+        let subs = this._eventSubs[event];
+        if (!subs) {
+            subs = [];
+            this._eventSubs[event] = subs;
+        }
+        subs.push(callback);
+    }
+
+    /**
+     * Fires an event at this Viewer.
+     *
+     * @param {String} event Event name
+     * @param {Object} value Event parameters
+     */
+    fire(event, value) {
+        const subs = this._eventSubs[event];
+        if (subs) {
+            for (let i = 0, len = subs.length; i < len; i++) {
+                subs[i](value);
+            }
+        }
+    }
+
+    /**
+     * Unsubscribes from an event fired at this Viewer.
+     * @param event
+     */
+    off(event) { // TODO
+
+    }
+
+    /**
+     * Logs a message to the JavaScript developer console, prefixed with the ID of this Viewer.
+     *
+     * @param {String} msg The message
+     */
+    log(msg) {
+        console.log(`[yjkkit viewer ${this.id}]: ${msg}`);
+    }
+
+    /**
+     * Logs an error message to the JavaScript developer console, prefixed with the ID of this Viewer.
+     *
+     * @param {String} msg The error message
+     */
+    error(msg) {
+        console.error(`[yjkkit viewer ${this.id}]: ${msg}`);
+    }
+
+    /**
+     * Installs a Plugin.
+     *
+     * @private
+     */
+    addPlugin(plugin) {
+        this._plugins.push(plugin);
+    }
+
+    /**
+     * Uninstalls a Plugin, clearing content from it first.
+     *
+     * @private
+     */
+    removePlugin(plugin) {
+        for (let i = 0, len = this._plugins.length; i < len; i++) {
+            const p = this._plugins[i];
+            if (p === plugin) {
+                if (p.clear) {
+                    p.clear();
+                }
+                this._plugins.splice(i, 1);
+                return;
+            }
+        }
+    }
+
+    /**
+     * Sends a message to installed Plugins.
+     *
+     * The message can optionally be accompanied by a value.
+     * @private
+     */
+    sendToPlugins(name, value) {
+        for (let i = 0, len = this._plugins.length; i < len; i++) {
+            const p = this._plugins[i];
+            if (p.send) {
+                p.send(name, value);
+            }
+        }
+    }
+
+    /**
+     * @private
+     * @deprecated
+     */
+    clear() {
+        throw "Viewer#clear() no longer implemented - use '#sendToPlugins(\"clear\") instead";
+    }
+
+    /**
+     * @private
+     * @deprecated
+     */
+    resetView() {
+        throw "Viewer#resetView() no longer implemented - use CameraMemento & ObjectsMemento classes instead";
+    }
+
+    /**
+     * Enter snapshot mode.
+     *
+     * Switches rendering to a hidden snapshot canvas.
+     *
+     * Exit snapshot mode using {@link Viewer#endSnapshot}.
+     */
+    beginSnapshot() {
+        if (this._snapshotBegun) {
+            return;
+        }
+        this.scene._renderer.beginSnapshot();
+        this._snapshotBegun = true;
+    }
+
+    /**
+     * Gets a snapshot of this Viewer's {@link Scene} as a Base64-encoded image.
+     *
+     * #### Usage:
+     *
+     * ````javascript
+     * const imageData = viewer.getSnapshot({
+     *    width: 500,
+     *    height: 500,
+     *    format: "png"
+     * });
+     * ````
+     * @param {*} [params] Capture options.
+     * @param {Number} [params.width] Desired width of result in pixels - defaults to width of canvas.
+     * @param {Number} [params.height] Desired height of result in pixels - defaults to height of canvas.
+     * @param {String} [params.format="jpeg"] Desired format; "jpeg", "png" or "bmp".
+     * @param {Boolean} [params.includeGizmos=false] When true, will include gizmos like {@link SectionPlane} in the snapshot.
+     * @returns {String} String-encoded image data URI.
+     */
+    getSnapshot(params = {}) {
+
+        const needFinishSnapshot = (!this._snapshotBegun);
+
+        if (!this._snapshotBegun) {
+            this.beginSnapshot();
+        }
+
+        if (!params.includeGizmos) {
+            this.sendToPlugins("snapshotStarting"); // Tells plugins to hide things that shouldn't be in snapshot
+        }
+
+        const resize = (params.width !== undefined && params.height !== undefined);
+        const canvas = this.scene.canvas.canvas;
+        const saveWidth = canvas.clientWidth;
+        const saveHeight = canvas.clientHeight;
+        const saveCssWidth = canvas.style.width;
+        const saveCssHeight = canvas.style.height;
+
+        const width = params.width ? Math.floor(params.width) : canvas.width;
+        const height = params.height ? Math.floor(params.height) : canvas.height;
+
+        if (resize) {
+            canvas.style.width = width + "px";
+            canvas.style.height = height + "px";
+        }
+
+        this.scene._renderer.renderSnapshot();
+
+        const imageDataURI = this.scene._renderer.readSnapshot(params);
+
+        if (resize) {
+            canvas.style.width = saveCssWidth;
+            canvas.style.height = saveCssHeight;
+            canvas.width = saveWidth;
+            canvas.height = saveHeight;
+
+            this.scene.glRedraw();
+        }
+
+        if (!params.includeGizmos) {
+            this.sendToPlugins("snapshotFinished");
+        }
+
+        if (needFinishSnapshot) {
+            this.endSnapshot();
+        }
+
+        return imageDataURI;
+    }
+
+    /**
+     * Exits snapshot mode.
+     *
+     * Switches rendering back to the main canvas.
+     *
+     */
+    endSnapshot() {
+        if (!this._snapshotBegun) {
+            return;
+        }
+        this.scene._renderer.endSnapshot();
+        this.scene._renderer.render({force: true});
+        this._snapshotBegun = false;
+    }
+
+    /** Destroys this Viewer.
+     */
+    destroy() {
+        const plugins = this._plugins.slice(); // Array will modify as we delete plugins
+        for (let i = 0, len = plugins.length; i < len; i++) {
+            const plugin = plugins[i];
+            plugin.destroy();
+        }
+        this.scene.destroy();
+    }
+}
+
+export {Viewer}

package/src/lib/gltf/assets/yjkkit-sdk/src/viewer/index.js

@@ -0,0 +1,3 @@
+export * from "./scene/index.js";
+export * from "./Plugin.js";
+export * from "./Viewer.js";

package/src/lib/gltf/assets/yjkkit-sdk/src/viewer/metadata/IFCObjectDefaultColors.js

@@ -0,0 +1,162 @@
+/**
+ * @desc Initial properties for {@link Entity}s loaded from IFC models accompanied by metadata.
+ *
+ * When loading a model, plugins such as {@link XKTLoaderPlugin} 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.
+ *
+ * @type {{String:Object}}
+ */
+const IFCObjectDefaultColors = {
+
+    // Priority 0
+
+    IfcRoof: {
+        colorize: [0.837255, 0.203922, 0.270588]
+    },
+    IfcSlab: {
+        colorize: [0.637255, 0.603922, 0.670588]
+    },
+    IfcWall: {
+        colorize: [0.537255, 0.337255, 0.237255]
+    },
+    IfcWallStandardCase: {
+        colorize: [0.537255, 0.337255, 0.237255]
+    },
+    IfcCovering: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+
+    // Priority 1
+
+    IfcDoor: {
+        colorize: [0.637255, 0.603922, 0.670588]
+    },
+
+    // Priority 2
+
+    IfcStair: {
+        colorize: [0.637255, 0.603922, 0.670588]
+    },
+    IfcStairFlight: {
+        colorize: [0.637255, 0.603922, 0.670588]
+    },
+    IfcProxy: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcRamp: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+
+    // Priority 3
+
+    IfcColumn: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcBeam: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcCurtainWall: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcPlate: {
+        colorize: [0.8470588235, 0.427450980392, 0, 0.5],
+        opacity: 0.3
+    },
+    IfcTransportElement: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcFooting: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+
+    // Priority 4
+
+    IfcRailing: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcFurnishingElement: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcFurniture: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcSystemFurnitureElement: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+
+    // Priority 5
+
+    IfcFlowSegment: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcFlowitting: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcFlowTerminal: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+    IfcFlowController: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcFlowFitting: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcDuctSegment: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcDistributionFlowElement: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcDuctFitting: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+    IfcLightFixture: {
+        colorize: [0.8470588235, 0.8470588235, 0.870588]
+    },
+
+    // Priority 6
+
+    IfcAirTerminal: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+
+    IfcOpeningElement: {
+        colorize: [0.137255, 0.403922, 0.870588],
+        pickable: false,
+        visible: false
+    },
+    IfcSpace: {
+        colorize: [0.137255, 0.403922, 0.870588],
+        pickable: false,
+        visible: false,
+        opacity: 0.5
+    },
+
+    IfcWindow: {
+        colorize: [0.137255, 0.403922, 0.870588],
+        pickable: true,
+        opacity: 0.1
+    },
+
+    //
+
+    IfcBuildingElementProxy: {
+        colorize: [0.5, 0.5, 0.5]
+    },
+
+    IfcSite: {
+        colorize: [0.137255, 0.403922, 0.870588]
+    },
+
+    IfcMember: {
+        colorize: [0.8470588235, 0.427450980392, 0]
+    },
+
+    DEFAULT: {
+        colorize: [0.5, 0.5, 0.5]
+    }
+};
+
+export {IFCObjectDefaultColors}

package/src/lib/gltf/assets/yjkkit-sdk/src/viewer/metadata/IFCObjectDefaults.js

@@ -0,0 +1,39 @@
+/**
+ * @desc Default initial properties for {@link Entity}s loaded from models accompanied by metadata.
+ *
+ * When loading a model, plugins such as {@link XKTLoaderPlugin} 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.
+ *
+ * @type {{String:Object}}
+ */
+const IFCObjectDefaults = {
+
+    IfcOpeningElement: {
+        pickable: false,
+        visible: false
+    },
+
+    IfcSpace: {
+        colorize: [0.137255, 0.403922, 0.870588],
+        pickable: false,
+        visible: false,
+        opacity: 0.4
+    },
+
+    IfcWindow: {
+        colorize: [0.137255, 0.403922, 0.870588],
+        opacity: 0.3
+    },
+
+    IfcPlate: {
+        colorize: [0.8470588235, 0.427450980392, 0, 0.5],
+        opacity: 0.3
+    },
+
+    DEFAULT: {
+    }
+};
+
+export {IFCObjectDefaults}