Create terrain for A-Frame scenes with data!
JavaScript
Latest commit 9d3f8c9 Aug 22, 2016 @bryik Use docs folder for gh-pages
Permalink
Failed to load latest commit information.
dist Rename component Aug 11, 2016
docs Use docs folder for gh-pages Aug 22, 2016
lib Initial commit Aug 10, 2016
.gitignore Use docs folder for gh-pages Aug 22, 2016
LICENSE Initial commit Aug 10, 2016
README.md Bump dependencies Aug 22, 2016
index.js Rename component Aug 11, 2016
package.json Use docs folder for gh-pages Aug 22, 2016

README.md

aframe-terrain-model-component

A terrain model component for A-Frame. Uses Bjørn Sandvik's terrain loader and based on code from a tutorial by the L.A. Times.

The basic idea is to create a large plane with a certain width, height, and number of vertices. Each vertex is then repositioned based on elevation from a digital elevation model (DEM). The DEM must be in ENVI format--see this blog post for conversion details.

API

Property Description Default Value
DEM Path to digital elevation model data in ENVI format.
texture Path to texture.
planeHeight The height of the plane.
planeWidth The width of the plane.
segmentsHeight Width of elevation grid minus one. 199
segmentsWidth Height of elevation grid minus one. 199
zPosition Vertical exaggeration. Lower values will seem flatter, higher values more mountainous. 1.5
debug Adds a wireframe false

The relationship between these properties and the DEM data may not be straightforward.

The height and width of the plane should have the same ratio as the height and width of the area covered by your DEM. For instance, if you've clipped your DEM down to an image/grid size of 6000 px by 6000 px then planeHeight and planeWidth could be set to 60.

The segmentsHeight and segmentsWidth values should be set to "the width and height of your elevation grid minus one". The height and width of your elevation grid was probably determined during the conversion to ENVI.

e.g.

    gdal_translate -scale 0 2470 0 65535 -ot UInt16 -outsize 200 200 -of ENVI jotunheimen.tif jotunheimen.bin

Corresponds to a segmentsHeight and segmentsWidth value of 199.

These values seem to control the "resolution" of the elevation data. The L.A. Times has this to say:

"You'll notice we specified the -outsize parameter, which specifies the number of data points in the output file, and the number of vertices in the plane in the Three.js scene. This can be as high or low as you want, but you'll find that larger values can be very taxing on the graphics processor when rendering the scene. We found that using 300 x 285 provided a good amount of detail without stressing out the GPU too much. For phones, we used a smaller file, 200 x 190, and for some phones even went to a 100 x 95 file, to ensure that the interactive ran smoothly."

Lastly, zPosition controls vertical exaggeration. It is a kind of scaling factor that alters terrain height. I'm not sure how to determine an accurate value for this; my tactic is to adjust until the result is aesthetically pleasing. The L.A. Times used a value of 100 for their Gale Crater experience, Sandvik used 5 for Jotunheimen, and I used 50 for the crater floor example.

References

Data (DEM and textures)

The Gale-Crater and Jotunheimen examples were created by journalists from the L.A. Times and Bjørn Sandvik respectively. The Jotunheimen data was obtained from The Norwegian Mapping Authority.

All Mars examples use public domain data from HiRISE (credit: NASA/JPL/University of Arizona).

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.2.0/aframe.min.js"></script>
  <script src="https://rawgit.com/bryik/aframe-terrain-model-component/master/dist/aframe-terrain-model-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity terrain-model='DEM: url(data/noctis-3500-clip-envi.bin); texture: url(data/noctis-3500-clip-textureRED-resized.jpg); planeWidth: 346; planeHeight: 346; segmentsWidth: 199; segmentsHeight: 199; zPosition: 100;'></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-terrain-model-component

Then register and use.

require('aframe');
require('aframe-terrain-model-component');