[Patchanim-commit] SF.net SVN: patchanim: [86] trunk/patchanim/src/com/mebigfatguy/patchanim/ PatchAnimDocument.java

[<dbr...@us...>]

Revision: 86
          http://patchanim.svn.sourceforge.net/patchanim/?rev=86&view=rev
Author:   dbrosius
Date:     2008-02-02 15:36:35 -0800 (Sat, 02 Feb 2008)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    trunk/patchanim/src/com/mebigfatguy/patchanim/PatchAnimDocument.java

Modified: trunk/patchanim/src/com/mebigfatguy/patchanim/PatchAnimDocument.java
===================================================================
--- trunk/patchanim/src/com/mebigfatguy/patchanim/PatchAnimDocument.java	2008-02-01 08:27:35 UTC (rev 85)
+++ trunk/patchanim/src/com/mebigfatguy/patchanim/PatchAnimDocument.java	2008-02-02 23:36:35 UTC (rev 86)
@@ -24,6 +24,9 @@
 
 import com.mebigfatguy.patchanim.surface.CombinedPatch;
 
+/**
+ * represents the document that can be saved to file.
+ */
 public class PatchAnimDocument implements Serializable {
 	
 	private static final long serialVersionUID = -587863884486252874L;
@@ -36,6 +39,9 @@
 	private OutOfBoundsColor outOfBoundsColor;
 	private int tweenCount;
 	
+	/**
+	 * constructs a new document for the New menu item
+	 */
 	public PatchAnimDocument() {
 		patches = new ArrayList<CombinedPatch>();
 		CombinedPatch patch = new CombinedPatch(true);
@@ -47,58 +53,114 @@
 		tweenCount = 10;
 	}
 
+	/**
+	 * determines if the document has been modified since it was last saved
+	 * @return whether the document has been modified.
+	 */
 	public boolean isDirty() {
 		return dirty;
 	}
 	
+	/**
+	 * marks whether or not the document has been modified.
+	 * @param isDirty whether or not the document has been modified
+	 */
 	public void setDirty(boolean isDirty) {
 		dirty = isDirty;
 	}
 	
+	/**
+	 * retrieves a list of all the bezier patches
+	 * @return the list of all the bezier patches
+	 */
 	public List<CombinedPatch> getPatches() {
 		return patches;
 	}
 
+	/**
+	 * sets the list of bezier patches to use for color blends
+	 * @param patches the list of bezier patches
+	 */
 	public void setPatches(List<CombinedPatch> patches) {
 		this.patches = patches;
 	}
 
+	/**
+	 * returns the preferred width in pixels of the generated animation file
+	 * @return the width in pixels
+	 */
 	public int getWidth() {
 		return width;
 	}
 
+	/**
+	 * sets the preferred width in pixels of generated animation files
+	 * @param width the width in pixels
+	 */
 	public void setWidth(int width) {
 		this.width = width;
 	}
 
+	/**
+	 * gets the height in pixels of the generated animation file
+	 * @return the height in pixels
+	 */
 	public int getHeight() {
 		return height;
 	}
 
+	/**
+	 * sets the height in pixels of the gnerated animation files
+	 * @param height the height in pixels
+	 */
 	public void setHeight(int height) {
 		this.height = height;
 	}
 
+	/**
+	 * gets the preferred animation type to use for the animation files
+	 * @return the preferred animation type
+	 */
 	public AnimationType getAnimationType() {
 		return animationType;
 	}
 
+	/**
+	 * sets the preferred animation type to use for animation files
+	 * @param animationType the preferred animation type
+	 */
 	public void setAnimationType(AnimationType animationType) {
 		this.animationType = animationType;
 	}
 
+	/**
+	 * gets the algorithm to use when a color is beyond the 0 - 255 range
+	 * @return the algorithm choice to use for out of bounds color
+	 */
 	public OutOfBoundsColor getOutOfBoundsColor() {
 		return outOfBoundsColor;
 	}
 
+	/**
+	 * sets the algorithm to use when a color is beyond the 0 - 255 range
+	 * @param outOfBoundsColor the algorithm choice to use for out of bounds colors
+	 */
 	public void setOutOfBoundsColor(OutOfBoundsColor outOfBoundsColor) {
 		this.outOfBoundsColor = outOfBoundsColor;
 	}
 
+	/**
+	 * gets the preferred number of in-between frames to generate when creating animations
+	 * @return the number of in-between frames
+	 */
 	public int getTweenCount() {
 		return tweenCount;
 	}
 
+	/**
+	 * sets the preferred number of in-between frames to generate when creating animations
+	 * @param tweenCount the number of in-between frames
+	 */
 	public void setTweenCount(int tweenCount) {
 		this.tweenCount = tweenCount;
 	}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.