// Copyright (c) 2015 - 2017 Uber Technologies, Inc. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. import { Layer, project32, picking, log, UNIT } from '@deck.gl/core'; import { Model, Geometry } from '@luma.gl/engine'; import vs from "./icon-layer-vertex.glsl.js"; import fs from "./icon-layer-fragment.glsl.js"; import IconManager from "./icon-manager.js"; const DEFAULT_COLOR = [0, 0, 0, 255]; const defaultProps = { iconAtlas: { type: 'image', value: null, async: true }, iconMapping: { type: 'object', value: {}, async: true }, sizeScale: { type: 'number', value: 1, min: 0 }, billboard: true, sizeUnits: 'pixels', sizeMinPixels: { type: 'number', min: 0, value: 0 }, // min point radius in pixels sizeMaxPixels: { type: 'number', min: 0, value: Number.MAX_SAFE_INTEGER }, // max point radius in pixels alphaCutoff: { type: 'number', value: 0.05, min: 0, max: 1 }, getPosition: { type: 'accessor', value: (x) => x.position }, getIcon: { type: 'accessor', value: (x) => x.icon }, getColor: { type: 'accessor', value: DEFAULT_COLOR }, getSize: { type: 'accessor', value: 1 }, getAngle: { type: 'accessor', value: 0 }, getPixelOffset: { type: 'accessor', value: [0, 0] }, onIconError: { type: 'function', value: null, optional: true }, textureParameters: { type: 'object', ignore: true, value: null } }; /** Render raster icons at given coordinates. */ class IconLayer extends Layer { getShaders() { return super.getShaders({ vs, fs, modules: [project32, picking] }); } initializeState() { this.state = { iconManager: new IconManager(this.context.device, { onUpdate: this._onUpdate.bind(this), onError: this._onError.bind(this) }) }; const attributeManager = this.getAttributeManager(); /* eslint-disable max-len */ attributeManager.addInstanced({ instancePositions: { size: 3, type: 'float64', fp64: this.use64bitPositions(), transition: true, accessor: 'getPosition' }, instanceSizes: { size: 1, transition: true, accessor: 'getSize', defaultValue: 1 }, instanceOffsets: { size: 2, accessor: 'getIcon', // eslint-disable-next-line @typescript-eslint/unbound-method transform: this.getInstanceOffset }, instanceIconFrames: { size: 4, accessor: 'getIcon', // eslint-disable-next-line @typescript-eslint/unbound-method transform: this.getInstanceIconFrame }, instanceColorModes: { size: 1, type: 'uint8', accessor: 'getIcon', // eslint-disable-next-line @typescript-eslint/unbound-method transform: this.getInstanceColorMode }, instanceColors: { size: this.props.colorFormat.length, type: 'unorm8', transition: true, accessor: 'getColor', defaultValue: DEFAULT_COLOR }, instanceAngles: { size: 1, transition: true, accessor: 'getAngle' }, instancePixelOffset: { size: 2, transition: true, accessor: 'getPixelOffset' } }); /* eslint-enable max-len */ } /* eslint-disable max-statements, complexity */ updateState(params) { super.updateState(params); const { props, oldProps, changeFlags } = params; const attributeManager = this.getAttributeManager(); const { iconAtlas, iconMapping, data, getIcon, textureParameters } = props; const { iconManager } = this.state; if (typeof iconAtlas === 'string') { return; } // internalState is always defined during updateState const prePacked = iconAtlas || this.internalState.isAsyncPropLoading('iconAtlas'); iconManager.setProps({ loadOptions: props.loadOptions, autoPacking: !prePacked, iconAtlas, iconMapping: prePacked ? iconMapping : null, textureParameters }); // prepacked iconAtlas from user if (prePacked) { if (oldProps.iconMapping !== props.iconMapping) { attributeManager.invalidate('getIcon'); } } else if (changeFlags.dataChanged || (changeFlags.updateTriggersChanged && (changeFlags.updateTriggersChanged.all || changeFlags.updateTriggersChanged.getIcon))) { // Auto packing - getIcon is expected to return an object iconManager.packIcons(data, getIcon); } if (changeFlags.extensionsChanged) { this.state.model?.destroy(); this.state.model = this._getModel(); attributeManager.invalidateAll(); } } /* eslint-enable max-statements, complexity */ get isLoaded() { return super.isLoaded && this.state.iconManager.isLoaded; } finalizeState(context) { super.finalizeState(context); // Release resources held by the icon manager this.state.iconManager.finalize(); } draw({ uniforms }) { const { sizeScale, sizeMinPixels, sizeMaxPixels, sizeUnits, billboard, alphaCutoff } = this.props; const { iconManager } = this.state; const iconsTexture = iconManager.getTexture(); if (iconsTexture) { const model = this.state.model; model.setBindings({ iconsTexture }); model.setUniforms(uniforms); model.setUniforms({ iconsTextureDim: [iconsTexture.width, iconsTexture.height], sizeUnits: UNIT[sizeUnits], sizeScale, sizeMinPixels, sizeMaxPixels, billboard, alphaCutoff }); model.draw(this.context.renderPass); } } _getModel() { // The icon-layer vertex shader uses 2d positions // specifed via: in vec2 positions; const positions = [-1, -1, 1, -1, -1, 1, 1, 1]; return new Model(this.context.device, { ...this.getShaders(), id: this.props.id, bufferLayout: this.getAttributeManager().getBufferLayouts(), geometry: new Geometry({ topology: 'triangle-strip', attributes: { // The size must be explicitly passed here otherwise luma.gl // will default to assuming that positions are 3D (x,y,z) positions: { size: 2, value: new Float32Array(positions) } } }), isInstanced: true }); } _onUpdate() { this.setNeedsRedraw(); } _onError(evt) { const onIconError = this.getCurrentLayer()?.props.onIconError; if (onIconError) { onIconError(evt); } else { log.error(evt.error.message)(); } } getInstanceOffset(icon) { const { width, height, anchorX = width / 2, anchorY = height / 2 } = this.state.iconManager.getIconMapping(icon); return [width / 2 - anchorX, height / 2 - anchorY]; } getInstanceColorMode(icon) { const mapping = this.state.iconManager.getIconMapping(icon); return mapping.mask ? 1 : 0; } getInstanceIconFrame(icon) { const { x, y, width, height } = this.state.iconManager.getIconMapping(icon); return [x, y, width, height]; } } IconLayer.defaultProps = defaultProps; IconLayer.layerName = 'IconLayer'; export default IconLayer;