geomerative 0.4.3-java → 2.1.0-java

data/src/geomerative/RStrip.java

@@ -1,7 +1,7 @@
 /**
  * Copyright 2004-2008 Ricard Marxer  <email@ricardmarxer.com>
  *
-    This file is part of Geomerative.
+ * This file is part of Geomerative.
  *
  * Geomerative is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
@@ -18,208 +18,205 @@
  */
 package geomerative;
 
-
-
 import processing.core.PConstants;
 import processing.core.PGraphics;
 
-
 /**
  * RStrip is a reduced interface for creating, holding and drawing triangle
  * strips. Triangle strips are ordered lists of points (RPoint) which define the
  * vertices of a mesh.
  *
- * @eexample RStrip
- * @usage Geometry
- * @related RPoint
- * @related RMesh
- * @extended
+ RStrip
+ * Geometry
+ * RPoint
+ * RMesh
+
  */
 public class RStrip {
 
-    /**
-     * @invisible
-     */
-    public int type = RGeomElem.TRISTRIP;
-
-    /**
-     * Array of RPoint objects holding the vertices of the strip.
-     *
-     * @eexample vertices
-     * @related RPoint
-     * @related countVertices ( )
-     * @related addVertex ( )
-     */
-    public RPoint vertices[];
-
-  // ----------------------
-    // --- Public Methods ---
-    // ----------------------
-    /**
-     * Use this method to create a new strip.
-     *
-     * @eexample RStrip ( )
-     * @related addVertex ( )
-     * @param s the object of which to make a copy
-     */
-    public RStrip(RStrip s) {
-        for (int i = 0; i < s.countVertices(); i++) {
-            this.append(new RPoint(s.vertices[i]));
-        }
-    }
-
-    public RStrip() {
-        vertices = null;
-    }
+  /**
+   *
+   */
+  public int type = RGeomElem.TRISTRIP;
 
-    /**
-     * Use this method to count the number of vertices in the strip.
-     *
-     * @eexample countVertices
-     * @return int, the number vertices in the strip
-     */
-    public int countVertices() {
-        if (this.vertices == null) {
-            return 0;
-        }
-
-        return this.vertices.length;
-    }
+  /**
+   * Array of RPoint objects holding the vertices of the strip.
+   *
+   vertices
+   * RPoint
+   * countVertices ( )
+   * addVertex ( )
+   */
+  public RPoint vertices[];
 
-    /**
-     * Use this method to draw the strip.
-     *
-     * @eexample drawStrip
-     * @param g PGraphics, the graphics object on which to draw the strip
-     */
-    public void draw(PGraphics g) {
-        int numVertices = countVertices();
-        g.beginShape(PConstants.TRIANGLE_STRIP);
-        for (int i = 0; i < numVertices; i++) {
-            g.vertex(vertices[i].x, vertices[i].y);
-        }
-        g.endShape();
+  // ----------------------
+  // --- Public Methods ---
+  // ----------------------
+  /**
+   * Use this method to create a new strip.
+   *
+   RStrip ( )
+   * addVertex ( )
+   * @param s the object of which to make a copy
+   */
+  public RStrip(RStrip s) {
+    for (int i = 0; i < s.countVertices(); i++) {
+      this.append(new RPoint(s.vertices[i]));
     }
+  }
 
-    /**
-     * Use this method to add new vertices to the strip.
-     *
-     * @param p
-     * @eexample addVertex ( )
-     */
-    public void addVertex(RPoint p) {
-        this.append(p);
-    }
+  public RStrip() {
+    vertices = null;
+  }
 
-    public void addVertex(float x, float y) {
-        this.append(new RPoint(x, y));
+  /**
+   * Use this method to count the number of vertices in the strip.
+   *
+   countVertices
+   * @return int, the number vertices in the strip
+   */
+  public int countVertices() {
+    if (this.vertices == null) {
+      return 0;
     }
 
-    /**
-     * Use this method to get the bounding box of the strip.
-     *
-     * @eexample getBounds
-     * @return RContour, the bounding box of the strip in the form of a
-     * four-point contour
-     * @related draw ( )
-     */
-    public RContour getBounds() {
-        float xmin = Float.MAX_VALUE;
-        float ymin = Float.MAX_VALUE;
-        float xmax = -Float.MAX_VALUE;
-        float ymax = -Float.MAX_VALUE;
-
-        for (int i = 0; i < this.countVertices(); i++) {
-            float x = this.vertices[i].x;
-            float y = this.vertices[i].y;
-            if (x < xmin) {
-                xmin = x;
-            }
-            if (x > xmax) {
-                xmax = x;
-            }
-            if (y < ymin) {
-                ymin = y;
-            }
-            if (y > ymax) {
-                ymax = y;
-            }
-        }
-
-        RContour c = new RContour();
-        c.addPoint(xmin, ymin);
-        c.addPoint(xmin, ymax);
-        c.addPoint(xmax, ymax);
-        c.addPoint(xmax, ymin);
-        return c;
-    }
+    return this.vertices.length;
+  }
 
-    /**
-     * Use this to get the vertices of the strip. It returns the points as an
-     * array of RPoint.
-     *
-     * @eexample RStrip_getHandles
-     * @return RPoint[], the vertices returned in an array.
+  /**
+   * Use this method to draw the strip.
    *
-     */
-    public RPoint[] getHandles() {
-        return vertices;
+   drawStrip
+   * @param g PGraphics, the graphics object on which to draw the strip
+   */
+  public void draw(PGraphics g) {
+    int numVertices = countVertices();
+    g.beginShape(PConstants.TRIANGLE_STRIP);
+    for (int i = 0; i < numVertices; i++) {
+      g.vertex(vertices[i].x, vertices[i].y);
     }
+    g.endShape();
+  }
 
-    /**
-     * Use this to get the vertices of the strip. It returns the points as an
-     * array of RPoint.
-     *
-     * @eexample RStrip_getPoints
-     * @return RPoint[], the vertices returned in an array.
+  /**
+   * Use this method to add new vertices to the strip.
    *
-     */
-    public RPoint[] getPoints() {
-        return vertices;
-    }
-
-    /**
-     * Use this method to transform the strip.
-     *
-     * @eexample transformStrip
-     * @param m RMatrix, the matrix of the affine transformation to apply to the
-     * strip
-     */
-    public void transform(RMatrix m) {
-        int numVertices = countVertices();
-        if (numVertices != 0) {
-            for (int i = 0; i < numVertices; i++) {
-                vertices[i].transform(m);
-            }
-        }
-    }
-
-    void add(RPoint p) {
-        this.append(p);
+   * @param p
+   addVertex ( )
+   */
+  public void addVertex(RPoint p) {
+    this.append(p);
+  }
+
+  public void addVertex(float x, float y) {
+    this.append(new RPoint(x, y));
+  }
+
+  /**
+   * Use this method to get the bounding box of the strip.
+   *
+   getBounds
+   * @return RContour, the bounding box of the strip in the form of a four-point
+   * contour
+   * draw ( )
+   */
+  public RContour getBounds() {
+    float xmin = Float.MAX_VALUE;
+    float ymin = Float.MAX_VALUE;
+    float xmax = -Float.MAX_VALUE;
+    float ymax = -Float.MAX_VALUE;
+
+    for (int i = 0; i < this.countVertices(); i++) {
+      float x = this.vertices[i].x;
+      float y = this.vertices[i].y;
+      if (x < xmin) {
+        xmin = x;
+      }
+      if (x > xmax) {
+        xmax = x;
+      }
+      if (y < ymin) {
+        ymin = y;
+      }
+      if (y > ymax) {
+        ymax = y;
+      }
     }
 
-    void add(float x, float y) {
-        this.append(new RPoint(x, y));
-    }
+    RContour c = new RContour();
+    c.addPoint(xmin, ymin);
+    c.addPoint(xmin, ymax);
+    c.addPoint(xmax, ymax);
+    c.addPoint(xmax, ymin);
+    return c;
+  }
+
+  /**
+   * Use this to get the vertices of the strip. It returns the points as an
+   * array of RPoint.
+   *
+   RStrip_getHandles
+   * @return RPoint[], the vertices returned in an array.
+   *
+   */
+  public RPoint[] getHandles() {
+    return vertices;
+  }
+
+  /**
+   * Use this to get the vertices of the strip. It returns the points as an
+   * array of RPoint.
+   *
+   RStrip_getPoints
+   * @return RPoint[], the vertices returned in an array.
+   *
+   */
+  public RPoint[] getPoints() {
+    return vertices;
+  }
 
-    /**
-     * Remove all of the points. Creates an empty polygon.
-     */
-    void clear() {
-        this.vertices = null;
+  /**
+   * Use this method to transform the strip.
+   *
+   transformStrip
+   * @param m RMatrix, the matrix of the affine transformation to apply to the
+   * strip
+   */
+  public void transform(RMatrix m) {
+    int numVertices = countVertices();
+    if (numVertices != 0) {
+      for (int i = 0; i < numVertices; i++) {
+        vertices[i].transform(m);
+      }
     }
-
-    final void append(RPoint nextvertex) {
-        RPoint[] newvertices;
-        if (vertices == null) {
-            newvertices = new RPoint[1];
-            newvertices[0] = nextvertex;
-        } else {
-            newvertices = new RPoint[this.vertices.length + 1];
-            System.arraycopy(this.vertices, 0, newvertices, 0, this.vertices.length);
-            newvertices[this.vertices.length] = nextvertex;
-        }
-        this.vertices = newvertices;
+  }
+
+  void add(RPoint p) {
+    this.append(p);
+  }
+
+  void add(float x, float y) {
+    this.append(new RPoint(x, y));
+  }
+
+  /**
+   * Remove all of the points. Creates an empty polygon.
+   */
+  void clear() {
+    this.vertices = null;
+  }
+
+  final void append(RPoint nextvertex) {
+    RPoint[] newvertices;
+    if (vertices == null) {
+      newvertices = new RPoint[1];
+      newvertices[0] = nextvertex;
+    } else {
+      newvertices = new RPoint[this.vertices.length + 1];
+      System.arraycopy(this.vertices, 0, newvertices, 0, this.vertices.length);
+      newvertices[this.vertices.length] = nextvertex;
     }
+    this.vertices = newvertices;
+  }
 
 }