org.pepsoft.worldpainter.operations

Interface Filter

All Known Implementing Classes:

CombinedFilter, DefaultFilter, ExceptOnTerrainOrLayerFilter, OnlyOnTerrainOrLayerFilter, TerrainOrLayerFilter

public interface Filter

A filter for applying operations to a WorldPainter dimensions.

Method Summary

Modifier and Type	Method and Description
default Filter	and(Filter filter) Returns a filter that combines this one and the specified one, returning the lowest strength of them both.
static DefaultFilter.Builder	build(Dimension dimension) Create a filter builder for a default filter implementation.
float	modifyStrength(int x, int y, float strength) Filter the input strength.

Method Detail

modifyStrength

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

Filter the input strength.

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.

and

default Filter and(Filter filter)

Returns a filter that combines this one and the specified one, returning the lowest strength of them both.

build

static DefaultFilter.Builder build(Dimension dimension)

Create a filter builder for a default filter implementation.