12256691367

Committed 10 Dec 2024 01:03PM UTC coverage: 87.065% (+0.3%) from 86.793%

Build # 12256691367

Build Type

push

github

Committed by

jailln

Commit Message

fix(doc): fix doc generation error

Run Details

2781 of 3692 branches covered (75.33%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

285 existing lines in 14 files now uncovered.

24990 of 28205 relevant lines covered (88.6%)

992.06 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.9

/src/Layer/GeometryLayer.js

import Layer from 'Layer/Layer';
import Picking from 'Core/Picking';
import { CACHE_POLICIES } from 'Core/Scheduler/Cache';
import ObjectRemovalHelper from 'Process/ObjectRemovalHelper';

/**
 * Fires when the opacity of the layer has changed.
 * @event GeometryLayer#opacity-property-changed
 */

/**
 * @property {boolean} isGeometryLayer - Used to checkout whether this layer is
 * a GeometryLayer. Default is true. You should not change this, as it is used
 * internally for optimisation.
 * @property {number} [zoom.max=Infinity] - this is the maximum zoom beyond which it'll be hidden.
 * The `max` is constant and the value is `Infinity` because there's no maximum display level after which it is hidden.
 * This property is used only if the layer is attached to {@link TiledGeometryLayer}.
 * @property {number} [zoom.min=0] - this is the minimum zoom from which it'll be visible.
 * This property is used only if the layer is attached to {@link TiledGeometryLayer}.
 */
class GeometryLayer extends Layer {
    /**
     * A layer usually managing a geometry to display on a view. For example, it
     * can be a layer of buildings extruded from a a WFS stream.
     *
     * @param {string} id - The id of the layer, that should be unique. It is
     * not mandatory, but an error will be emitted if this layer is added a
     * {@link View} that already has a layer going by that id.
     * @param {THREE.Object3D} object3d - The object3D used to contain the
     * geometry of the GeometryLayer. It is usually a `THREE.Group`, but it can
     * be anything inheriting from a `THREE.Object3D`.
     * @param {Object} [config] - Optional configuration, all elements in it
     * will be merged as is in the layer. For example, if the configuration
     * contains three elements `name, protocol, extent`, these elements will be
     * available using `layer.name` or something else depending on the property
     * name.
     * @param {Source} config.source - Description and options of the source.
     * @param {number} [config.cacheLifeTime=Infinity] - set life time value in cache.
     * This value is used for [Cache]{@link Cache} expiration mechanism.
     * @param {boolean} [config.visible]
     *
     * @throws {Error} `object3d` must be a valid `THREE.Object3d`.
     *
     * @example
     * // Create a GeometryLayer
     * const geometry = new GeometryLayer('buildings', new THREE.Object3D(), {
     *      source: {
     *          url: 'http://server.geo/wfs?',
     *          protocol: 'wfs',
     *          format: 'application/json'
     *      },
     * });
     *
     * // Add the layer
     * view.addLayer(geometry);
     */
    constructor(id, object3d, config = {}) {
        const {
            cacheLifeTime = CACHE_POLICIES.GEOMETRY,
            visible = true,
            opacity = 1.0,
            ...layerConfig
        } = config;

        super(id, {
            ...layerConfig,
            cacheLifeTime,
        });

        /**
         * @type {boolean}
         * @readonly
         */
        this.isGeometryLayer = true;

        if (!object3d || !object3d.isObject3D) {
            throw new Error(`Missing/Invalid object3d parameter (must be a
                three.js Object3D instance)`);
        }

        if (object3d.type === 'Group' && object3d.name === '') {
            object3d.name = id;
        }

        /**
         * @type {THREE.Object3D}
         * @readonly
         */
        this.object3d = object3d;
        Object.defineProperty(this, 'object3d', {
            writable: false,
            configurable: true,
        });

        /**
         * @type {number}
         */
        this.opacity = opacity;

        /**
         * @type {boolean}
         */
        this.wireframe = false;

        /**
         * @type {Layer[]}
         */
        this.attachedLayers = [];

        /**
         * @type {boolean}
         */
        this.visible = visible;
        Object.defineProperty(this.zoom, 'max', {
            value: Infinity,
            writable: false,
        });

        // Feature options
        this.filteringExtent = !this.source.isFileSource;
        this.structure = '3d';
    }

    get visible() {
        return this.object3d.visible;
    }

    set visible(value) {
        if (this.object3d.visible !== value) {
            const event = { type: 'visible-property-changed', previous: {}, new: {} };
            event.previous.visible = this.object3d.visible;
            event.new.visible = value;
            this.dispatchEvent(event);
            this.object3d.visible = value;
        }
    }

    // Attached layers expect to receive the visual representation of a
    // layer (= THREE object with a material).  So if a layer's update
    // function don't process this kind of object, the layer must provide a
    // getObjectToUpdateForAttachedLayers function that returns the correct
    // object to update for attached layer.
    // See 3dtilesLayer or PotreeLayer for examples.
    // eslint-disable-next-line arrow-body-style
    getObjectToUpdateForAttachedLayers(obj) {
        if (obj.parent && obj.material) {
            return {
                element: obj,
                parent: obj.parent,
            };
        }
    }

    // Placeholder
    // eslint-disable-next-line
    postUpdate() {}

    // Placeholder
    // eslint-disable-next-line
    culling() {
        return true;
    }

    /**
     * Attach another layer to this one. Layers attached to a GeometryLayer will
     * be available in `geometryLayer.attachedLayers`.
     *
     * @param {Layer} layer - The layer to attach, that must have an `update`
     * method.
     */
    attach(layer) {
        if (!layer.update) {
            throw new Error(`Missing 'update' function -> can't attach layer
                ${layer.id}`);
        }
        this.attachedLayers.push(layer);
        // To traverse GeometryLayer object3d attached
        layer.parent = this;
    }

    /**
     * Detach a layer attached to this one. See {@link attach} to learn how to
     * attach a layer.
     *
     * @param {Layer} layer - The layer to detach.
     *
     * @return {boolean} Confirmation of the detachment of the layer.
     */
    detach(layer) {
        const count = this.attachedLayers.length;
        this.attachedLayers = this.attachedLayers.filter(attached => attached.id != layer.id);
        layer.parent = undefined;
        return this.attachedLayers.length < count;
    }

    /**
     * All layer's 3D objects are removed from the scene and disposed from the video device.
     * @param {boolean} [clearCache=false] Whether to clear the layer cache or not
     */
    delete(clearCache) {
        if (clearCache) {
            this.cache.clear();
        }

        // if Layer is attached
        if (this.parent) {
            ObjectRemovalHelper.removeChildrenAndCleanupRecursively(this, this.parent.object3d);
        }

        if (this.object3d.parent) {
            this.object3d.parent.remove(this.object3d);
        }
        ObjectRemovalHelper.removeChildrenAndCleanupRecursively(this, this.object3d);
    }

    /**
     * Picking method for this layer.
     *
     * @param {View} view - The view instance.
     * @param {Object} coordinates - The coordinates to pick in the view. It
     * should have at least `x` and `y` properties.
     * @param {number} radius - Radius of the picking circle.
     * @param {Array} target - target to push result.
     *
     * @return {Array} An array containing all targets picked under the
     * specified coordinates.
     */
    pickObjectsAt(view, coordinates, radius = this.options.defaultPickingRadius, target = []) {
        return Picking.pickObjectsAt(view, coordinates, radius, this.object3d, target);
    }
}

export default GeometryLayer;

1	import Layer from 'Layer/Layer';	1✔
2	import Picking from 'Core/Picking';	1✔
3	import { CACHE_POLICIES } from 'Core/Scheduler/Cache';	1✔
4	import ObjectRemovalHelper from 'Process/ObjectRemovalHelper';	1✔
5		1✔
6	/**	1✔
7	* Fires when the opacity of the layer has changed.	1✔
8	* @event GeometryLayer#opacity-property-changed	1✔
9	*/	1✔
10		1✔
11	/**	1✔
12	* @property {boolean} isGeometryLayer - Used to checkout whether this layer is	1✔
13	* a GeometryLayer. Default is true. You should not change this, as it is used	1✔
14	* internally for optimisation.	1✔
15	* @property {number} [zoom.max=Infinity] - this is the maximum zoom beyond which it'll be hidden.	1✔
16	* The `max` is constant and the value is `Infinity` because there's no maximum display level after which it is hidden.	1✔
17	* This property is used only if the layer is attached to {@link TiledGeometryLayer}.	1✔
18	* @property {number} [zoom.min=0] - this is the minimum zoom from which it'll be visible.	1✔
19	* This property is used only if the layer is attached to {@link TiledGeometryLayer}.	1✔
20	*/	1✔
21	class GeometryLayer extends Layer {	1✔
22	/**	1✔
23	* A layer usually managing a geometry to display on a view. For example, it	1✔
24	* can be a layer of buildings extruded from a a WFS stream.	1✔
25	*	1✔
26	* @param {string} id - The id of the layer, that should be unique. It is	1✔
27	* not mandatory, but an error will be emitted if this layer is added a	1✔
28	* {@link View} that already has a layer going by that id.	1✔
29	* @param {THREE.Object3D} object3d - The object3D used to contain the	1✔
30	* geometry of the GeometryLayer. It is usually a `THREE.Group`, but it can	1✔
31	* be anything inheriting from a `THREE.Object3D`.	1✔
32	* @param {Object} [config] - Optional configuration, all elements in it	1✔
33	* will be merged as is in the layer. For example, if the configuration	1✔
34	* contains three elements `name, protocol, extent`, these elements will be	1✔
35	* available using `layer.name` or something else depending on the property	1✔
36	* name.	1✔
37	* @param {Source} config.source - Description and options of the source.	1✔
38	* @param {number} [config.cacheLifeTime=Infinity] - set life time value in cache.	1✔
39	* This value is used for [Cache]{@link Cache} expiration mechanism.	1✔
40	* @param {boolean} [config.visible]	1✔
41	*	1✔
42	* @throws {Error} `object3d` must be a valid `THREE.Object3d`.	1✔
43	*	1✔
44	* @example	1✔
45	* // Create a GeometryLayer	1✔
46	* const geometry = new GeometryLayer('buildings', new THREE.Object3D(), {	1✔
47	* source: {	1✔
48	* url: 'http://server.geo/wfs?',	1✔
49	* protocol: 'wfs',	1✔
50	* format: 'application/json'	1✔
51	* },	1✔
52	* });	1✔
53	*	1✔
54	* // Add the layer	1✔
55	* view.addLayer(geometry);	1✔
56	*/	1✔
57	constructor(id, object3d, config = {}) {	1!
58	const {	83✔
59	cacheLifeTime = CACHE_POLICIES.GEOMETRY,	83✔
60	visible = true,	83✔
61	opacity = 1.0,	83✔
62	...layerConfig	83✔
63	} = config;	83✔
64		83✔
65	super(id, {	83✔
66	...layerConfig,	83✔
67	cacheLifeTime,	83✔
68	});	83✔
69		83✔
70	/**	83✔
71	* @type {boolean}	83✔
72	* @readonly	83✔
73	*/	83✔
74	this.isGeometryLayer = true;	83✔
75		83✔
76	if (!object3d \|\| !object3d.isObject3D) {	83!
UNCOV 77	throw new Error(`Missing/Invalid object3d parameter (must be a	×
UNCOV 78	three.js Object3D instance)`);	×
UNCOV 79	}	×
80		83✔
81	if (object3d.type === 'Group' && object3d.name === '') {	83✔
82	object3d.name = id;	63✔
83	}	63✔
84		83✔
85	/**	83✔
86	* @type {THREE.Object3D}	83✔
87	* @readonly	83✔
88	*/	83✔
89	this.object3d = object3d;	83✔
90	Object.defineProperty(this, 'object3d', {	83✔
91	writable: false,	83✔
92	configurable: true,	83✔
93	});	83✔
94		83✔
95	/**	83✔
96	* @type {number}	83✔
97	*/	83✔
98	this.opacity = opacity;	83✔
99		83✔
100	/**	83✔
101	* @type {boolean}	83✔
102	*/	83✔
103	this.wireframe = false;	83✔
104		83✔
105	/**	83✔
106	* @type {Layer[]}	83✔
107	*/	83✔
108	this.attachedLayers = [];	83✔
109		83✔
110	/**	83✔
111	* @type {boolean}	83✔
112	*/	83✔
113	this.visible = visible;	83✔
114	Object.defineProperty(this.zoom, 'max', {	83✔
115	value: Infinity,	83✔
116	writable: false,	83✔
117	});	83✔
118		83✔
119	// Feature options	83✔
120	this.filteringExtent = !this.source.isFileSource;	83✔
121	this.structure = '3d';	83✔
122	}	83✔
123		1✔
124	get visible() {	1✔
125	return this.object3d.visible;	178✔
126	}	178✔
127		1✔
128	set visible(value) {	1✔
129	if (this.object3d.visible !== value) {	83!
UNCOV 130	const event = { type: 'visible-property-changed', previous: {}, new: {} };	×
UNCOV 131	event.previous.visible = this.object3d.visible;	×
UNCOV 132	event.new.visible = value;	×
133	this.dispatchEvent(event);	×
134	this.object3d.visible = value;	×
UNCOV 135	}	×
136	}	83✔
137		1✔
138	// Attached layers expect to receive the visual representation of a	1✔
139	// layer (= THREE object with a material). So if a layer's update	1✔
140	// function don't process this kind of object, the layer must provide a	1✔
141	// getObjectToUpdateForAttachedLayers function that returns the correct	1✔
142	// object to update for attached layer.	1✔
143	// See 3dtilesLayer or PotreeLayer for examples.	1✔
144	// eslint-disable-next-line arrow-body-style	1✔
145	getObjectToUpdateForAttachedLayers(obj) {	1✔
146	if (obj.parent && obj.material) {	4!
147	return {	×
UNCOV 148	element: obj,	×
UNCOV 149	parent: obj.parent,	×
UNCOV 150	};	×
UNCOV 151	}	×
152	}	4✔
153		1✔
154	// Placeholder	1✔
155	// eslint-disable-next-line	1✔
156	postUpdate() {}	1✔
157		1✔
158	// Placeholder	1✔
159	// eslint-disable-next-line	1✔
160	culling() {	1✔
UNCOV 161	return true;	×
UNCOV 162	}	×
163		1✔
164	/**	1✔
165	* Attach another layer to this one. Layers attached to a GeometryLayer will	1✔
166	* be available in `geometryLayer.attachedLayers`.	1✔
167	*	1✔
168	* @param {Layer} layer - The layer to attach, that must have an `update`	1✔
169	* method.	1✔
170	*/	1✔
171	attach(layer) {	1✔
172	if (!layer.update) {	41!
UNCOV 173	throw new Error(`Missing 'update' function -> can't attach layer	×
174	${layer.id}`);	×
175	}	×
176	this.attachedLayers.push(layer);	41✔
177	// To traverse GeometryLayer object3d attached	41✔
178	layer.parent = this;	41✔
179	}	41✔
180		1✔
181	/**	1✔
182	* Detach a layer attached to this one. See {@link attach} to learn how to	1✔
183	* attach a layer.	1✔
184	*	1✔
185	* @param {Layer} layer - The layer to detach.	1✔
186	*	1✔
187	* @return {boolean} Confirmation of the detachment of the layer.	1✔
188	*/	1✔
189	detach(layer) {	1✔
190	const count = this.attachedLayers.length;	1✔
191	this.attachedLayers = this.attachedLayers.filter(attached => attached.id != layer.id);	1✔
192	layer.parent = undefined;	1✔
193	return this.attachedLayers.length < count;	1✔
194	}	1✔
195		1✔
196	/**	1✔
197	* All layer's 3D objects are removed from the scene and disposed from the video device.	1✔
198	* @param {boolean} [clearCache=false] Whether to clear the layer cache or not	1✔
199	*/	1✔
200	delete(clearCache) {	1✔
201	if (clearCache) {	2!
202	this.cache.clear();	×
UNCOV 203	}	×
204		2✔
205	// if Layer is attached	2✔
206	if (this.parent) {	2!
UNCOV 207	ObjectRemovalHelper.removeChildrenAndCleanupRecursively(this, this.parent.object3d);	×
UNCOV 208	}	×
209		2✔
210	if (this.object3d.parent) {	2✔
211	this.object3d.parent.remove(this.object3d);	2✔
212	}	2✔
213	ObjectRemovalHelper.removeChildrenAndCleanupRecursively(this, this.object3d);	2✔
214	}	2✔
215		1✔
216	/**	1✔
217	* Picking method for this layer.	1✔
218	*	1✔
219	* @param {View} view - The view instance.	1✔
220	* @param {Object} coordinates - The coordinates to pick in the view. It	1✔
221	* should have at least `x` and `y` properties.	1✔
222	* @param {number} radius - Radius of the picking circle.	1✔
223	* @param {Array} target - target to push result.	1✔
224	*	1✔
225	* @return {Array} An array containing all targets picked under the	1✔
226	* specified coordinates.	1✔
227	*/	1✔
228	pickObjectsAt(view, coordinates, radius = this.options.defaultPickingRadius, target = []) {	1✔
UNCOV 229	return Picking.pickObjectsAt(view, coordinates, radius, this.object3d, target);	×
UNCOV 230	}	×
231	}	1✔
232		1✔
233	export default GeometryLayer;	1✔

iTowns / itowns / 12256691367

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous