/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */

/*

Part of the Processing project - http://processing.org

Copyright (c) 2006-10 Ben Fry and Casey Reas

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License version 2.1 as published by the Free Software Foundation.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

*/

package processing.core;

import java.util.HashMap;

import processing.core.PApplet;

import processing.core.PGraphicsJava2D;

/**

* ( begin auto-generated from PShape.xml )

*

* Datatype for storing shapes. Processing can currently load and display

* SVG (Scalable Vector Graphics) shapes. Before a shape is used, it must

* be loaded with the <b>loadShape()</b> function. The <b>shape()</b>

* function is used to draw the shape to the display window. The

* <b>PShape</b> object contain a group of methods, linked below, that can

* operate on the shape data.

* <br /><br />

* The <b>loadShape()</b> function supports SVG files created with Inkscape

* and Adobe Illustrator. It is not a full SVG implementation, but offers

* some straightforward support for handling vector data.

*

* ( end auto-generated )

* <h3>Advanced</h3>

*

* In-progress class to handle shape data, currently to be considered of

* alpha or beta quality. Major structural work may be performed on this class

* after the release of Processing 1.0. Such changes may include:

*

* <ul>

* <li> addition of proper accessors to read shape vertex and coloring data

* (this is the second most important part of having a PShape class after all).

* <li> a means of creating PShape objects ala beginShape() and endShape().

* <li> load(), update(), and cache methods ala PImage, so that shapes can

* have renderer-specific optimizations, such as vertex arrays in OpenGL.

* <li> splitting this class into multiple classes to handle different

* varieties of shape data (primitives vs collections of vertices vs paths)

* <li> change of package declaration, for instance moving the code into

* package processing.shape (if the code grows too much).

* </ul>

*

* <p>For the time being, this class and its shape() and loadShape() friends in

* PApplet exist as placeholders for more exciting things to come. If you'd

* like to work with this class, make a subclass (see how PShapeSVG works)

* and you can play with its internal methods all you like.</p>

*

* <p>Library developers are encouraged to create PShape objects when loading

* shape data, so that they can eventually hook into the bounty that will be

* the PShape interface, and the ease of loadShape() and shape().</p>

*

* @webref shape

* @usage Web &amp; Application

* @see PApplet#loadShape(String)

* @see PApplet#createShape()

* @see PApplet#shapeMode(int)

* @instanceName sh any variable of type PShape

*/

