com.flagstone.transform.filter
Class BevelFilter.Builder

java.lang.Object
  com.flagstone.transform.filter.BevelFilter.Builder

Enclosing class:

BevelFilter

public static final class BevelFilter.Builder
extends Object

Builder for creating BevelFilter objects.

Constructor Summary

BevelFilter.Builder()

Method Summary

BevelFilter	build() Create a BevelFilter object using the parameters defined in the Builder.
BevelFilter.Builder	setAngle(float radians) Set the shadow angle in radians.
BevelFilter.Builder	setBlur(float xAmount, float yAmount) Set the blur amounts.
BevelFilter.Builder	setDistance(float width) Set the distance from the object that the shadow is displayed.
BevelFilter.Builder	setHighlight(Color color) Set the colour used for the highlight section of hte bevel.
BevelFilter.Builder	setMode(FilterMode filterMode) Set the compositing mode for the shadow.
BevelFilter.Builder	setPasses(int count) Set the number of passes for creating the blur.
BevelFilter.Builder	setShadow(Color color) Set the colour used for the shadow section of the bevel.
BevelFilter.Builder	setStrength(float weight) Set the shadow strength.

Methods inherited from class java.lang.Object

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

Constructor Detail

BevelFilter.Builder

public BevelFilter.Builder()

Method Detail

setShadow

public BevelFilter.Builder setShadow(Color color)

Set the colour used for the shadow section of the bevel.

Parameters:

color - the shadow colour.

Returns:

this Builder.

setHighlight

public BevelFilter.Builder setHighlight(Color color)

Set the colour used for the highlight section of hte bevel.

Parameters:

color - the highlight colour.

Returns:

this Builder.

setBlur

public BevelFilter.Builder setBlur(float xAmount,
                                   float yAmount)

Set the blur amounts.

Parameters:

xAmount - the horizontal blur amount.

yAmount - the vertical blur amount.

Returns:

this Builder.

setMode

public BevelFilter.Builder setMode(FilterMode filterMode)

Set the compositing mode for the shadow.

Parameters:

filterMode - the compositing mode, either INNER, KNOCKOUT or TOP.

Returns:

this Builder.

setAngle

public BevelFilter.Builder setAngle(float radians)

Set the shadow angle in radians.

Parameters:

radians - the angle.

Returns:

this Builder.

setDistance

public BevelFilter.Builder setDistance(float width)

Set the distance from the object that the shadow is displayed.

Parameters:

width - the width of the shadow.

Returns:

this Builder.

setStrength

public BevelFilter.Builder setStrength(float weight)

Set the shadow strength.

Parameters:

weight - the weight of the shadow.

Returns:

this Builder.

setPasses

public BevelFilter.Builder setPasses(int count)

Set the number of passes for creating the blur.

Parameters:

count - the number of blur passes.

Returns:

this Builder.

build

public BevelFilter build()

Create a BevelFilter object using the parameters defined in the Builder.

Returns:

a BevelFilter object.