125 lines
4.1 KiB
JavaScript
125 lines
4.1 KiB
JavaScript
/**
|
|
* @module ol/layer/WebGLPoints
|
|
*/
|
|
import Layer from './Layer.js';
|
|
import WebGLPointsLayerRenderer from '../renderer/webgl/PointsLayer.js';
|
|
import {assign} from '../obj.js';
|
|
import {parseLiteralStyle} from '../webgl/ShaderBuilder.js';
|
|
|
|
/**
|
|
* @typedef {Object} Options
|
|
* @property {import('../style/literal.js').LiteralStyle} style Literal style to apply to the layer features.
|
|
* @property {string} [className='ol-layer'] A CSS class name to set to the layer element.
|
|
* @property {number} [opacity=1] Opacity (0, 1).
|
|
* @property {boolean} [visible=true] Visibility.
|
|
* @property {import("../extent.js").Extent} [extent] The bounding extent for layer rendering. The layer will not be
|
|
* rendered outside of this extent.
|
|
* @property {number} [zIndex] The z-index for layer rendering. At rendering time, the layers
|
|
* will be ordered, first by Z-index and then by position. When `undefined`, a `zIndex` of 0 is assumed
|
|
* for layers that are added to the map's `layers` collection, or `Infinity` when the layer's `setMap()`
|
|
* method was used.
|
|
* @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
|
|
* visible.
|
|
* @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
|
|
* be visible.
|
|
* @property {number} [minZoom] The minimum view zoom level (exclusive) above which this layer will be
|
|
* visible.
|
|
* @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will
|
|
* be visible.
|
|
* @property {import("../source/Vector.js").default} [source] Source.
|
|
* @property {boolean} [disableHitDetection=false] Setting this to true will provide a slight performance boost, but will
|
|
* prevent all hit detection on the layer.
|
|
*/
|
|
|
|
/**
|
|
* @classdesc
|
|
* Layer optimized for rendering large point datasets. Takes a `style` property which
|
|
* is a serializable JSON object describing how the layer should be rendered.
|
|
*
|
|
* Here are a few samples of literal style objects:
|
|
* ```js
|
|
* const style = {
|
|
* symbol: {
|
|
* symbolType: 'circle',
|
|
* size: 8,
|
|
* color: '#33AAFF',
|
|
* opacity: 0.9
|
|
* }
|
|
* }
|
|
* ```
|
|
*
|
|
* ```js
|
|
* const style = {
|
|
* symbol: {
|
|
* symbolType: 'image',
|
|
* offset: [0, 12],
|
|
* size: [4, 8],
|
|
* src: '../static/exclamation-mark.png'
|
|
* }
|
|
* }
|
|
* ```
|
|
*
|
|
* **Important: a `WebGLPoints` layer must be manually disposed when removed, otherwise the underlying WebGL context
|
|
* will not be garbage collected.**
|
|
*
|
|
* Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
|
|
* property on the layer object; for example, setting `title: 'My Title'` in the
|
|
* options means that `title` is observable, and has get/set accessors.
|
|
*
|
|
* @template {import("../source/Vector.js").default} VectorSourceType
|
|
* @extends {Layer<VectorSourceType>}
|
|
* @fires import("../render/Event.js").RenderEvent
|
|
*/
|
|
class WebGLPointsLayer extends Layer {
|
|
/**
|
|
* @param {Options} options Options.
|
|
*/
|
|
constructor(options) {
|
|
const baseOptions = assign({}, options);
|
|
|
|
super(baseOptions);
|
|
|
|
/**
|
|
* @private
|
|
* @type {import('../webgl/ShaderBuilder.js').StyleParseResult}
|
|
*/
|
|
this.parseResult_ = parseLiteralStyle(options.style);
|
|
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
this.hitDetectionDisabled_ = !!options.disableHitDetection;
|
|
}
|
|
|
|
/**
|
|
* Create a renderer for this layer.
|
|
* @return {WebGLPointsLayerRenderer} A layer renderer.
|
|
*/
|
|
createRenderer() {
|
|
return new WebGLPointsLayerRenderer(this, {
|
|
className: this.getClassName(),
|
|
vertexShader: this.parseResult_.builder.getSymbolVertexShader(),
|
|
fragmentShader: this.parseResult_.builder.getSymbolFragmentShader(),
|
|
hitVertexShader:
|
|
!this.hitDetectionDisabled_ &&
|
|
this.parseResult_.builder.getSymbolVertexShader(true),
|
|
hitFragmentShader:
|
|
!this.hitDetectionDisabled_ &&
|
|
this.parseResult_.builder.getSymbolFragmentShader(true),
|
|
uniforms: this.parseResult_.uniforms,
|
|
attributes: this.parseResult_.attributes,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Clean up.
|
|
*/
|
|
disposeInternal() {
|
|
this.getRenderer().disposeInternal();
|
|
super.disposeInternal();
|
|
}
|
|
}
|
|
|
|
export default WebGLPointsLayer;
|