com.mebigfatguy.patchanim
Class PatchAnimDocument

java.lang.Object
  com.mebigfatguy.patchanim.PatchAnimDocument

All Implemented Interfaces:

java.io.Serializable

public class PatchAnimDocument
extends java.lang.Object
implements java.io.Serializable

represents the document that can be saved to file.

See Also:

Serialized Form

Constructor Summary

PatchAnimDocument(int patchOrder, boolean alpha)
constructs a new document for the New menu item

Method Summary

AnimationType	getAnimationType() gets the preferred animation type to use for the animation files
int	getHeight() gets the height in pixels of the generated animation file
int	getOrder() returns the order of the bezier patch used for this document
OutOfBoundsColor	getOutOfBoundsColor() gets the algorithm to use when a color is beyond the 0 - 255 range
java.util.List<CombinedPatch>	getPatches() retrieves a list of all the bezier patches
int	getTweenCount() gets the preferred number of in-between frames to generate when creating animations
TweenStyle	getTweenStyle() gets the algorithm used to tween between one patch and another
int	getWidth() returns the preferred width in pixels of the generated animation file
boolean	isDirty() determines if the document has been modified since it was last saved
void	setAnimationType(AnimationType animationType) sets the preferred animation type to use for animation files
void	setDirty(boolean isDirty) marks whether or not the document has been modified.
void	setHeight(int height) sets the height in pixels of the gnerated animation files
void	setOutOfBoundsColor(OutOfBoundsColor outOfBoundsColor) sets the algorithm to use when a color is beyond the 0 - 255 range
void	setPatches(java.util.List<CombinedPatch> patches) sets the list of bezier patches to use for color blends
void	setTweenCount(int tweenCount) sets the preferred number of in-between frames to generate when creating animations
void	setTweenStyle(TweenStyle tweenStyle) sets the algorithm used to tween between one patch and another
void	setWidth(int width) sets the preferred width in pixels of generated animation files
boolean	useAlpha() returns whether to use the alpha channel

Methods inherited from class java.lang.Object

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

Constructor Detail

PatchAnimDocument

public PatchAnimDocument(int patchOrder,
                         boolean alpha)

constructs a new document for the New menu item

Method Detail

isDirty

public boolean isDirty()

determines if the document has been modified since it was last saved

Returns:

whether the document has been modified.

setDirty

public void setDirty(boolean isDirty)

marks whether or not the document has been modified.

Parameters:

isDirty - whether or not the document has been modified

getOrder

public int getOrder()

returns the order of the bezier patch used for this document

Returns:

the order of the patch

useAlpha

public boolean useAlpha()

returns whether to use the alpha channel

Returns:

the alpha channel option flag

getPatches

public java.util.List<CombinedPatch> getPatches()

retrieves a list of all the bezier patches

Returns:

the list of all the bezier patches

setPatches

public void setPatches(java.util.List<CombinedPatch> patches)

sets the list of bezier patches to use for color blends

Parameters:

patches - the list of bezier patches

getWidth

public int getWidth()

returns the preferred width in pixels of the generated animation file

Returns:

the width in pixels

setWidth

public void setWidth(int width)

sets the preferred width in pixels of generated animation files

Parameters:

width - the width in pixels

getHeight

public int getHeight()

gets the height in pixels of the generated animation file

Returns:

the height in pixels

setHeight

public void setHeight(int height)

sets the height in pixels of the gnerated animation files

Parameters:

height - the height in pixels

getAnimationType

public AnimationType getAnimationType()

gets the preferred animation type to use for the animation files

Returns:

the preferred animation type

setAnimationType

public void setAnimationType(AnimationType animationType)

sets the preferred animation type to use for animation files

Parameters:

animationType - the preferred animation type

getOutOfBoundsColor

public OutOfBoundsColor getOutOfBoundsColor()

gets the algorithm to use when a color is beyond the 0 - 255 range

Returns:

the algorithm choice to use for out of bounds color

setOutOfBoundsColor

public void setOutOfBoundsColor(OutOfBoundsColor outOfBoundsColor)

sets the algorithm to use when a color is beyond the 0 - 255 range

Parameters:

outOfBoundsColor - the algorithm choice to use for out of bounds colors

getTweenCount

public int getTweenCount()

gets the preferred number of in-between frames to generate when creating animations

Returns:

the number of in-between frames

setTweenCount

public void setTweenCount(int tweenCount)

sets the preferred number of in-between frames to generate when creating animations

Parameters:

tweenCount - the number of in-between frames

getTweenStyle

public TweenStyle getTweenStyle()

gets the algorithm used to tween between one patch and another

Returns:

the tween algorithm

setTweenStyle

public void setTweenStyle(TweenStyle tweenStyle)

sets the algorithm used to tween between one patch and another

Parameters:

tweenStyle - the tween algorithm