public class PShape implements PConstants {

protected String name;

protected HashMap<String,PShape> nameTable;

// /** Generic, only draws its child objects. */

// static public final int GROUP = 0;

// GROUP now inherited from PConstants

/** A line, ellipse, arc, image, etc. */

static public final int PRIMITIVE = 1;

/** A series of vertex, curveVertex, and bezierVertex calls. */

static public final int PATH = 2;

/** Collections of vertices created with beginShape(). */

static public final int GEOMETRY = 3;

/** The shape type, one of GROUP, PRIMITIVE, PATH, or GEOMETRY. */

protected int family;

/** ELLIPSE, LINE, QUAD; TRIANGLE_FAN, QUAD_STRIP; etc. */

protected int kind;

protected PMatrix matrix;

protected int textureMode;

/** Texture or image data associated with this shape. */

protected PImage image;

public static final String OUTSIDE_BEGIN_END_ERROR =

"%1$s can only be called between beginShape() and endShape()";

public static final String INSIDE_BEGIN_END_ERROR =

"%1$s can only be called outside beginShape() and endShape()";

public static final String NO_SUCH_VERTEX_ERROR =

"%1$s vertex index does not exist";

// boundary box of this shape

//protected float x;

//protected float y;

//protected float width;

//protected float height;

/**

* ( begin auto-generated from PShape_width.xml )

*

* The width of the PShape document.

*

* ( end auto-generated )

* @webref pshape:field

* @usage web_application

* @brief Shape document width

* @see PShape#height

*/

public float width;

/**

* ( begin auto-generated from PShape_height.xml )

*

* The height of the PShape document.

*

* ( end auto-generated )

* @webref pshape:field

* @usage web_application

* @brief Shape document height

* @see PShape#width

*/

public float height;

public float depth;

PGraphicsJava2D g;

// set to false if the object is hidden in the layers palette

protected boolean visible = true;

/** Retained shape being created with beginShape/endShape */

protected boolean openShape = false;

protected boolean openContour = false;

protected boolean stroke;

protected int strokeColor;

protected float strokeWeight; // default is 1

protected int strokeCap;

protected int strokeJoin;

protected boolean fill;

protected int fillColor;

protected boolean tint;

protected int tintColor;

protected int ambientColor;

protected boolean setAmbient;

protected int specularColor;

protected int emissiveColor;

protected float shininess;

protected int sphereDetailU, sphereDetailV;

protected int rectMode;

protected int ellipseMode;

/** Temporary toggle for whether styles should be honored. */

protected boolean style = true;

/** For primitive shapes in particular, params like x/y/w/h or x1/y1/x2/y2. */

protected float[] params;

protected int vertexCount;

/**

* When drawing POLYGON shapes, the second param is an array of length

* VERTEX_FIELD_COUNT. When drawing PATH shapes, the second param has only

* two variables.

*/

protected float[][] vertices;

protected PShape parent;

protected int childCount;

protected PShape[] children;

/** Array of VERTEX, BEZIER_VERTEX, and CURVE_VERTEX calls. */

protected int vertexCodeCount;

protected int[] vertexCodes;

/** True if this is a closed path. */

protected boolean close;

// ........................................................

// internal color for setting/calculating

protected float calcR, calcG, calcB, calcA;

protected int calcRi, calcGi, calcBi, calcAi;

protected int calcColor;

protected boolean calcAlpha;

/** The current colorMode */

public int colorMode; // = RGB;

/** Max value for red (or hue) set by colorMode */

public float colorModeX; // = 255;

/** Max value for green (or saturation) set by colorMode */

public float colorModeY; // = 255;

/** Max value for blue (or value) set by colorMode */

public float colorModeZ; // = 255;

/** Max value for alpha set by colorMode */

public float colorModeA; // = 255;

/** True if colors are not in the range 0..1 */

boolean colorModeScale; // = true;

/** True if colorMode(RGB, 255) */

boolean colorModeDefault; // = true;

/** True if contains 3D data */

protected boolean is3D = false;

// should this be called vertices (consistent with PGraphics internals)

// or does that hurt flexibility?

// POINTS, LINES, xLINE_STRIP, xLINE_LOOP

// TRIANGLES, TRIANGLE_STRIP, TRIANGLE_FAN

// QUADS, QUAD_STRIP

// xPOLYGON

// static final int PATH = 1; // POLYGON, LINE_LOOP, LINE_STRIP

// static final int GROUP = 2;

// how to handle rectmode/ellipsemode?

// are they bitshifted into the constant?

// CORNER, CORNERS, CENTER, (CENTER_RADIUS?)

// static final int RECT = 3; // could just be QUAD, but would be x1/y1/x2/y2

// static final int ELLIPSE = 4;

//

// static final int VERTEX = 7;

// static final int CURVE = 5;

// static final int BEZIER = 6;

// fill and stroke functions will need a pointer to the parent

// PGraphics object.. may need some kind of createShape() fxn

// or maybe the values are stored until draw() is called?

// attaching images is very tricky.. it's a different type of data

// material parameters will be thrown out,

// except those currently supported (kinds of lights)

// pivot point for transformations

// public float px;

// public float py;

/**

* @nowebref

*/

public PShape() {

this.family = GROUP;

}

/**

* @nowebref

*/

public PShape(int family) {

this.family = family;

}

/**

* @nowebref

*/

public PShape(PGraphicsJava2D pg, int family) {

this.g = pg;

this.family = family;

this.parent = null;

// Style parameters are retrieved from the current values in the renderer.

textureMode = pg.textureMode;

colorMode(pg.colorMode,

pg.colorModeX, pg.colorModeY, pg.colorModeZ, pg.colorModeA);

// Initial values for fill, stroke and tint colors are also imported from

// the renderer. This is particular relevant for primitive shapes, since is

// not possible to set their color separately when creating them, and their

// input vertices are actually generated at rendering time, by which the

// color configuration of the renderer might have changed.

fill = pg.fill;

fillColor = pg.fillColor;

stroke = pg.stroke;

strokeColor = pg.strokeColor;

strokeWeight = pg.strokeWeight;

strokeCap = pg.strokeCap;

strokeJoin = pg.strokeJoin;

tint = pg.tint;

tintColor = pg.tintColor;

setAmbient = pg.setAmbient;

ambientColor = pg.ambientColor;

specularColor = pg.specularColor;

emissiveColor = pg.emissiveColor;

shininess = pg.shininess;

sphereDetailU = pg.sphereDetailU;

sphereDetailV = pg.sphereDetailV;

// bezierDetail = pg.bezierDetail;

// curveDetail = pg.curveDetail;

// curveTightness = pg.curveTightness;

// The rect and ellipse modes are set to CORNER since it is the expected

// mode for svg shapes.

rectMode = CORNER;

ellipseMode = CORNER;

// normalX = normalY = 0;

// normalZ = 1;

//

// normalMode = NORMAL_MODE_AUTO;

// To make sure that the first vertex is marked as a break.

// Same behavior as in the immediate mode.

// breakShape = false;

if (family == GROUP) {

// GROUP shapes are always marked as ended.

// shapeCreated = true;

}

}

public void setKind(int kind) {

this.kind = kind;

}

public void setName(String name) {

this.name = name;

}

public String getName() {

return name;

}

/**

* ( begin auto-generated from PShape_isVisible.xml )

*

* Returns a boolean value "true" if the image is set to be visible,

* "false" if not. This is modified with the <b>setVisible()</b> parameter.

* <br/> <br/>

* The visibility of a shape is usually controlled by whatever program

* created the SVG file. For instance, this parameter is controlled by

* showing or hiding the shape in the layers palette in Adobe Illustrator.

*

* ( end auto-generated )

* @webref pshape:method

* @usage web_application

* @brief Returns a boolean value "true" if the image is set to be visible, "false" if not

* @see PShape#setVisible(boolean)

*/

public boolean isVisible() {

return visible;

}

/**

* ( begin auto-generated from PShape_setVisible.xml )

*

* Sets the shape to be visible or invisible. This is determined by the

* value of the <b>visible</b> parameter.

* <br/> <br/>

* The visibility of a shape is usually controlled by whatever program

* created the SVG file. For instance, this parameter is controlled by

* showing or hiding the shape in the layers palette in Adobe Illustrator.

*

* ( end auto-generated )

* @webref pshape:mathod

* @usage web_application

* @brief Sets the shape to be visible or invisible

* @param visible "false" makes the shape invisible and "true" makes it visible

* @see PShape#isVisible()

*/

public void setVisible(boolean visible) {

this.visible = visible;

}

/**

* ( begin auto-generated from PShape_disableStyle.xml )

*

* Disables the shape's style data and uses Processing's current styles.

* Styles include attributes such as colors, stroke weight, and stroke

* joints.

*

* ( end auto-generated )

* <h3>Advanced</h3>

* Overrides this shape's style information and uses PGraphics styles and

* colors. Identical to ignoreStyles(true). Also disables styles for all

* child shapes.

* @webref pshape:method

* @usage web_application

* @brief Disables the shape's style data and uses Processing styles

* @see PShape#enableStyle()

*/

public void disableStyle() {

style = false;

for (int i = 0; i < childCount; i++) {

children[i].disableStyle();

}

}

/**

* ( begin auto-generated from PShape_enableStyle.xml )

*

* Enables the shape's style data and ignores Processing's current styles.

* Styles include attributes such as colors, stroke weight, and stroke

* joints.

*

* ( end auto-generated )

*

* @webref pshape:method

* @usage web_application

* @brief Enables the shape's style data and ignores the Processing styles

* @see PShape#disableStyle()

*/

public void enableStyle() {

style = true;

for (int i = 0; i < childCount; i++) {

children[i].enableStyle();

}

}

// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

// protected void checkBounds() {

// if (width == 0 || height == 0) {

// // calculate bounds here (also take kids into account)

// width = 1;

// height = 1;

// }

// }

/**

* Get the width of the drawing area (not necessarily the shape boundary).

*/

public float getWidth() {

//checkBounds();

return width;

}

/**

* Get the height of the drawing area (not necessarily the shape boundary).

*/

public float getHeight() {

//checkBounds();

return height;

}

/**

* Get the depth of the shape area (not necessarily the shape boundary). Only makes sense for 3D PShape subclasses,

* such as PShape3D.

*/

public float getDepth() {

//checkBounds();

return depth;

}

/*

// TODO unapproved

protected PVector getTop() {

return getTop(null);

}

protected PVector getTop(PVector top) {

if (top == null) {

top = new PVector();

}

return top;

}

protected PVector getBottom() {

return getBottom(null);

}

protected PVector getBottom(PVector bottom) {

if (bottom == null) {

bottom = new PVector();

}

return bottom;

}

*/

/**

* Return true if this shape is 2D. Defaults to true.

*/

public boolean is2D() {

return !is3D;

}

/**

* Return true if this shape is 3D. Defaults to false.

*/

public boolean is3D() {

return is3D;

}

public void is3D(boolean val) {

is3D = val;

}

// /**

// * Return true if this shape requires rendering through OpenGL. Defaults to false.

// */

// // TODO unapproved

// public boolean isGL() {

// return false;

// }

///////////////////////////////////////////////////////////

//

// Drawing methods

public void textureMode(int mode) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "textureMode()");

