picrate 0.5.0-java → 0.6.0-java

data/src/main/java/processing/event/Event.java

@@ -21,27 +21,84 @@
  */
 package processing.event;
 
+/**
+ *
+ * @author Martin Prout
+ */
 public class Event {
 
+    /**
+     *
+     */
     protected Object nativeObject;
 
+    /**
+     *
+     */
     protected long millis;
+
+    /**
+     *
+     */
     protected int action;
 
     // These correspond to the java.awt.Event modifiers (not to be confused with
     // the newer getModifiersEx), though they're not guaranteed to in the future.
+
+    /**
+     *
+     */
     static public final int SHIFT = 1;
+
+    /**
+     *
+     */
     static public final int CTRL = 1 << 1;
+
+    /**
+     *
+     */
     static public final int META = 1 << 2;
+
+    /**
+     *
+     */
     static public final int ALT = 1 << 3;
+
+    /**
+     *
+     */
     protected int modifiers;
 
     // Types of events. As with all constants in Processing, brevity's preferred.
+
+    /**
+     *
+     */
     static public final int KEY = 1;
+
+    /**
+     *
+     */
     static public final int MOUSE = 2;
+
+    /**
+     *
+     */
     static public final int TOUCH = 3;
+
+    /**
+     *
+     */
     protected int flavor;
 
+    /**
+     *
+     * @param nativeObject
+     * @param millis
+     * @param action
+     * @param modifiers
+     */
     public Event(Object nativeObject, long millis, int action, int modifiers) {
         this.nativeObject = nativeObject;
         this.millis = millis;
@@ -49,6 +106,10 @@ public class Event {
         this.modifiers = modifiers;
     }
 
+    /**
+     *
+     * @return
+     */
     public int getFlavor() {
         return flavor;
     }
@@ -69,6 +130,11 @@ public class Event {
 //  public void setNative(Object nativeObject) {
 //    this.nativeObject = nativeObject;
 //  }
+
+    /**
+     *
+     * @return
+     */
     public long getMillis() {
         return millis;
     }
@@ -76,6 +142,11 @@ public class Event {
 //  public void setMillis(long millis) {
 //    this.millis = millis;
 //  }
+
+    /**
+     *
+     * @return
+     */
     public int getAction() {
         return action;
     }
@@ -83,6 +154,11 @@ public class Event {
 //  public void setAction(int action) {
 //    this.action = action;
 //  }
+
+    /**
+     *
+     * @return
+     */
     public int getModifiers() {
         return modifiers;
     }
@@ -90,18 +166,35 @@ public class Event {
 //  public void setModifiers(int modifiers) {
 //    this.modifiers = modifiers;
 //  }
+
+    /**
+     *
+     * @return
+     */
     public boolean isShiftDown() {
         return (modifiers & SHIFT) != 0;
     }
 
+    /**
+     *
+     * @return
+     */
     public boolean isControlDown() {
         return (modifiers & CTRL) != 0;
     }
 
+    /**
+     *
+     * @return
+     */
     public boolean isMetaDown() {
         return (modifiers & META) != 0;
     }
 
+    /**
+     *
+     * @return
+     */
     public boolean isAltDown() {
         return (modifiers & ALT) != 0;
     }

data/src/main/java/processing/event/KeyEvent.java

@@ -22,19 +22,42 @@
 
 package processing.event;
 
-
+/**
+ *
+ * @author Martin Prout
+ */
 public class KeyEvent extends Event {
-  static public final int PRESS = 1;
-  static public final int RELEASE = 2;
-  static public final int TYPE = 3;
+
+    /**
+     *
+     */
+    static public final int PRESS = 1;
+
+    /**
+     *
+     */
+    static public final int RELEASE = 2;
+
+    /**
+     *
+     */
+    static public final int TYPE = 3;
 
   char key;
   int keyCode;
 
   boolean isAutoRepeat;
 
-
-  public KeyEvent(Object nativeObject,
+    /**
+     *
+     * @param nativeObject
+     * @param millis
+     * @param action
+     * @param modifiers
+     * @param key
+     * @param keyCode
+     */
+    public KeyEvent(Object nativeObject,
                   long millis, int action, int modifiers,
                   char key, int keyCode) {
     super(nativeObject, millis, action, modifiers);
@@ -43,7 +66,17 @@ public class KeyEvent extends Event {
     this.keyCode = keyCode;
   }
 
-  public KeyEvent(Object nativeObject,
+    /**
+     *
+     * @param nativeObject
+     * @param millis
+     * @param action
+     * @param modifiers
+     * @param key
+     * @param keyCode
+     * @param isAutoRepeat
+     */
+    public KeyEvent(Object nativeObject,
                   long millis, int action, int modifiers,
                   char key, int keyCode, boolean isAutoRepeat) {
     super(nativeObject, millis, action, modifiers);
@@ -53,18 +86,27 @@ public class KeyEvent extends Event {
     this.isAutoRepeat = isAutoRepeat;
   }
 
-
-  public char getKey() {
+    /**
+     *
+     * @return
+     */
+    public char getKey() {
     return key;
   }
 
-
-  public int getKeyCode() {
+    /**
+     *
+     * @return
+     */
+    public int getKeyCode() {
     return keyCode;
   }
 
-
-  public boolean isAutoRepeat() {
+    /**
+     *
+     * @return
+     */
+    public boolean isAutoRepeat() {
     return isAutoRepeat;
   }
 }

data/src/main/java/processing/event/MouseEvent.java

@@ -22,21 +22,73 @@
 package processing.event;
 
 //import processing.core.PConstants;
+
+/**
+ *
+ * @author Martin Prout
+ */
 public class MouseEvent extends Event {
 
+    /**
+     *
+     */
     static public final int PRESS = 1;
+
+    /**
+     *
+     */
     static public final int RELEASE = 2;
+
+    /**
+     *
+     */
     static public final int CLICK = 3;
+
+    /**
+     *
+     */
     static public final int DRAG = 4;
+
+    /**
+     *
+     */
     static public final int MOVE = 5;
+
+    /**
+     *
+     */
     static public final int ENTER = 6;
+
+    /**
+     *
+     */
     static public final int EXIT = 7;
+
+    /**
+     *
+     */
     static public final int WHEEL = 8;
 
-    protected int x, y;
+    /**
+     *
+     */
+    protected int x,
+
+    /**
+     *
+     */
+    y;
+
+    /**
+     *
+     */
     protected int button;
 //  protected int clickCount;
 //  protected float amount;
+
+    /**
+     *
+     */
     protected int count;
 
 //  public MouseEvent(int x, int y) {
@@ -44,6 +96,18 @@ public class MouseEvent extends Event {
 //         System.currentTimeMillis(), PRESSED, 0,
 //         x, y, PConstants.LEFT, 1);
 //  }
+
+    /**
+     *
+     * @param nativeObject
+     * @param millis
+     * @param action
+     * @param modifiers
+     * @param x
+     * @param y
+     * @param button
+     * @param count
+     */
     public MouseEvent(Object nativeObject,
             long millis, int action, int modifiers,
             int x, int y, int button, int count) {  //float amount) {  //int clickCount) {
@@ -57,10 +121,18 @@ public class MouseEvent extends Event {
         this.count = count;
     }
 
+    /**
+     *
+     * @return
+     */
     public int getX() {
         return x;
     }
 
+    /**
+     *
+     * @return
+     */
     public int getY() {
         return y;
     }
@@ -141,6 +213,10 @@ public class MouseEvent extends Event {
         }
     }
 
+    /**
+     *
+     * @return
+     */
     @Override
     public String toString() {
         return String.format("<MouseEvent %s@%d,%d count:%d button:%d>",

data/src/main/java/processing/event/TouchEvent.java

@@ -48,9 +48,22 @@ Pointer and gesture events (Windows)
 http://msdn.microsoft.com/en-US/library/ie/hh673557.aspx
 
 */
+
+/**
+ *
+ * @author Martin Prout
+ */
+
 public class TouchEvent extends Event {
 
-  public TouchEvent(Object nativeObject, long millis, int action, int modifiers) {
+    /**
+     *
+     * @param nativeObject
+     * @param millis
+     * @param action
+     * @param modifiers
+     */
+    public TouchEvent(Object nativeObject, long millis, int action, int modifiers) {
     super(nativeObject, millis, action, modifiers);
     this.flavor = TOUCH;
   }

data/src/main/java/processing/javafx/PGraphicsFX2D.java

@@ -8,8 +8,16 @@ import processing.core.PMatrix3D;
 import processing.core.PShape;
 import processing.core.PSurface;
 
+/**
+ *
+ * @author Martin Prout
+ */
 public class PGraphicsFX2D extends PGraphics{
     final String message = "FX2D renderer not supported in this version of picrate";
+
+    /**
+     *
+     */
     public PGraphicsFX2D(){
     }
 

data/src/main/java/processing/opengl/FrameBuffer.java

@@ -42,33 +42,107 @@ import java.nio.IntBuffer;
  */
 
 public class FrameBuffer implements PConstants {
-  protected PGraphicsOpenGL pg;
-  protected PGL pgl;
-  protected int context;   // The context that created this framebuffer.
-
-  public int glFbo;
-  public int glDepth;
-  public int glStencil;
-  public int glDepthStencil;
-  public int glMultisample;
-  public int width;
-  public int height;
-  private GLResourceFrameBuffer glres;
-
-  protected int depthBits;
-  protected int stencilBits;
-  protected boolean packedDepthStencil;
-
-  protected boolean multisample;
-  protected int nsamples;
 
-  protected int numColorBuffers;
-  protected Texture[] colorBufferTex;
-
-  protected boolean screenFb;
-  protected boolean noDepth;
+    /**
+     *
+     */
+    protected PGraphicsOpenGL pg;
+
+    /**
+     *
+     */
+    protected PGL pgl;
+
+    /**
+     *
+     */
+    protected int context;   // The context that created this framebuffer.
+
+    /**
+     *
+     */
+    public int glFbo;
+
+    /**
+     *
+     */
+    public int glDepth;
+
+    /**
+     *
+     */
+    public int glStencil;
+
+    /**
+     *
+     */
+    public int glDepthStencil;
+
+    /**
+     *
+     */
+    public int glMultisample;
+
+    /**
+     *
+     */
+    public int width;
+
+    /**
+     *
+     */
+    public int height;
+  private GLResourceFrameBuffer glres;
 
-  protected IntBuffer pixelBuffer;
+    /**
+     *
+     */
+    protected int depthBits;
+
+    /**
+     *
+     */
+    protected int stencilBits;
+
+    /**
+     *
+     */
+    protected boolean packedDepthStencil;
+
+    /**
+     *
+     */
+    protected boolean multisample;
+
+    /**
+     *
+     */
+    protected int nsamples;
+
+    /**
+     *
+     */
+    protected int numColorBuffers;
+
+    /**
+     *
+     */
+    protected Texture[] colorBufferTex;
+
+    /**
+     *
+     */
+    protected boolean screenFb;
+
+    /**
+     *
+     */
+    protected boolean noDepth;
+
+    /**
+     *
+     */
+    protected IntBuffer pixelBuffer;
 
 
   FrameBuffer(PGraphicsOpenGL pg) {
@@ -150,8 +224,10 @@ public class FrameBuffer implements PConstants {
     this(pg, w, h, 1, 1, 0, 0, false, screen);
   }
 
-
-  public void clear() {
+    /**
+     *
+     */
+    public void clear() {
     pg.pushFramebuffer();
     pg.setFramebuffer(this);
     pgl.clearDepth(1);
@@ -163,19 +239,36 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-  public void copyColor(FrameBuffer dest) {
+    /**
+     *
+     * @param dest
+     */
+    public void copyColor(FrameBuffer dest) {
     copy(dest, PGL.COLOR_BUFFER_BIT);
   }
 
-  public void copyDepth(FrameBuffer dest) {
+    /**
+     *
+     * @param dest
+     */
+    public void copyDepth(FrameBuffer dest) {
     copy(dest, PGL.DEPTH_BUFFER_BIT);
   }
 
-  public void copyStencil(FrameBuffer dest) {
+    /**
+     *
+     * @param dest
+     */
+    public void copyStencil(FrameBuffer dest) {
     copy(dest, PGL.STENCIL_BUFFER_BIT);
   }
 
-  public void copy(FrameBuffer dest, int mask) {
+    /**
+     *
+     * @param dest
+     * @param mask
+     */
+    public void copy(FrameBuffer dest, int mask) {
     pgl.bindFramebufferImpl(PGL.READ_FRAMEBUFFER, this.glFbo);
     pgl.bindFramebufferImpl(PGL.DRAW_FRAMEBUFFER, dest.glFbo);
     pgl.blitFramebuffer(0, 0, this.width, this.height,
@@ -184,15 +277,24 @@ public class FrameBuffer implements PConstants {
     pgl.bindFramebufferImpl(PGL.DRAW_FRAMEBUFFER, pg.getCurrentFB().glFbo);
   }
 
-  public void bind() {
+    /**
+     *
+     */
+    public void bind() {
     pgl.bindFramebufferImpl(PGL.FRAMEBUFFER, glFbo);
   }
 
-  public void disableDepthTest() {
+    /**
+     *
+     */
+    public void disableDepthTest() {
     noDepth = true;
   }
 
-  public void finish() {
+    /**
+     *
+     */
+    public void finish() {
     if (noDepth) {
       // No need to clear depth buffer because depth testing was disabled.
       if (pg.getHint(ENABLE_DEPTH_TEST)) {
@@ -203,33 +305,56 @@ public class FrameBuffer implements PConstants {
     }
   }
 
-  public void readPixels() {
+    /**
+     *
+     */
+    public void readPixels() {
     if (pixelBuffer == null) createPixelBuffer();
     pixelBuffer.rewind();
     pgl.readPixels(0, 0, width, height, PGL.RGBA, PGL.UNSIGNED_BYTE,
                    pixelBuffer);
   }
 
-  public void getPixels(int[] pixels) {
+    /**
+     *
+     * @param pixels
+     */
+    public void getPixels(int[] pixels) {
     if (pixelBuffer != null) {
       pixelBuffer.get(pixels, 0, pixels.length);
       pixelBuffer.rewind();
     }
   }
 
-  public IntBuffer getPixelBuffer() {
+    /**
+     *
+     * @return
+     */
+    public IntBuffer getPixelBuffer() {
     return pixelBuffer;
   }
 
-  public boolean hasDepthBuffer() {
+    /**
+     *
+     * @return
+     */
+    public boolean hasDepthBuffer() {
     return 0 < depthBits;
   }
 
-  public boolean hasStencilBuffer() {
+    /**
+     *
+     * @return
+     */
+    public boolean hasStencilBuffer() {
     return 0 < stencilBits;
   }
 
-  public void setFBO(int id) {
+    /**
+     *
+     * @param id
+     */
+    public void setFBO(int id) {
     if (screenFb) {
       glFbo = id;
     }
@@ -239,18 +364,28 @@ public class FrameBuffer implements PConstants {
 
   // Color buffer setters.
 
-
-  public void setColorBuffer(Texture tex) {
+    /**
+     *
+     * @param tex
+     */
+    public void setColorBuffer(Texture tex) {
     setColorBuffers(new Texture[] { tex }, 1);
   }
 
-
-  public void setColorBuffers(Texture[] textures) {
+    /**
+     *
+     * @param textures
+     */
+    public void setColorBuffers(Texture[] textures) {
     setColorBuffers(textures, textures.length);
   }
 
-
-  public void setColorBuffers(Texture[] textures, int n) {
+    /**
+     *
+     * @param textures
+     * @param n
+     */
+    public void setColorBuffers(Texture[] textures, int n) {
     if (screenFb) return;
 
     if (numColorBuffers != PApplet.min(n, textures.length)) {
@@ -282,8 +417,10 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-
-  public void swapColorBuffers() {
+    /**
+     *
+     */
+    public void swapColorBuffers() {
     for (int i = 0; i < numColorBuffers - 1; i++) {
       int i1 = (i + 1);
       Texture tmp = colorBufferTex[i];
@@ -303,8 +440,11 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-
-  public int getDefaultReadBuffer() {
+    /**
+     *
+     * @return
+     */
+    public int getDefaultReadBuffer() {
     if (screenFb) {
       return pgl.getDefaultReadBuffer();
     } else {
@@ -312,8 +452,11 @@ public class FrameBuffer implements PConstants {
     }
   }
 
-
-  public int getDefaultDrawBuffer() {
+    /**
+     *
+     * @return
+     */
+    public int getDefaultDrawBuffer() {
     if (screenFb) {
       return pgl.getDefaultDrawBuffer();
     } else {
@@ -326,6 +469,10 @@ public class FrameBuffer implements PConstants {
 
   // Allocate/release framebuffer.
 
+    /**
+     *
+     */
+
 
   protected void allocate() {
     dispose(); // Just in the case this object is being re-allocated.
@@ -353,8 +500,10 @@ public class FrameBuffer implements PConstants {
     }
   }
 
-
-  protected void dispose() {
+    /**
+     *
+     */
+    protected void dispose() {
     if (screenFb) return;
     if (glres != null) {
       glres.dispose();
@@ -367,8 +516,11 @@ public class FrameBuffer implements PConstants {
     }
   }
 
-
-  protected boolean contextIsOutdated() {
+    /**
+     *
+     * @return
+     */
+    protected boolean contextIsOutdated() {
     if (screenFb) return false;
 
     boolean outdated = !pgl.contextIsCurrent(context);
@@ -381,8 +533,10 @@ public class FrameBuffer implements PConstants {
     return outdated;
   }
 
-
-  protected void initColorBufferMultisample() {
+    /**
+     *
+     */
+    protected void initColorBufferMultisample() {
     if (screenFb) return;
 
     pg.pushFramebuffer();
@@ -397,8 +551,10 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-
-  protected void initPackedDepthStencilBuffer() {
+    /**
+     *
+     */
+    protected void initPackedDepthStencilBuffer() {
     if (screenFb) return;
 
     if (width == 0 || height == 0) {
@@ -426,8 +582,10 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-
-  protected void initDepthBuffer() {
+    /**
+     *
+     */
+    protected void initDepthBuffer() {
     if (screenFb) return;
 
     if (width == 0 || height == 0) {
@@ -461,8 +619,10 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-
-  protected void initStencilBuffer() {
+    /**
+     *
+     */
+    protected void initStencilBuffer() {
     if (screenFb) return;
 
     if (width == 0 || height == 0) {
@@ -495,8 +655,10 @@ public class FrameBuffer implements PConstants {
     pg.popFramebuffer();
   }
 
-
-  protected void createPixelBuffer() {
+    /**
+     *
+     */
+    protected void createPixelBuffer() {
     pixelBuffer = IntBuffer.allocate(width * height);
     pixelBuffer.rewind();
   }