Fixed interpretation of roll yaw and pitch. Increased time to sleep between to events send to the wiimote.

git-svn-id: svn://svn.code.sf.net/p/wiigee/code/trunk@96 c7eff9ee-dd40-0410-8832-91a4d88773cf

src/org/wiigee/control/Wiigee.java

@@ -27,13 +27,17 @@ package org.wiigee.control;
 import org.wiigee.util.Log;
 
 /**
+ * The mother of all classes. :-) It's just used as parent class
+ * to print version information and later on maybe dynamic configuring
+ * of the whole wiimote system... detecting plugins and devices automatically
+ * maybe. :)
  *
- * @author bepo
+ * @author Benjamin 'BePo' Poppinga
  */
 public class Wiigee {
 
-    protected static String version = "1.5.2 alpha";
-    protected static String releasedate = "20090625";
+    protected static String version = "1.5.3 alpha";
+    protected static String releasedate = "20090626";
 
     protected Wiigee() {
         Log.write("This is wiigee version "+version+" ("+releasedate+")");

src/org/wiigee/device/Device.java

@@ -31,6 +31,14 @@ import org.wiigee.logic.*;
 import org.wiigee.event.*;
 import org.wiigee.filter.*;
 
+/**
+ * Abstract representation of a device with very basic functionalities. This
+ * class should be derived from, if anybody plans to add a new class of devices,
+ * like Wiimote or AndroidDevice does. This class mainly consist of filter
+ * management, recognition control and core event control.
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class Device {
 	
 	// Fixed number values.

src/org/wiigee/event/ActionStartEvent.java

@@ -28,6 +28,13 @@ import java.util.EventObject;
 
 import org.wiigee.device.Device;
 
+/**
+ * An ActionStartEvent is an Event where other different events can
+ * be derived from, if they can be considered as an event actually starting
+ * a process like e.g. Training, Recognition, ...
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class ActionStartEvent extends EventObject {
 
 	protected boolean trainbutton;

src/org/wiigee/event/ActionStopEvent.java

@@ -27,6 +27,13 @@ package org.wiigee.event;
 import java.util.EventObject;
 import org.wiigee.device.Device;
 
+/**
+ * An ActionStopEvent is an Event where other different events can
+ * be derived from, if they can be considered as an event actually stopping
+ * a process like e.g. Training, Recognition, ...
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class ActionStopEvent extends EventObject {
 	
 	public ActionStopEvent(Device source) {

src/org/wiigee/event/ButtonPressedEvent.java

@@ -51,6 +51,8 @@ import org.wiigee.device.*;
  * Button 15 unknown
  * Button 16 unknown
  *
+ * There can be other interpretations of buttons for other devices.
+ *
  * @author Benjamin 'BePo' Poppinga
  */
 public class ButtonPressedEvent extends ActionStartEvent {

src/org/wiigee/event/MotionStartEvent.java

@@ -26,6 +26,11 @@ package org.wiigee.event;
 
 import org.wiigee.device.Device;
 
+/**
+ * This Event gets fired, if the Device starts to move.
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class MotionStartEvent extends ActionStartEvent {
 	
 	public MotionStartEvent(Device source) {

src/org/wiigee/event/MotionStopEvent.java

@@ -29,7 +29,7 @@ import org.wiigee.device.Device;
 /**
 * 
 * This event would be generated if a motion stops.
-* contains: source (wiimote).
+* contains: source.
 *
 * @author Benjamin 'BePo' Poppinga
 */
@@ -37,7 +37,6 @@ public class MotionStopEvent extends ActionStopEvent {
 
 	public MotionStopEvent(Device source) {
 		super(source);
-		// TODO Auto-generated constructor stub
 	}
 	
 }

src/org/wiigee/event/StateEvent.java

@@ -28,7 +28,6 @@ import java.util.EventObject;
 import org.wiigee.logic.ProcessingUnit;
 
 /**
- * 
  * This is a StateEvent, telling the listeners in which state of recognition
  * the tool is:
  * 	1 = training,

src/org/wiigee/event/StateListener.java

@@ -27,7 +27,6 @@ package org.wiigee.event;
 import java.util.EventListener;
 
 /**
- * 
  * This is the StateListener interface which has to be implemented
  * by any application which should receive recognized statechanges.
  * 

src/org/wiigee/filter/DirectionalEquivalenceFilter.java

@@ -24,6 +24,12 @@
 
 package org.wiigee.filter;
 
+/**
+ * This filter removes a vector, if it doesn't differ enough from
+ * the previously retrieved filter.
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class DirectionalEquivalenceFilter extends Filter {
 	
 	private double sensivity;

src/org/wiigee/filter/Filter.java

@@ -24,6 +24,11 @@
 
 package org.wiigee.filter;
 
+/**
+ * Abstract class to give a definition for a general filter.
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public abstract class Filter {
 	
 	/***

src/org/wiigee/filter/IdleStateFilter.java

@@ -24,6 +24,12 @@
 
 package org.wiigee.filter;
 
+/**
+ * Filters if the wiimote is not moved in any way. Be careful in using
+ * this filter together with a HighPassFilter.
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class IdleStateFilter extends Filter {
 	
 	private double sensivity;

src/org/wiigee/filter/MotionDetectFilter.java

@@ -26,6 +26,12 @@ package org.wiigee.filter;
 
 import org.wiigee.device.Device;
 
+/**
+ * This filter uses time to determine if the wiimote actually is in motion
+ * or not. This filter only works together with the IdleStateFilter.
+ *
+ * @author Benjamin 'BePo' Poppinga
+ */
 public class MotionDetectFilter extends Filter {
 
 	private int motionchangetime;