return;

}

textureMode = mode;

}

public void texture(PImage tex) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "texture()");

return;

}

image = tex;

}

public void noTexture() {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "noTexture()");

return;

}

image = null;

}

// TODO unapproved

protected void solid(boolean solid) {

}

/**

* @webref shape:vertex

* @brief Starts a new contour

* @see PShape#endContour()

*/

public void beginContour() {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "beginContour()");

return;

}

if (family == GROUP) {

PGraphics.showWarning("Cannot begin contour in GROUP shapes");

return;

}

if (openContour) {

PGraphics.showWarning("Already called beginContour().");

return;

}

openContour = true;

beginContourImpl();

}

protected void beginContourImpl() {

if (vertexCodes.length == vertexCodeCount) {

vertexCodes = PApplet.expand(vertexCodes);

}

vertexCodes[vertexCodeCount++] = BREAK;

}

/**

* @webref shape:vertex

* @brief Ends a contour

* @see PShape#beginContour()

*/

public void endContour() {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "endContour()");

return;

}

if (family == GROUP) {

PGraphics.showWarning("Cannot end contour in GROUP shapes");

return;

}

if (!openContour) {

PGraphics.showWarning("Need to call beginContour() first.");

return;

}

endContourImpl();

openContour = false;

}

protected void endContourImpl() {

}

