Package Exports
- tiled-geometry
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tiled-geometry) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Tiled Geometry
Utilities for 2-D tiled geometry
This library contains several useful functions and classes for dealing with 2-D tiled geometry.
Installation
npm install tiled-geometry
API
Constants and utlities for 2-D tiled coordinate spaces:
Direction
- constants for eight compass directionsTurn
- constants for rotation among eight compass directionsCardinalDirection
- constants for four cardinal directionsCardinalTurn
- constants for rotation among four cardinal directionsCardinalDirectionFlags
- bitmask constants for four cardinal directionsFlip
- constants for mirroring the coordinate spaceCardinalOrientation
- constants combining CardinalDirection and FlipAxis
- constants for the two major axes
Classes for coordinates, shapes, masks, and more:
Offset
- a location or relative offsetSize
- a two-dimensional extentRectangle
- a rectangle (with offset and size)Mask
- a rectangular area with boolean values for each cellMaskRectangle
- a mask with an offsetRasterMask
- a mask encoded as "raster lines"CardinalPath
- a path on the grid, moving only in the four cardinal directionsTransformRectangle
- maps a rectangular area onto a grid with transformations