@dlr-eoc/utils-maps
TypeScript icon, indicating that this package has built-in type declarations

12.0.1-next.4 • Public • Published

dlr-eoc/utils-maps

This library contains a collection of utilities that do not themselves depend on angular.

ol

Utilities that help in the management of openlayers.

  • flattenLayers: layers can be arbitrarily nested. This function flattens such a nested collection.

Utilities for copying the images of openlayers' multiple canvases into one, ready to download.

  • mapToSingleCanvas
  • scaledMapToSingleCanvas
  • simpleMapToCanvas

Example usage:

  previewButton.addEventListener('click', () => {
    simpleMapToCanvas(map, previewCanvas, paper.widthPx, paper.heightPx, (updated) => {
        console.log('done');
    });
  });
  downloadButton.addEventListener('click', () => {
     downloadUrl(previewCanvas.toDataURL('image/png'), 'full');
  });

Custom renderers. Openlayers allows us to define our own, custom renderers. Currently we have:

  • minimal_renderer contains an absolute minimal example of what is required to create a custom renderer
  • dtm_renderer illustrates how WebGL can make use of normal-maps
  • particle_renderer procedurally generates little white particles that move along a force-field (that the user may change at any point)
  • interpolation_renderer does an inverse distance interpolation between a set of data-points on a per-pixel basis.

webgl

This is a simple object-oriented abstraction of the webgl-api.

  • webgl.ts contains a very simple wrapper around the native webgl-api-calls. It only attempts to group commonly associated operations and abstract away the details of data-assignment.
  • engine.core.ts is a object-oriented wrapper around webgl.ts. Creating an instance of the class Shader will make sure the programmer has provided all the required attributes, uniforms, textures and indices, and also simplify binding and drawing. There's even some - limited - glsl-parsing to avoid the most common errors in shader-programming.
  • engine.shapes.ts contains a few commonly used vertex-primitives like triangles, rectangles, boxes, etc., as well as shape-building helpers like a Bezier-curve creator.

Development

The utils libraries are all designed to have no production dependencies on angular. The primary objective here is to create utilities that can be used in other frameworks or framework-independent. Such utilities might take on the form of libraries of webcomponents.

Inspired by clarity-design's shift to a framework-independent core, we strive to make those utilities available outside of angular, while at the same time cause minimal disruptions in the current usage of all those outsourced tools.

We intend to obtain this goal by:

  • Minimal disruptions to the current usage: When a components or parts of them are moved to a utils-library, we maintain a wrapper that keeps the angular-template syntax. We strive to minimize breaking changes.
  • Minimal external dependencies: We hope to make our utils as atomic as possible, meaning that we'll avoid external dependencies where possible. We will, of course, still use very important libraries like openlayers, but avoid others that are less vital.
  • Unopinionated: These utilities are intended to be used in any framework. As such, we try to avoid any Angular- or UKIS-specific idioms that might not fit in with another users idea of how a certain tool is best used.
  • Gradual transition: As UKIS matures, we will move more and more functionality out of angular-components and into utility-libraries.
  • Keeping up with web-standards: One core motivation for the creation of the utils-libraries was our objective of using some functionality of Ukis within other applications (like static site generators, django, CMS etc) as web components. As a consequence, we intend to design the utilities with modern web-standards and -api's in mind.

Package Sidebar

Install

npm i @dlr-eoc/utils-maps

Weekly Downloads

15

Version

12.0.1-next.4

License

Apache-2.0

Unpacked Size

713 kB

Total Files

26

Last publish

Collaborators

  • dlr-eoc-ukis