public void vertex(float x, float y) {

if (vertices == null) {

vertices = new float[10][2];

} else if (vertices.length == vertexCount) {

vertices = (float[][]) PApplet.expand(vertices);

}

vertices[vertexCount++] = new float[] { x, y };

if (vertexCodes == null) {

vertexCodes = new int[10];

} else if (vertexCodes.length == vertexCodeCount) {

vertexCodes = PApplet.expand(vertexCodes);

}

vertexCodes[vertexCodeCount++] = VERTEX;

if (x > width) {

width = x;

}

if (y > height) {

height = y;

}

}

public void vertex(float x, float y, float u, float v) {

}

public void vertex(float x, float y, float z) {

// why not?

vertex(x, y);

}

public void vertex(float x, float y, float z, float u, float v) {

}

public void normal(float nx, float ny, float nz) {

}

/**

* @webref pshape:method

* @brief Starts the creation of a new PShape

* @see PApplet#endShape()

*/

public void beginShape() {

beginShape(POLYGON);

}

public void beginShape(int kind) {

this.kind = kind;

openShape = true;

}

/**

* @webref pshape:method

* @brief Finishes the creation of a new PShape

* @see PApplet#beginShape()

*/

public void endShape() {

endShape(OPEN);

}

public void endShape(int mode) {

if (family == GROUP) {

PGraphics.showWarning("Cannot end GROUP shape");

return;

}

if (!openShape) {

PGraphics.showWarning("Need to call beginShape() first");

return;

}

close = (mode==CLOSE);

// this is the state of the shape

openShape = false;

}

