com.sk89q.worldedit.math.convolution

Class HeightMap

java.lang.Object

com.sk89q.worldedit.math.convolution.HeightMap

public class HeightMap
extends Object

Allows applications of Kernels onto the region's height map.

Currently only used for smoothing (with a GaussianKernel)

.

Constructor Summary

Constructors

Constructor and Description
HeightMap(EditSession session, Region region) Constructs the HeightMap
HeightMap(EditSession session, Region region, boolean naturalOnly) Constructs the HeightMap

Method Summary

Modifier and Type	Method and Description
int	apply(int[] data) Apply a raw heightmap to the region
int	applyFilter(HeightMapFilter filter, int iterations) Apply the filter 'iterations' amount times.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeightMap

public HeightMap(EditSession session,
                 Region region)

Constructs the HeightMap

Parameters:

session - an edit session

region - the region

HeightMap

public HeightMap(EditSession session,
                 Region region,
                 boolean naturalOnly)

Constructs the HeightMap

Parameters:

session - an edit session

region - the region

naturalOnly - ignore non-natural blocks

Method Detail

applyFilter

public int applyFilter(HeightMapFilter filter,
                       int iterations)
                throws MaxChangedBlocksException

Apply the filter 'iterations' amount times.

Parameters:

filter - the filter

iterations - the number of iterations

Returns:

number of blocks affected

Throws:

MaxChangedBlocksException

apply

public int apply(int[] data)
          throws MaxChangedBlocksException

Apply a raw heightmap to the region

Parameters:

data - the data

Returns:

number of blocks affected

Throws:

MaxChangedBlocksException