From fc6dccb6f08f78e1640163282ddd07d975b9d9da Mon Sep 17 00:00:00 2001 From: Anadroid Date: Wed, 16 Sep 2020 14:30:44 +0200 Subject: [PATCH] Added

Advanced

in the comments where it was missing --- core/src/processing/core/PApplet.java | 187 ++++++++++++----------- core/src/processing/core/PFont.java | 1 + core/src/processing/core/PVector.java | 2 +- core/src/processing/data/JSONArray.java | 1 + core/src/processing/data/JSONObject.java | 2 +- core/src/processing/data/Table.java | 1 + 6 files changed, 99 insertions(+), 95 deletions(-) diff --git a/core/src/processing/core/PApplet.java b/core/src/processing/core/PApplet.java index 98cbf7e51..e54bb3f06 100644 --- a/core/src/processing/core/PApplet.java +++ b/core/src/processing/core/PApplet.java @@ -6317,6 +6317,7 @@ public class PApplet implements PConstants { * to the function, so that the program is not waiting for additional input. * The callback is necessary because of how threading works. * + *

Advanced

*
    * void setup() {
    *   selectInput("Select a file to process:", "fileSelected");
@@ -11179,44 +11180,44 @@ public class PApplet implements PConstants {
   }
 
 
-  	/**
-	 *
-	 * Using the beginShape() and endShape() functions allow creating
-	 * more complex forms. beginShape() begins recording vertices for a shape
-	 * and endShape() stops recording. The value of the kind parameter
-	 * tells it which types of shapes to create from the provided vertices. With no
-	 * mode specified, the shape can be any irregular polygon. The parameters
-	 * available for beginShape() are POINTS, LINES, TRIANGLES, TRIANGLE_FAN,
-	 * TRIANGLE_STRIP, QUADS, and QUAD_STRIP. After calling the beginShape()
-	 * function, a series of vertex() commands must follow. To stop drawing
-	 * the shape, call endShape(). The vertex() function with two
-	 * parameters specifies a position in 2D and the vertex() function with
-	 * three parameters specifies a position in 3D. Each shape will be outlined with
-	 * the current stroke color and filled with the fill color. 
- *
- * Transformations such as translate(), rotate(), and - * scale() do not work within beginShape(). It is also not - * possible to use other shapes, such as ellipse() or rect() - * within beginShape().
- *
- * The P2D and P3D renderers allow stroke() and fill() to be - * altered on a per-vertex basis, but the default renderer does not. Settings - * such as strokeWeight(), strokeCap(), and strokeJoin() - * cannot be changed while inside a beginShape()/endShape() block - * with any renderer. - * - * @webref shape:vertex - * @webBrief Using the beginShape() and endShape() functions allow - * creating more complex forms. - * @param kind Either POINTS, LINES, TRIANGLES, TRIANGLE_FAN, TRIANGLE_STRIP, - * QUADS, or QUAD_STRIP - * @see PShape - * @see PGraphics#endShape() - * @see PGraphics#vertex(float, float, float, float, float) - * @see PGraphics#curveVertex(float, float, float) - * @see PGraphics#bezierVertex(float, float, float, float, float, float, float, - * float, float) - */ + /** + * + * Using the beginShape() and endShape() functions allow creating + * more complex forms. beginShape() begins recording vertices for a shape + * and endShape() stops recording. The value of the kind parameter + * tells it which types of shapes to create from the provided vertices. With no + * mode specified, the shape can be any irregular polygon. The parameters + * available for beginShape() are POINTS, LINES, TRIANGLES, TRIANGLE_FAN, + * TRIANGLE_STRIP, QUADS, and QUAD_STRIP. After calling the beginShape() + * function, a series of vertex() commands must follow. To stop drawing + * the shape, call endShape(). The vertex() function with two + * parameters specifies a position in 2D and the vertex() function with + * three parameters specifies a position in 3D. Each shape will be outlined with + * the current stroke color and filled with the fill color.
+ *
+ * Transformations such as translate(), rotate(), and + * scale() do not work within beginShape(). It is also not + * possible to use other shapes, such as ellipse() or rect() + * within beginShape().
+ *
+ * The P2D and P3D renderers allow stroke() and fill() to be + * altered on a per-vertex basis, but the default renderer does not. Settings + * such as strokeWeight(), strokeCap(), and strokeJoin() + * cannot be changed while inside a beginShape()/endShape() block + * with any renderer. + * + * @webref shape:vertex + * @webBrief Using the beginShape() and endShape() functions allow + * creating more complex forms. + * @param kind Either POINTS, LINES, TRIANGLES, TRIANGLE_FAN, TRIANGLE_STRIP, + * QUADS, or QUAD_STRIP + * @see PShape + * @see PGraphics#endShape() + * @see PGraphics#vertex(float, float, float, float, float) + * @see PGraphics#curveVertex(float, float, float) + * @see PGraphics#bezierVertex(float, float, float, float, float, float, float, + * float, float) + */ public void beginShape(int kind) { if (recorder != null) recorder.beginShape(kind); g.beginShape(kind); @@ -11233,24 +11234,24 @@ public class PApplet implements PConstants { } - /** - * - * Sets the current normal vector. Used for drawing three dimensional shapes and - * surfaces, normal() specifies a vector perpendicular to a shape's - * surface which, in turn, determines how lighting affects it. Processing - * attempts to automatically assign normals to shapes, but since that's - * imperfect, this is a better option when you want more control. This function - * is identical to glNormal3f() in OpenGL. - * - * @webref lights_camera:lights - * @webBrief Sets the current normal vector. - * @param nx x direction - * @param ny y direction - * @param nz z direction - * @see PGraphics#beginShape(int) - * @see PGraphics#endShape(int) - * @see PGraphics#lights() - */ + /** + * + * Sets the current normal vector. Used for drawing three dimensional shapes and + * surfaces, normal() specifies a vector perpendicular to a shape's + * surface which, in turn, determines how lighting affects it. Processing + * attempts to automatically assign normals to shapes, but since that's + * imperfect, this is a better option when you want more control. This function + * is identical to glNormal3f() in OpenGL. + * + * @webref lights_camera:lights + * @webBrief Sets the current normal vector. + * @param nx x direction + * @param ny y direction + * @param nz z direction + * @see PGraphics#beginShape(int) + * @see PGraphics#endShape(int) + * @see PGraphics#lights() + */ public void normal(float nx, float ny, float nz) { if (recorder != null) recorder.normal(nx, ny, nz); g.normal(nx, ny, nz); @@ -11293,23 +11294,23 @@ public class PApplet implements PConstants { } - /** - * - * Sets the coordinate space for texture mapping. The default mode is - * IMAGE, which refers to the actual coordinates of the image. - * NORMAL refers to a normalized space of values ranging from 0 to 1. - * This function only works with the P2D and P3D renderers.
- *
- * With IMAGE, if an image is 100 x 200 pixels, mapping the image onto - * the entire size of a quad would require the points (0,0) (100, 0) (100,200) - * (0,200). The same mapping in NORMAL is (0,0) (1,0) (1,1) (0,1). - * - * @webref image:textures - * @webBrief Sets the coordinate space for texture mapping. - * @param mode either IMAGE or NORMAL - * @see PGraphics#texture(PImage) - * @see PGraphics#textureWrap(int) - */ + /** + * + * Sets the coordinate space for texture mapping. The default mode is + * IMAGE, which refers to the actual coordinates of the image. + * NORMAL refers to a normalized space of values ranging from 0 to 1. + * This function only works with the P2D and P3D renderers.
+ *
+ * With IMAGE, if an image is 100 x 200 pixels, mapping the image onto + * the entire size of a quad would require the points (0,0) (100, 0) (100,200) + * (0,200). The same mapping in NORMAL is (0,0) (1,0) (1,1) (0,1). + * + * @webref image:textures + * @webBrief Sets the coordinate space for texture mapping. + * @param mode either IMAGE or NORMAL + * @see PGraphics#texture(PImage) + * @see PGraphics#textureWrap(int) + */ public void textureMode(int mode) { if (recorder != null) recorder.textureMode(mode); g.textureMode(mode); @@ -11335,26 +11336,26 @@ public class PApplet implements PConstants { } - /** - * - * Sets a texture to be applied to vertex points. The texture() function - * must be called between beginShape() and endShape() and before - * any calls to vertex(). This function only works with the P2D and P3D - * renderers.
- *
- * When textures are in use, the fill color is ignored. Instead, use - * tint() to specify the color of the texture as it is applied to the - * shape. - * - * @webref image:textures - * @webBrief Sets a texture to be applied to vertex points. - * @param image reference to a PImage object - * @see PGraphics#textureMode(int) - * @see PGraphics#textureWrap(int) - * @see PGraphics#beginShape(int) - * @see PGraphics#endShape(int) - * @see PGraphics#vertex(float, float, float, float, float) - */ + /** + * + * Sets a texture to be applied to vertex points. The texture() function + * must be called between beginShape() and endShape() and before + * any calls to vertex(). This function only works with the P2D and P3D + * renderers.
+ *
+ * When textures are in use, the fill color is ignored. Instead, use + * tint() to specify the color of the texture as it is applied to the + * shape. + * + * @webref image:textures + * @webBrief Sets a texture to be applied to vertex points. + * @param image reference to a PImage object + * @see PGraphics#textureMode(int) + * @see PGraphics#textureWrap(int) + * @see PGraphics#beginShape(int) + * @see PGraphics#endShape(int) + * @see PGraphics#vertex(float, float, float, float, float) + */ public void texture(PImage image) { if (recorder != null) recorder.texture(image); g.texture(image); diff --git a/core/src/processing/core/PFont.java b/core/src/processing/core/PFont.java index 563c1fe63..f18f12d25 100644 --- a/core/src/processing/core/PFont.java +++ b/core/src/processing/core/PFont.java @@ -49,6 +49,7 @@ import java.util.HashMap; * To create a new font dynamically, use the createFont() function. Do * not use the syntax new PFont(). * + *

Advanced

*

* Awful (and by that, I mean awesome) ASCII (non-)art for how this works: * diff --git a/core/src/processing/core/PVector.java b/core/src/processing/core/PVector.java index 08555966d..1f5ac1cf0 100644 --- a/core/src/processing/core/PVector.java +++ b/core/src/processing/core/PVector.java @@ -46,7 +46,7 @@ import java.io.Serializable; * need to do some "vector" math, which is made easy by the methods inside the * PVector class. * - * + *

Advanced

* A class to describe a two or three dimensional vector. *

* The result of all functions are applied to the vector itself, with the diff --git a/core/src/processing/data/JSONArray.java b/core/src/processing/data/JSONArray.java index a99618c78..32919e672 100644 --- a/core/src/processing/data/JSONArray.java +++ b/core/src/processing/data/JSONArray.java @@ -50,6 +50,7 @@ import processing.core.PApplet; * be generated from scratch, dynamically, or using data from an existing file. * JSON can also be output and saved to disk, as in the example above. * + *

Advanced

* A JSONArray is an ordered sequence of values. Its external text form is a * string wrapped in square brackets with commas separating the values. The * internal form is an object having get and opt diff --git a/core/src/processing/data/JSONObject.java b/core/src/processing/data/JSONObject.java index 7b7152a3b..f5413b3ae 100644 --- a/core/src/processing/data/JSONObject.java +++ b/core/src/processing/data/JSONObject.java @@ -62,7 +62,7 @@ import processing.core.PApplet; * existing file. JSON can also be output and saved to disk, as in the example * above. * - * + *

Advanced

* A JSONObject is an unordered collection of name/value pairs. Its external * form is a string wrapped in curly braces with colons between the names and * values, and commas between the values and names. The internal form is an diff --git a/core/src/processing/data/Table.java b/core/src/processing/data/Table.java index 9686851c2..2426e14cc 100644 --- a/core/src/processing/data/Table.java +++ b/core/src/processing/data/Table.java @@ -55,6 +55,7 @@ import processing.core.PConstants; * "http://processing.github.io/processing-javadocs/core/processing/data/Table.html">Processing * Table Javadoc. * + *

Advanced

*

* Generic class for handling tabular data, typically from a CSV, TSV, or other * sort of spreadsheet file.