com.jme3.terrain.heightmap

Class RawHeightMap

java.lang.Object

com.jme3.terrain.heightmap.AbstractHeightMap

com.jme3.terrain.heightmap.RawHeightMap

All Implemented Interfaces:

HeightMap

public class RawHeightMap
extends AbstractHeightMap

RawHeightMap creates a height map from a RAW image file. The greyscale image denotes height based on the value of the pixel for each point. Where pure black the lowest point and pure white denotes the highest.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORMAT_16BITBE Format specification for 16 bit big endian heightmaps
static int	FORMAT_16BITLE Format specification for 16 bit little endian heightmaps
static int	FORMAT_8BIT Format specification for 8 bit precision heightmaps

Fields inherited from class com.jme3.terrain.heightmap.AbstractHeightMap

filter, heightData, heightScale, NORMALIZE_RANGE, size

Constructor Summary

Constructors

Constructor and Description
RawHeightMap(float[] heightData)
RawHeightMap(java.io.InputStream stream, int size, int format, boolean swapxy)
RawHeightMap(java.lang.String filename, int size) Constructor creates a new RawHeightMap object and loads a RAW image file to use as a height field.
RawHeightMap(java.lang.String filename, int size, int format, boolean swapxy)
RawHeightMap(java.net.URL resource, int size, int format, boolean swapxy)

Method Summary

Modifier and Type	Method and Description
boolean	load() load fills the height data array with the appropriate data from the set RAW image.
void	setFilename(java.lang.String filename) setFilename sets the file to use for the RAW data.
void	setHeightStream(java.io.InputStream stream) setHeightStream sets the stream to use for the RAW data.

Methods inherited from class com.jme3.terrain.heightmap.AbstractHeightMap

erodeTerrain, findMinMaxHeights, flatten, getHeightMap, getInterpolatedHeight, getScaledHeightAtPoint, getScaledHeightMap, getSize, getTrueHeightAtPoint, normalizeTerrain, save, setHeightAtPoint, setHeightScale, setMagnificationFilter, setSize, smooth, smooth, unloadHeightMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_8BIT

public static final int FORMAT_8BIT

Format specification for 8 bit precision heightmaps

See Also:

Constant Field Values

FORMAT_16BITLE

public static final int FORMAT_16BITLE

Format specification for 16 bit little endian heightmaps

See Also:

Constant Field Values

FORMAT_16BITBE

public static final int FORMAT_16BITBE

Format specification for 16 bit big endian heightmaps

See Also:

Constant Field Values

Constructor Detail

RawHeightMap

public RawHeightMap(java.lang.String filename,
                    int size)
             throws java.lang.Exception

Constructor creates a new RawHeightMap object and loads a RAW image file to use as a height field. The greyscale image denotes the height of the terrain, where dark is low point and bright is high point. The values of the RAW correspond directly with the RAW values or 0 - 255.

Parameters:

filename - the RAW file to use as the heightmap.

size - the size of the RAW (must be square).

Throws:

java.lang.Exception - if the filename is null or not RAW, and if the size is 0 or less.

RawHeightMap

public RawHeightMap(float[] heightData)

RawHeightMap

public RawHeightMap(java.lang.String filename,
                    int size,
                    int format,
                    boolean swapxy)
             throws java.lang.Exception

Throws:

java.lang.Exception

RawHeightMap

public RawHeightMap(java.io.InputStream stream,
                    int size,
                    int format,
                    boolean swapxy)
             throws java.lang.Exception

Throws:

java.lang.Exception

RawHeightMap

public RawHeightMap(java.net.URL resource,
                    int size,
                    int format,
                    boolean swapxy)
             throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

load

public boolean load()

load fills the height data array with the appropriate data from the set RAW image.

Returns:

true if the load is successful, false otherwise.

Throws:

java.lang.RuntimeException - if the RAW image has not been set

setFilename

public void setFilename(java.lang.String filename)
                 throws java.lang.Exception

setFilename sets the file to use for the RAW data. A call to load is required to put the changes into effect.

Parameters:

filename - the new file to use for the height data.

Throws:

java.lang.Exception - if the file is null or not RAW.

setHeightStream

public void setHeightStream(java.io.InputStream stream)
                     throws java.lang.Exception

setHeightStream sets the stream to use for the RAW data. A call to load is required to put the changes into effect.

Parameters:

stream - the new stream to use for the height data.

Throws:

java.lang.Exception - if the stream is null or not RAW.