org.pepsoft.worldpainter.heightMaps

Class DelegatingHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.DelegatingHeightMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, HeightMap

Direct Known Subclasses:

BicubicHeightMap, CombiningHeightMap, DisplacementHeightMap, ShelvingHeightMap, SlopeHeightMap, TransformingHeightMap

public abstract class DelegatingHeightMap
extends AbstractHeightMap

Created by pepijn on 26-3-16.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HeightMap[]	children
protected boolean	constant
protected int	constantColour
protected double	constantValue

Fields inherited from class org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

name, seed

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DelegatingHeightMap(java.lang.String... roles)

Method Summary

Modifier and Type	Method and Description
protected void	childrenChanged()
protected void	determineConstant() Determines whether this height map can be constant by checking that all its children are constant height maps.
protected int	doGetColour(int x, int y)
protected double	doGetHeight(float x, float y)
protected double	doGetHeight(int x, int y)
int	getColour(int x, int y) Get the colour of the height map at a particular location as a combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.
double	getConstantValue() If the height map is constant: returns the constant value that would be returned for any location from HeightMap.getHeight(int, int) and HeightMap.getHeight(float, float).
double	getHeight(float x, float y) Get the height of the height map at a particular location.
double	getHeight(int x, int y) Get the height of the height map at a particular location.
HeightMap	getHeightMap(int index)
HeightMap	getHeightMap(java.lang.String role)
int	getHeightMapCount()
int	getIndex(HeightMap heightMap)
int	getIndex(java.lang.String role)
java.lang.String	getRole(int index)
long	getSeed() Get the seed of the height map.
boolean	isConstant() Indicate whether the height map is constant, i.e.
protected java.lang.Object	readResolve()
void	recalculateConstantValue() Recursively recalculate the constant value, if any, of the tree of height maps.
int	replace(HeightMap oldChild, HeightMap newChild)
HeightMap	replace(int index, HeightMap newChild)
void	setHeightMap(int index, HeightMap child)
void	setHeightMap(java.lang.String role, HeightMap child)
void	setSeed(long seed) Set the seed of the height map.

Methods inherited from class org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

clone, getBaseHeight, getExtent, getName, getParent, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.HeightMap

clamped, getIcon, getRange, minus, minus, plus, plus, scaled, smoothed, times, times

Field Detail

children

protected final HeightMap[] children

constantValue

protected transient double constantValue

constant

protected transient boolean constant

constantColour

protected transient int constantColour

Constructor Detail

DelegatingHeightMap

protected DelegatingHeightMap(java.lang.String... roles)

Method Detail

recalculateConstantValue

public void recalculateConstantValue()

Recursively recalculate the constant value, if any, of the tree of height maps.

getHeightMapCount

public final int getHeightMapCount()

getRole

public final java.lang.String getRole(int index)

getIndex

public final int getIndex(java.lang.String role)

getIndex

public final int getIndex(HeightMap heightMap)

getHeightMap

public final HeightMap getHeightMap(int index)

getHeightMap

public final HeightMap getHeightMap(java.lang.String role)

setHeightMap

public final void setHeightMap(int index,
                               HeightMap child)

setHeightMap

public final void setHeightMap(java.lang.String role,
                               HeightMap child)

replace

public final HeightMap replace(int index,
                               HeightMap newChild)

replace

public final int replace(HeightMap oldChild,
                         HeightMap newChild)

getSeed

public final long getSeed()

Description copied from interface: HeightMap

Get the seed of the height map.

Specified by:

getSeed in interface HeightMap

Overrides:

getSeed in class AbstractHeightMap

Returns:

The seed of the height map.

setSeed

public final void setSeed(long seed)

Description copied from interface: HeightMap

Set the seed of the height map.

Specified by:

setSeed in interface HeightMap

Overrides:

setSeed in class AbstractHeightMap

Parameters:

seed - The new seed of the height map.

isConstant

public boolean isConstant()

Description copied from interface: HeightMap

Indicate whether the height map is constant, i.e. it always returns the same value regardless of the location.

Specified by:

isConstant in interface HeightMap

Overrides:

isConstant in class AbstractHeightMap

Returns:

true if the height map is constant.

getConstantValue

public double getConstantValue()

Description copied from interface: HeightMap

If the height map is constant: returns the constant value that would be returned for any location from HeightMap.getHeight(int, int) and HeightMap.getHeight(float, float). If the height map is not constant the behaviour is undefined.

Specified by:

getConstantValue in interface HeightMap

Overrides:

getConstantValue in class AbstractHeightMap

Returns:

The constant value of this height map, providing that it is constant according to HeightMap.isConstant().

getHeight

public final double getHeight(float x,
                              float y)

Description copied from interface: HeightMap

Get the height of the height map at a particular location.

Specified by:

getHeight in interface HeightMap

Overrides:

getHeight in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the height.

y - The Y coordinate of the location of which to get the height.

Returns:

The height at the specified location.

getHeight

public final double getHeight(int x,
                              int y)

Description copied from interface: HeightMap

Get the height of the height map at a particular location.

Specified by:

getHeight in interface HeightMap

Overrides:

getHeight in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the height.

y - The Y coordinate of the location of which to get the height.

Returns:

The height at the specified location.

getColour

public final int getColour(int x,
                           int y)

Description copied from interface: HeightMap

Get the colour of the height map at a particular location as a combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.

Specified by:

getColour in interface HeightMap

Overrides:

getColour in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the colour.

y - The Y coordinate of the location of which to get the colour.

Returns:

The colour at the specified location.

childrenChanged

protected void childrenChanged()

determineConstant

protected void determineConstant()

Determines whether this height map can be constant by checking that all its children are constant height maps. Invoked automatically whenever the children of this height map change; should also be invoked by subclasses whenever some property which affects the calculated value of the height map changes.

doGetColour

protected int doGetColour(int x,
                          int y)

doGetHeight

protected double doGetHeight(float x,
                             float y)

doGetHeight

protected double doGetHeight(int x,
                             int y)

readResolve

protected java.lang.Object readResolve()
                                throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException