org.pepsoft.worldpainter.panels

Class DefaultFilter

java.lang.Object

org.pepsoft.worldpainter.panels.DefaultFilter

All Implemented Interfaces:

Filter

public final class DefaultFilter
extends java.lang.Object
implements Filter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultFilter.Builder
static class	DefaultFilter.Condition
static class	DefaultFilter.LayerValue
static class	DefaultFilter.LevelType

Constructor Summary

Constructors

Constructor and Description
DefaultFilter(Dimension dimension, boolean inSelection, boolean outsideSelection, int aboveLevel, int belowLevel, boolean feather, boolean onlyOn, java.lang.Object onlyOnItem, boolean exceptOn, java.lang.Object exceptOnItem, int aboveDegrees, boolean slopeIsAbove)

Method Summary

Modifier and Type	Method and Description
static DefaultFilter.Builder	buildForDimension(Dimension dimension)
int	getAboveLevel()
int	getBelowLevel()
Dimension	getDimension()
Layer	getExceptOnLayer() This gets the "except on" layer, but only if there is one layer selected.
Layer	getOnlyOnLayer() This gets the "only on" layer, but only if there is one layer selected.
boolean	isInSelection()
float	modifyStrength(int x, int y, float strength) Filter the input strength.
void	setDimension(Dimension dimension)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.operations.Filter

and, build

Constructor Detail

DefaultFilter

public DefaultFilter(Dimension dimension,
                     boolean inSelection,
                     boolean outsideSelection,
                     int aboveLevel,
                     int belowLevel,
                     boolean feather,
                     boolean onlyOn,
                     java.lang.Object onlyOnItem,
                     boolean exceptOn,
                     java.lang.Object exceptOnItem,
                     int aboveDegrees,
                     boolean slopeIsAbove)

Method Detail

getAboveLevel

public int getAboveLevel()

getBelowLevel

public int getBelowLevel()

getDimension

public Dimension getDimension()

setDimension

public void setDimension(Dimension dimension)

isInSelection

public boolean isInSelection()

getOnlyOnLayer

public Layer getOnlyOnLayer()

This gets the "only on" layer, but only if there is one layer selected.

getExceptOnLayer

public Layer getExceptOnLayer()

This gets the "except on" layer, but only if there is one layer selected.

buildForDimension

public static DefaultFilter.Builder buildForDimension(Dimension dimension)

modifyStrength

public float modifyStrength(int x,
                            int y,
                            float strength)

Description copied from interface: Filter

Filter the input strength.

Specified by:

modifyStrength in interface Filter

Parameters:

x - The X coordinate in WorldPainter dimension coordinates for which to determine the filter strength.

y - The Y coordinate in WorldPainter dimension coordinates for which to determine the filter strength.

strength - The input filter strength as a number between 0.0 and 1.0.

Returns:

The modified strength as a number between 0.0 and 1.0.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object