picrate 0.5.0-java → 0.6.0-java

data/src/main/java/monkstone/MathToolModule.java

@@ -24,6 +24,7 @@ import org.jruby.runtime.builtin.IRubyObject;
 /**
  *
  *
+ * @author Martin Prout
  */
 @JRubyModule(name = "MathTool")
 public class MathToolModule {

data/src/main/java/monkstone/PicrateLibrary.java

@@ -20,6 +20,7 @@ import org.jruby.runtime.load.Library;
 /**
  *
  *
+ * @author Martin Prout
  */
 public class PicrateLibrary implements Library{
   

data/src/main/java/monkstone/fastmath/Deglut.java

@@ -31,6 +31,7 @@ import org.jruby.runtime.builtin.IRubyObject;
 /**
 *
 *
+ * @author Martin Prout
 */
 @JRubyModule(name = "DegLut")
 public class Deglut {

data/src/main/java/monkstone/noise/SimplexNoise.java

@@ -19,7 +19,7 @@ package monkstone.noise;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public class SimplexNoise {  // Simplex noise in 2D, 3D and 4D
 
@@ -92,7 +92,7 @@ public class SimplexNoise {  // Simplex noise in 2D, 3D and 4D
      *
      * @param xin
      * @param yin
-     * @return
+     * @return noise double
      */
     public static double noise(double xin, double yin) {
         double n0, n1, n2; // Noise contributions from the three corners
@@ -297,7 +297,7 @@ public class SimplexNoise {  // Simplex noise in 2D, 3D and 4D
      * @param y
      * @param z
      * @param w
-     * @return
+     * @return noise double
      */
     public static double noise(double x, double y, double z, double w) {
 

data/src/main/java/monkstone/slider/CustomHorizontalSlider.java

@@ -24,7 +24,7 @@ import processing.core.PConstants;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public class CustomHorizontalSlider extends SliderBar {
 

data/src/main/java/monkstone/slider/CustomVerticalSlider.java

@@ -25,7 +25,7 @@ import static processing.core.PConstants.*;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public class CustomVerticalSlider extends SliderBar {
 

data/src/main/java/monkstone/slider/SimpleHorizontalSlider.java

@@ -24,7 +24,7 @@ import processing.core.PConstants;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public class SimpleHorizontalSlider extends SimpleSlider {
     

data/src/main/java/monkstone/slider/SimpleSlider.java

@@ -9,7 +9,7 @@ import processing.core.PApplet;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public abstract class SimpleSlider implements Slider {//implements Slider {
 
@@ -60,7 +60,7 @@ public abstract class SimpleSlider implements Slider {//implements Slider {
     /**
      *
      */
-    
+
     @Override
     public void showLabel() {
         displayLabel = true;
@@ -69,7 +69,7 @@ public abstract class SimpleSlider implements Slider {//implements Slider {
     /**
      *
      */
-    
+
     @Override
     public void hideLabel() {
         displayLabel = false;
@@ -78,7 +78,7 @@ public abstract class SimpleSlider implements Slider {//implements Slider {
     /**
      *
      */
-    
+
     @Override
     public void showNumbers() {
         displayValue = true;
@@ -99,7 +99,7 @@ public abstract class SimpleSlider implements Slider {//implements Slider {
     /**
      *
      */
-    
+
     @Override
     public void hideBackground() {
         backgroundVisible = false;
@@ -107,9 +107,9 @@ public abstract class SimpleSlider implements Slider {//implements Slider {
 
     /**
      *
-     * @return
+     * @return value as a Float
      */
-    
+
     @Override
     public float readValue() {
         return pValue;
@@ -140,7 +140,7 @@ public abstract class SimpleSlider implements Slider {//implements Slider {
      *
      * @param s
      */
-    
+
     @Override
     public void labelSize(int s) {
         labelSize = (s < 4) ? 4 : s;

data/src/main/java/monkstone/slider/SimpleVerticalSlider.java

@@ -25,7 +25,7 @@ import static processing.core.PConstants.HALF_PI;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public class SimpleVerticalSlider extends SimpleSlider {
     

data/src/main/java/monkstone/slider/Slider.java

@@ -7,7 +7,7 @@ package monkstone.slider;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public interface Slider {
 
@@ -44,7 +44,7 @@ public interface Slider {
 
     /**
      *
-     * @return
+     * @return value
      */
     float readValue();
 
@@ -63,5 +63,5 @@ public interface Slider {
      *
      */
     void showNumbers();
-    
+
 }

data/src/main/java/monkstone/slider/SliderBar.java

@@ -24,7 +24,7 @@ import processing.event.MouseEvent;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public abstract class SliderBar implements Slider {
 

data/src/main/java/monkstone/slider/SliderGroup.java

@@ -25,7 +25,7 @@ import processing.core.PApplet;
 
 /**
  *
- * @author tux
+ * @author Martin Prout
  */
 public class SliderGroup {
 

data/src/main/java/monkstone/vecmath/AppRender.java

@@ -6,6 +6,7 @@ import processing.core.PGraphics;
 /**
  *
  *
+ * @author Martin Prout
  */
 public class AppRender implements JRender {
 

data/src/main/java/monkstone/vecmath/JRender.java

@@ -3,6 +3,7 @@ package monkstone.vecmath;
 /**
  *
  *
+ * @author Martin Prout
  */
 public interface JRender {
 

data/src/main/java/monkstone/vecmath/ShapeRender.java

@@ -5,6 +5,7 @@ import processing.core.PShape;
 /**
  *
  *
+ * @author Martin Prout
  */
 public class ShapeRender implements JRender {
 

data/src/main/java/monkstone/vecmath/vec2/Vec2.java

@@ -57,10 +57,18 @@ public class Vec2 extends RubyObject {
         vec2Cls.defineAnnotatedMethods(Vec2.class);
     }
 
+    /**
+     *
+     * @return x value :double
+     */
     public double javax() {
         return jx;
     }
 
+    /**
+     *
+     * @return y value :double
+     */
     public double javay() {
         return jy;
     }

data/src/main/java/monkstone/vecmath/vec3/Vec3.java

@@ -37,6 +37,7 @@ import monkstone.vecmath.vec2.Vec2;
 /**
  *
  *
+ * @author Martin Prout
  */
 @JRubyClass(name = "Vec3D")
 public final class Vec3 extends RubyObject {

data/src/main/java/processing/awt/PGraphicsJava2D.java

@@ -60,6 +60,10 @@ public class PGraphicsJava2D extends PGraphics {
 ////  boolean useOffscreen = true;  // ~40fps
 //  boolean useOffscreen = false;
 
+    /**
+     *
+     */
+
   public Graphics2D g2;
 //  protected BufferedImage offscreen;
 
@@ -91,16 +95,45 @@ public class PGraphicsJava2D extends PGraphics {
   Rectangle2D.Float rect = new Rectangle2D.Float();
   Arc2D.Float arc = new Arc2D.Float();
 
-  protected Color tintColorObject;
+    /**
+     *
+     */
+    protected Color tintColorObject;
+
+    /**
+     *
+     */
+    protected Color fillColorObject;
+
+    /**
+     *
+     */
+    public boolean fillGradient;
+
+    /**
+     *
+     */
+    public Paint fillGradientObject;
+
+    /**
+     *
+     */
+    protected Stroke strokeObject;
+
+    /**
+     *
+     */
+    protected Color strokeColorObject;
 
-  protected Color fillColorObject;
-  public boolean fillGradient;
-  public Paint fillGradientObject;
+    /**
+     *
+     */
+    public boolean strokeGradient;
 
-  protected Stroke strokeObject;
-  protected Color strokeColorObject;
-  public boolean strokeGradient;
-  public Paint strokeGradientObject;
+    /**
+     *
+     */
+    public Paint strokeGradientObject;
 
   Font fontObject;
 
@@ -110,6 +143,10 @@ public class PGraphicsJava2D extends PGraphics {
 
   // INTERNAL
 
+    /**
+     *
+     */
+
 
   public PGraphicsJava2D() { }
 
@@ -256,6 +293,7 @@ public class PGraphicsJava2D extends PGraphics {
   /**
    * Still need a means to get the java.awt.Image object, since getNative()
    * is going to return the {@link Graphics2D} object.
+     * @return 
    */
   @Override
   public Image getImage() {
@@ -263,7 +301,8 @@ public class PGraphicsJava2D extends PGraphics {
   }
 
 
-  /** Returns the java.awt.Graphics2D object used by this renderer. */
+  /** Returns the java.awt.Graphics2D object used by this renderer.
+     * @return  */
   @Override
   public Object getNative() {
     return g2;
@@ -293,6 +332,11 @@ public class PGraphicsJava2D extends PGraphics {
 
 //  Graphics2D g2old;
 
+    /**
+     *
+     * @return
+     */
+
   public Graphics2D checkImage() {
     if (image == null ||
       ((BufferedImage) image).getWidth() != width*pixelDensity ||
@@ -1323,6 +1367,11 @@ public class PGraphicsJava2D extends PGraphics {
 
   // JAVA2D SHAPE/PATH HANDLING
 
+    /**
+     *
+     * @param s
+     */
+
 
   protected void fillShape(Shape s) {
     if (fillGradient) {
@@ -1334,8 +1383,11 @@ public class PGraphicsJava2D extends PGraphics {
     }
   }
 
-
-  protected void strokeShape(Shape s) {
+    /**
+     *
+     * @param s
+     */
+    protected void strokeShape(Shape s) {
     if (strokeGradient) {
       g2.setPaint(strokeGradientObject);
       g2.draw(s);
@@ -1345,8 +1397,11 @@ public class PGraphicsJava2D extends PGraphics {
     }
   }
 
-
-  protected void drawShape(Shape s) {
+    /**
+     *
+     * @param s
+     */
+    protected void drawShape(Shape s) {
     if (fillGradient) {
       g2.setPaint(fillGradientObject);
       g2.fill(s);
@@ -1559,6 +1614,7 @@ public class PGraphicsJava2D extends PGraphics {
 
   /**
    * Handle renderer-specific image drawing.
+     * @param who
    */
   @Override
   protected void imageImpl(PImage who,
@@ -2430,8 +2486,10 @@ public class PGraphicsJava2D extends PGraphics {
     strokeImpl();
   }
 
-
-  protected void strokeImpl() {
+    /**
+     *
+     */
+    protected void strokeImpl() {
     int cap = BasicStroke.CAP_BUTT;
     if (strokeCap == ROUND) {
       cap = BasicStroke.CAP_ROUND;
@@ -2553,7 +2611,11 @@ public class PGraphicsJava2D extends PGraphics {
 
   int[] clearPixels;
 
-  protected void clearPixels(int color) {
+    /**
+     *
+     * @param color
+     */
+    protected void clearPixels(int color) {
     // On a hi-res display, image may be larger than width/height
     int imageWidth = image.getWidth(null);
     int imageHeight = image.getHeight(null);
@@ -2710,6 +2772,11 @@ public class PGraphicsJava2D extends PGraphics {
 
   // getImage, setCache, getCache, removeCache, isModified, setModified
 
+    /**
+     *
+     * @return
+     */
+
 
   protected WritableRaster getRaster() {
     WritableRaster raster = null;
@@ -2783,6 +2850,8 @@ public class PGraphicsJava2D extends PGraphics {
    * <P>
    * Unlike in PImage, where updatePixels() only requests that the
    * update happens, in PGraphicsJava2D, this will happen immediately.
+     * @param d
+     * @param c
    */
   @Override
   public void updatePixels(int x, int y, int c, int d) {