com.flagstone.transform.filter
Class GlowFilter.Builder

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

Enclosing class:

GlowFilter

public static final class GlowFilter.Builder
extends Object

Builder for creating GlowFilter objects.

Constructor Summary

GlowFilter.Builder()

Method Summary

GlowFilter	build() Create a GlowFilter object using the parameters defined in the Builder.
GlowFilter.Builder	setBlur(float xAmount, float yAmount) Set the blur amounts.
GlowFilter.Builder	setColor(Color aColor) Set the colour of the glow.
GlowFilter.Builder	setMode(FilterMode filterMode) Set the compositing mode for the glow.
GlowFilter.Builder	setPasses(int count) Set the number of passes for creating the blur.
GlowFilter.Builder	setStrength(float weight) Set the glow strength.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlowFilter.Builder

public GlowFilter.Builder()

Method Detail

setColor

public GlowFilter.Builder setColor(Color aColor)

Set the colour of the glow.

Parameters:

aColor - the glow colour.

Returns:

this Builder.

setBlur

public GlowFilter.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 GlowFilter.Builder setMode(FilterMode filterMode)

Set the compositing mode for the glow.

Parameters:

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

Returns:

this Builder.

setStrength

public GlowFilter.Builder setStrength(float weight)

Set the glow strength.

Parameters:

weight - the weight of the glow.

Returns:

this Builder.

setPasses

public GlowFilter.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 GlowFilter build()

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

Returns:

a GlowFilter object.