Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jesstelford/aframe-map
Map entity & component for A-Frame.
https://github.com/jesstelford/aframe-map
Last synced: 28 days ago
JSON representation
Map entity & component for A-Frame.
- Host: GitHub
- URL: https://github.com/jesstelford/aframe-map
- Owner: jesstelford
- License: mit
- Created: 2016-10-16T05:34:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-11T13:26:10.000Z (over 6 years ago)
- Last Synced: 2024-11-08T21:16:21.931Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://jesstelford.github.io/aframe-map
- Size: 900 KB
- Stars: 35
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Looking for maintainers
I have recently [started a new business](https://mobile.twitter.com/ceteio), which means I no longer have time to maintain this project.
Please [reach out](https://github.com/jesstelford) if you are interested in updating this component to the latest versions of aframe, merging the pending PRs, and resolving the list of issues ❤️
# aframe-map
A 3D street map entity & component for [A-Frame](https://aframe.io).
The `` entity displays a plane textured with a rendered OpenStreetMap
map.
### Installation
#### Browser
Use directly from the unpkg CDN:
```html
```
#### npm
Install via npm:
```bash
npm install aframe-map
```
Then register and use.
```javascript
import 'aframe';
import 'aframe-map';
```
### `map` component
_Note: The `` entity automatically includes the
`map` component._
#### Schema
| attribute | type | default | description |
|---|---|---|---|
| pxToWorldRatio | number | 100 | The number of pixels per world unit to render the map on the plane. ie; when set to 100, will display 100 pixels per 1 meter in world space. (see [a note on fidelity](#a-note-on-fidelity)) |
| accessToken | string | | An optional access token if using Mapbox's style. Not needed if you use your own styling |
| style | string | '' | Either a Mapbox URL (like `mapbox://styles/mapbox/...`) or a `JSON.stringify`'d [MapBox style](https://mapbox.com/mapbox-gl-style-spec/). If none is provided, a default style will be loaded. (see [creating a style](#creating-a-style)) |
| ... | | | All other options are passed directly to Mapbox GL |
##### A note on fidelity
The higher `pxToWorldRatio`, the more map area will be displayed per world
unit. That canvas has to be translated into a plane in world space. This is
combined with the width and height in world space (from geometry.width and
geometry.height on the entity) to set up the plane for rendering in 3D.
The map is rendered as a texture on a 3D plane. For best performance, texture
sizes should be kept to powers of 2. Keeping this in mind, you should work to
ensure `width * pxToWorldRatio` and `height * pxToWorldRatio` are powers of 2.
##### Creating a style
[MapBox styles](https://mapbox.com/mapbox-gl-style-spec/) are a JSON
specification for how to render different layers of the map.
Creating new styles can be done by hand, or with an editor such as
[Maputnik](https://github.com/maputnik/editor).
Take special note of the _tile server_ to be used;
Mapbox charges for access to theirs,
however there is a [free CDN](http://osm2vectortiles.tileserver.com/v2.json)
powered by [osm2vectortiles.org/](http://osm2vectortiles.org) (this is the
server used by the default style).
_Note: The osm2vectortiles free CDN defaults to insecure http URLs which will be
rejected by browsers on security grounds when the main site is served over
secure https._
You can also easily [host your own tile
server](http://osm2vectortiles.org/docs/getting-started/)!
#### Events
| event name | data | description |
|---|---|---|
| `map-loaded` | (none) | Fired on the first render of the map component |
| `map-moveend` | (none) | Fired when zoom, center, bearing, or pitch are changed _after_ the initial render |