//////////////////////////////////////////////////////////////

// STROKE CAP/JOIN/WEIGHT

public void strokeWeight(float weight) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "strokeWeight()");

return;

}

strokeWeight = weight;

}

public void strokeJoin(int join) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "strokeJoin()");

return;

}

strokeJoin = join;

}

public void strokeCap(int cap) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "strokeCap()");

return;

}

strokeCap = cap;

}

//////////////////////////////////////////////////////////////

// FILL COLOR

public void noFill() {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "noFill()");

return;

}

fill = false;

fillColor = 0x0;

if (!setAmbient) {

ambientColor = fillColor;

}

}

public void fill(int rgb) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "fill()");

return;

}

fill = true;

colorCalc(rgb);

fillColor = calcColor;

if (!setAmbient) {

ambientColor = fillColor;

}

}

public void fill(int rgb, float alpha) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "fill()");

return;

}

fill = true;

colorCalc(rgb, alpha);

fillColor = calcColor;

if (!setAmbient) {

ambientColor = fillColor;

}

}

public void fill(float gray) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "fill()");

return;

}

fill = true;

colorCalc(gray);

fillColor = calcColor;

if (!setAmbient) {

ambientColor = fillColor;

}

}

public void fill(float gray, float alpha) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "fill()");

return;

}

fill = true;

colorCalc(gray, alpha);

fillColor = calcColor;

if (!setAmbient) {

ambient(fillColor);

setAmbient = false;

}

if (!setAmbient) {

ambientColor = fillColor;

}

}

public void fill(float x, float y, float z) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "fill()");

return;

}

fill = true;

colorCalc(x, y, z);

fillColor = calcColor;

if (!setAmbient) {

ambientColor = fillColor;

}

}

public void fill(float x, float y, float z, float a) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "fill()");

return;

}

fill = true;

colorCalc(x, y, z, a);

fillColor = calcColor;

if (!setAmbient) {

ambientColor = fillColor;

}

}

//////////////////////////////////////////////////////////////

// STROKE COLOR

public void noStroke() {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "noStroke()");

return;

}

stroke = false;

}

public void stroke(int rgb) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "stroke()");

return;

}

stroke = true;

colorCalc(rgb);

strokeColor = calcColor;

}

public void stroke(int rgb, float alpha) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "stroke()");

return;

}

stroke = true;

colorCalc(rgb, alpha);

strokeColor = calcColor;

}

public void stroke(float gray) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "stroke()");

return;

}

stroke = true;

colorCalc(gray);

strokeColor = calcColor;

}

public void stroke(float gray, float alpha) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "stroke()");

return;

}

stroke = true;

colorCalc(gray, alpha);

strokeColor = calcColor;

}

public void stroke(float x, float y, float z) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "stroke()");

return;

}

stroke = true;

colorCalc(x, y, z);

strokeColor = calcColor;

}

public void stroke(float x, float y, float z, float alpha) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "stroke()");

return;

}

stroke = true;

colorCalc(x, y, z, alpha);

strokeColor = calcColor;

}

//////////////////////////////////////////////////////////////

// TINT COLOR

public void noTint() {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "noTint()");

return;

}

tint = false;

}

public void tint(int rgb) {

if (!openShape) {

PGraphics.showWarning(OUTSIDE_BEGIN_END_ERROR, "tint()");

return;