aframe-map
Advanced tools
A 3D street map entity & component for A-Frame.
The <a-map> entity displays a plane textured with a rendered OpenStreetMap
map.
Use directly from the unpkg CDN:
<head>
<script src="https://aframe.io/releases/0.3.0/aframe.min.js"></script>
<script src="https://unpkg.com/aframe-map"></script>
<script>
registerAframeMap(window.AFRAME);
</script>
</head>
<body>
<a-scene>
<a-map position="0 0 -5"></a-map>
<a-camera></a-camera>
</a-scene>
</body>
Install via npm:
npm install aframe-map
Then register and use.
import aframe from 'aframe';
import registerMap from 'aframe-map';
registerMap(aframe);
map componentNote: The <a-map> entity automatically includes the
map component.
| 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) |
| style | string | '' | A JSON.stringify'd MapBox style. If none is provided, a default style will be loaded. (see creating a style) |
| ... | All other options are passed directly to Mapbox GL |
This 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.
MapBox styles 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. Take special note of the tile server to be used; Mapbox charges for access to theirs, however there is a free CDN powered by 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!
| 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 |
FAQs
Map entity & component for A-Frame.
The npm package aframe-map receives a total of 9 weekly downloads. As such, aframe-map popularity was classified as not popular.
We found that aframe-map demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.