/** * @module ol/render/Feature */ import Feature from '../Feature.js'; import { LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon, } from '../geom.js'; import { compose as composeTransform, create as createTransform, } from '../transform.js'; import { createOrUpdateFromCoordinate, createOrUpdateFromFlatCoordinates, getCenter, getHeight, } from '../extent.js'; import {extend} from '../array.js'; import { getInteriorPointOfArray, getInteriorPointsOfMultiArray, } from '../geom/flat/interiorpoint.js'; import {get as getProjection} from '../proj.js'; import {inflateEnds} from '../geom/flat/orient.js'; import {interpolatePoint} from '../geom/flat/interpolate.js'; import {linearRingss as linearRingssCenter} from '../geom/flat/center.js'; import {transform2D} from '../geom/flat/transform.js'; /** * @type {import("../transform.js").Transform} */ const tmpTransform = createTransform(); /** * Lightweight, read-only, {@link module:ol/Feature~Feature} and {@link module:ol/geom/Geometry~Geometry} like * structure, optimized for vector tile rendering and styling. Geometry access * through the API is limited to getting the type and extent of the geometry. */ class RenderFeature { /** * @param {import("../geom/Geometry.js").Type} type Geometry type. * @param {Array} flatCoordinates Flat coordinates. These always need * to be right-handed for polygons. * @param {Array|Array>} ends Ends or Endss. * @param {Object} properties Properties. * @param {number|string|undefined} id Feature id. */ constructor(type, flatCoordinates, ends, properties, id) { /** * @type {import("../style/Style.js").StyleFunction|undefined} */ this.styleFunction; /** * @private * @type {import("../extent.js").Extent|undefined} */ this.extent_; /** * @private * @type {number|string|undefined} */ this.id_ = id; /** * @private * @type {import("../geom/Geometry.js").Type} */ this.type_ = type; /** * @private * @type {Array} */ this.flatCoordinates_ = flatCoordinates; /** * @private * @type {Array} */ this.flatInteriorPoints_ = null; /** * @private * @type {Array} */ this.flatMidpoints_ = null; /** * @private * @type {Array|Array>} */ this.ends_ = ends; /** * @private * @type {Object} */ this.properties_ = properties; } /** * Get a feature property by its key. * @param {string} key Key * @return {*} Value for the requested key. * @api */ get(key) { return this.properties_[key]; } /** * Get the extent of this feature's geometry. * @return {import("../extent.js").Extent} Extent. * @api */ getExtent() { if (!this.extent_) { this.extent_ = this.type_ === 'Point' ? createOrUpdateFromCoordinate(this.flatCoordinates_) : createOrUpdateFromFlatCoordinates( this.flatCoordinates_, 0, this.flatCoordinates_.length, 2 ); } return this.extent_; } /** * @return {Array} Flat interior points. */ getFlatInteriorPoint() { if (!this.flatInteriorPoints_) { const flatCenter = getCenter(this.getExtent()); this.flatInteriorPoints_ = getInteriorPointOfArray( this.flatCoordinates_, 0, /** @type {Array} */ (this.ends_), 2, flatCenter, 0 ); } return this.flatInteriorPoints_; } /** * @return {Array} Flat interior points. */ getFlatInteriorPoints() { if (!this.flatInteriorPoints_) { const flatCenters = linearRingssCenter( this.flatCoordinates_, 0, /** @type {Array>} */ (this.ends_), 2 ); this.flatInteriorPoints_ = getInteriorPointsOfMultiArray( this.flatCoordinates_, 0, /** @type {Array>} */ (this.ends_), 2, flatCenters ); } return this.flatInteriorPoints_; } /** * @return {Array} Flat midpoint. */ getFlatMidpoint() { if (!this.flatMidpoints_) { this.flatMidpoints_ = interpolatePoint( this.flatCoordinates_, 0, this.flatCoordinates_.length, 2, 0.5 ); } return this.flatMidpoints_; } /** * @return {Array} Flat midpoints. */ getFlatMidpoints() { if (!this.flatMidpoints_) { this.flatMidpoints_ = []; const flatCoordinates = this.flatCoordinates_; let offset = 0; const ends = /** @type {Array} */ (this.ends_); for (let i = 0, ii = ends.length; i < ii; ++i) { const end = ends[i]; const midpoint = interpolatePoint(flatCoordinates, offset, end, 2, 0.5); extend(this.flatMidpoints_, midpoint); offset = end; } } return this.flatMidpoints_; } /** * Get the feature identifier. This is a stable identifier for the feature and * is set when reading data from a remote source. * @return {number|string|undefined} Id. * @api */ getId() { return this.id_; } /** * @return {Array} Flat coordinates. */ getOrientedFlatCoordinates() { return this.flatCoordinates_; } /** * For API compatibility with {@link module:ol/Feature~Feature}, this method is useful when * determining the geometry type in style function (see {@link #getType}). * @return {RenderFeature} Feature. * @api */ getGeometry() { return this; } /** * @param {number} squaredTolerance Squared tolerance. * @return {RenderFeature} Simplified geometry. */ getSimplifiedGeometry(squaredTolerance) { return this; } /** * Get a transformed and simplified version of the geometry. * @abstract * @param {number} squaredTolerance Squared tolerance. * @param {import("../proj.js").TransformFunction} [transform] Optional transform function. * @return {RenderFeature} Simplified geometry. */ simplifyTransformed(squaredTolerance, transform) { return this; } /** * Get the feature properties. * @return {Object} Feature properties. * @api */ getProperties() { return this.properties_; } /** * @return {number} Stride. */ getStride() { return 2; } /** * @return {import('../style/Style.js').StyleFunction|undefined} Style */ getStyleFunction() { return this.styleFunction; } /** * Get the type of this feature's geometry. * @return {import("../geom/Geometry.js").Type} Geometry type. * @api */ getType() { return this.type_; } /** * Transform geometry coordinates from tile pixel space to projected. * * @param {import("../proj.js").ProjectionLike} projection The data projection */ transform(projection) { projection = getProjection(projection); const pixelExtent = projection.getExtent(); const projectedExtent = projection.getWorldExtent(); if (pixelExtent && projectedExtent) { const scale = getHeight(projectedExtent) / getHeight(pixelExtent); composeTransform( tmpTransform, projectedExtent[0], projectedExtent[3], scale, -scale, 0, 0, 0 ); transform2D( this.flatCoordinates_, 0, this.flatCoordinates_.length, 2, tmpTransform, this.flatCoordinates_ ); } } /** * @return {Array|Array>} Ends or endss. */ getEnds() { return this.ends_; } } RenderFeature.prototype.getEndss = RenderFeature.prototype.getEnds; /** * @return {Array} Flat coordinates. */ RenderFeature.prototype.getFlatCoordinates = RenderFeature.prototype.getOrientedFlatCoordinates; /** * Create a geometry from an `ol/render/Feature` * @param {RenderFeature} renderFeature * Render Feature * @return {Point|MultiPoint|LineString|MultiLineString|Polygon|MultiPolygon} * New geometry instance. * @api */ export function toGeometry(renderFeature) { const geometryType = renderFeature.getType(); switch (geometryType) { case 'Point': return new Point(renderFeature.getFlatCoordinates()); case 'MultiPoint': return new MultiPoint(renderFeature.getFlatCoordinates(), 'XY'); case 'LineString': return new LineString(renderFeature.getFlatCoordinates(), 'XY'); case 'MultiLineString': return new MultiLineString( renderFeature.getFlatCoordinates(), 'XY', /** @type {Array} */ (renderFeature.getEnds()) ); case 'Polygon': const flatCoordinates = renderFeature.getFlatCoordinates(); const ends = /** @type {Array} */ (renderFeature.getEnds()); const endss = inflateEnds(flatCoordinates, ends); return endss.length > 1 ? new MultiPolygon(flatCoordinates, 'XY', endss) : new Polygon(flatCoordinates, 'XY', ends); default: throw new Error('Invalid geometry type:' + geometryType); } } /** * Create an `ol/Feature` from an `ol/render/Feature` * @param {RenderFeature} renderFeature RenderFeature * @param {string} [geometryName='geometry'] Geometry name to use * when creating the Feature. * @return {Feature} Newly constructed `ol/Feature` with properties, * geometry, and id copied over. * @api */ export function toFeature(renderFeature, geometryName) { const id = renderFeature.getId(); const geometry = toGeometry(renderFeature); const properties = renderFeature.getProperties(); const feature = new Feature(); if (geometryName !== undefined) { feature.setGeometryName(geometryName); } feature.setGeometry(geometry); if (id !== undefined) { feature.setId(id); } feature.setProperties(properties, true); return feature; } export default RenderFeature;