com.flagstone.transform.fillstyle
Class MorphSolidFill

java.lang.Object
  com.flagstone.transform.fillstyle.MorphSolidFill

All Implemented Interfaces:

Copyable<FillStyle>, SWFEncodeable, FillStyle

public final class MorphSolidFill
extends Object
implements FillStyle

MorphSolidFill defines the solid colours that are used to fill a shape at the start and end of the morphing process.

Constructor Summary

MorphSolidFill(Color start, Color end)
Creates a MorphSolidFill object specifying the starting and ending colours.

MorphSolidFill(MorphSolidFill object)
Creates and initialises a MorphSolidFill fill style using the values copied from another MorphSolidFill object.

MorphSolidFill(SWFDecoder coder, Context context)
Creates and initialises a MorphSolidFill fill style using values encoded in the Flash binary format.

Method Summary

MorphSolidFill	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
Color	getEndColor() Get the colour at the end of the morphing process.
Color	getStartColor() Get the colour at the start of the morphing process.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
void	setEndColor(Color aColor) Sets the colour at the end of the morphing process.
void	setStartColor(Color aColor) Sets the colour at the start of the morphing process.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MorphSolidFill

public MorphSolidFill(SWFDecoder coder,
                      Context context)
               throws IOException

Creates and initialises a MorphSolidFill fill style using values encoded in the Flash binary format.

Parameters:

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

context - a Context object used to manage the decoders for different type of object and to pass information on how objects are decoded.

Throws:

IOException - if an error occurs while decoding the data.

MorphSolidFill

public MorphSolidFill(Color start,
                      Color end)

Creates a MorphSolidFill object specifying the starting and ending colours.

Parameters:

start - the colour at the start of the morphing process.

end - the colour at the end of the morphing process.

MorphSolidFill

public MorphSolidFill(MorphSolidFill object)

Creates and initialises a MorphSolidFill fill style using the values copied from another MorphSolidFill object.

Parameters:

object - a MorphSolidFill fill style from which the values will be copied.

Method Detail

getStartColor

public Color getStartColor()

Get the colour at the start of the morphing process.

Returns:

the starting fill colour.

getEndColor

public Color getEndColor()

Get the colour at the end of the morphing process.

Returns:

the final fill colour.

setStartColor

public void setStartColor(Color aColor)

Sets the colour at the start of the morphing process.

Parameters:

aColor - the start colour. Must not be null.

setEndColor

public void setEndColor(Color aColor)

Sets the colour at the end of the morphing process.

Parameters:

aColor - the end colour. Must not be null.

copy

public MorphSolidFill copy()

Creates a complete copy of this object.

Specified by:

copy in interface Copyable<FillStyle>

Returns:

a deep-copy of this object. New instances of mutable objects are copied and immutable instances are shared.

toString

public String toString()

Overrides:

toString 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.