picrate 0.3.0-java → 0.4.0-java

data/src/main/java/processing/core/PStyle.java

@@ -23,41 +23,186 @@
 
 package processing.core;
 
-
+/**
+ *
+ * @author tux
+ */
 public class PStyle implements PConstants {
-  public int imageMode;
-  public int rectMode;
-  public int ellipseMode;
-  public int shapeMode;
-
-  public int blendMode;
-
-  public int colorMode;
-  public float colorModeX;
-  public float colorModeY;
-  public float colorModeZ;
-  public float colorModeA;
-
-  public boolean tint;
-  public int tintColor;
-  public boolean fill;
-  public int fillColor;
-  public boolean stroke;
-  public int strokeColor;
-  public float strokeWeight;
-  public int strokeCap;
-  public int strokeJoin;
+
+    /**
+     *
+     */
+    public int imageMode;
+
+    /**
+     *
+     */
+    public int rectMode;
+
+    /**
+     *
+     */
+    public int ellipseMode;
+
+    /**
+     *
+     */
+    public int shapeMode;
+
+    /**
+     *
+     */
+    public int blendMode;
+
+    /**
+     *
+     */
+    public int colorMode;
+
+    /**
+     *
+     */
+    public float colorModeX;
+
+    /**
+     *
+     */
+    public float colorModeY;
+
+    /**
+     *
+     */
+    public float colorModeZ;
+
+    /**
+     *
+     */
+    public float colorModeA;
+
+    /**
+     *
+     */
+    public boolean tint;
+
+    /**
+     *
+     */
+    public int tintColor;
+
+    /**
+     *
+     */
+    public boolean fill;
+
+    /**
+     *
+     */
+    public int fillColor;
+
+    /**
+     *
+     */
+    public boolean stroke;
+
+    /**
+     *
+     */
+    public int strokeColor;
+
+    /**
+     *
+     */
+    public float strokeWeight;
+
+    /**
+     *
+     */
+    public int strokeCap;
+
+    /**
+     *
+     */
+    public int strokeJoin;
 
   // TODO these fellas are inconsistent, and may need to go elsewhere
-  public float ambientR, ambientG, ambientB;
-  public float specularR, specularG, specularB;
-  public float emissiveR, emissiveG, emissiveB;
-  public float shininess;
-
-  public PFont textFont;
-  public int textAlign;
-  public int textAlignY;
-  public int textMode;
-  public float textSize;
-  public float textLeading;
+
+    /**
+     *
+     */
+  public float ambientR,
+
+    /**
+     *
+     */
+    ambientG,
+
+    /**
+     *
+     */
+    ambientB;
+
+    /**
+     *
+     */
+    public float specularR,
+
+    /**
+     *
+     */
+    specularG,
+
+    /**
+     *
+     */
+    specularB;
+
+    /**
+     *
+     */
+    public float emissiveR,
+
+    /**
+     *
+     */
+    emissiveG,
+
+    /**
+     *
+     */
+    emissiveB;
+
+    /**
+     *
+     */
+    public float shininess;
+
+    /**
+     *
+     */
+    public PFont textFont;
+
+    /**
+     *
+     */
+    public int textAlign;
+
+    /**
+     *
+     */
+    public int textAlignY;
+
+    /**
+     *
+     */
+    public int textMode;
+
+    /**
+     *
+     */
+    public float textSize;
+
+    /**
+     *
+     */
+    public float textLeading;
 }

data/src/main/java/processing/core/PSurface.java

@@ -22,7 +22,10 @@
 
 package processing.core;
 
