mirror of
https://github.com/processing/processing4.git
synced 2026-06-16 04:26:26 +02:00
Formatting brief descriptions
This commit is contained in:
@@ -1029,7 +1029,7 @@ public class PGraphicsJava2D extends PGraphics {
|
||||
*
|
||||
*
|
||||
* @webref Rendering
|
||||
* @webBrief Blends the pixels in the display window according to a defined mode.
|
||||
* @webBrief Blends the pixels in the display window according to a defined mode
|
||||
* @param mode the blending mode to use
|
||||
*/
|
||||
@Override
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -135,7 +135,7 @@ public interface PConstants {
|
||||
*
|
||||
* @webref constants
|
||||
* @webBrief PI is a mathematical constant with the value
|
||||
* 3.14159265358979323846.
|
||||
* 3.14159265358979323846
|
||||
* @see PConstants#TWO_PI
|
||||
* @see PConstants#TAU
|
||||
* @see PConstants#HALF_PI
|
||||
@@ -152,7 +152,7 @@ public interface PConstants {
|
||||
*
|
||||
* @webref constants
|
||||
* @webBrief HALF_PI is a mathematical constant with the value
|
||||
* 1.57079632679489661923.
|
||||
* 1.57079632679489661923
|
||||
* @see PConstants#PI
|
||||
* @see PConstants#TWO_PI
|
||||
* @see PConstants#TAU
|
||||
@@ -168,7 +168,7 @@ public interface PConstants {
|
||||
* <b>sin()</b> and <b>cos()</b>.
|
||||
*
|
||||
* @webref constants
|
||||
* @webBrief QUARTER_PI is a mathematical constant with the value 0.7853982.
|
||||
* @webBrief QUARTER_PI is a mathematical constant with the value 0.7853982
|
||||
* @see PConstants#PI
|
||||
* @see PConstants#TWO_PI
|
||||
* @see PConstants#TAU
|
||||
@@ -183,7 +183,7 @@ public interface PConstants {
|
||||
* <b>sin()</b> and <b>cos()</b>.
|
||||
*
|
||||
* @webref constants
|
||||
* @webBrief TWO_PI is a mathematical constant with the value 6.28318530717958647693.
|
||||
* @webBrief TWO_PI is a mathematical constant with the value 6.28318530717958647693
|
||||
* @see PConstants#PI
|
||||
* @see PConstants#TAU
|
||||
* @see PConstants#HALF_PI
|
||||
@@ -199,7 +199,7 @@ public interface PConstants {
|
||||
* <b>cos()</b>.
|
||||
*
|
||||
* @webref constants
|
||||
* @webBrief An alias for TWO_PI
|
||||
* @webBrief An alias for <b>TWO_PI</b>
|
||||
* @see PConstants#PI
|
||||
* @see PConstants#TWO_PI
|
||||
* @see PConstants#HALF_PI
|
||||
|
||||
@@ -72,7 +72,7 @@ import java.util.HashMap;
|
||||
* </PRE>
|
||||
*
|
||||
* @webref typography
|
||||
* @webBrief Grayscale bitmap font class used by Processing.
|
||||
* @webBrief Grayscale bitmap font class used by Processing
|
||||
* @see PApplet#loadFont(String)
|
||||
* @see PApplet#createFont(String, float, boolean, char[])
|
||||
* @see PGraphics#textFont(PFont)
|
||||
@@ -876,7 +876,7 @@ public class PFont implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref pfont
|
||||
* @webBrief Gets a list of the fonts installed on the system.
|
||||
* @webBrief Gets a list of the fonts installed on the system
|
||||
* @usage application
|
||||
* @brief Gets a list of the fonts installed on the system
|
||||
*/
|
||||
|
||||
@@ -146,7 +146,7 @@ import processing.opengl.PShader;
|
||||
*
|
||||
* @webref rendering
|
||||
* @webBrief Main graphics and rendering context, as well as the base API
|
||||
* implementation for processing "core".
|
||||
* implementation for processing "core"
|
||||
* @instanceName graphics any object of the type PGraphics
|
||||
* @usage Web & Application
|
||||
* @see PApplet#createGraphics(int, int, String)
|
||||
@@ -879,7 +879,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* drawing anything.
|
||||
*
|
||||
* @webref pgraphics:method
|
||||
* @webBrief Sets the default properties for a <b>PGraphics</b> object.
|
||||
* @webBrief Sets the default properties for a <b>PGraphics</b> object
|
||||
*/
|
||||
public void beginDraw() { // ignore
|
||||
}
|
||||
@@ -895,7 +895,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* you're finished drawing.
|
||||
*
|
||||
* @webref pgraphics:method
|
||||
* @webBrief Finalizes the rendering of a <b>PGraphics</b> object so that it can be shown on screen.
|
||||
* @webBrief Finalizes the rendering of a <b>PGraphics</b> object so that it can be shown on screen
|
||||
* @brief Finalizes the rendering of a PGraphics object
|
||||
*/
|
||||
public void endDraw() { // ignore
|
||||
@@ -1128,7 +1128,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* To enable, call <b>hint(ENABLE_ASYNC_SAVEFRAME)</b>.
|
||||
*
|
||||
* @webref rendering
|
||||
* @webBrief Set various hints and hacks for the renderer.
|
||||
* @webBrief Set various hints and hacks for the renderer
|
||||
* @param which name of the hint to be enabled or disabled
|
||||
* @see PGraphics
|
||||
* @see PApplet#createGraphics(int, int, String, String)
|
||||
@@ -1194,7 +1194,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief Using the <b>beginShape()</b> and <b>endShape()</b> functions allow
|
||||
* creating more complex forms.
|
||||
* creating more complex forms
|
||||
* @param kind Either POINTS, LINES, TRIANGLES, TRIANGLE_FAN, TRIANGLE_STRIP,
|
||||
* QUADS, or QUAD_STRIP
|
||||
* @see PShape
|
||||
@@ -1228,7 +1228,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* is identical to <b>glNormal3f()</b> in OpenGL.
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Sets the current normal vector.
|
||||
* @webBrief Sets the current normal vector
|
||||
* @param nx x direction
|
||||
* @param ny y direction
|
||||
* @param nz z direction
|
||||
@@ -1297,7 +1297,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* (0,200). The same mapping in <b>NORMAL</b> is (0,0) (1,0) (1,1) (0,1).
|
||||
*
|
||||
* @webref image:textures
|
||||
* @webBrief Sets the coordinate space for texture mapping.
|
||||
* @webBrief Sets the coordinate space for texture mapping
|
||||
* @param mode either IMAGE or NORMAL
|
||||
* @see PGraphics#texture(PImage)
|
||||
* @see PGraphics#textureWrap(int)
|
||||
@@ -1317,7 +1317,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref image:textures
|
||||
* @webBrief Defines if textures repeat or draw once within a texture map.
|
||||
* @webBrief Defines if textures repeat or draw once within a texture map
|
||||
* @param wrap Either CLAMP (default) or REPEAT
|
||||
* @see PGraphics#texture(PImage)
|
||||
* @see PGraphics#textureMode(int)
|
||||
@@ -1339,7 +1339,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* shape.
|
||||
*
|
||||
* @webref image:textures
|
||||
* @webBrief Sets a texture to be applied to vertex points.
|
||||
* @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)
|
||||
@@ -1593,7 +1593,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* changed with <b>textureMode()</b>.
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief All shapes are constructed by connecting a series of vertices.
|
||||
* @webBrief All shapes are constructed by connecting a series of vertices
|
||||
* @param x x-coordinate of the vertex
|
||||
* @param y y-coordinate of the vertex
|
||||
* @param z z-coordinate of the vertex
|
||||
@@ -1679,7 +1679,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* or <b>rect()</b> within.
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief Begins recording vertices for the shape.
|
||||
* @webBrief Begins recording vertices for the shape
|
||||
*/
|
||||
public void beginContour() {
|
||||
showMissingWarning("beginContour");
|
||||
@@ -1702,7 +1702,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* or <b>rect()</b> within.
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief Stops recording vertices for the shape.
|
||||
* @webBrief Stops recording vertices for the shape
|
||||
*/
|
||||
public void endContour() {
|
||||
showMissingWarning("endContour");
|
||||
@@ -1724,7 +1724,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* beginning and the end).
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief the companion to <b>beginShape()</b> and may only be called after <b>beginShape()</b>.
|
||||
* @webBrief the companion to <b>beginShape()</b> and may only be called after <b>beginShape()</b>
|
||||
* @param mode use CLOSE to close the shape
|
||||
* @see PShape
|
||||
* @see PGraphics#beginShape(int)
|
||||
@@ -1758,7 +1758,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* the value returned is null.<br />
|
||||
*
|
||||
* @webref shape
|
||||
* @webBrief Loads geometry into a variable of type <b>PShape</b>.
|
||||
* @webBrief Loads geometry into a variable of type <b>PShape</b>
|
||||
* @param filename name of file to load, can be .svg or .obj
|
||||
* @see PShape
|
||||
* @see PApplet#createShape()
|
||||
@@ -1812,7 +1812,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* PShape class are in the <a href="http://processing.github.io/processing-javadocs/core/">Processing Javadoc</a>.
|
||||
*
|
||||
* @webref shape
|
||||
* @webBrief The <b>createShape()</b> function is used to define a new shape.
|
||||
* @webBrief The <b>createShape()</b> function is used to define a new shape
|
||||
* @see PShape
|
||||
* @see PShape#endShape()
|
||||
* @see PApplet#loadShape(String)
|
||||
@@ -1933,7 +1933,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
// SHADERS
|
||||
|
||||
/**
|
||||
* Loads a shader into the PShader object. The shader file must be
|
||||
* Loads a shader into the <b>PShader</b> object. The shader file must be
|
||||
* loaded in the sketch's "data" folder/directory to load correctly.
|
||||
* Shaders are compatible with the P2D and P3D renderers, but not
|
||||
* with the default renderer.<br />
|
||||
@@ -1951,7 +1951,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref rendering:shaders
|
||||
* @webBrief Loads a shader into the PShader object.
|
||||
* @webBrief Loads a shader into the <b>PShader</b> object
|
||||
* @param fragFilename name of fragment shader file
|
||||
*/
|
||||
public PShader loadShader(String fragFilename) {
|
||||
@@ -1976,7 +1976,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref rendering:shaders
|
||||
* @webBrief Applies the shader specified by the parameters.
|
||||
* @webBrief Applies the shader specified by the parameters
|
||||
* @param shader name of shader file
|
||||
*/
|
||||
public void shader(PShader shader) {
|
||||
@@ -1999,7 +1999,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref rendering:shaders
|
||||
* @webBrief Restores the default shaders.
|
||||
* @webBrief Restores the default shaders
|
||||
*/
|
||||
public void resetShader() {
|
||||
showMissingWarning("resetShader");
|
||||
@@ -2036,7 +2036,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref rendering
|
||||
* @webBrief Limits the rendering to the boundaries of a rectangle defined
|
||||
* by the parameters.
|
||||
* by the parameters
|
||||
* @param a x-coordinate of the rectangle, by default
|
||||
* @param b y-coordinate of the rectangle, by default
|
||||
* @param c width of the rectangle, by default
|
||||
@@ -2086,7 +2086,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref rendering
|
||||
* @webBrief Disables the clipping previously started by the <b>clip()</b> function.
|
||||
* @webBrief Disables the clipping previously started by the <b>clip()</b> function
|
||||
*/
|
||||
public void noClip() {
|
||||
showMissingWarning("noClip");
|
||||
@@ -2135,7 +2135,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref rendering
|
||||
* @webBrief Blends the pixels in the display window according to a defined mode.
|
||||
* @webBrief Blends the pixels in the display window according to a defined mode
|
||||
* @param mode the blending mode to use
|
||||
*/
|
||||
public void blendMode(int mode) {
|
||||
@@ -2215,7 +2215,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* for more information).
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief Specifies vertex coordinates for Bezier curves.
|
||||
* @webBrief Specifies vertex coordinates for Bezier curves
|
||||
* @param x2 the x-coordinate of the 1st control point
|
||||
* @param y2 the y-coordinate of the 1st control point
|
||||
* @param z2 the z-coordinate of the 1st control point
|
||||
@@ -2276,7 +2276,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* reference for more information).
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief Specifies vertex coordinates for quadratic Bezier curves.
|
||||
* @webBrief Specifies vertex coordinates for quadratic Bezier curves
|
||||
* @param cx the x-coordinate of the control point
|
||||
* @param cy the y-coordinate of the control point
|
||||
* @param x3 the x-coordinate of the anchor point
|
||||
@@ -2360,7 +2360,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:vertex
|
||||
* @webBrief Specifies vertex coordinates for curves.
|
||||
* @webBrief Specifies vertex coordinates for curves
|
||||
* @param x the x-coordinate of the vertex
|
||||
* @param y the y-coordinate of the vertex
|
||||
* @see PGraphics#curve(float, float, float, float, float, float, float, float, float, float, float, float)
|
||||
@@ -2521,7 +2521,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws a point, a coordinate in space at the dimension of one pixel.
|
||||
* @webBrief Draws a point, a coordinate in space at the dimension of one pixel
|
||||
* @param x x-coordinate of the point
|
||||
* @param y y-coordinate of the point
|
||||
* @see PGraphics#stroke(int)
|
||||
@@ -2554,7 +2554,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* parameter in combination with <b>size()</b> as shown in the above example.
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws a line (a direct path between two points) to the screen.
|
||||
* @webBrief Draws a line (a direct path between two points) to the screen
|
||||
* @param x1 x-coordinate of the first point
|
||||
* @param y1 y-coordinate of the first point
|
||||
* @param x2 x-coordinate of the second point
|
||||
@@ -2590,7 +2590,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* second point, and the last two arguments specify the third point.
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief A triangle is a plane created by connecting three points.
|
||||
* @webBrief A triangle is a plane created by connecting three points
|
||||
* @param x1 x-coordinate of the first point
|
||||
* @param y1 y-coordinate of the first point
|
||||
* @param x2 x-coordinate of the second point
|
||||
@@ -2618,7 +2618,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* counter-clockwise around the defined shape.
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief A quad is a quadrilateral, a four sided polygon.
|
||||
* @webBrief A quad is a quadrilateral, a four sided polygon
|
||||
* @param x1 x-coordinate of the first corner
|
||||
* @param y1 y-coordinate of the first corner
|
||||
* @param x2 x-coordinate of the second corner
|
||||
@@ -2669,7 +2669,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* case-sensitive language.
|
||||
*
|
||||
* @webref shape:attributes
|
||||
* @webBrief Modifies the location from which rectangles draw.
|
||||
* @webBrief Modifies the location from which rectangles draw
|
||||
* @param mode either CORNER, CORNERS, CENTER, or RADIUS
|
||||
* @see PGraphics#rect(float, float, float, float)
|
||||
*/
|
||||
@@ -2696,7 +2696,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws a rectangle to the screen.
|
||||
* @webBrief Draws a rectangle to the screen
|
||||
* @param a x-coordinate of the rectangle by default
|
||||
* @param b y-coordinate of the rectangle by default
|
||||
* @param c width of the rectangle by default
|
||||
@@ -2861,7 +2861,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws a square to the screen.
|
||||
* @webBrief Draws a square to the screen
|
||||
* @param x x-coordinate of the rectangle by default
|
||||
* @param y y-coordinate of the rectangle by default
|
||||
* @param extent width and height of the rectangle by default
|
||||
@@ -2906,7 +2906,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref shape:attributes
|
||||
* @webBrief The origin of the ellipse is modified by the <b>ellipseMode()</b>
|
||||
* function.
|
||||
* function
|
||||
* @param mode either CENTER, RADIUS, CORNER, or CORNERS
|
||||
* @see PApplet#ellipse(float, float, float, float)
|
||||
* @see PApplet#arc(float, float, float, float, float, float)
|
||||
@@ -2924,7 +2924,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* be changed with the <b>ellipseMode()</b> function.
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws an ellipse (oval) in the display window.
|
||||
* @webBrief Draws an ellipse (oval) in the display window
|
||||
* @param a x-coordinate of the ellipse
|
||||
* @param b y-coordinate of the ellipse
|
||||
* @param c width of the ellipse by default
|
||||
@@ -2991,7 +2991,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* arc yourself with <b>beginShape()</b>/<b>endShape()</b> or a <b>PShape</b>.
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws an arc in the display window.
|
||||
* @webBrief Draws an arc in the display window
|
||||
* @param a x-coordinate of the arc's ellipse
|
||||
* @param b y-coordinate of the arc's ellipse
|
||||
* @param c width of the arc's ellipse by default
|
||||
@@ -3077,7 +3077,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* function.
|
||||
*
|
||||
* @webref shape:2d_primitives
|
||||
* @webBrief Draws a circle to the screen.
|
||||
* @webBrief Draws a circle to the screen
|
||||
* @param x x-coordinate of the ellipse
|
||||
* @param y y-coordinate of the ellipse
|
||||
* @param extent width and height of the ellipse by default
|
||||
@@ -3095,12 +3095,12 @@ public class PGraphics extends PImage implements PConstants {
|
||||
|
||||
/**
|
||||
*
|
||||
* A box is an extruded rectangle. A box with equal dimension on all sides
|
||||
* A box is an extruded <b>rectangle</b>. A box with equal dimension on all sides
|
||||
* is a cube.
|
||||
*
|
||||
*
|
||||
* @webref shape:3d_primitives
|
||||
* @webBrief A box is an extruded rectangle.
|
||||
* @webBrief A box is an extruded <b>rectangle</b>
|
||||
* @param size dimension of the box in all dimensions (creates a cube)
|
||||
* @see PGraphics#sphere(float)
|
||||
*/
|
||||
@@ -3198,7 +3198,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* @param res number of segments (minimum 3) used per full circle revolution
|
||||
* @webref shape:3d_primitives
|
||||
* @webBrief Controls the detail used to render a sphere by adjusting the number of
|
||||
* vertices of the sphere mesh.
|
||||
* vertices of the sphere mesh
|
||||
* @see PGraphics#sphere(float)
|
||||
*/
|
||||
public void sphereDetail(int res) {
|
||||
@@ -3279,7 +3279,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* </PRE>
|
||||
*
|
||||
* @webref shape:3d_primitives
|
||||
* @webBrief A sphere is a hollow ball made from tessellated triangles.
|
||||
* @webBrief A sphere is a hollow ball made from tessellated triangles
|
||||
* @param r the radius of the sphere
|
||||
* @see PGraphics#sphereDetail(int)
|
||||
*/
|
||||
@@ -3385,7 +3385,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* endShape();</PRE>
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Evaluates the Bezier at point t for points a, b, c, d.
|
||||
* @webBrief Evaluates the Bezier at point t for points a, b, c, d
|
||||
* @param a coordinate of first point on the curve
|
||||
* @param b coordinate of first control point
|
||||
* @param c coordinate of second control point
|
||||
@@ -3410,7 +3410,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* Code submitted by Dave Bollinger (davbol) for release 0136.
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Calculates the tangent of a point on a Bezier curve.
|
||||
* @webBrief Calculates the tangent of a point on a Bezier curve
|
||||
* @param a coordinate of first point on the curve
|
||||
* @param b coordinate of first control point
|
||||
* @param c coordinate of second control point
|
||||
@@ -3449,7 +3449,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Sets the resolution at which Beziers display.
|
||||
* @webBrief Sets the resolution at which Beziers display
|
||||
* @param detail resolution of the curves
|
||||
* @see PGraphics#curve(float, float, float, float, float, float, float, float,
|
||||
* float, float, float, float)
|
||||
@@ -3520,7 +3520,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* <PRE>bezier(x1, y1, cx, cy, cx, cy, x2, y2);</PRE>
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Draws a Bezier curve on the screen.
|
||||
* @webBrief Draws a Bezier curve on the screen
|
||||
* @param x1 coordinates for the first anchor point
|
||||
* @param y1 coordinates for the first anchor point
|
||||
* @param z1 coordinates for the first anchor point
|
||||
@@ -3567,7 +3567,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Evaluates the curve at point t for points a, b, c, d.
|
||||
* @webBrief Evaluates the curve at point t for points a, b, c, d
|
||||
* @param a coordinate of first control point
|
||||
* @param b coordinate of first point on the curve
|
||||
* @param c coordinate of second point on the curve
|
||||
@@ -3604,7 +3604,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* Code thanks to Dave Bollinger (Bug #715)
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Calculates the tangent of a point on a curve.
|
||||
* @webBrief Calculates the tangent of a point on a curve
|
||||
* @param a coordinate of first point on the curve
|
||||
* @param b coordinate of first control point
|
||||
* @param c coordinate of second control point
|
||||
@@ -3638,7 +3638,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Sets the resolution at which curves display.
|
||||
* @webBrief Sets the resolution at which curves display
|
||||
* @param detail resolution of the curves
|
||||
* @see PGraphics#curve(float, float, float, float, float, float, float, float, float, float, float, float)
|
||||
* @see PGraphics#curveVertex(float, float)
|
||||
@@ -3663,7 +3663,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Modifies the quality of forms created with <b>curve()</b> and
|
||||
* <b>curveVertex()</b>.
|
||||
* <b>curveVertex()</b>
|
||||
* @param tightness amount of deformation from the original vertices
|
||||
* @see PGraphics#curve(float, float, float, float, float, float, float, float,
|
||||
* float, float, float, float)
|
||||
@@ -3756,7 +3756,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* </PRE>
|
||||
*
|
||||
* @webref shape:curves
|
||||
* @webBrief Draws a curved line on the screen.
|
||||
* @webBrief Draws a curved line on the screen
|
||||
* @param x1 coordinates for the beginning control point
|
||||
* @param y1 coordinates for the beginning control point
|
||||
* @param x2 coordinates for the first point
|
||||
@@ -3894,7 +3894,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref image:loading_displaying
|
||||
* @webBrief Modifies the location from which images draw.
|
||||
* @webBrief Modifies the location from which images draw
|
||||
* @param mode either CORNER, CORNERS, or CENTER
|
||||
* @see PApplet#loadImage(String, String)
|
||||
* @see PImage
|
||||
@@ -3933,7 +3933,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* renderer, smooth() will also improve image quality of resized images.
|
||||
*
|
||||
* @webref image:loading_displaying
|
||||
* @webBrief Displays images to the screen.
|
||||
* @webBrief Displays images to the screen
|
||||
* @param img the image to display
|
||||
* @param a x-coordinate of the image by default
|
||||
* @param b y-coordinate of the image by default
|
||||
@@ -4106,7 +4106,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:loading_displaying
|
||||
* @webBrief Modifies the location from which shapes draw.
|
||||
* @webBrief Modifies the location from which shapes draw
|
||||
* @param mode either CORNER, CORNERS, CENTER
|
||||
* @see PShape
|
||||
* @see PGraphics#shape(PShape)
|
||||
@@ -4150,7 +4150,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:loading_displaying
|
||||
* @webBrief Displays shapes to the screen.
|
||||
* @webBrief Displays shapes to the screen
|
||||
* @param shape the shape to display
|
||||
* @param x x-coordinate of the shape
|
||||
* @param y y-coordinate of the shape
|
||||
@@ -4326,7 +4326,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref typography:attributes
|
||||
* @webBrief Sets the current alignment for drawing text.
|
||||
* @webBrief Sets the current alignment for drawing text
|
||||
* @param alignX horizontal alignment, either LEFT, CENTER, or RIGHT
|
||||
* @param alignY vertical alignment, either TOP, BOTTOM, CENTER, or BASELINE
|
||||
* @see PApplet#loadFont(String)
|
||||
@@ -4349,7 +4349,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref typography:metrics
|
||||
* @webBrief Returns ascent of the current font at its current size.
|
||||
* @webBrief Returns ascent of the current font at its current size
|
||||
* @see PGraphics#textDescent()
|
||||
*/
|
||||
public float textAscent() {
|
||||
@@ -4366,7 +4366,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* useful for determining the height of the font below the baseline.
|
||||
*
|
||||
* @webref typography:metrics
|
||||
* @webBrief Returns descent of the current font at its current size.
|
||||
* @webBrief Returns descent of the current font at its current size
|
||||
* @see PGraphics#textAscent()
|
||||
*/
|
||||
public float textDescent() {
|
||||
@@ -4398,7 +4398,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref typography:loading_displaying
|
||||
* @webBrief Sets the current font that will be drawn with the <b>text()</b>
|
||||
* function.
|
||||
* function
|
||||
* @param which any variable of the type PFont
|
||||
* @see PApplet#createFont(String, float, boolean)
|
||||
* @see PApplet#loadFont(String)
|
||||
@@ -4488,7 +4488,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref typography:attributes
|
||||
* @webBrief Sets the spacing between lines of text in units of pixels.
|
||||
* @webBrief Sets the spacing between lines of text in units of pixels
|
||||
* @param leading the size in pixels for spacing between lines
|
||||
* @see PApplet#loadFont(String)
|
||||
* @see PFont#PFont
|
||||
@@ -4520,7 +4520,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* <b>beginRaw()</b>.
|
||||
*
|
||||
* @webref typography:attributes
|
||||
* @webBrief Sets the way text draws to the screen.
|
||||
* @webBrief Sets the way text draws to the screen
|
||||
* @param mode either MODEL or SHAPE
|
||||
* @see PApplet#loadFont(String)
|
||||
* @see PFont#PFont
|
||||
@@ -4565,7 +4565,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref typography:attributes
|
||||
* @webBrief Sets the current font size.
|
||||
* @webBrief Sets the current font size
|
||||
* @param size the size of the letters in units of pixels
|
||||
* @see PApplet#loadFont(String)
|
||||
* @see PFont#PFont
|
||||
@@ -4628,7 +4628,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref typography:attributes
|
||||
* @webBrief Calculates and returns the width of any character or text string.
|
||||
* @webBrief Calculates and returns the width of any character or text string
|
||||
* @param str the String of characters to measure
|
||||
* @see PApplet#loadFont(String)
|
||||
* @see PFont#PFont
|
||||
@@ -4715,7 +4715,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref typography:loading_displaying
|
||||
* @webBrief Draws text to the screen.
|
||||
* @webBrief Draws text to the screen
|
||||
* @param c the alphanumeric character to be displayed
|
||||
* @param x x-coordinate of text
|
||||
* @param y y-coordinate of text
|
||||
@@ -5319,7 +5319,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* @webref structure
|
||||
* @webBrief The <b>push()</b> function saves the current drawing style
|
||||
* settings and transformations, while <b>pop()</b> restores these
|
||||
* settings.
|
||||
* settings
|
||||
* @see PGraphics#pop()
|
||||
*/
|
||||
public void push() {
|
||||
@@ -5356,7 +5356,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref structure
|
||||
* @webBrief The <b>pop()</b> function restores the previous drawing style
|
||||
* settings and transformations after <b>push()</b> has changed them.
|
||||
* settings and transformations after <b>push()</b> has changed them
|
||||
* @see PGraphics#push()
|
||||
*/
|
||||
public void pop() {
|
||||
@@ -5384,7 +5384,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Pushes the current transformation matrix onto the matrix stack.
|
||||
* @webBrief Pushes the current transformation matrix onto the matrix stack
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#translate(float, float, float)
|
||||
* @see PGraphics#scale(float)
|
||||
@@ -5410,7 +5410,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Pops the current transformation matrix off the matrix stack.
|
||||
* @webBrief Pops the current transformation matrix off the matrix stack
|
||||
* @see PGraphics#pushMatrix()
|
||||
*/
|
||||
public void popMatrix() {
|
||||
@@ -5443,7 +5443,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Specifies an amount to displace objects within the display window.
|
||||
* @webBrief Specifies an amount to displace objects within the display window
|
||||
* @param x left/right translation
|
||||
* @param y up/down translation
|
||||
* @see PGraphics#popMatrix()
|
||||
@@ -5487,7 +5487,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Rotates a shape the amount specified by the <b>angle</b> parameter.
|
||||
* @webBrief Rotates a shape the amount specified by the <b>angle</b> parameter
|
||||
* @param angle angle of rotation specified in radians
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#pushMatrix()
|
||||
@@ -5520,7 +5520,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Rotates a shape around the x-axis the amount specified by the
|
||||
* <b>angle</b> parameter.
|
||||
* <b>angle</b> parameter
|
||||
* @param angle angle of rotation specified in radians
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#pushMatrix()
|
||||
@@ -5553,7 +5553,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Rotates a shape around the y-axis the amount specified by the
|
||||
* <b>angle</b> parameter.
|
||||
* <b>angle</b> parameter
|
||||
* @param angle angle of rotation specified in radians
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#pushMatrix()
|
||||
@@ -5586,7 +5586,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Rotates a shape around the z-axis the amount specified by the
|
||||
* <b>angle</b> parameter.
|
||||
* <b>angle</b> parameter
|
||||
* @param angle angle of rotation specified in radians
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#pushMatrix()
|
||||
@@ -5631,7 +5631,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Increases or decreases the size of a shape by expanding and
|
||||
* contracting vertices.
|
||||
* contracting vertices
|
||||
* @param s percentage to scale the object
|
||||
* @see PGraphics#pushMatrix()
|
||||
* @see PGraphics#popMatrix()
|
||||
@@ -5689,7 +5689,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Shears a shape around the x-axis the amount specified by the
|
||||
* <b>angle</b> parameter.
|
||||
* <b>angle</b> parameter
|
||||
* @param angle angle of shear specified in radians
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#pushMatrix()
|
||||
@@ -5723,7 +5723,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Shears a shape around the y-axis the amount specified by the
|
||||
* <b>angle</b> parameter.
|
||||
* <b>angle</b> parameter
|
||||
* @param angle angle of shear specified in radians
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#pushMatrix()
|
||||
@@ -5749,7 +5749,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Replaces the current matrix with the identity matrix.
|
||||
* @webBrief Replaces the current matrix with the identity matrix
|
||||
* @see PGraphics#pushMatrix()
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#applyMatrix(PMatrix)
|
||||
@@ -5769,7 +5769,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Multiplies the current matrix by the one specified through the
|
||||
* parameters.
|
||||
* parameters
|
||||
* @source
|
||||
* @see PGraphics#pushMatrix()
|
||||
* @see PGraphics#popMatrix()
|
||||
@@ -5900,7 +5900,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref transform
|
||||
* @webBrief Prints the current matrix to the Console (the text window at the bottom
|
||||
* of Processing).
|
||||
* of Processing)
|
||||
* @see PGraphics#pushMatrix()
|
||||
* @see PGraphics#popMatrix()
|
||||
* @see PGraphics#resetMatrix()
|
||||
@@ -5937,7 +5937,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief The <b>beginCamera()</b> and <b>endCamera()</b> functions enable
|
||||
* advanced customization of the camera space.
|
||||
* advanced customization of the camera space
|
||||
* @see PGraphics#camera()
|
||||
* @see PGraphics#endCamera()
|
||||
* @see PGraphics#applyMatrix(PMatrix)
|
||||
@@ -5958,7 +5958,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief The <b>beginCamera()</b> and <b>endCamera()</b> functions enable
|
||||
* advanced customization of the camera space.
|
||||
* advanced customization of the camera space
|
||||
* @see PGraphics#beginCamera()
|
||||
* @see PGraphics#camera(float, float, float, float, float, float, float, float, float)
|
||||
*/
|
||||
@@ -5980,7 +5980,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief Sets the position of the camera.
|
||||
* @webBrief Sets the position of the camera
|
||||
* @see PGraphics#beginCamera()
|
||||
* @see PGraphics#endCamera()
|
||||
* @see PGraphics#frustum(float, float, float, float, float, float)
|
||||
@@ -6013,7 +6013,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief Prints the current camera matrix to the Console (the text window at the
|
||||
* bottom of Processing).
|
||||
* bottom of Processing)
|
||||
* @see PGraphics#camera(float, float, float, float, float, float, float, float, float)
|
||||
*/
|
||||
public void printCamera() {
|
||||
@@ -6039,7 +6039,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief Sets an orthographic projection and defines a parallel clipping
|
||||
* volume.
|
||||
* volume
|
||||
*/
|
||||
public void ortho() {
|
||||
showMissingWarning("ortho");
|
||||
@@ -6082,7 +6082,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief Sets a perspective projection applying foreshortening, making distant
|
||||
* objects appear smaller than closer ones.
|
||||
* objects appear smaller than closer ones
|
||||
*/
|
||||
public void perspective() {
|
||||
showMissingWarning("perspective");
|
||||
@@ -6122,7 +6122,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief Sets a perspective matrix defined through the parameters.
|
||||
* @webBrief Sets a perspective matrix defined through the parameters
|
||||
* @param left left coordinate of the clipping plane
|
||||
* @param right right coordinate of the clipping plane
|
||||
* @param bottom bottom coordinate of the clipping plane
|
||||
@@ -6149,7 +6149,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:camera
|
||||
* @webBrief Prints the current projection matrix to the Console.
|
||||
* @webBrief Prints the current projection matrix to the Console
|
||||
* @see PGraphics#camera(float, float, float, float, float, float, float, float, float)
|
||||
*/
|
||||
public void printProjection() {
|
||||
@@ -6171,7 +6171,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:coordinates
|
||||
* @webBrief Takes a three-dimensional X, Y, Z position and returns the X value for
|
||||
* where it will appear on a (two-dimensional) screen.
|
||||
* where it will appear on a (two-dimensional) screen
|
||||
* @param x 3D x-coordinate to be mapped
|
||||
* @param y 3D y-coordinate to be mapped
|
||||
* @see PGraphics#screenY(float, float, float)
|
||||
@@ -6191,7 +6191,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:coordinates
|
||||
* @webBrief Takes a three-dimensional X, Y, Z position and returns the Y value for
|
||||
* where it will appear on a (two-dimensional) screen.
|
||||
* where it will appear on a (two-dimensional) screen
|
||||
* @param x 3D x-coordinate to be mapped
|
||||
* @param y 3D y-coordinate to be mapped
|
||||
* @see PGraphics#screenX(float, float, float)
|
||||
@@ -6230,7 +6230,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:coordinates
|
||||
* @webBrief Takes a three-dimensional X, Y, Z position and returns the Z value for
|
||||
* where it will appear on a (two-dimensional) screen.
|
||||
* where it will appear on a (two-dimensional) screen
|
||||
* @param x 3D x-coordinate to be mapped
|
||||
* @param y 3D y-coordinate to be mapped
|
||||
* @param z 3D z-coordinate to be mapped
|
||||
@@ -6260,7 +6260,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:coordinates
|
||||
* @webBrief Returns the three-dimensional X, Y, Z position in model space.
|
||||
* @webBrief Returns the three-dimensional X, Y, Z position in model space
|
||||
* @param x 3D x-coordinate to be mapped
|
||||
* @param y 3D y-coordinate to be mapped
|
||||
* @param z 3D z-coordinate to be mapped
|
||||
@@ -6290,7 +6290,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:coordinates
|
||||
* @webBrief Returns the three-dimensional X, Y, Z position in model space.
|
||||
* @webBrief Returns the three-dimensional X, Y, Z position in model space
|
||||
* @param x 3D x-coordinate to be mapped
|
||||
* @param y 3D y-coordinate to be mapped
|
||||
* @param z 3D z-coordinate to be mapped
|
||||
@@ -6320,7 +6320,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:coordinates
|
||||
* @webBrief Returns the three-dimensional X, Y, Z position in model space.
|
||||
* @webBrief Returns the three-dimensional X, Y, Z position in model space
|
||||
* @param x 3D x-coordinate to be mapped
|
||||
* @param y 3D y-coordinate to be mapped
|
||||
* @param z 3D z-coordinate to be mapped
|
||||
@@ -6357,7 +6357,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref structure
|
||||
* @webBrief Saves the current style settings and <b>popStyle()</b> restores the prior settings.
|
||||
* @webBrief Saves the current style settings and <b>popStyle()</b> restores the prior settings
|
||||
* @see PGraphics#popStyle()
|
||||
*/
|
||||
public void pushStyle() {
|
||||
@@ -6547,7 +6547,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref shape:attributes
|
||||
* @webBrief Sets the width of the stroke used for lines, points, and the border
|
||||
* around shapes.
|
||||
* around shapes
|
||||
* @param weight the weight (in pixels) of the stroke
|
||||
* @see PGraphics#stroke(int, float)
|
||||
* @see PGraphics#strokeJoin(int)
|
||||
@@ -6565,7 +6565,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref shape:attributes
|
||||
* @webBrief Sets the style of the joints which connect line segments.
|
||||
* @webBrief Sets the style of the joints which connect line segments
|
||||
* @param join either MITER, BEVEL, ROUND
|
||||
* @see PGraphics#stroke(int, float)
|
||||
* @see PGraphics#strokeWeight(float)
|
||||
@@ -6585,7 +6585,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* <b>strokeCap(SQUARE)</b> (no cap) causes points to become invisible.
|
||||
*
|
||||
* @webref shape:attributes
|
||||
* @webBrief Sets the style for rendering line endings.
|
||||
* @webBrief Sets the style for rendering line endings
|
||||
* @param cap either SQUARE, PROJECT, or ROUND
|
||||
* @see PGraphics#stroke(int, float)
|
||||
* @see PGraphics#strokeWeight(float)
|
||||
@@ -6610,7 +6610,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Disables drawing the stroke (outline).
|
||||
* @webBrief Disables drawing the stroke (outline)
|
||||
* @see PGraphics#stroke(int, float)
|
||||
* @see PGraphics#fill(float, float, float, float)
|
||||
* @see PGraphics#noFill()
|
||||
@@ -6644,7 +6644,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* performance). See the hint() documentation for more details.
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Sets the color used to draw lines and borders around shapes.
|
||||
* @webBrief Sets the color used to draw lines and borders around shapes
|
||||
* @param rgb color value in hexadecimal notation
|
||||
* @see PGraphics#noStroke()
|
||||
* @see PGraphics#strokeWeight(float)
|
||||
@@ -6732,7 +6732,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref image:loading_displaying
|
||||
* @webBrief Removes the current fill value for displaying images and reverts to
|
||||
* displaying images with their original hues.
|
||||
* displaying images with their original hues
|
||||
* @usage web_application
|
||||
* @see PGraphics#tint(float, float, float, float)
|
||||
* @see PGraphics#image(PImage, float, float, float, float)
|
||||
@@ -6769,7 +6769,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref image:loading_displaying
|
||||
* @webBrief Sets the fill value for displaying images.
|
||||
* @webBrief Sets the fill value for displaying images
|
||||
* @usage web_application
|
||||
* @param rgb color value in hexadecimal notation
|
||||
* @see PGraphics#noTint()
|
||||
@@ -6849,7 +6849,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Disables filling geometry.
|
||||
* @webBrief Disables filling geometry
|
||||
* @usage web_application
|
||||
* @see PGraphics#fill(float, float, float, float)
|
||||
* @see PGraphics#stroke(int, float)
|
||||
@@ -6884,7 +6884,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Sets the color used to fill shapes.
|
||||
* @webBrief Sets the color used to fill shapes
|
||||
* @usage web_application
|
||||
* @param rgb color variable or hex value
|
||||
* @see PGraphics#noFill()
|
||||
@@ -6972,7 +6972,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:material_properties
|
||||
* @webBrief Sets the ambient reflectance for shapes drawn to the screen.
|
||||
* @webBrief Sets the ambient reflectance for shapes drawn to the screen
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#emissive(float, float, float)
|
||||
@@ -7029,7 +7029,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:material_properties
|
||||
* @webBrief Sets the specular color of the materials used for shapes drawn to the
|
||||
* screen, which sets the color of highlights.
|
||||
* screen, which sets the color of highlights
|
||||
* @usage web_application
|
||||
* @param rgb color to set
|
||||
* @see PGraphics#lightSpecular(float, float, float)
|
||||
@@ -7088,7 +7088,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:material_properties
|
||||
* @webBrief Sets the amount of gloss in the surface of shapes.
|
||||
* @webBrief Sets the amount of gloss in the surface of shapes
|
||||
* @usage web_application
|
||||
* @param shine degree of shininess
|
||||
* @see PGraphics#emissive(float, float, float)
|
||||
@@ -7109,7 +7109,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:material_properties
|
||||
* @webBrief Sets the emissive color of the material used for drawing shapes drawn to
|
||||
* the screen.
|
||||
* the screen
|
||||
* @usage web_application
|
||||
* @param rgb color to set
|
||||
* @see PGraphics#ambient(float, float, float)
|
||||
@@ -7179,7 +7179,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Sets the default ambient light, directional light, falloff, and specular
|
||||
* values.
|
||||
* values
|
||||
* @usage web_application
|
||||
* @see PGraphics#ambientLight(float, float, float, float, float, float)
|
||||
* @see PGraphics#directionalLight(float, float, float, float, float, float)
|
||||
@@ -7200,7 +7200,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Disable all lighting.
|
||||
* @webBrief Disable all lighting
|
||||
* @usage web_application
|
||||
* @see PGraphics#lights()
|
||||
*/
|
||||
@@ -7221,7 +7221,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Adds an ambient light.
|
||||
* @webBrief Adds an ambient light
|
||||
* @usage web_application
|
||||
* @param v1 red or hue value (depending on current color mode)
|
||||
* @param v2 green or saturation value (depending on current color mode)
|
||||
@@ -7262,7 +7262,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Adds a directional light.
|
||||
* @webBrief Adds a directional light
|
||||
* @usage web_application
|
||||
* @param v1 red or hue value (depending on current color mode)
|
||||
* @param v2 green or saturation value (depending on current color mode)
|
||||
@@ -7291,7 +7291,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Adds a point light.
|
||||
* @webBrief Adds a point light
|
||||
* @usage web_application
|
||||
* @param v1 red or hue value (depending on current color mode)
|
||||
* @param v2 green or saturation value (depending on current color mode)
|
||||
@@ -7324,7 +7324,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* that cone.
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Adds a spot light.
|
||||
* @webBrief Adds a spot light
|
||||
* @usage web_application
|
||||
* @param v1 red or hue value (depending on current color mode)
|
||||
* @param v2 green or saturation value (depending on current color
|
||||
@@ -7371,7 +7371,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Sets the falloff rates for point lights, spot lights, and ambient
|
||||
* lights.
|
||||
* lights
|
||||
* @usage web_application
|
||||
* @param constant constant value or determining falloff
|
||||
* @param linear linear value for determining falloff
|
||||
@@ -7399,7 +7399,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref lights_camera:lights
|
||||
* @webBrief Sets the specular color for lights.
|
||||
* @webBrief Sets the specular color for lights
|
||||
* @usage web_application
|
||||
* @param v1 red or hue value (depending on current color mode)
|
||||
* @param v2 green or saturation value (depending on current color mode)
|
||||
@@ -7456,7 +7456,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* </p>
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Sets the color used for the background of the Processing window.
|
||||
* @webBrief Sets the color used for the background of the Processing window
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#stroke(float)
|
||||
@@ -7552,7 +7552,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* 100% transparent.
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Clears the pixels within a buffer.
|
||||
* @webBrief Clears the pixels within a buffer
|
||||
*/
|
||||
public void clear() {
|
||||
background(0, 0, 0, 0);
|
||||
@@ -7658,7 +7658,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref color:setting
|
||||
* @webBrief Changes the way Processing interprets color data.
|
||||
* @webBrief Changes the way Processing interprets color data
|
||||
* @usage web_application
|
||||
* @param mode Either RGB or HSB, corresponding to Red/Green/Blue and
|
||||
* Hue/Saturation/Brightness
|
||||
@@ -7995,7 +7995,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* Extracts the alpha value from a color.
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the alpha value from a color.
|
||||
* @webBrief Extracts the alpha value from a color
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#red(int)
|
||||
@@ -8034,7 +8034,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the red value from a color, scaled to match current
|
||||
* <b>colorMode()</b>.
|
||||
* <b>colorMode()</b>
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#green(int)
|
||||
@@ -8074,7 +8074,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the green value from a color, scaled to match current
|
||||
* <b>colorMode()</b>.
|
||||
* <b>colorMode()</b>
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#red(int)
|
||||
@@ -8114,7 +8114,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the blue value from a color, scaled to match current
|
||||
* <b>colorMode()</b>.
|
||||
* <b>colorMode()</b>
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#red(int)
|
||||
@@ -8137,7 +8137,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* Extracts the hue value from a color.
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the hue value from a color.
|
||||
* @webBrief Extracts the hue value from a color
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#red(int)
|
||||
@@ -8162,7 +8162,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
* Extracts the saturation value from a color.
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the saturation value from a color.
|
||||
* @webBrief Extracts the saturation value from a color
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#red(int)
|
||||
@@ -8188,7 +8188,7 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Extracts the brightness value from a color.
|
||||
* @webBrief Extracts the brightness value from a color
|
||||
* @usage web_application
|
||||
* @param rgb any value of the color datatype
|
||||
* @see PGraphics#red(int)
|
||||
@@ -8229,8 +8229,8 @@ public class PGraphics extends PImage implements PConstants {
|
||||
*
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Calculates a color or colors between two color at a specific
|
||||
* increment.
|
||||
* @webBrief Calculates a <b>color</b> or <b>colors</b> between two <b>colors</b> at a specific
|
||||
* increment
|
||||
* @usage web_application
|
||||
* @param c1 interpolate from this color
|
||||
* @param c2 interpolate to this color
|
||||
|
||||
@@ -54,7 +54,7 @@ import processing.awt.ShimAWT;
|
||||
*
|
||||
*
|
||||
* @webref image
|
||||
* @webBrief Datatype for storing images.
|
||||
* @webBrief Datatype for storing images
|
||||
* @usage Web & Application
|
||||
* @instanceName pimg any object of type PImage
|
||||
* @see PApplet#loadImage(String)
|
||||
@@ -96,7 +96,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
*
|
||||
*
|
||||
* @webref image:pixels
|
||||
* @webBrief Array containing the color of every pixel in the image.
|
||||
* @webBrief Array containing the color of every pixel in the image
|
||||
* @usage web_application
|
||||
*/
|
||||
public int[] pixels;
|
||||
@@ -113,7 +113,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
* The width of the image in units of pixels.
|
||||
*
|
||||
* @webref pimage:field
|
||||
* @webBrief The width of the image in units of pixels.
|
||||
* @webBrief The width of the image in units of pixels
|
||||
* @usage web_application
|
||||
*/
|
||||
public int width;
|
||||
@@ -123,7 +123,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
* The height of the image in units of pixels.
|
||||
*
|
||||
* @webref pimage:field
|
||||
* @webBrief The height of the image in units of pixels.
|
||||
* @webBrief The height of the image in units of pixels
|
||||
* @usage web_application
|
||||
*/
|
||||
public int height;
|
||||
@@ -379,7 +379,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
* copy all data into the pixels[] array
|
||||
*
|
||||
* @webref pimage:pixels
|
||||
* @webBrief Loads the pixel data for the image into its <b>pixels[]</b> array.
|
||||
* @webBrief Loads the pixel data for the image into its <b>pixels[]</b> array
|
||||
* @usage web_application
|
||||
*/
|
||||
public void loadPixels() { // ignore
|
||||
@@ -408,7 +408,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
* future.
|
||||
*
|
||||
* @webref pimage:pixels
|
||||
* @webBrief Updates the image with the data in its <b>pixels[]</b> array.
|
||||
* @webBrief Updates the image with the data in its <b>pixels[]</b> array
|
||||
* @usage web_application
|
||||
* @param x x-coordinate of the upper-left corner
|
||||
* @param y y-coordinate of the upper-left corner
|
||||
@@ -474,7 +474,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
* method, and call <b>resize()</b> on the PImage that is returned.
|
||||
*
|
||||
* @webref pimage:method
|
||||
* @webBrief Resize the image to a new width and height.
|
||||
* @webBrief Resize the image to a new width and height
|
||||
* @usage web_application
|
||||
* @param w the resized image width
|
||||
* @param h the resized image height
|
||||
@@ -551,7 +551,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
* pixels[] array directly.
|
||||
*
|
||||
* @webref image:pixels
|
||||
* @webBrief Reads the color of any pixel or grabs a rectangle of pixels.
|
||||
* @webBrief Reads the color of any pixel or grabs a rectangle of pixels
|
||||
* @usage web_application
|
||||
* @param x x-coordinate of the pixel
|
||||
* @param y y-coordinate of the pixel
|
||||
@@ -1582,7 +1582,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
*
|
||||
* @webref color:creating_reading
|
||||
* @webBrief Blends two color values together based on the blending mode given as the
|
||||
* <b>MODE</b> parameter.
|
||||
* <b>MODE</b> parameter
|
||||
* @usage web_application
|
||||
* @param c1 the first color to blend
|
||||
* @param c2 the second color to blend
|
||||
@@ -1674,7 +1674,7 @@ public class PImage implements PConstants, Cloneable {
|
||||
*
|
||||
*
|
||||
* @webref image:pixels
|
||||
* @webBrief Copies a pixel or rectangle of pixels using different blending modes.
|
||||
* @webBrief Copies a pixel or rectangle of pixels using different blending modes
|
||||
* @param src an image variable referring to the source image
|
||||
* @param sx X coordinate of the source's upper left corner
|
||||
* @param sy Y coordinate of the source's upper left corner
|
||||
@@ -3289,7 +3289,7 @@ int testFunction(int dst, int src) {
|
||||
* file with no error.
|
||||
*
|
||||
* @webref pimage:method
|
||||
* @webBrief Saves the image to a TIFF, TARGA, PNG, or JPEG file.
|
||||
* @webBrief Saves the image to a TIFF, TARGA, PNG, or JPEG file
|
||||
* @usage application
|
||||
* @param filename a sequence of letters and numbers
|
||||
*/
|
||||
|
||||
@@ -87,7 +87,7 @@ import java.util.Base64;
|
||||
* </p>
|
||||
*
|
||||
* @webref shape
|
||||
* @webBrief Datatype for storing shapes.
|
||||
* @webBrief Datatype for storing shapes
|
||||
* @usage Web & Application
|
||||
* @see PApplet#loadShape(String)
|
||||
* @see PApplet#createShape()
|
||||
@@ -400,7 +400,7 @@ public class PShape implements PConstants {
|
||||
|
||||
/**
|
||||
*
|
||||
* Returns a boolean value "true" if the image is set to be visible, "false" if
|
||||
* Returns a boolean value <b>true</b> if the image is set to be visible, <b>false</b> if
|
||||
* not. This value can be modified with the <b>setVisible()</b> method.<br />
|
||||
* <br />
|
||||
* The default visibility of a shape is usually controlled by whatever program
|
||||
@@ -409,8 +409,8 @@ public class PShape implements PConstants {
|
||||
*
|
||||
* @webref pshape:method
|
||||
* @usage web_application
|
||||
* @webBrief Returns a boolean value "true" if the image is set to be visible,
|
||||
* "false" if not
|
||||
* @webBrief Returns a boolean value <b>true</b> if the image is set to be visible,
|
||||
* <b>false</b> if not
|
||||
* @see PShape#setVisible(boolean)
|
||||
*/
|
||||
public boolean isVisible() {
|
||||
@@ -781,7 +781,7 @@ public class PShape implements PConstants {
|
||||
* function. It's always and only used with <b>createShape()</b>.
|
||||
*
|
||||
* @webref pshape:method
|
||||
* @webBrief Starts the creation of a new PShape
|
||||
* @webBrief Starts the creation of a new <b>PShape</b>
|
||||
* @see PApplet#endShape()
|
||||
*/
|
||||
public void beginShape() {
|
||||
@@ -799,7 +799,7 @@ public class PShape implements PConstants {
|
||||
* function. It's always and only used with <b>createShape()</b>.
|
||||
*
|
||||
* @webref pshape:method
|
||||
* @webBrief Finishes the creation of a new PShape
|
||||
* @webBrief Finishes the creation of a new <b>PShape</b>
|
||||
* @see PApplet#beginShape()
|
||||
*/
|
||||
public void endShape() {
|
||||
|
||||
@@ -62,7 +62,7 @@ import java.io.Serializable;
|
||||
* <a href="http://www.shiffman.net">Dan Shiffman</a>.
|
||||
*
|
||||
* @webref math
|
||||
* @webBrief A class to describe a two or three dimensional vector.
|
||||
* @webBrief A class to describe a two or three dimensional vector
|
||||
*/
|
||||
public class PVector implements Serializable {
|
||||
/**
|
||||
@@ -205,7 +205,7 @@ public class PVector implements Serializable {
|
||||
* @webref pvector:method
|
||||
* @usage web_application
|
||||
* @return the random PVector
|
||||
* @webBrief Make a new 2D unit vector with a random direction.
|
||||
* @webBrief Make a new 2D unit vector with a random direction
|
||||
* @see PVector#random3D()
|
||||
*/
|
||||
static public PVector random2D() {
|
||||
@@ -255,7 +255,7 @@ public class PVector implements Serializable {
|
||||
* @webref pvector:method
|
||||
* @usage web_application
|
||||
* @return the random PVector
|
||||
* @webBrief Make a new 3D unit vector with a random direction.
|
||||
* @webBrief Make a new 3D unit vector with a random direction
|
||||
* @see PVector#random2D()
|
||||
*/
|
||||
static public PVector random3D() {
|
||||
|
||||
@@ -14,7 +14,7 @@ import processing.core.PApplet;
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief A simple table class to use a <b>String</b> as a lookup for a float
|
||||
* value.
|
||||
* value
|
||||
* @see IntDict
|
||||
* @see StringDict
|
||||
*/
|
||||
|
||||
@@ -18,7 +18,7 @@ import processing.core.PApplet;
|
||||
* a sorted copy, use <b>list.copy().sort()</b>.
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief Helper class for a list of floats.
|
||||
* @webBrief Helper class for a list of floats
|
||||
* @see IntList
|
||||
* @see StringList
|
||||
*/
|
||||
@@ -678,7 +678,7 @@ public class FloatList implements Iterable<Float> {
|
||||
* <b>reverse()</b>, but is more efficient than running each separately.
|
||||
*
|
||||
* @webref floatlist:method
|
||||
* @webBrief A sort in reverse.
|
||||
* @webBrief A sort in reverse
|
||||
*/
|
||||
public void sortReverse() {
|
||||
new Sort() {
|
||||
|
||||
@@ -13,7 +13,7 @@ import processing.core.PApplet;
|
||||
* associated with integer values.
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief A simple class to use a <b>String</b> as a lookup for an int value.
|
||||
* @webBrief A simple class to use a <b>String</b> as a lookup for an int value
|
||||
* @see FloatDict
|
||||
* @see StringDict
|
||||
*/
|
||||
|
||||
@@ -23,7 +23,7 @@ import processing.core.PApplet;
|
||||
* a sorted copy, use <b>list.copy().sort()</b>.
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief Helper class for a list of ints.
|
||||
* @webBrief Helper class for a list of ints
|
||||
* @see FloatList
|
||||
* @see StringList
|
||||
*/
|
||||
|
||||
@@ -96,7 +96,7 @@ import processing.core.PApplet;
|
||||
* @author JSON.org
|
||||
* @version 2012-11-13
|
||||
* @webref data:composite
|
||||
* @webBrief A JSONArray is an ordered sequence of values.
|
||||
* @webBrief A JSONArray is an ordered sequence of values
|
||||
* @see JSONObject
|
||||
* @see PApplet#loadJSONObject(String)
|
||||
* @see PApplet#loadJSONArray(String)
|
||||
@@ -317,7 +317,7 @@ public class JSONArray {
|
||||
* Gets the int value associated with the specified index.
|
||||
*
|
||||
* @webref jsonarray:method
|
||||
* @webBrief Gets the int value associated with the specified index.
|
||||
* @webBrief Gets the int value associated with the specified index
|
||||
* @param index must be between 0 and length() - 1
|
||||
* @return The value.
|
||||
* @throws RuntimeException If the key is not found or if the value is not a number.
|
||||
@@ -395,7 +395,7 @@ public class JSONArray {
|
||||
* Gets the float value associated with the specified index.
|
||||
*
|
||||
* @webref jsonarray:method
|
||||
* @webBrief Gets the float value associated with the specified index.
|
||||
* @webBrief Gets the float value associated with the specified index
|
||||
* @param index must be between 0 and length() - 1
|
||||
* @see JSONArray#getInt(int)
|
||||
* @see JSONArray#getString(int)
|
||||
@@ -457,7 +457,7 @@ public class JSONArray {
|
||||
* Gets the boolean value associated with the specified index.
|
||||
*
|
||||
* @webref jsonarray:method
|
||||
* @webBrief Gets the boolean value associated with the specified index.
|
||||
* @webBrief Gets the boolean value associated with the specified index
|
||||
* @param index must be between 0 and length() - 1
|
||||
* @return The truth.
|
||||
* @throws RuntimeException If there is no value for the index or if the
|
||||
@@ -503,7 +503,7 @@ public class JSONArray {
|
||||
* Retrieves the <b>JSONArray</b> with the associated index value.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Retrieves the <b>JSONArray</b> with the associated index value.
|
||||
* @webBrief Retrieves the <b>JSONArray</b> with the associated index value
|
||||
* @param index must be between 0 and length() - 1
|
||||
* @return A JSONArray value.
|
||||
* @throws RuntimeException If there is no value for the index. or if the
|
||||
@@ -534,7 +534,7 @@ public class JSONArray {
|
||||
* Retrieves the <b>JSONObject</b> with the associated index value.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Retrieves the <b>JSONObject</b> with the associated index value.
|
||||
* @webBrief Retrieves the <b>JSONObject</b> with the associated index value
|
||||
* @param index the index value of the object to get
|
||||
* @return A JSONObject value.
|
||||
* @throws RuntimeException If there is no value for the index or if the
|
||||
@@ -862,7 +862,7 @@ public class JSONArray {
|
||||
* necessary to pad it out.
|
||||
*
|
||||
* @webref jsonarray:method
|
||||
* @webBrief Inserts a new value into the <b>JSONArray</b> at the specified index position.
|
||||
* @webBrief Inserts a new value into the <b>JSONArray</b> at the specified index position
|
||||
* @param index an index value
|
||||
* @param value the value to assign
|
||||
* @return this.
|
||||
|
||||
@@ -116,7 +116,7 @@ import processing.core.PApplet;
|
||||
* @author JSON.org
|
||||
* @version 2012-12-01
|
||||
* @webref data:composite
|
||||
* @webBrief A JSONObject is an unordered collection of name/value pairs.
|
||||
* @webBrief A <b>JSONObject</b> is an unordered collection of name/value pairs
|
||||
* @see JSONArray
|
||||
* @see PApplet#loadJSONObject(String)
|
||||
* @see PApplet#loadJSONArray(String)
|
||||
@@ -570,7 +570,7 @@ public class JSONObject {
|
||||
* Gets the <b>String</b> value associated with the specified key.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Gets the String value associated with the specified key
|
||||
* @webBrief Gets the <b>String</b> value associated with the specified key
|
||||
* @param key a key string
|
||||
* @return A string which is the value.
|
||||
* @throws RuntimeException if there is no string value for the key.
|
||||
@@ -606,10 +606,10 @@ public class JSONObject {
|
||||
|
||||
|
||||
/**
|
||||
* Gets the int value associated with the specified key.
|
||||
* Gets the <b>int</b> value associated with the specified key.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Gets the int value associated with the specified key
|
||||
* @webBrief Gets the <b>int</b> value associated with the specified key
|
||||
* @param key A key string.
|
||||
* @return The integer value.
|
||||
* @throws RuntimeException if the key is not found or if the value cannot
|
||||
@@ -691,10 +691,10 @@ public class JSONObject {
|
||||
|
||||
|
||||
/**
|
||||
* Gets the float value associated with the specified key
|
||||
* Gets the <b>float</b> value associated with the specified key
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Gets the float value associated with a key
|
||||
* @webBrief Gets the <b>float</b> value associated with a key
|
||||
* @param key a key string
|
||||
* @see JSONObject#getInt(String)
|
||||
* @see JSONObject#getString(String)
|
||||
@@ -753,10 +753,10 @@ public class JSONObject {
|
||||
|
||||
|
||||
/**
|
||||
* Gets the boolean value associated with the specified key.
|
||||
* Gets the <b>boolean</b> value associated with the specified key.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Gets the boolean value associated with the specified key
|
||||
* @webBrief Gets the <b>boolean</b> value associated with the specified key
|
||||
* @param key a key string
|
||||
* @return The truth.
|
||||
* @throws RuntimeException if the value is not a Boolean or the String "true" or "false".
|
||||
@@ -933,7 +933,7 @@ public class JSONObject {
|
||||
*
|
||||
* @webref
|
||||
* @webBrief Determines if the value associated with the key is <b>null</b>, that is has
|
||||
* no defined value (<b>false</b>) or if it has a value (<b>true</b>).
|
||||
* no defined value (<b>false</b>) or if it has a value (<b>true</b>)
|
||||
* @param key A key string.
|
||||
* @return true if there is no value associated with the key or if
|
||||
* the value is the JSONObject.NULL object.
|
||||
@@ -1227,7 +1227,7 @@ public class JSONObject {
|
||||
* the specified key already exists, assigns a new value.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Put a key/float pair in the JSONObject
|
||||
* @webBrief Put a key/float pair in the <b>JSONObject</b>
|
||||
* @param key a key string
|
||||
* @param value the value to assign
|
||||
* @throws RuntimeException If the key is null or if the number is NaN or infinite.
|
||||
@@ -1260,7 +1260,7 @@ public class JSONObject {
|
||||
* with the specified key already exists, assigns a new value.
|
||||
*
|
||||
* @webref jsonobject:method
|
||||
* @webBrief Put a key/boolean pair in the JSONObject
|
||||
* @webBrief Put a key/boolean pair in the <b>JSONObject</b>
|
||||
* @param key a key string
|
||||
* @param value the value to assign
|
||||
* @return this.
|
||||
|
||||
@@ -13,7 +13,7 @@ import processing.core.PApplet;
|
||||
* are associated with <b>String</b> values.
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief A simple class to use a String as a lookup for an String value
|
||||
* @webBrief A simple class to use a <b>String</b> as a lookup for an <b>String</b> value
|
||||
* @see IntDict
|
||||
* @see FloatDict
|
||||
*/
|
||||
|
||||
@@ -17,7 +17,7 @@ import processing.core.PApplet;
|
||||
* a sorted copy, use <b>list.copy().sort()</b>.
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief Helper class for a list of Strings.
|
||||
* @webBrief Helper class for a list of Strings
|
||||
* @see IntList
|
||||
* @see FloatList
|
||||
*/
|
||||
|
||||
@@ -76,7 +76,7 @@ import processing.core.PConstants;
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief Generic class for handling tabular data, typically from a CSV, TSV,
|
||||
* or other sort of spreadsheet file.
|
||||
* or other sort of spreadsheet file
|
||||
* @see PApplet#loadTable(String)
|
||||
* @see PApplet#saveTable(Table, String)
|
||||
* @see TableRow
|
||||
@@ -2285,10 +2285,10 @@ public class Table {
|
||||
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
|
||||
|
||||
/**
|
||||
* Returns the total number of rows in a table.
|
||||
* Returns the total number of rows in a <b>Table</b>.
|
||||
*
|
||||
* @webref table:method
|
||||
* @webBrief Returns the total number of rows in a table
|
||||
* @webBrief Returns the total number of rows in a <b>Table</b>
|
||||
* @see Table#getColumnCount()
|
||||
*/
|
||||
public int getRowCount() {
|
||||
|
||||
@@ -4,13 +4,13 @@ import java.io.PrintWriter;
|
||||
|
||||
/**
|
||||
* A <b>TableRow</b> object represents a single row of data values,
|
||||
* stored in columns, from a table.<br />
|
||||
* stored in columns, from a <b>Table</b>.<br />
|
||||
* <br />
|
||||
* Additional <b>TableRow</b> methods are documented in the
|
||||
* <a href="http://processing.github.io/processing-javadocs/core/">Processing Data Javadoc</a>.
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief represents a single row of data values, stored in columns, from a table.
|
||||
* @webBrief Represents a single row of data values, stored in columns, from a <b>Table<b>
|
||||
* @see Table
|
||||
* @see Table#addRow()
|
||||
* @see Table#removeRow(int)
|
||||
@@ -25,7 +25,7 @@ public interface TableRow {
|
||||
* The column may be specified by either its ID or title.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Get an String value from the specified column
|
||||
* @webBrief Get a <b>String</b> value from the specified column
|
||||
* @param column ID number of the column to reference
|
||||
* @see TableRow#getInt(int)
|
||||
* @see TableRow#getFloat(int)
|
||||
@@ -42,7 +42,7 @@ public interface TableRow {
|
||||
* The column may be specified by either its ID or title.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Get an integer value from the specified column
|
||||
* @webBrief Get an <b>integer</b> value from the specified column
|
||||
* @param column ID number of the column to reference
|
||||
* @see TableRow#getFloat(int)
|
||||
* @see TableRow#getString(int)
|
||||
@@ -55,7 +55,7 @@ public interface TableRow {
|
||||
public int getInt(String columnName);
|
||||
|
||||
/**
|
||||
* @webBrief Get a long value from the specified column
|
||||
* @webBrief Get a <b>long</b> value from the specified column
|
||||
* @param column ID number of the column to reference
|
||||
* @see TableRow#getFloat(int)
|
||||
* @see TableRow#getString(int)
|
||||
@@ -73,7 +73,7 @@ public interface TableRow {
|
||||
* The column may be specified by either its ID or title.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Get a float value from the specified column
|
||||
* @webBrief Get a <b>float</b> value from the specified column
|
||||
* @param column ID number of the column to reference
|
||||
* @see TableRow#getInt(int)
|
||||
* @see TableRow#getString(int)
|
||||
@@ -86,7 +86,7 @@ public interface TableRow {
|
||||
public float getFloat(String columnName);
|
||||
|
||||
/**
|
||||
* @webBrief Get a double value from the specified column
|
||||
* @webBrief Get a <b>double</b> value from the specified column
|
||||
* @param column ID number of the column to reference
|
||||
* @see TableRow#getInt(int)
|
||||
* @see TableRow#getString(int)
|
||||
@@ -103,7 +103,7 @@ public interface TableRow {
|
||||
* may be specified by either its ID or title.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Store a String value in the specified column
|
||||
* @webBrief Store a <b>String</b> value in the specified column
|
||||
* @param column ID number of the target column
|
||||
* @param value value to assign
|
||||
* @see TableRow#setInt(int, int)
|
||||
@@ -120,7 +120,7 @@ public interface TableRow {
|
||||
* may be specified by either its ID or title.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Store an integer value in the specified column
|
||||
* @webBrief Store an <b>integer</b> value in the specified column
|
||||
* @param column ID number of the target column
|
||||
* @param value value to assign
|
||||
* @see TableRow#setFloat(int, float)
|
||||
@@ -134,7 +134,7 @@ public interface TableRow {
|
||||
public void setInt(String columnName, int value);
|
||||
|
||||
/**
|
||||
* @webBrief Store a long value in the specified column
|
||||
* @webBrief Store a <b>long</b> value in the specified column
|
||||
* @param column ID number of the target column
|
||||
* @param value value to assign
|
||||
* @see TableRow#setFloat(int, float)
|
||||
@@ -152,7 +152,7 @@ public interface TableRow {
|
||||
* may be specified by either its ID or title.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Store a float value in the specified column
|
||||
* @webBrief Store a <b>float</b> value in the specified column
|
||||
* @param column ID number of the target column
|
||||
* @param value value to assign
|
||||
* @see TableRow#setInt(int, int)
|
||||
@@ -166,7 +166,7 @@ public interface TableRow {
|
||||
public void setFloat(String columnName, float value);
|
||||
|
||||
/**
|
||||
* @webBrief Store a double value in the specified column
|
||||
* @webBrief Store a <b>double</b> value in the specified column
|
||||
* @param column ID number of the target column
|
||||
* @param value value to assign
|
||||
* @see TableRow#setFloat(int, float)
|
||||
@@ -183,13 +183,13 @@ public interface TableRow {
|
||||
* Returns the number of columns in a <b>TableRow</b>.
|
||||
*
|
||||
* @webref tablerow:method
|
||||
* @webBrief Get the column count.
|
||||
* @webBrief Get the column count
|
||||
* @return count of all columns
|
||||
*/
|
||||
public int getColumnCount();
|
||||
|
||||
/**
|
||||
* @webBrief Get the column type.
|
||||
* @webBrief Get the column type
|
||||
* @param columnName title of the target column
|
||||
* @return type of the column
|
||||
*/
|
||||
|
||||
@@ -50,7 +50,7 @@ import processing.core.PApplet;
|
||||
*
|
||||
* @webref data:composite
|
||||
* @webBrief This is the base class used for the Processing XML library,
|
||||
* representing a single node of an <b>XML</b> tree.
|
||||
* representing a single node of an <b>XML</b> tree
|
||||
* @see PApplet#loadXML(String)
|
||||
* @see PApplet#parseXML(String)
|
||||
* @see PApplet#saveXML(XML, String)
|
||||
|
||||
@@ -42,7 +42,7 @@ import java.util.HashMap;
|
||||
*
|
||||
* @webref rendering:shaders
|
||||
* @webBrief This class encapsulates a GLSL shader program, including a vertex
|
||||
* and a fragment shader.
|
||||
* and a fragment shader
|
||||
*/
|
||||
public class PShader implements PConstants {
|
||||
static protected final int POINT = 0;
|
||||
|
||||
@@ -124,7 +124,7 @@ public class I2C {
|
||||
* time.
|
||||
*
|
||||
* @webref I2C
|
||||
* @webBrief Closes the I2C device.
|
||||
* @webBrief Closes the I2C device
|
||||
*/
|
||||
public void close() {
|
||||
if (NativeInterface.isSimulated()) {
|
||||
@@ -155,7 +155,7 @@ public class I2C {
|
||||
* @see beginTransmission
|
||||
* @see write
|
||||
* @webref I2C
|
||||
* @webBrief Ends the current transmissions.
|
||||
* @webBrief Ends the current transmissions
|
||||
*/
|
||||
public void endTransmission() {
|
||||
if (!transmitting) {
|
||||
@@ -223,7 +223,7 @@ public class I2C {
|
||||
* @see write
|
||||
* @see endTransmission
|
||||
* @webref I2C
|
||||
* @webBrief Read bytes from the attached device.
|
||||
* @webBrief Read bytes from the attached device
|
||||
*/
|
||||
public byte[] read(int len) {
|
||||
if (!transmitting) {
|
||||
@@ -261,7 +261,7 @@ public class I2C {
|
||||
* @see read
|
||||
* @see endTransmission
|
||||
* @webref I2C
|
||||
* @webBrief Add bytes to be written to the device.
|
||||
* @webBrief Add bytes to be written to the device
|
||||
*/
|
||||
public void write(byte[] out) {
|
||||
if (!transmitting) {
|
||||
|
||||
@@ -37,7 +37,7 @@ import java.net.*;
|
||||
* listening on a different port, an exception is thrown.
|
||||
*
|
||||
* @webref client
|
||||
* @webBrief The client class is used to create client Objects which connect to a server to exchange data.
|
||||
* @webBrief The client class is used to create client Objects which connect to a server to exchange data
|
||||
* @instanceName client any variable of type Client
|
||||
* @usage Application
|
||||
* @see_external LIB_net/clientEvent
|
||||
@@ -321,7 +321,7 @@ public class Client implements Runnable {
|
||||
*
|
||||
* @webref client
|
||||
* @usage application
|
||||
* @webBrief Returns the IP address of the machine as a String
|
||||
* @webBrief Returns the IP address of the machine as a <b>String</b>
|
||||
*/
|
||||
public String ip() {
|
||||
if (socket != null){
|
||||
@@ -422,7 +422,7 @@ public class Client implements Runnable {
|
||||
*
|
||||
* @webref client
|
||||
* @usage application
|
||||
* @webBrief Reads a group of bytes from the buffer.
|
||||
* @webBrief Reads a group of bytes from the buffer
|
||||
*/
|
||||
public byte[] readBytes() {
|
||||
synchronized (bufferLock) {
|
||||
@@ -596,7 +596,7 @@ public class Client implements Runnable {
|
||||
|
||||
/**
|
||||
*
|
||||
* Returns the all the data from the buffer as a String. This method
|
||||
* Returns the all the data from the buffer as a <b>String</b>. This method
|
||||
* assumes the incoming characters are ASCII. If you want to transfer
|
||||
* Unicode data, first convert the String to a byte stream in the
|
||||
* representation of your choice (i.e. UTF8 or two-byte Unicode data), and
|
||||
@@ -604,7 +604,7 @@ public class Client implements Runnable {
|
||||
*
|
||||
* @webref client
|
||||
* @usage application
|
||||
* @webBrief Returns the buffer as a String
|
||||
* @webBrief Returns the buffer as a <b>String</b>
|
||||
*/
|
||||
public String readString() {
|
||||
byte b[] = readBytes();
|
||||
@@ -626,7 +626,7 @@ public class Client implements Runnable {
|
||||
*
|
||||
* @webref client
|
||||
* @usage application
|
||||
* @webBrief Returns the buffer as a String up to and including a particular character
|
||||
* @webBrief Returns the buffer as a <b>String</b> up to and including a particular character
|
||||
* @param interesting character designated to mark the end of the data
|
||||
*/
|
||||
public String readStringUntil(int interesting) {
|
||||
@@ -644,7 +644,7 @@ public class Client implements Runnable {
|
||||
*
|
||||
* @webref client
|
||||
* @usage application
|
||||
* @webBrief Writes bytes, chars, ints, bytes[], Strings
|
||||
* @webBrief Writes <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b>
|
||||
* @param data data to write
|
||||
*/
|
||||
public void write(int data) { // will also cover char
|
||||
|
||||
@@ -44,7 +44,7 @@ import java.net.*;
|
||||
* @webref server
|
||||
* @usage application
|
||||
* @webBrief The server class is used to create server objects which send
|
||||
* and receives data to and from its associated clients (other programs connected to it).
|
||||
* and receives data to and from its associated clients (other programs connected to it)
|
||||
* @instanceName server any variable of type Server
|
||||
*/
|
||||
public class Server implements Runnable {
|
||||
@@ -118,7 +118,7 @@ public class Server implements Runnable {
|
||||
* Disconnect a particular client.
|
||||
*
|
||||
* @webref server
|
||||
* @webBrief Disconnect a particular client.
|
||||
* @webBrief Disconnect a particular client
|
||||
* @param client the client to disconnect
|
||||
*/
|
||||
public void disconnect(Client client) {
|
||||
@@ -188,7 +188,7 @@ public class Server implements Runnable {
|
||||
* into any trouble.
|
||||
*
|
||||
* @webref server
|
||||
* @webBrief Return true if this server is still active.
|
||||
* @webBrief Return <b>true</b> if this server is still active
|
||||
*/
|
||||
public boolean active() {
|
||||
return thread != null;
|
||||
@@ -215,7 +215,7 @@ public class Server implements Runnable {
|
||||
* Returns the next client in line with a new message.
|
||||
*
|
||||
* @webref server
|
||||
* @webBrief Returns the next client in line with a new message.
|
||||
* @webBrief Returns the next client in line with a new message
|
||||
* @usage application
|
||||
*/
|
||||
public Client available() {
|
||||
@@ -255,7 +255,7 @@ public class Server implements Runnable {
|
||||
* is still running. Otherwise, it will be automatically be shut down by the
|
||||
* host PApplet using dispose(), which is identical.
|
||||
* @webref server
|
||||
* @webBrief Disconnects all clients and stops the server.
|
||||
* @webBrief Disconnects all clients and stops the server
|
||||
* @usage application
|
||||
*/
|
||||
public void stop() {
|
||||
|
||||
@@ -38,7 +38,7 @@ import jssc.*;
|
||||
* Class for sending and receiving data using the serial communication protocol.
|
||||
*
|
||||
* @webref serial
|
||||
* @webBrief Class for sending and receiving data using the serial communication protocol.
|
||||
* @webBrief Class for sending and receiving data using the serial communication protocol
|
||||
* @instanceName serial any variable of type Serial
|
||||
* @usage Application
|
||||
* @see_external LIB_serial/serialEvent
|
||||
@@ -189,7 +189,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_available.xml
|
||||
* @webref serial
|
||||
* @webBrief Returns the number of bytes available.
|
||||
* @webBrief Returns the number of bytes available
|
||||
* @usage web_application
|
||||
*/
|
||||
public int available() {
|
||||
@@ -215,7 +215,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_bufferUntil.xml
|
||||
* @webref serial
|
||||
* @webBrief Sets a specific byte to buffer until before calling <b>serialEvent()</b>.
|
||||
* @webBrief Sets a specific byte to buffer until before calling <b>serialEvent()</b>
|
||||
* @usage web_application
|
||||
* @param inByte the value to buffer until
|
||||
*/
|
||||
@@ -230,7 +230,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_clear.xml
|
||||
* @webref serial
|
||||
* @webBrief Empty the buffer, removes all the data stored there.
|
||||
* @webBrief Empty the buffer, removes all the data stored there
|
||||
* @usage web_application
|
||||
*/
|
||||
public void clear() {
|
||||
@@ -273,7 +273,7 @@ public class Serial implements SerialPortEventListener {
|
||||
* and clears the buffer. Useful when you just want the most
|
||||
* recent value sent over the port.
|
||||
* @webref serial
|
||||
* @webBrief Returns last byte received or -1 if there is none available.
|
||||
* @webBrief Returns last byte received or -1 if there is none available
|
||||
* @usage web_application
|
||||
*/
|
||||
public int last() {
|
||||
@@ -295,7 +295,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_lastChar.xml
|
||||
* @webref serial
|
||||
* @webBrief Returns the last byte received as a char or -1 if there is none available.
|
||||
* @webBrief Returns the last byte received as a char or -1 if there is none available
|
||||
* @usage web_application
|
||||
*/
|
||||
public char lastChar() {
|
||||
@@ -309,7 +309,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_list.xml
|
||||
* @webref serial
|
||||
* @webBrief Gets a list of all available serial ports.
|
||||
* @webBrief Gets a list of all available serial ports
|
||||
* @usage web_application
|
||||
*/
|
||||
public static String[] list() {
|
||||
@@ -326,7 +326,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_read.xml
|
||||
* @webref serial
|
||||
* @webBrief Returns a number between 0 and 255 for the next byte that's waiting in the buffer.
|
||||
* @webBrief Returns a number between 0 and 255 for the next byte that's waiting in the buffer
|
||||
* @usage web_application
|
||||
*/
|
||||
public int read() {
|
||||
@@ -354,7 +354,7 @@ public class Serial implements SerialPortEventListener {
|
||||
* <b>byteBuffer</b>, only those that fit are read.
|
||||
* @generate Serial_readBytes.xml
|
||||
* @webref serial
|
||||
* @webBrief Reads a group of bytes from the buffer or <b>null</b> if there are none available.
|
||||
* @webBrief Reads a group of bytes from the buffer or <b>null</b> if there are none available
|
||||
* @usage web_application
|
||||
*/
|
||||
public byte[] readBytes() {
|
||||
@@ -446,7 +446,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_readBytesUntil.xml
|
||||
* @webref serial
|
||||
* @webBrief Reads from the port into a buffer of bytes up to and including a particular character.
|
||||
* @webBrief Reads from the port into a buffer of bytes up to and including a particular character
|
||||
* @usage web_application
|
||||
* @param inByte character designated to mark the end of the data
|
||||
*/
|
||||
@@ -532,7 +532,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_readChar.xml
|
||||
* @webref serial
|
||||
* @webBrief Returns the next byte in the buffer as a char.
|
||||
* @webBrief Returns the next byte in the buffer as a char
|
||||
* @usage web_application
|
||||
*/
|
||||
public char readChar() {
|
||||
@@ -541,14 +541,14 @@ public class Serial implements SerialPortEventListener {
|
||||
|
||||
|
||||
/**
|
||||
* Returns all the data from the buffer as a String or <b>null</b> if there is nothing available.
|
||||
* Returns all the data from the buffer as a <b>String</b> or <b>null</b> if there is nothing available.
|
||||
* This method assumes the incoming characters are ASCII. If you want to transfer Unicode data,
|
||||
* first convert the String to a byte stream in the representation of your choice (i.e. UTF8 or
|
||||
* two-byte Unicode data), and send it as a byte array.
|
||||
*
|
||||
* @generate Serial_readString.xml
|
||||
* @webref serial
|
||||
* @webBrief Returns all the data from the buffer as a String or <b>null</b> if there is nothing available.
|
||||
* @webBrief Returns all the data from the buffer as a <b>String</b> or <b>null</b> if there is nothing available
|
||||
* @usage web_application
|
||||
*/
|
||||
public String readString() {
|
||||
@@ -570,7 +570,7 @@ public class Serial implements SerialPortEventListener {
|
||||
* (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.
|
||||
*
|
||||
* @webref serial
|
||||
* @webBrief Combination of <b>readBytesUntil()</b> and <b>readString()</b>.
|
||||
* @webBrief Combination of <b>readBytesUntil()</b> and <b>readString()</b>
|
||||
* @usage web_application
|
||||
* @param inByte character designated to mark the end of the data
|
||||
*/
|
||||
@@ -594,7 +594,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate serialEvent.xml
|
||||
* @webref serial_event
|
||||
* @webBrief Called when data is available.
|
||||
* @webBrief Called when data is available
|
||||
* @usage web_application
|
||||
* @param event the port where new data is available
|
||||
*/
|
||||
@@ -679,7 +679,7 @@ public class Serial implements SerialPortEventListener {
|
||||
*
|
||||
* @generate Serial_stop.xml
|
||||
* @webref serial
|
||||
* @webBrief Stops data communication on this port.
|
||||
* @webBrief Stops data communication on this port
|
||||
* @usage web_application
|
||||
*/
|
||||
public void stop() {
|
||||
|
||||
Reference in New Issue
Block a user