sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
107 lines
4.8 KiB
JavaScript
107 lines
4.8 KiB
JavaScript
/**
|
|
* @module ol/render
|
|
*/
|
|
import CanvasImmediateRenderer from './render/canvas/Immediate.js';
|
|
import { DEVICE_PIXEL_RATIO } from './has.js';
|
|
import { apply as applyTransform, create as createTransform, multiply as multiplyTransform, scale as scaleTransform, } from './transform.js';
|
|
import { getSquaredTolerance } from './renderer/vector.js';
|
|
import { getTransformFromProjections, getUserProjection } from './proj.js';
|
|
/**
|
|
* @typedef {Object} State
|
|
* @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to.
|
|
* @property {import("./Feature.js").FeatureLike} feature Feature.
|
|
* @property {import("./geom/SimpleGeometry.js").default} geometry Geometry.
|
|
* @property {number} pixelRatio Pixel ratio used by the layer renderer.
|
|
* @property {number} resolution Resolution that the render batch was created and optimized for.
|
|
* This is not the view's resolution that is being rendered.
|
|
* @property {number} rotation Rotation of the rendered layer in radians.
|
|
*/
|
|
/**
|
|
* A function to be used when sorting features before rendering.
|
|
* It takes two instances of {@link module:ol/Feature~Feature} or
|
|
* {@link module:ol/render/Feature~RenderFeature} and returns a `{number}`.
|
|
*
|
|
* @typedef {function(import("./Feature.js").FeatureLike, import("./Feature.js").FeatureLike):number} OrderFunction
|
|
*/
|
|
/**
|
|
* @typedef {Object} ToContextOptions
|
|
* @property {import("./size.js").Size} [size] Desired size of the canvas in css
|
|
* pixels. When provided, both canvas and css size will be set according to the
|
|
* `pixelRatio`. If not provided, the current canvas and css sizes will not be
|
|
* altered.
|
|
* @property {number} [pixelRatio=window.devicePixelRatio] Pixel ratio (canvas
|
|
* pixel to css pixel ratio) for the canvas.
|
|
*/
|
|
/**
|
|
* Binds a Canvas Immediate API to a canvas context, to allow drawing geometries
|
|
* to the context's canvas.
|
|
*
|
|
* The units for geometry coordinates are css pixels relative to the top left
|
|
* corner of the canvas element.
|
|
* ```js
|
|
* import {toContext} from 'ol/render';
|
|
* import Fill from 'ol/style/Fill';
|
|
* import Polygon from 'ol/geom/Polygon';
|
|
*
|
|
* var canvas = document.createElement('canvas');
|
|
* var render = toContext(canvas.getContext('2d'),
|
|
* { size: [100, 100] });
|
|
* render.setFillStrokeStyle(new Fill({ color: blue }));
|
|
* render.drawPolygon(
|
|
* new Polygon([[[0, 0], [100, 100], [100, 0], [0, 0]]]));
|
|
* ```
|
|
*
|
|
* @param {CanvasRenderingContext2D} context Canvas context.
|
|
* @param {ToContextOptions} [opt_options] Options.
|
|
* @return {CanvasImmediateRenderer} Canvas Immediate.
|
|
* @api
|
|
*/
|
|
export function toContext(context, opt_options) {
|
|
var canvas = context.canvas;
|
|
var options = opt_options ? opt_options : {};
|
|
var pixelRatio = options.pixelRatio || DEVICE_PIXEL_RATIO;
|
|
var size = options.size;
|
|
if (size) {
|
|
canvas.width = size[0] * pixelRatio;
|
|
canvas.height = size[1] * pixelRatio;
|
|
canvas.style.width = size[0] + 'px';
|
|
canvas.style.height = size[1] + 'px';
|
|
}
|
|
var extent = [0, 0, canvas.width, canvas.height];
|
|
var transform = scaleTransform(createTransform(), pixelRatio, pixelRatio);
|
|
return new CanvasImmediateRenderer(context, pixelRatio, extent, transform, 0);
|
|
}
|
|
/**
|
|
* Gets a vector context for drawing to the event's canvas.
|
|
* @param {import("./render/Event.js").default} event Render event.
|
|
* @return {CanvasImmediateRenderer} Vector context.
|
|
* @api
|
|
*/
|
|
export function getVectorContext(event) {
|
|
if (!(event.context instanceof CanvasRenderingContext2D)) {
|
|
throw new Error('Only works for render events from Canvas 2D layers');
|
|
}
|
|
// canvas may be at a different pixel ratio than frameState.pixelRatio
|
|
var canvasPixelRatio = event.inversePixelTransform[0];
|
|
var frameState = event.frameState;
|
|
var transform = multiplyTransform(event.inversePixelTransform.slice(), frameState.coordinateToPixelTransform);
|
|
var squaredTolerance = getSquaredTolerance(frameState.viewState.resolution, canvasPixelRatio);
|
|
var userTransform;
|
|
var userProjection = getUserProjection();
|
|
if (userProjection) {
|
|
userTransform = getTransformFromProjections(userProjection, frameState.viewState.projection);
|
|
}
|
|
return new CanvasImmediateRenderer(event.context, canvasPixelRatio, frameState.extent, transform, frameState.viewState.rotation, squaredTolerance, userTransform);
|
|
}
|
|
/**
|
|
* Gets the pixel of the event's canvas context from the map viewport's CSS pixel.
|
|
* @param {import("./render/Event.js").default} event Render event.
|
|
* @param {import("./pixel.js").Pixel} pixel CSS pixel relative to the top-left
|
|
* corner of the map viewport.
|
|
* @return {import("./pixel.js").Pixel} Pixel on the event's canvas context.
|
|
* @api
|
|
*/
|
|
export function getRenderPixel(event, pixel) {
|
|
return applyTransform(event.inversePixelTransform, pixel.slice(0));
|
|
}
|
|
//# sourceMappingURL=render.js.map
|