com.flagstone.transform.filter
Class BlurFilter

java.lang.Object
  com.flagstone.transform.filter.BlurFilter

All Implemented Interfaces:

SWFEncodeable, Filter

public final class BlurFilter
extends Object
implements Filter

BlurFilter is used to apply a Box filter to the pixel of an object on the display list.

Constructor Summary

BlurFilter(float xBlur, float yBlur, int count)
Create a BlurFilter with the horizontal and vertical blur values and the number of passes.

BlurFilter(SWFDecoder coder)
Creates and initialises a BlueFilter object using values encoded in the Flash binary format.

Method Summary

void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
boolean	equals(Object object)
float	getBlurX() Get the blur amount in the x-direction.
float	getBlurY() Get the blur amount in the y-direction.
int	getPasses() Get the number of passes.
int	hashCode()
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BlurFilter

public BlurFilter(SWFDecoder coder)
           throws IOException

Creates and initialises a BlueFilter object using values encoded in the Flash binary format.

Parameters:

coder - an SWFDecoder object that contains the encoded Flash data.

Throws:

IOException - if an error occurs while decoding the data.

BlurFilter

public BlurFilter(float xBlur,
                  float yBlur,
                  int count)

Create a BlurFilter with the horizontal and vertical blur values and the number of passes.

Parameters:

xBlur - the blur amount in the x-direction.

yBlur - the blue amount in the y-direction.

count - the number of passes to apply.

Method Detail

getBlurX

public float getBlurX()

Get the blur amount in the x-direction.

Returns:

the horizontal blur amount.

getBlurY

public float getBlurY()

Get the blur amount in the y-direction.

Returns:

the vertical blur amount.

getPasses

public int getPasses()

Get the number of passes.

Returns:

the times the blurring is applied.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

prepareToEncode

public int prepareToEncode(Context context)

Prepare an object for encoding, returning the expected size of an object when it is encoded. This method also used to initialise variables, such as offsets and flags that will be used when the object is encoded. Generally the method returns the size in bytes, however when called on objects that use bit fields such as shapes the methods will return the size in bits.

Specified by:

prepareToEncode in interface SWFEncodeable

Parameters:

context - an Context that allows information to be passed between objects to control how they are initialised for encoding.

Returns:

the size of the object when it is encoded.

encode

public void encode(SWFEncoder coder,
                   Context context)
            throws IOException

Encode an object to the Flash binary format.

Specified by:

encode in interface SWFEncodeable

Parameters:

coder - an SWFEncoder object.

context - an Context that allows information to be passed between objects to control how they are initialised for encoding.

Throws:

IOException - if an error occurs while encoding the object.