com.flagstone.transform.filter
Class GradientGlowFilter.Builder

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

Enclosing class:

GradientGlowFilter

public static final class GradientGlowFilter.Builder
extends Object

Builder for creating GradientGlowFilter objects.

Constructor Summary

GradientGlowFilter.Builder()
Creates a new Builder.

Method Summary

GradientGlowFilter.Builder	addGradient(Gradient gradient) Add a Gradient to the list.
GradientGlowFilter	build() Create a GradientGlowFilter object using the parameters defined in the Builder.
GradientGlowFilter.Builder	setAngle(float radians) Set the glow angle in radians.
GradientGlowFilter.Builder	setBlur(float xAmount, float yAmount) Set the blur amounts.
GradientGlowFilter.Builder	setDistance(float width) Set the distance of the glow from the object.
GradientGlowFilter.Builder	setMode(FilterMode filterMode) Set the compositing mode for the shadow.
GradientGlowFilter.Builder	setPasses(int count) Set the number of passes for creating the blur.
GradientGlowFilter.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

GradientGlowFilter.Builder

public GradientGlowFilter.Builder()

Creates a new Builder.

Method Detail

addGradient

public GradientGlowFilter.Builder addGradient(Gradient gradient)

Add a Gradient to the list.

Parameters:

gradient - a Gradient object.

Returns:

this Builder.

setBlur

public GradientGlowFilter.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 GradientGlowFilter.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 GradientGlowFilter.Builder setAngle(float radians)

Set the glow angle in radians.

Parameters:

radians - the angle.

Returns:

this Builder.

setDistance

public GradientGlowFilter.Builder setDistance(float width)

Set the distance of the glow from the object.

Parameters:

width - the width of the glow.

Returns:

this Builder.

setStrength

public GradientGlowFilter.Builder setStrength(float weight)

Set the glow strength.

Parameters:

weight - the weight of the glow.

Returns:

this Builder.

setPasses

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

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

Returns:

a GradientGlowFilter object.