Added more documentation...

Cube Control/cubeWorker.java

@@ -25,12 +25,18 @@
  * This class handles one animation file. This file can contain
  * many animations, but has to be only 1Mbit in size (128*1024 Byte).
  */
-
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.StringTokenizer;
 
+/**
+ * This class holds all Data of the Application. Additionally it performs the transmission of animation data to/from the cube and saves/loads animations in/from a file.
+ * @author Thomas Buck
+ * @author Felix Bäder
+ * @author Max Nuding
+ * @version 1.0
+ */
+
 public class cubeWorker {
 
 // --------------------
@@ -50,6 +56,9 @@ public class cubeWorker {
 
 // --------------------
 
+  /**
+   * Creates a worker with one animation, containing an empty frame.
+   */
   cubeWorker() {
   animations.add(new Animation());
   animations.get(0).setName("Animation 1");
@@ -57,7 +66,11 @@ public class cubeWorker {
   animations.get(0).get(0).setName("Frame 1");
   framesRemaining--;
   }
-
+  
+  /**
+   * Creates a worker from the given animation list
+   * @param anims List of animations
+   */
   cubeWorker(ArrayList<Animation> anims) {
     animations = anims;
   }
@@ -66,17 +79,27 @@ public class cubeWorker {
 // Misc. Methods
 // --------------------
 
-  // Returns how many animations are defined
+	/**
+	 * Get the number of animations in this worker.
+	 * @return number of animations
+	 */
     public int numOfAnimations() {
            return animations.size();
     }
 
-    // Returns how many frames are in the current animation
+	/**
+	 * Get the number of frames in an animation.
+	 * @param selectedAnimation the animation you want to check
+	 * @return number of frames in this animation
+	 */
     public int numOfFrames(int selectedAnimation) {
            return animations.get(selectedAnimation).size();
     }
 
-  // Tells how many Frames you can add until you reached 1 Mbit...
+    /**
+	 * Get the number of frames you can add until the Cubes memory is full.
+	 * @return number of frames remaining
+	 */
     public int framesRemaining() {
            return framesRemaining;
     }
@@ -86,37 +109,55 @@ public class cubeWorker {
 // Animation Specific
 // --------------------
 
-  // Adds a new Animation
-    // Returns id if ok, -1 if error or not enough space for
-    // another animation
+	/**
+	 * Add an animation.
+	 * @return Index of new animation, or -1 if not enough space remaining.
+	 */
     public int addAnimation() {
-    changedState = true;
-    if (framesRemaining <= 0) {
+    	changedState = true;
+    	if (framesRemaining <= 0) {
           return -1;
-    } else {
-      int s = animations.size();
-      animations.add(s, new Animation());
-      animations.get(s).setName("Animation " + animations.size());
-      return s;
-    }
+    	} else {
+    	  int s = animations.size();
+    	  animations.add(s, new Animation());
+    	  animations.get(s).setName("Animation " + animations.size());
+    	  return s;
+    	}
     }
 
-    // Removes an animation
+	/**
+	 * Remove an animation.
+	 * @param selectedAnimation the animation you want to delete
+	 */
     public void removeAnimation(int selectedAnimation) {
     changedState = true;
     animations.remove(selectedAnimation);
-    selectedAnimation = 0;
     }
 
+	/**
+	 * Get the name of an animation
+	 * @return The name
+	 * @param selectedAnimation The animation you want to get the name from
+	 */
   public String getAnimationName(int selectedAnimation) {
       return animations.get(selectedAnimation).getName();
     }
 
+	/**
+	 * Set the name of an animation
+	 * @param s New name
+	 * @param selectedAnimation Index of the animation you want to change
+	 */
   public void setAnimationName(String s, int selectedAnimation) {
       changedState = true;
     animations.get(selectedAnimation).setName(s);
     }
 
+	/**
+	 * Move an animation UP or DOWN.
+	 * @param dir Direction. Use UP and DOWN defined in cubeWorker
+	 * @param selectedAnimation Animation you want to move
+	 */
   public void moveAnimation(int dir, int selectedAnimation) {
   changedState = true;
     if (dir == UP){
@@ -136,17 +177,31 @@ public class cubeWorker {
 // Frame Specific
 // --------------------
 
+	/**
+	 * Get the name of a frame.
+	 * @param anim Animation the frame is in
+	 * @param frame Index of the frame
+	 */
   public String getFrameName(int anim, int frame) {
       return animations.get(anim).get(frame).getName();
     }
 
+	/**
+	 * Set the name of a frame.
+	 * @param s New name
+	 * @param anim Animation Index
+	 * @param frame Frame Index
+	 */
     public void setFrameName(String s, int anim, int frame) {
     changedState = true;
     animations.get(anim).get(frame).setName(s);
     }
 
-    // Adds a Frame to the current animation.
-    // Returns id if okay, -1 if error
+	/**
+	 * Add a Frame to an animation.
+	 * @return Index of new Frame or -1 if not enough space
+	 * @param anim Animation Index
+	 */
     public int addFrame(int anim) {
     changedState = true;
     if (framesRemaining <= 0) {
@@ -159,32 +214,67 @@ public class cubeWorker {
     return s;
     }
 
-    // Remove the frame
+    /**
+	 * Remove a frame.
+	 * @param anim Animation Index
+	 * @param frame Frame you want to remove
+	 */
     public void removeFrame(int anim, int frame) {
     changedState = true;
     animations.get(anim).remove(frame);
     }
 
-    // Returns array with 64 bytes with led values
+	/**
+	 * Get the data of a frame.
+	 * @param anim Animation Index
+	 * @param frame Frame Index
+	 * @return 64 byte array with data (8 bits per byte => 512 bits)
+	 */
     public short[] getFrame(int anim, int frame) {
     return animations.get(anim).get(frame).getData();
   }
 
+	/**
+	 * Set the data of a frame
+	 * @param data 64 byte array with data
+	 * @param anim Animation Index
+	 * @param frame Frame Index
+	 * @see cubeWorker#getFrame(int, int) getFrame()
+	 */
     public void setFrame(short[] data, int anim, int frame) {
     changedState = true;
     animations.get(anim).get(frame).setData(data);
     }
 
-  // Frame duration in 1/24th of a second
+  /**
+   * Get frame duration.
+   * @param anim Animation Index
+   * @param frame Frame Index
+   * @return Duration. 0 means 1/24th of a second.
+   */
   public short getFrameTime(int anim, int frame) {
     return animations.get(anim).get(frame).getTime();
   }
 
+  /**
+   * Set the frames duration.
+   * @param time New duration
+   * @param anim Animation Index
+   * @param frame Frame Index
+   * @see cubeWorker#getFrameTime(int, int) getFrameTime()
+   */
   public void setFrameTime(short time, int anim, int frame) {
     changedState = true;
     animations.get(anim).get(frame).setTime(time);
   }
 
+  /**
+   * Move a frame.
+   * @param dir Direction to move. Use UP and DOWN from cubeWorker
+   * @param anim Animation Index
+   * @param frame Frame Index
+   * @see cubeWorker#moveAnimation(int, int) moveAnimation()
+   */
   public void moveFrame(int dir, int anim, int frame){
   changedState = true;
     if (dir == UP){
@@ -204,7 +294,11 @@ public class cubeWorker {
 // File Specific
 // --------------------
 
-    // Loads an animation file into this object
+	/**
+	 * Loads an animation file into this worker.
+	 * @param path Path of file to load
+	 * @return 0 on success, -1 on error.
+	 */
     public int loadState(String path) {
       changedState = false;
     try {
@@ -225,7 +319,11 @@ public class cubeWorker {
         return 0;
     }
 
-    // Saves the state of this object in an animation file
+	/**
+	 * Save the state of this object into a file.
+	 * @param path Path to save file in
+	 * @return 0 on success, -1 on error
+	 */
     public int saveState(String path) {
            changedState = false;
        AnimationUtility.writeFile(path, animations);
@@ -236,7 +334,10 @@ public class cubeWorker {
            return 0;
     }
 
-  // Returns true if last saved state != current state
+	/**
+	 * Check if something changed after loading/saving.
+	 * @return TRUE if something changed, FALSE otherwise
+	 */
     public boolean changedStateSinceSave() {
            return changedState;
     }
@@ -245,18 +346,30 @@ public class cubeWorker {
 // Serial Port Specific
 // --------------------
 
-    // sends state of object to led cube
+    /**
+	 * Send all animations to the cube.
+	 * @param port Name of serial port to use
+	 * @return 0 on success, -1 on error
+	 */
     public int uploadState(String port) {
 
-           return 0;
+           return -1;
     }
 
-    // loads all state from the cube into this object
+	/**
+	 * Get all animations from the cube, place it in this object
+	 * @param port Name of serial port to use
+	 * @return 0 on success, -1 on error
+	 */
     public int downloadState(String port) {
 
-           return 0;
+           return -1;
     }
 
+	/**
+	 * Get the names of all available serial ports.
+	 * @return Array of port names. First entry is always "Select serial port..."
+	 */
     public String[] getSerialPorts() {
 		String[] ports = {"Select serial port..."};
 		String helperName;

Cube Control/doc/AFrame.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:29 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:17 CET 2011 -->
 <TITLE>
 AFrame
 </TITLE>

Cube Control/doc/Animation.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:29 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:17 CET 2011 -->
 <TITLE>
 Animation
 </TITLE>

Cube Control/doc/AnimationUtility.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:29 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:17 CET 2011 -->
 <TITLE>
 AnimationUtility
 </TITLE>

Cube Control/doc/HelperUtility.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:30 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:18 CET 2011 -->
 <TITLE>
 HelperUtility
 </TITLE>

Cube Control/doc/Led3D.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 Led3D
 </TITLE>

Cube Control/doc/allclasses-frame.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 All Classes
 </TITLE>

Cube Control/doc/allclasses-noframe.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 All Classes
 </TITLE>

Cube Control/doc/constant-values.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 Constant Field Values
 </TITLE>

Cube Control/doc/cubeWorker.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:29 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:17 CET 2011 -->
 <TITLE>
 cubeWorker
 </TITLE>
@@ -96,6 +96,10 @@ java.lang.Object
 </PRE>
 
 <P>
+This class holds all Data of the Application. Additionally it performs the transmission of animation data to/from the cube and saves/loads animations in/from a file.
+<P>
+
+<P>
 <HR>
 
 <P>
@@ -114,7 +118,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#addAnimation()">addAnimation</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an animation.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -122,7 +126,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#addFrame(int)">addFrame</A></B>(int&nbsp;anim)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a Frame to an animation.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -130,7 +134,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#changedStateSinceSave()">changedStateSinceSave</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check if something changed after loading/saving.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -138,7 +142,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#downloadState(java.lang.String)">downloadState</A></B>(java.lang.String&nbsp;port)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get all animations from the cube, place it in this object</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -146,7 +150,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#framesRemaining()">framesRemaining</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of frames you can add until the Cubes memory is full.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -154,7 +158,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#getAnimationName(int)">getAnimationName</A></B>(int&nbsp;selectedAnimation)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of an animation</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -163,7 +167,7 @@ java.lang.Object
          int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the data of a frame.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -172,7 +176,7 @@ java.lang.Object
              int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of a frame.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -181,7 +185,7 @@ java.lang.Object
              int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get frame duration.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -189,7 +193,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#getSerialPorts()">getSerialPorts</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the names of all available serial ports.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -197,7 +201,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#loadState(java.lang.String)">loadState</A></B>(java.lang.String&nbsp;path)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads an animation file into this worker.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -206,7 +210,7 @@ java.lang.Object
               int&nbsp;selectedAnimation)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move an animation UP or DOWN.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -216,7 +220,7 @@ java.lang.Object
           int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move a frame.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -224,7 +228,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#numOfAnimations()">numOfAnimations</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of animations in this worker.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -232,7 +236,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#numOfFrames(int)">numOfFrames</A></B>(int&nbsp;selectedAnimation)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of frames in an animation.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -240,7 +244,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#removeAnimation(int)">removeAnimation</A></B>(int&nbsp;selectedAnimation)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove an animation.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -249,7 +253,7 @@ java.lang.Object
             int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove a frame.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -257,7 +261,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#saveState(java.lang.String)">saveState</A></B>(java.lang.String&nbsp;path)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Save the state of this object into a file.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -266,7 +270,8 @@ java.lang.Object
                  int&nbsp;selectedAnimation)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of an animation
+ @param s New name</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -276,7 +281,7 @@ java.lang.Object
          int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the data of a frame</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -286,7 +291,7 @@ java.lang.Object
              int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of a frame.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -296,7 +301,7 @@ java.lang.Object
              int&nbsp;frame)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the frames duration.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -304,7 +309,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="cubeWorker.html#uploadState(java.lang.String)">uploadState</A></B>(java.lang.String&nbsp;port)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send all animations to the cube.</TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -334,8 +339,11 @@ numOfAnimations</H3>
 <PRE>
 public int <B>numOfAnimations</B>()</PRE>
 <DL>
+<DD>Get the number of animations in this worker.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>number of animations</DL>
 </DD>
 </DL>
 <HR>
@@ -345,8 +353,11 @@ numOfFrames</H3>
 <PRE>
 public int <B>numOfFrames</B>(int&nbsp;selectedAnimation)</PRE>
 <DL>
+<DD>Get the number of frames in an animation.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>selectedAnimation</CODE> - the animation you want to check
+<DT><B>Returns:</B><DD>number of frames in this animation</DL>
 </DD>
 </DL>
 <HR>
@@ -356,8 +367,11 @@ framesRemaining</H3>
 <PRE>
 public int <B>framesRemaining</B>()</PRE>
 <DL>
+<DD>Get the number of frames you can add until the Cubes memory is full.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>number of frames remaining</DL>
 </DD>
 </DL>
 <HR>
@@ -367,8 +381,11 @@ addAnimation</H3>
 <PRE>
 public int <B>addAnimation</B>()</PRE>
 <DL>
+<DD>Add an animation.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>Index of new animation, or -1 if not enough space remaining.</DL>
 </DD>
 </DL>
 <HR>
@@ -378,8 +395,10 @@ removeAnimation</H3>
 <PRE>
 public void <B>removeAnimation</B>(int&nbsp;selectedAnimation)</PRE>
 <DL>
+<DD>Remove an animation.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>selectedAnimation</CODE> - the animation you want to delete</DL>
 </DD>
 </DL>
 <HR>
@@ -389,8 +408,11 @@ getAnimationName</H3>
 <PRE>
 public java.lang.String <B>getAnimationName</B>(int&nbsp;selectedAnimation)</PRE>
 <DL>
+<DD>Get the name of an animation
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>selectedAnimation</CODE> - The animation you want to get the name from
+<DT><B>Returns:</B><DD>The name</DL>
 </DD>
 </DL>
 <HR>
@@ -401,8 +423,11 @@ setAnimationName</H3>
 public void <B>setAnimationName</B>(java.lang.String&nbsp;s,
                              int&nbsp;selectedAnimation)</PRE>
 <DL>
+<DD>Set the name of an animation
+ @param s New name
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>selectedAnimation</CODE> - Index of the animation you want to change</DL>
 </DD>
 </DL>
 <HR>
@@ -413,8 +438,10 @@ moveAnimation</H3>
 public void <B>moveAnimation</B>(int&nbsp;dir,
                           int&nbsp;selectedAnimation)</PRE>
 <DL>
+<DD>Move an animation UP or DOWN.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>dir</CODE> - Direction. Use UP and DOWN defined in cubeWorker<DD><CODE>selectedAnimation</CODE> - Animation you want to move</DL>
 </DD>
 </DL>
 <HR>
@@ -425,8 +452,10 @@ getFrameName</H3>
 public java.lang.String <B>getFrameName</B>(int&nbsp;anim,
                                      int&nbsp;frame)</PRE>
 <DL>
+<DD>Get the name of a frame.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>anim</CODE> - Animation the frame is in<DD><CODE>frame</CODE> - Index of the frame</DL>
 </DD>
 </DL>
 <HR>
@@ -438,8 +467,10 @@ public void <B>setFrameName</B>(java.lang.String&nbsp;s,
                          int&nbsp;anim,
                          int&nbsp;frame)</PRE>
 <DL>
+<DD>Set the name of a frame.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>s</CODE> - New name<DD><CODE>anim</CODE> - Animation Index<DD><CODE>frame</CODE> - Frame Index</DL>
 </DD>
 </DL>
 <HR>
@@ -449,8 +480,11 @@ addFrame</H3>
 <PRE>
 public int <B>addFrame</B>(int&nbsp;anim)</PRE>
 <DL>
+<DD>Add a Frame to an animation.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>anim</CODE> - Animation Index
+<DT><B>Returns:</B><DD>Index of new Frame or -1 if not enough space</DL>
 </DD>
 </DL>
 <HR>
@@ -461,8 +495,10 @@ removeFrame</H3>
 public void <B>removeFrame</B>(int&nbsp;anim,
                         int&nbsp;frame)</PRE>
 <DL>
+<DD>Remove a frame.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>anim</CODE> - Animation Index<DD><CODE>frame</CODE> - Frame you want to remove</DL>
 </DD>
 </DL>
 <HR>
@@ -473,8 +509,12 @@ getFrame</H3>
 public short[] <B>getFrame</B>(int&nbsp;anim,
                         int&nbsp;frame)</PRE>
 <DL>
+<DD>Get the data of a frame.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>anim</CODE> - Animation Index
+ @param frame Frame Index
+<DT><B>Returns:</B><DD>64 byte array with data (8 bits per byte => 512 bits)</DL>
 </DD>
 </DL>
 <HR>
@@ -486,8 +526,10 @@ public void <B>setFrame</B>(short[]&nbsp;data,
                      int&nbsp;anim,
                      int&nbsp;frame)</PRE>
 <DL>
+<DD>Set the data of a frame
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>data</CODE> - 64 byte array with data<DD><CODE>anim</CODE> - Animation Index<DD><CODE>frame</CODE> - Frame Index<DT><B>See Also:</B><DD><A HREF="cubeWorker.html#getFrame(int, int)"><CODE>getFrame()</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -498,8 +540,11 @@ getFrameTime</H3>
 public short <B>getFrameTime</B>(int&nbsp;anim,
                           int&nbsp;frame)</PRE>
 <DL>
+<DD>Get frame duration.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>anim</CODE> - Animation Index<DD><CODE>frame</CODE> - Frame Index
+<DT><B>Returns:</B><DD>Duration. 0 means 1/24th of a second.</DL>
 </DD>
 </DL>
 <HR>
@@ -511,8 +556,10 @@ public void <B>setFrameTime</B>(short&nbsp;time,
                          int&nbsp;anim,
                          int&nbsp;frame)</PRE>
 <DL>
+<DD>Set the frames duration.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>time</CODE> - New duration<DD><CODE>anim</CODE> - Animation Index<DD><CODE>frame</CODE> - Frame Index<DT><B>See Also:</B><DD><A HREF="cubeWorker.html#getFrameTime(int, int)"><CODE>getFrameTime()</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -524,8 +571,10 @@ public void <B>moveFrame</B>(int&nbsp;dir,
                       int&nbsp;anim,
                       int&nbsp;frame)</PRE>
 <DL>
+<DD>Move a frame.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>dir</CODE> - Direction to move. Use UP and DOWN from cubeWorker<DD><CODE>anim</CODE> - Animation Index<DD><CODE>frame</CODE> - Frame Index<DT><B>See Also:</B><DD><A HREF="cubeWorker.html#moveAnimation(int, int)"><CODE>moveAnimation()</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -535,8 +584,11 @@ loadState</H3>
 <PRE>
 public int <B>loadState</B>(java.lang.String&nbsp;path)</PRE>
 <DL>
+<DD>Loads an animation file into this worker.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - Path of file to load
+<DT><B>Returns:</B><DD>0 on success, -1 on error.</DL>
 </DD>
 </DL>
 <HR>
@@ -546,8 +598,11 @@ saveState</H3>
 <PRE>
 public int <B>saveState</B>(java.lang.String&nbsp;path)</PRE>
 <DL>
+<DD>Save the state of this object into a file.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>path</CODE> - Path to save file in
+<DT><B>Returns:</B><DD>0 on success, -1 on error</DL>
 </DD>
 </DL>
 <HR>
@@ -557,8 +612,11 @@ changedStateSinceSave</H3>
 <PRE>
 public boolean <B>changedStateSinceSave</B>()</PRE>
 <DL>
+<DD>Check if something changed after loading/saving.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>TRUE if something changed, FALSE otherwise</DL>
 </DD>
 </DL>
 <HR>
@@ -568,8 +626,11 @@ uploadState</H3>
 <PRE>
 public int <B>uploadState</B>(java.lang.String&nbsp;port)</PRE>
 <DL>
+<DD>Send all animations to the cube.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>port</CODE> - Name of serial port to use
+<DT><B>Returns:</B><DD>0 on success, -1 on error</DL>
 </DD>
 </DL>
 <HR>
@@ -579,8 +640,11 @@ downloadState</H3>
 <PRE>
 public int <B>downloadState</B>(java.lang.String&nbsp;port)</PRE>
 <DL>
+<DD>Get all animations from the cube, place it in this object
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>port</CODE> - Name of serial port to use
+ @return 0 on success, -1 on error</DL>
 </DD>
 </DL>
 <HR>
@@ -590,8 +654,11 @@ getSerialPorts</H3>
 <PRE>
 public java.lang.String[] <B>getSerialPorts</B>()</PRE>
 <DL>
+<DD>Get the names of all available serial ports.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>Array of port names. First entry is always "Select serial port..."</DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->

Cube Control/doc/deprecated-list.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 Deprecated List
 </TITLE>

Cube Control/doc/frame.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:29 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:17 CET 2011 -->
 <TITLE>
 Frame
 </TITLE>

Cube Control/doc/help-doc.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 API Help
 </TITLE>

Cube Control/doc/index-all.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 Index
 </TITLE>
@@ -88,10 +88,10 @@ Method in class <A HREF="./Animation.html" title="class in &lt;Unnamed&gt;">Anim
 <DD>Add a specified frame at the specified position
 <DT><A HREF="./cubeWorker.html#addAnimation()"><B>addAnimation()</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Add an animation.
 <DT><A HREF="./cubeWorker.html#addFrame(int)"><B>addFrame(int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Add a Frame to an animation.
 <DT><A HREF="./AFrame.html" title="class in &lt;Unnamed&gt;"><B>AFrame</B></A> - Class in <A HREF="./package-summary.html">&lt;Unnamed&gt;</A><DD>The representation of a single frame.<DT><A HREF="./AFrame.html#AFrame()"><B>AFrame()</B></A> - 
 Constructor for class <A HREF="./AFrame.html" title="class in &lt;Unnamed&gt;">AFrame</A>
 <DD>&nbsp;
@@ -120,7 +120,7 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DL>
 <DT><A HREF="./layerEditFrame.html#btnClicked(int, int)"><B>btnClicked(int, int)</B></A> - 
 Method in class <A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;">layerEditFrame</A>
-<DD>&nbsp;
+<DD>Gets called when the user clicks on a Toggle Button.
 </DL>
 <HR>
 <A NAME="_C_"><!-- --></A><H2>
@@ -128,11 +128,11 @@ Method in class <A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;"
 <DL>
 <DT><A HREF="./layerEditFrame.html#cancel()"><B>cancel()</B></A> - 
 Method in class <A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;">layerEditFrame</A>
-<DD>&nbsp;
+<DD>Action of Cancel Button.
 <DT><A HREF="./cubeWorker.html#changedStateSinceSave()"><B>changedStateSinceSave()</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
-<DT><A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;"><B>cubeWorker</B></A> - Class in <A HREF="./package-summary.html">&lt;Unnamed&gt;</A><DD>&nbsp;</DL>
+<DD>Check if something changed after loading/saving.
+<DT><A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;"><B>cubeWorker</B></A> - Class in <A HREF="./package-summary.html">&lt;Unnamed&gt;</A><DD>This class holds all Data of the Application.</DL>
 <HR>
 <A NAME="_D_"><!-- --></A><H2>
 <B>D</B></H2>
@@ -142,7 +142,7 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#downloadState(java.lang.String)"><B>downloadState(String)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get all animations from the cube, place it in this object
 </DL>
 <HR>
 <A NAME="_E_"><!-- --></A><H2>
@@ -194,7 +194,7 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#framesRemaining()"><B>framesRemaining()</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the number of frames you can add until the Cubes memory is full.
 <DT><A HREF="./Frame.html#frameUp_ActionPerformed(java.awt.event.ActionEvent)"><B>frameUp_ActionPerformed(ActionEvent)</B></A> - 
 Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A>
 <DD>&nbsp;
@@ -211,22 +211,22 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#getAnimationName(int)"><B>getAnimationName(int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the name of an animation
 <DT><A HREF="./AFrame.html#getData()"><B>getData()</B></A> - 
 Method in class <A HREF="./AFrame.html" title="class in &lt;Unnamed&gt;">AFrame</A>
 <DD>Gets tha Data of this Frame
 <DT><A HREF="./layerEditFrame.html#getFinalFrame()"><B>getFinalFrame()</B></A> - 
 Method in class <A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;">layerEditFrame</A>
-<DD>&nbsp;
+<DD>Get the edited data back.
 <DT><A HREF="./cubeWorker.html#getFrame(int, int)"><B>getFrame(int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the data of a frame.
 <DT><A HREF="./cubeWorker.html#getFrameName(int, int)"><B>getFrameName(int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the name of a frame.
 <DT><A HREF="./cubeWorker.html#getFrameTime(int, int)"><B>getFrameTime(int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get frame duration.
 <DT><A HREF="./AnimationUtility.html#getLastError()"><B>getLastError()</B></A> - 
 Static method in class <A HREF="./AnimationUtility.html" title="class in &lt;Unnamed&gt;">AnimationUtility</A>
 <DD>Get the last error that occured while writing
@@ -241,7 +241,7 @@ Method in class <A HREF="./Animation.html" title="class in &lt;Unnamed&gt;">Anim
 <DD>Gets the name of this animation
 <DT><A HREF="./cubeWorker.html#getSerialPorts()"><B>getSerialPorts()</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the names of all available serial ports.
 <DT><A HREF="./AFrame.html#getTime()"><B>getTime()</B></A> - 
 Method in class <A HREF="./AFrame.html" title="class in &lt;Unnamed&gt;">AFrame</A>
 <DD>Gets the Duration of this Frame
@@ -258,9 +258,9 @@ Constructor for class <A HREF="./HelperUtility.html" title="class in &lt;Unnamed
 <A NAME="_L_"><!-- --></A><H2>
 <B>L</B></H2>
 <DL>
-<DT><A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;"><B>layerEditFrame</B></A> - Class in <A HREF="./package-summary.html">&lt;Unnamed&gt;</A><DD>&nbsp;<DT><A HREF="./layerEditFrame.html#layerEditFrame(int, int, int, cubeWorker, Frame)"><B>layerEditFrame(int, int, int, cubeWorker, Frame)</B></A> - 
+<DT><A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;"><B>layerEditFrame</B></A> - Class in <A HREF="./package-summary.html">&lt;Unnamed&gt;</A><DD>Shows a windows that allows the user to toggle the state of 64 LEDs.<DT><A HREF="./layerEditFrame.html#layerEditFrame(int, int, int, cubeWorker, Frame)"><B>layerEditFrame(int, int, int, cubeWorker, Frame)</B></A> - 
 Constructor for class <A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;">layerEditFrame</A>
-<DD>&nbsp;
+<DD>Create a new layer editor.
 <DT><A HREF="./Led3D.html" title="class in &lt;Unnamed&gt;"><B>Led3D</B></A> - Class in <A HREF="./package-summary.html">&lt;Unnamed&gt;</A><DD>This class is responsible for displaying the 3D View of our Cube.<DT><A HREF="./Led3D.html#Led3D(javax.media.j3d.Canvas3D)"><B>Led3D(Canvas3D)</B></A> - 
 Constructor for class <A HREF="./Led3D.html" title="class in &lt;Unnamed&gt;">Led3D</A>
 <DD>&nbsp;
@@ -269,7 +269,7 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#loadState(java.lang.String)"><B>loadState(String)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Loads an animation file into this worker.
 </DL>
 <HR>
 <A NAME="_M_"><!-- --></A><H2>
@@ -280,10 +280,10 @@ Static method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">F
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#moveAnimation(int, int)"><B>moveAnimation(int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Move an animation UP or DOWN.
 <DT><A HREF="./cubeWorker.html#moveFrame(int, int, int)"><B>moveFrame(int, int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Move a frame.
 </DL>
 <HR>
 <A NAME="_N_"><!-- --></A><H2>
@@ -291,10 +291,10 @@ Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cub
 <DL>
 <DT><A HREF="./cubeWorker.html#numOfAnimations()"><B>numOfAnimations()</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the number of animations in this worker.
 <DT><A HREF="./cubeWorker.html#numOfFrames(int)"><B>numOfFrames(int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Get the number of frames in an animation.
 </DL>
 <HR>
 <A NAME="_P_"><!-- --></A><H2>
@@ -316,10 +316,10 @@ Method in class <A HREF="./Animation.html" title="class in &lt;Unnamed&gt;">Anim
 <DD>Removes a frame.
 <DT><A HREF="./cubeWorker.html#removeAnimation(int)"><B>removeAnimation(int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Remove an animation.
 <DT><A HREF="./cubeWorker.html#removeFrame(int, int)"><B>removeFrame(int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Remove a frame.
 <DT><A HREF="./HelperUtility.html#runHelper(java.lang.String[])"><B>runHelper(String[])</B></A> - 
 Static method in class <A HREF="./HelperUtility.html" title="class in &lt;Unnamed&gt;">HelperUtility</A>
 <DD>Run the serialHelper with the given arguments
@@ -330,7 +330,7 @@ Static method in class <A HREF="./HelperUtility.html" title="class in &lt;Unname
 <DL>
 <DT><A HREF="./layerEditFrame.html#save()"><B>save()</B></A> - 
 Method in class <A HREF="./layerEditFrame.html" title="class in &lt;Unnamed&gt;">layerEditFrame</A>
-<DD>&nbsp;
+<DD>Gets called when clicking the save button.
 <DT><A HREF="./Frame.html#save_ActionPerformed(java.awt.event.ActionEvent)"><B>save_ActionPerformed(ActionEvent)</B></A> - 
 Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A>
 <DD>&nbsp;
@@ -339,13 +339,14 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#saveState(java.lang.String)"><B>saveState(String)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Save the state of this object into a file.
 <DT><A HREF="./Animation.html#set(AFrame, int)"><B>set(AFrame, int)</B></A> - 
 Method in class <A HREF="./Animation.html" title="class in &lt;Unnamed&gt;">Animation</A>
 <DD>Sets the selected Frame
 <DT><A HREF="./cubeWorker.html#setAnimationName(java.lang.String, int)"><B>setAnimationName(String, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Set the name of an animation
+ @param s New name
 <DT><A HREF="./AFrame.html#setData(short[])"><B>setData(short[])</B></A> - 
 Method in class <A HREF="./AFrame.html" title="class in &lt;Unnamed&gt;">AFrame</A>
 <DD>Sets the Data of this Frame
@@ -354,13 +355,13 @@ Method in class <A HREF="./Led3D.html" title="class in &lt;Unnamed&gt;">Led3D</A
 <DD>Sets the data that is displayed by the LEDs
 <DT><A HREF="./cubeWorker.html#setFrame(short[], int, int)"><B>setFrame(short[], int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Set the data of a frame
 <DT><A HREF="./cubeWorker.html#setFrameName(java.lang.String, int, int)"><B>setFrameName(String, int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Set the name of a frame.
 <DT><A HREF="./cubeWorker.html#setFrameTime(short, int, int)"><B>setFrameTime(short, int, int)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Set the frames duration.
 <DT><A HREF="./AFrame.html#setName(java.lang.String)"><B>setName(String)</B></A> - 
 Method in class <A HREF="./AFrame.html" title="class in &lt;Unnamed&gt;">AFrame</A>
 <DD>Sets the Name of this Frame
@@ -383,7 +384,7 @@ Method in class <A HREF="./Frame.html" title="class in &lt;Unnamed&gt;">Frame</A
 <DD>&nbsp;
 <DT><A HREF="./cubeWorker.html#uploadState(java.lang.String)"><B>uploadState(String)</B></A> - 
 Method in class <A HREF="./cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>
-<DD>&nbsp;
+<DD>Send all animations to the cube.
 </DL>
 <HR>
 <A NAME="_V_"><!-- --></A><H2>

Cube Control/doc/index.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc on Mon Dec 05 16:34:31 CET 2011-->
+<!-- Generated by javadoc on Mon Dec 05 17:23:19 CET 2011-->
 <TITLE>
 Generated Documentation (Untitled)
 </TITLE>

Cube Control/doc/layerEditFrame.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:30 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:18 CET 2011 -->
 <TITLE>
 layerEditFrame
 </TITLE>
@@ -104,6 +104,10 @@ java.lang.Object
 </PRE>
 
 <P>
+Shows a windows that allows the user to toggle the state of 64 LEDs.
+<P>
+
+<P>
 <DL>
 <DT><B>See Also:</B><DD><A HREF="serialized-form.html#layerEditFrame">Serialized Form</A></DL>
 <HR>
@@ -239,7 +243,7 @@ java.lang.Object
                <A HREF="Frame.html" title="class in &lt;Unnamed&gt;">Frame</A>&nbsp;LEDframe)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new layer editor.</TD>
 </TR>
 </TABLE>
 &nbsp;
@@ -258,7 +262,7 @@ java.lang.Object
            int&nbsp;j)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets called when the user clicks on a Toggle Button.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -266,7 +270,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="layerEditFrame.html#cancel()">cancel</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Action of Cancel Button.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -274,7 +278,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="layerEditFrame.html#getFinalFrame()">getFinalFrame</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the edited data back.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -282,7 +286,7 @@ java.lang.Object
 <TD><CODE><B><A HREF="layerEditFrame.html#save()">save</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets called when clicking the save button.</TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_javax.swing.JFrame"><!-- --></A>
@@ -370,6 +374,10 @@ public <B>layerEditFrame</B>(int&nbsp;animIndex,
                       <A HREF="cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A>&nbsp;work,
                       <A HREF="Frame.html" title="class in &lt;Unnamed&gt;">Frame</A>&nbsp;LEDframe)</PRE>
 <DL>
+<DD>Create a new layer editor.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>animIndex</CODE> - Current animation<DD><CODE>frameIndex</CODE> - Current frame<DD><CODE>layerIndex</CODE> - Layer to edit<DD><CODE>work</CODE> - the cubeWorker containing the data<DD><CODE>LEDframe</CODE> - Used to call valueChanged, to trigger 3D View update</DL>
 </DL>
 
 <!-- ============ METHOD DETAIL ========== -->
@@ -387,8 +395,11 @@ getFinalFrame</H3>
 <PRE>
 public short[] <B>getFinalFrame</B>()</PRE>
 <DL>
+<DD>Get the edited data back. NOTE: The worker is updated automagically!
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>Now changed 64 byte array.</DL>
 </DD>
 </DL>
 <HR>
@@ -399,8 +410,10 @@ btnClicked</H3>
 public void <B>btnClicked</B>(int&nbsp;i,
                        int&nbsp;j)</PRE>
 <DL>
+<DD>Gets called when the user clicks on a Toggle Button.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>i</CODE> - X-Coordinate of Button<DD><CODE>j</CODE> - Y-Coordinate of Button</DL>
 </DD>
 </DL>
 <HR>
@@ -410,6 +423,8 @@ cancel</H3>
 <PRE>
 public void <B>cancel</B>()</PRE>
 <DL>
+<DD>Action of Cancel Button. Removes this window...
+<P>
 <DD><DL>
 </DL>
 </DD>
@@ -421,6 +436,8 @@ save</H3>
 <PRE>
 public void <B>save</B>()</PRE>
 <DL>
+<DD>Gets called when clicking the save button. Puts data back into Worker and fires ListSelectionEvent in Worker, so that the 3D View is updated.
+<P>
 <DD><DL>
 </DL>
 </DD>

Cube Control/doc/overview-tree.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 Class Hierarchy
 </TITLE>

Cube Control/doc/package-frame.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 &lt;Unnamed&gt;
 </TITLE>

Cube Control/doc/package-summary.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 
 </TITLE>
@@ -90,7 +90,7 @@ Package &lt;Unnamed&gt;
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD WIDTH="15%"><B><A HREF="cubeWorker.html" title="class in &lt;Unnamed&gt;">cubeWorker</A></B></TD>
-<TD>&nbsp;</TD>
+<TD>This class holds all Data of the Application.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD WIDTH="15%"><B><A HREF="Frame.html" title="class in &lt;Unnamed&gt;">Frame</A></B></TD>
@@ -102,7 +102,7 @@ Package &lt;Unnamed&gt;
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD WIDTH="15%"><B><A HREF="layerEditFrame.html" title="class in &lt;Unnamed&gt;">layerEditFrame</A></B></TD>
-<TD>&nbsp;</TD>
+<TD>Shows a windows that allows the user to toggle the state of 64 LEDs.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD WIDTH="15%"><B><A HREF="Led3D.html" title="class in &lt;Unnamed&gt;">Led3D</A></B></TD>

Cube Control/doc/package-tree.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
  Class Hierarchy
 </TITLE>

Cube Control/doc/serialized-form.html

@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 16:34:31 CET 2011 -->
+<!-- Generated by javadoc (build 1.6.0_29) on Mon Dec 05 17:23:19 CET 2011 -->
 <TITLE>
 Serialized Form
 </TITLE>

Cube Control/layerEditFrame.java

@@ -27,9 +27,17 @@ import java.awt.event.*;
 import javax.swing.*;
 import javax.swing.event.*;
 
+/**
+ * Shows a windows that allows the user to toggle the state of 64 LEDs.
+ * @author Max Nuding
+ * @author Thomas Buck
+ * @author Felix Bäder
+ * @version 1.0
+ */
 
 public class layerEditFrame extends JFrame {
   // Anfang Attribute
+
   private JPanel panelLED1 = new JPanel(null, true);
   JButton[][] ledPanels = new JButton[8][8];
   ImageIcon on = new ImageIcon(getClass().getResource("LEDon.png"));
@@ -45,7 +53,14 @@ public class layerEditFrame extends JFrame {
   Frame LedFrame;
 
   // Ende Attribute
-
+  /**
+   * Create a new layer editor.
+   * @param animIndex Current animation
+   * @param frameIndex Current frame
+   * @param layerIndex Layer to edit
+   * @param work the cubeWorker containing the data
+   * @param LEDframe Used to call valueChanged, to trigger 3D View update
+   */
   public layerEditFrame(int animIndex, int frameIndex, int layerIndex, cubeWorker work, Frame LEDframe) {
     // Frame-Initialisierung
     super("Layer Edit");
@@ -147,14 +162,22 @@ public class layerEditFrame extends JFrame {
 
   }
 
+	/**
+	 * Get the edited data back. NOTE: The worker is updated automagically!
+	 * @return Now changed 64 byte array.
+	 */
    public short[] getFinalFrame(){
       if (finish == false) {
         return null;
       }
-      //return shortToByteArray(frame);
       return frame;
    }
 
+	/**
+	 * Gets called when the user clicks on a Toggle Button.
+	 * @param i X-Coordinate of Button
+	 * @param j Y-Coordinate of Button
+	 */
   public void btnClicked(int i, int j){
     changedStateSinceSave = true;
     if (ledPanels[i][j].getIcon() == on){
@@ -167,11 +190,16 @@ public class layerEditFrame extends JFrame {
 
   }
 
+	/**
+	 * Action of Cancel Button. Removes this window...
+	 */
   public void cancel(){
     dispose();
   }
 
-
+	/**
+	 * Gets called when clicking the save button. Puts data back into Worker and fires ListSelectionEvent in Worker, so that the 3D View is updated.
+	 */
   public void save(){
     int ctr = 0;
     short[] tmpFrame = frame;