-
+/**
+ *
+ * @author tux
+ */
 public interface PSurface {
   /**
    * Minimum dimensions for the window holding an applet. This varies between
@@ -32,9 +35,18 @@ public interface PSurface {
    * sizes to be negative numbers.
    */
   static public final int MIN_WINDOW_WIDTH = 128;
-  static public final int MIN_WINDOW_HEIGHT = 128;
+
+    /**
+     *
+     */
+    static public final int MIN_WINDOW_HEIGHT = 128;
 
   // renderer that doesn't draw to the screen
+
+    /**
+     *
+     * @param sketch
+     */
   public void initOffscreen(PApplet sketch);
 
   // considering removal in favor of separate Component classes for appropriate renderers
@@ -44,6 +56,11 @@ public interface PSurface {
   //public Frame initFrame(PApplet sketch, Color backgroundColor,
 //  public void initFrame(PApplet sketch, int backgroundColor,
 //                        int deviceIndex, boolean fullScreen, boolean spanDisplays);
+
+    /**
+     *
+     * @param sketch
+     */
   public void initFrame(PApplet sketch);
 
   /**
@@ -53,6 +70,7 @@ public interface PSurface {
    * and using this method means you're willing to deal with underlying
    * implementation changes and that you won't throw a fit like a toddler
    * if your code breaks sometime in the future.
+     * @return 
    */
   public Object getNative();
 
@@ -62,30 +80,53 @@ public interface PSurface {
   // Silly, but prevents a lot of rewrite and extra methods for little benefit.
   // However, maybe prevents us from having to document the 'frame' variable?
 
-  /** Set the window (and dock, or whatever necessary) title. */
+  /** Set the window (and dock, or whatever necessary) title.
+     * @param title */
   public void setTitle(String title);
 
-  /** Show or hide the window. */
+  /** Show or hide the window.
+     * @param visible */
   public void setVisible(boolean visible);
 
-  /** Set true if we want to resize things (default is not resizable) */
+  /** Set true if we want to resize things (default is not resizable)
+     * @param resizable */
   public void setResizable(boolean resizable);
 
-  /** Dumb name, but inherited from Frame and no better ideas. */
+  /** Dumb name, but inherited from Frame and no better ideas.
+     * @param always */
   public void setAlwaysOnTop(boolean always);
 
-  public void setIcon(PImage icon);
+    /**
+     *
+     * @param icon
+     */
+    public void setIcon(PImage icon);
 
   //
 
 //  public void placeWindow(int[] location);
 
+    /**
+     *
+     * @param location
+     * @param editorLocation
+     */
+
   public void placeWindow(int[] location, int[] editorLocation);
 
   //public void placeFullScreen(boolean hideStop);
+
+    /**
+     *
+     * @param stopColor
+     */
   public void placePresent(int stopColor);
 
   // Sketch is running from the PDE, set up messaging back to the PDE
+
+    /**
+     *
+     */
   public void setupExternalMessages();
 
   //
@@ -93,9 +134,20 @@ public interface PSurface {
   // sets displayWidth/Height inside PApplet
   //public void checkDisplaySize();
 
+    /**
+     *
+     * @param x
+     * @param y
+     */
+
   public void setLocation(int x, int y);
 
-  public void setSize(int width, int height);
+    /**
+     *
+     * @param width
+     * @param height
+     */
+    public void setSize(int width, int height);
 
 //  /**
 //   * Called by {@link PApplet#createGraphics} to initialize the
@@ -118,6 +170,11 @@ public interface PSurface {
 //   */
 //  public void setSmooth(int level);
 
+    /**
+     *
+     * @param fps
+     */
+
   public void setFrameRate(float fps);
 
 //  // called on the first frame so that the now-visible drawing surface can
@@ -129,13 +186,30 @@ public interface PSurface {
 
   //
 
+    /**
+     *
+     * @param kind
+     */
+
   public void setCursor(int kind);
 
-  public void setCursor(PImage image, int hotspotX, int hotspotY);
+    /**
+     *
+     * @param image
+     * @param hotspotX
+     * @param hotspotY
+     */
+    public void setCursor(PImage image, int hotspotX, int hotspotY);
 
-  public void showCursor();
+    /**
+     *
+     */
+    public void showCursor();
 
-  public void hideCursor();
+    /**
+     *
+     */
+    public void hideCursor();
 
   //
 
@@ -149,7 +223,10 @@ public interface PSurface {
    */
   public void pauseThread();
 
-  public void resumeThread();
+    /**
+     *
+     */
+    public void resumeThread();
 
   /**
    * Stop the animation thread (set it null)
@@ -157,5 +234,9 @@ public interface PSurface {
    */
   public boolean stopThread();
 
-  public boolean isStopped();
+    /**
+     *
+     * @return
+     */
+    public boolean isStopped();
 }

data/src/main/java/processing/core/PSurfaceNone.java

@@ -28,23 +28,55 @@ package processing.core;
  * class for other drawing surfaces. It includes the standard rendering loop.
  */
 public class PSurfaceNone implements PSurface {
-  protected PApplet sketch;
-  protected PGraphics graphics;
 
-  protected Thread thread;
-  protected boolean paused;
-  protected Object pauseObject = new Object();
+    /**
+     *
+     */
+    protected PApplet sketch;
 
-  protected float frameRateTarget = 60;
-  protected long frameRatePeriod = 1000000000L / 60L;
+    /**
+     *
+     */
+    protected PGraphics graphics;
 
+    /**
+     *
+     */
+    protected Thread thread;
 
-  public PSurfaceNone(PGraphics graphics) {
+    /**
+     *
+     */
+    protected boolean paused;
+
+    /**
+     *
+     */
+    protected Object pauseObject = new Object();
+
+    /**
+     *
+     */
+    protected float frameRateTarget = 60;
+
+    /**
+     *
+     */
+    protected long frameRatePeriod = 1000000000L / 60L;
+
+    /**
+     *
+     * @param graphics
+     */
+    public PSurfaceNone(PGraphics graphics) {
     this.graphics = graphics;
   }
 
-
-  @Override
+    /**
+     *
+     * @param sketch
+     */
+    @Override
   public void initOffscreen(PApplet sketch) {
     this.sketch = sketch;
 
@@ -56,6 +88,11 @@ public class PSurfaceNone implements PSurface {
 //    return null;
 //  }
 
+    /**
+     *
+     * @param sketch
+     */
+
 
   @Override
   public void initFrame(PApplet sketch) {/*, int backgroundColor,
@@ -72,42 +109,57 @@ public class PSurfaceNone implements PSurface {
   }
 
 
-  /** Set the window (and dock, or whatever necessary) title. */
+  /** Set the window (and dock, or whatever necessary) title.
+     * @param title */
   @Override
   public void setTitle(String title) {
     // You're in a utopian PSurface implementation where titles don't exist.
   }
 
-
-  @Override
+    /**
+     *
+     * @param image
+     */
+    @Override
   public void setIcon(PImage image) {
     // I ain't visible, man.
   }
 
 
-  /** Show or hide the window. */
+  /** Show or hide the window.
+     * @param visible */
   @Override
   public void setVisible(boolean visible) {
     // I'm always invisible. You can't catch me.
   }
 
 
-  /** Set true if we want to resize things (default is not resizable) */
+  /** Set true if we want to resize things (default is not resizable)
+     * @param resizable */
   @Override
   public void setResizable(boolean resizable) {
     // I don't need size to know my worth.
   }
 
-
-  @Override
+    /**
+     *
+     * @param location
+     * @param editorLocation
+     */
+    @Override
   public void placeWindow(int[] location, int[] editorLocation) { }
 
-
-  @Override
+    /**
+     *
+     * @param stopColor
+     */
+    @Override
   public void placePresent(int stopColor) { }
 
-
-  @Override
+    /**
+     *
+     */
+    @Override
   public void setupExternalMessages() { }
 
 
@@ -117,14 +169,24 @@ public class PSurfaceNone implements PSurface {
 
   //
 
+    /**
+     *
+     * @param x
+     * @param y
+     */
+
 
   @Override
   public void setLocation(int x, int y) {
     // I'm everywhere, because I'm nowhere.
   }
 
-
-  @Override
+    /**
+     *
+     * @param wide
+     * @param high
+     */
+    @Override
   public void setSize(int wide, int high) {
     if (PApplet.DEBUG) {
       //System.out.format("frame visible %b, setSize(%d, %d) %n", frame.isVisible(), wide, high);
@@ -169,17 +231,39 @@ public class PSurfaceNone implements PSurface {
 //    // TODO Auto-generated method stub
 //  }
 
+    /**
+     *
+     * @param kind
+     */
+
   public void setCursor(int kind) { }
 
-  public void setCursor(PImage image, int hotspotX, int hotspotY) { }
+    /**
+     *
+     * @param image
+     * @param hotspotX
+     * @param hotspotY
+     */
+    public void setCursor(PImage image, int hotspotX, int hotspotY) { }
 
-  public void showCursor() { }
+    /**
+     *
+     */
+    public void showCursor() { }
 
-  public void hideCursor() { }
+    /**
+     *
+     */
+    public void hideCursor() { }
 
 
   //
 
+    /**
+     *
+     * @return
+     */
+
 
   public Thread createThread() {
     return new AnimationThread();
@@ -205,8 +289,11 @@ public class PSurfaceNone implements PSurface {
     return true;
   }
 
-
-  public boolean isStopped() {
+    /**
+     *
+     * @return
+     */
+    public boolean isStopped() {
     return thread == null || !thread.isAlive();
   }
 
@@ -219,6 +306,10 @@ public class PSurfaceNone implements PSurface {
 
 
   // halts the animation thread if the pause flag is set
+
+    /**
+     *
+     */
   protected void checkPause() {
     if (paused) {
       synchronized (pauseObject) {
@@ -233,29 +324,43 @@ public class PSurfaceNone implements PSurface {
 //    PApplet.debug("done with pause");
   }
 
-
-  public void resumeThread() {
+    /**
+     *
+     */
+    public void resumeThread() {
     paused = false;
     synchronized (pauseObject) {
       pauseObject.notifyAll();  // wake up the animation thread
     }
   }
 
-
-  public void setFrameRate(float fps) {
+    /**
+     *
+     * @param fps
+     */
+    public void setFrameRate(float fps) {
     frameRateTarget = fps;
     frameRatePeriod = (long) (1000000000.0 / frameRateTarget);
     //g.setFrameRate(fps);
   }
 
+    /**
+     *
+     */
+    public class AnimationThread extends Thread {
 
-  public class AnimationThread extends Thread {
-
-    public AnimationThread() {
+      /**
+       *
+       */
+      public AnimationThread() {
       super("Animation Thread");
     }
 
     // broken out so it can be overridden by Danger et al
+
+      /**
+       *
+       */
     public void callDraw() {
       sketch.handleDraw();
     }