org.pepsoft.worldpainter.brushes

Interface Brush

public interface Brush

Method Summary

Modifier and Type	Method and Description
Brush	clone() Create a deep copy of the brush.
BrushShape	getBrushShape() Get the shape of the brush.
int	getEffectiveRadius() Get the "radius" of the bounding box of the brush.
float	getFullStrength(int dx, int dy) Get the maximum brush strength at a specific point on the brush, in other words the strength if the level was set to 1.0f.
float	getLevel() Get the current level of the brush.
java.lang.String	getName() Get the name of the brush.
int	getRadius() Get the current radius of the brush.
float	getStrength(int dx, int dy) Get the brush strength at a specific point on the brush.
void	setLevel(float level) Set the level of the brush.
void	setRadius(int radius) Set the radius of the brush.

Method Detail

getName

java.lang.String getName()

Get the name of the brush.

Returns:

The name of the brush.

getStrength

float getStrength(int dx,
                  int dy)

Get the brush strength at a specific point on the brush.

Parameters:

dx - The X coordinate relative to the center of the brush.

dy - The Y coordinate relative to the center of the brush.

Returns:

The brush strength at the specified location, from 0.0f (no effect) to 1.0f (maximum effect) (inclusive).

getFullStrength

float getFullStrength(int dx,
                      int dy)

Get the maximum brush strength at a specific point on the brush, in other words the strength if the level was set to 1.0f. Synonymous with invoking setLevel(1.0f); getStrength(dx, dy), but possibly more efficient and without actually changing the value of the level property.

Parameters:

dx - The X coordinate relative to the center of the brush.

dy - The Y coordinate relative to the center of the brush.

Returns:

The maximum brush strength at the specified location, from 0.0f (no effect) to 1.0f (maximum effect) (inclusive).

getRadius

int getRadius()

Get the current radius of the brush.

Returns:

The current radius of the brush in pixels.

setRadius

void setRadius(int radius)

Set the radius of the brush.

Parameters:

radius - The new radius of the brush in pixels.

getEffectiveRadius

int getEffectiveRadius()

Get the "radius" of the bounding box of the brush. Usually this will be the same as getRadius(), but it could be larger for, for instance, a rotated square brush.

Returns:

The radius of the bounding box of the brush.

getLevel

float getLevel()

Get the current level of the brush.

Returns:

The current level of the brush, from 0.0f (no effect) to 1.0f (maximum effect) (inclusive).

setLevel

void setLevel(float level)

Set the level of the brush.

Parameters:

level - The new level of the brush, from 0.0f (no effect) to 1.0f (maximum effect) (inclusive).

getBrushShape

BrushShape getBrushShape()

Get the shape of the brush.

Returns:

The shape of the brush.

clone

Brush clone()

Create a deep copy of the brush. The copy will not be affected by subsequent modifications to the original.

Returns:

A deep copy of the brush.