1.0.0 • Published 2 years ago

aframe-geothree-component v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

aframe-geothree-component

Version License

World-scale maps using geo-three and support for multiple map providers (Mapbox, Bing, HereMaps, etc)

For A-Frame.

API

PropertyDescriptionDefault Value
providerMap Tiles Providermapbox-satellite-labels
providerHeightMap Tiles Provider to fetch terrain heightmapbox-satellite
mapViewMethod to display map - planar, height, height-shader or sphericalplanar
loddecides how tiles are subdividedraycast
mapboxApiKeyAPI Key for Mapbox''
mapboxCustomStyleonly when using mapbox-custom provider'mapbox/dark-v10
hereMapsAppCodeApp Code from HereMaps when using HereMaps providers''
hereMapsAppIdApp ID from HereMaps when using HereMaps providers''
bingApiKeyBing Maps API Key when using Bing maps providers''
mapTilerApiKeyMapTiler API Key when using MapTiler maps providers''
openMapTilesServerMapServer path for self-hosted OpenMapTiles Server''

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/1.2.0/aframe.min.js"></script>
  <script src="https://unpkg.com/aframe-geothree-component@1.0.0/dist/aframe-geothree-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity geothree="provider: mapbox-dark; mapboxApiKey: pk.useamapboxapikeyhere"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-geothree-component

Then require and use.

require('aframe');
require('aframe-geothree-component');