PShape

java.lang.Object
- processing.core.PShape

All Implemented Interfaces:

PConstants

Direct Known Subclasses:

PShapeOBJ, PShapeOpenGL, PShapeSVG
```
public class PShape
extends java.lang.Object
implements PConstants
```
( 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 loadShape() function. The shape() function is used to draw the shape to the display window. The PShape object contain a group of methods, linked below, that can operate on the shape data.

The loadShape() 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 )
Advanced
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:
- 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).
- a means of creating PShape objects ala beginShape() and endShape().
- load(), update(), and cache methods ala PImage, so that shapes can have renderer-specific optimizations, such as vertex arrays in OpenGL.
- splitting this class into multiple classes to handle different varieties of shape data (primitives vs collections of vertices vs paths)
- change of package declaration, for instance moving the code into package processing.shape (if the code grows too much).
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.

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().
See Also:

PApplet.loadShape(String), PApplet.createShape(), PApplet.shapeMode(int)

Usage:

Web & Application

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`colorMode` The current colorMode
`float`	`colorModeA` Max value for alpha set by colorMode
`float`	`colorModeX` Max value for red (or hue) set by colorMode
`float`	`colorModeY` Max value for green (or saturation) set by colorMode
`float`	`colorModeZ` Max value for blue (or value) set by colorMode
`float`	`depth`
`static int`	`GEOMETRY` Collections of vertices created with beginShape().
`float`	`height` ( begin auto-generated from PShape_height.xml ) The height of the PShape document.
`static java.lang.String`	`INSIDE_BEGIN_END_ERROR`
`static java.lang.String`	`NO_SUCH_VERTEX_ERROR`
`static java.lang.String`	`NO_VERTICES_ERROR`
`static java.lang.String`	`NOT_A_SIMPLE_VERTEX`
`static java.lang.String`	`OUTSIDE_BEGIN_END_ERROR`
`static int`	`PATH` A series of vertex, curveVertex, and bezierVertex calls.
`static java.lang.String`	`PER_VERTEX_UNSUPPORTED`
`static int`	`PRIMITIVE` A line, ellipse, arc, image, etc.
`float`	`width` ( begin auto-generated from PShape_width.xml ) The width of the PShape document.

Fields inherited from interface processing.core.PConstants
ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ASYNC_SAVEFRAME, DISABLE_BUFFER_READING, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_KEY_REPEAT, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ASYNC_SAVEFRAME, ENABLE_BUFFER_READING, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_KEY_REPEAT, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ESC, EXCLUSION, FX2D, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADRATIC_VERTEX, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPAN, SPHERE, SPOT, SQUARE, SUBTRACT, SVG, TAB, TARGA, TAU, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Constructor Summary

Constructors
Constructor and Description

PShape()

PShape(int family)

PShape(PGraphics g, int family)

PShape(PGraphics g, int kind, float... params)

Constructors
Constructor and Description
`PShape()`
`PShape(int family)`
`PShape(PGraphics g, int family)`
`PShape(PGraphics g, int kind, float... params)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(PShape who)`
`void`	`addChild(PShape who, int idx)`
`void`	`addName(java.lang.String nom, PShape shape)` Add a shape to the name lookup table.
`void`	`ambient(float gray)`
`void`	`ambient(float x, float y, float z)`
`void`	`ambient(int rgb)`
`void`	`applyMatrix(float n00, float n01, float n02, float n10, float n11, float n12)`
`void`	`applyMatrix(float n00, float n01, float n02, float n03, float n10, float n11, float n12, float n13, float n20, float n21, float n22, float n23, float n30, float n31, float n32, float n33)`
`void`	`applyMatrix(PMatrix source)`
`void`	`applyMatrix(PMatrix2D source)`
`void`	`applyMatrix(PMatrix3D source)`
`void`	`attrib(java.lang.String name, boolean... values)`
`void`	`attrib(java.lang.String name, float... values)`
`void`	`attrib(java.lang.String name, int... values)`
`void`	`attribColor(java.lang.String name, int color)`
`void`	`attribNormal(java.lang.String name, float nx, float ny, float nz)`
`void`	`attribPosition(java.lang.String name, float x, float y, float z)`
`void`	`beginContour()`
`void`	`beginShape()`
`void`	`beginShape(int kind)`
`void`	`bezierDetail(int detail)`
`void`	`bezierVertex(float x2, float y2, float x3, float y3, float x4, float y4)`
`void`	`bezierVertex(float x2, float y2, float z2, float x3, float y3, float z3, float x4, float y4, float z4)`
`void`	`colorMode(int mode)` Set the pivot point for all transformations.
`void`	`colorMode(int mode, float max)`
`void`	`colorMode(int mode, float maxX, float maxY, float maxZ)`
`void`	`colorMode(int mode, float maxX, float maxY, float maxZ, float maxA)`
`boolean`	`contains(float x, float y)` Return true if this x, y coordinate is part of this shape.
`void`	`curveDetail(int detail)`
`void`	`curveTightness(float tightness)`
`void`	`curveVertex(float x, float y)`
`void`	`curveVertex(float x, float y, float z)`
`void`	`disableStyle()` ( begin auto-generated from PShape_disableStyle.xml ) Disables the shape's style data and uses Processing's current styles.
`void`	`draw(PGraphics g)` Called by the following (the shape() command adds the g) PShape s = loadShape("blah.svg"); shape(s);
`void`	`emissive(float gray)`
`void`	`emissive(float x, float y, float z)`
`void`	`emissive(int rgb)`
`void`	`enableStyle()` ( begin auto-generated from PShape_enableStyle.xml ) Enables the shape's style data and ignores Processing's current styles.
`void`	`endContour()`
`void`	`endShape()`
`void`	`endShape(int mode)`
`void`	`fill(float gray)`
`void`	`fill(float gray, float alpha)`
`void`	`fill(float x, float y, float z)`
`void`	`fill(float x, float y, float z, float a)`
`void`	`fill(int rgb)`
`void`	`fill(int rgb, float alpha)`
`PShape`	`findChild(java.lang.String target)` Same as getChild(name), except that it first walks all the way up the hierarchy to the eldest grandparent, so that children can be found anywhere.
`int`	`getAmbient(int index)`
`PShape`	`getChild(int index)` ( begin auto-generated from PShape_getChild.xml ) Extracts a child shape from a parent shape.
`PShape`	`getChild(java.lang.String target)`
`int`	`getChildCount()`
`int`	`getChildIndex(PShape who)` Returns the index of child who.
`PShape[]`	`getChildren()`
`float`	`getDepth()` Get the depth of the shape area (not necessarily the shape boundary).
`int`	`getEmissive(int index)`
`int`	`getFamily()` The shape type, one of GROUP, PRIMITIVE, PATH, or GEOMETRY.
`int`	`getFill(int index)`
`float`	`getHeight()` Get the height of the drawing area (not necessarily the shape boundary).
`int`	`getKind()`
`java.lang.String`	`getName()`
`PVector`	`getNormal(int index)`
`PVector`	`getNormal(int index, PVector vec)`
`float`	`getNormalX(int index)`
`float`	`getNormalY(int index)`
`float`	`getNormalZ(int index)`
`float`	`getParam(int index)`
`float[]`	`getParams()`
`float[]`	`getParams(float[] target)`
`PShape`	`getParent()`
`float`	`getShininess(int index)`
`int`	`getSpecular(int index)`
`int`	`getStroke(int index)`
`float`	`getStrokeWeight(int index)`
`PShape`	`getTessellation()`
`float`	`getTextureU(int index)`
`float`	`getTextureV(int index)`
`int`	`getTint(int index)`
`PVector`	`getVertex(int index)`
`PVector`	`getVertex(int index, PVector vec)`
`int`	`getVertexCode(int index)` One of VERTEX, BEZIER_VERTEX, CURVE_VERTEX, or BREAK.
`int`	`getVertexCodeCount()`
`int[]`	`getVertexCodes()`
`int`	`getVertexCount()`
`float`	`getVertexX(int index)`
`float`	`getVertexY(int index)`
`float`	`getVertexZ(int index)`
`float`	`getWidth()` Get the width of the drawing area (not necessarily the shape boundary).
`boolean`	`is2D()` Return true if this shape is 2D.
`boolean`	`is3D()` Return true if this shape is 3D.
`boolean`	`isClosed()`
`boolean`	`isVisible()` ( begin auto-generated from PShape_isVisible.xml ) Returns a boolean value "true" if the image is set to be visible, "false" if not.
`void`	`noFill()`
`void`	`normal(float nx, float ny, float nz)`
`void`	`noStroke()`
`void`	`noTexture()`
`void`	`noTint()`
`void`	`quadraticVertex(float cx, float cy, float x3, float y3)`
`void`	`quadraticVertex(float cx, float cy, float cz, float x3, float y3, float z3)`
`void`	`removeChild(int idx)` Remove the child shape with index idx.
`void`	`resetMatrix()` ( begin auto-generated from PShape_resetMatrix.xml ) Replaces the current matrix of a shape with the identity matrix.
`void`	`rotate(float angle)` ( begin auto-generated from PShape_rotate.xml ) Rotates a shape the amount specified by the angle parameter.
`void`	`rotate(float angle, float v0, float v1, float v2)`
`void`	`rotateX(float angle)` ( begin auto-generated from PShape_rotateX.xml ) Rotates a shape around the x-axis the amount specified by the angle parameter.
`void`	`rotateY(float angle)` ( begin auto-generated from PShape_rotateY.xml ) Rotates a shape around the y-axis the amount specified by the angle parameter.
`void`	`rotateZ(float angle)` ( begin auto-generated from PShape_rotateZ.xml ) Rotates a shape around the z-axis the amount specified by the angle parameter.
`void`	`scale(float s)` ( begin auto-generated from PShape_scale.xml ) Increases or decreases the size of a shape by expanding and contracting vertices.
`void`	`scale(float x, float y)`
`void`	`scale(float x, float y, float z)`
`void`	`set3D(boolean val)`
`void`	`setAmbient(int ambient)`
`void`	`setAmbient(int index, int ambient)`
`void`	`setAttrib(java.lang.String name, int index, boolean... values)`
`void`	`setAttrib(java.lang.String name, int index, float... values)`
`void`	`setAttrib(java.lang.String name, int index, int... values)`
`void`	`setEmissive(int emissive)`
`void`	`setEmissive(int index, int emissive)`
`void`	`setFamily(int family)`
`void`	`setFill(boolean fill)`
`void`	`setFill(int fill)` ( begin auto-generated from PShape_setFill.xml ) The setFill() method defines the fill color of a PShape.
`void`	`setFill(int index, int fill)`
`void`	`setKind(int kind)`
`void`	`setName(java.lang.String name)`
`void`	`setNormal(int index, float nx, float ny, float nz)`
`void`	`setPath(int vcount, float[][] verts)`
`void`	`setShininess(float shine)`
`void`	`setShininess(int index, float shine)`
`void`	`setSpecular(int specular)`
`void`	`setSpecular(int index, int specular)`
`void`	`setStroke(boolean stroke)`
`void`	`setStroke(int stroke)` ( begin auto-generated from PShape_setStroke.xml ) The setStroke() method defines the outline color of a PShape.
`void`	`setStroke(int index, int stroke)`
`void`	`setStrokeCap(int cap)`
`void`	`setStrokeJoin(int join)`
`void`	`setStrokeWeight(float weight)`
`void`	`setStrokeWeight(int index, float weight)`
`void`	`setTexture(PImage tex)`
`void`	`setTextureMode(int mode)`
`void`	`setTextureUV(int index, float u, float v)`
`void`	`setTint(boolean tint)`
`void`	`setTint(int fill)`
`void`	`setTint(int index, int tint)`
`void`	`setVertex(int index, float x, float y)`
`void`	`setVertex(int index, float x, float y, float z)`
`void`	`setVertex(int index, PVector vec)`
`void`	`setVisible(boolean visible)` ( begin auto-generated from PShape_setVisible.xml ) Sets the shape to be visible or invisible.
`void`	`shininess(float shine)`
`void`	`specular(float gray)`
`void`	`specular(float x, float y, float z)`
`void`	`specular(int rgb)`
`void`	`stroke(float gray)`
`void`	`stroke(float gray, float alpha)`
`void`	`stroke(float x, float y, float z)`
`void`	`stroke(float x, float y, float z, float alpha)`
`void`	`stroke(int rgb)`
`void`	`stroke(int rgb, float alpha)`
`void`	`strokeCap(int cap)`
`void`	`strokeJoin(int join)`
`void`	`strokeWeight(float weight)`
`void`	`texture(PImage tex)`
`void`	`textureMode(int mode)`
`void`	`tint(float gray)`
`void`	`tint(float gray, float alpha)`
`void`	`tint(float x, float y, float z)`
`void`	`tint(float x, float y, float z, float alpha)`
`void`	`tint(int rgb)`
`void`	`tint(int rgb, float alpha)`
`void`	`translate(float x, float y)` ( begin auto-generated from PShape_translate.xml ) Specifies an amount to displace the shape.
`void`	`translate(float x, float y, float z)`
`void`	`vertex(float x, float y)`
`void`	`vertex(float x, float y, float z)`
`void`	`vertex(float x, float y, float u, float v)`
`void`	`vertex(float x, float y, float z, float u, float v)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRIMITIVE
```
public static final int PRIMITIVE
```
    A line, ellipse, arc, image, etc.
    
    See Also:
    
    Constant Field Values
  - PATH
```
public static final int PATH
```
    A series of vertex, curveVertex, and bezierVertex calls.
    
    See Also:
    
    Constant Field Values
  - GEOMETRY
```
public static final int GEOMETRY
```
    Collections of vertices created with beginShape().
    
    See Also:
    
    Constant Field Values
  - OUTSIDE_BEGIN_END_ERROR
```
public static final java.lang.String OUTSIDE_BEGIN_END_ERROR
```
    See Also:
    
    Constant Field Values
  - INSIDE_BEGIN_END_ERROR
```
public static final java.lang.String INSIDE_BEGIN_END_ERROR
```
    See Also:
    
    Constant Field Values
  - NO_SUCH_VERTEX_ERROR
```
public static final java.lang.String NO_SUCH_VERTEX_ERROR
```
    See Also:
    
    Constant Field Values
  - NO_VERTICES_ERROR
```
public static final java.lang.String NO_VERTICES_ERROR
```
    See Also:
    
    Constant Field Values
  - NOT_A_SIMPLE_VERTEX
```
public static final java.lang.String NOT_A_SIMPLE_VERTEX
```
    See Also:
    
    Constant Field Values
  - PER_VERTEX_UNSUPPORTED
```
public static final java.lang.String PER_VERTEX_UNSUPPORTED
```
    See Also:
    
    Constant Field Values
  - width
```
public float width
```
    ( begin auto-generated from PShape_width.xml ) The width of the PShape document. ( end auto-generated )
    
    See Also:
    
    height
    
    In brief:
    
    Shape document width
    
    Usage:
    
    web_application
  - height
```
public float height
```
    ( begin auto-generated from PShape_height.xml ) The height of the PShape document. ( end auto-generated )
    
    See Also:
    
    width
    
    In brief:
    
    Shape document height
    
    Usage:
    
    web_application
  - depth
```
public float depth
```
  - colorMode
```
public int colorMode
```
    The current colorMode
  - colorModeX
```
public float colorModeX
```
    Max value for red (or hue) set by colorMode
  - colorModeY
```
public float colorModeY
```
    Max value for green (or saturation) set by colorMode
  - colorModeZ
```
public float colorModeZ
```
    Max value for blue (or value) set by colorMode
  - colorModeA
```
public float colorModeA
```
    Max value for alpha set by colorMode
- Constructor Detail
  - PShape
```
public PShape()
```
  - PShape
```
public PShape(int family)
```
  - PShape
```
public PShape(PGraphics g,
              int family)
```
  - PShape
```
public PShape(PGraphics g,
              int kind,
              float... params)
```
- Method Detail
  - setFamily
```
public void setFamily(int family)
```
  - setKind
```
public void setKind(int kind)
```
  - setName
```
public void setName(java.lang.String name)
```
  - getName
```
public java.lang.String getName()
```
  - isVisible
```
public boolean isVisible()
```
    ( 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 setVisible() parameter.
    
    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 )
    
    See Also:
    
    setVisible(boolean)
    
    In brief:
    
    Returns a boolean value "true" if the image is set to be visible, "false" if not
    
    Usage:
    
    web_application
  - setVisible
```
public void setVisible(boolean visible)
```
    ( begin auto-generated from PShape_setVisible.xml ) Sets the shape to be visible or invisible. This is determined by the value of the visible parameter.
    
    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 )
    
    Parameters:
    
    visible - "false" makes the shape invisible and "true" makes it visible
    
    See Also:
    
    isVisible()
    
    In brief:
    
    Sets the shape to be visible or invisible
    
    Usage:
    
    web_application
  - disableStyle
```
public void disableStyle()
```
    ( 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 )
    Advanced
    Overrides this shape's style information and uses PGraphics styles and colors. Identical to ignoreStyles(true). Also disables styles for all child shapes.
    
    See Also:
    
    enableStyle()
    
    In brief:
    
    Disables the shape's style data and uses Processing styles
    
    Usage:
    
    web_application
  - enableStyle
```
public void enableStyle()
```
    ( 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 )
    
    See Also:
    
    disableStyle()
    
    In brief:
    
    Enables the shape's style data and ignores the Processing styles
    
    Usage:
    
    web_application
  - getWidth
```
public float getWidth()
```
    Get the width of the drawing area (not necessarily the shape boundary).
  - getHeight
```
public float getHeight()
```
    Get the height of the drawing area (not necessarily the shape boundary).
  - getDepth
```
public float getDepth()
```
    Get the depth of the shape area (not necessarily the shape boundary). Only makes sense for 3D PShape subclasses, such as PShape3D.
  - is2D
```
public boolean is2D()
```
    Return true if this shape is 2D. Defaults to true.
  - is3D
```
public boolean is3D()
```
    Return true if this shape is 3D. Defaults to false.
  - set3D
```
public void set3D(boolean val)
```
  - textureMode
```
public void textureMode(int mode)
```
  - texture
```
public void texture(PImage tex)
```
  - noTexture
```
public void noTexture()
```
  - beginContour
```
public void beginContour()
```
    See Also:
    
    endContour()
    
    In brief:
    
    Starts a new contour
  - endContour
```
public void endContour()
```
    See Also:
    
    beginContour()
    
    In brief:
    
    Ends a contour
  - vertex
```
public void vertex(float x,
                   float y)
```
  - vertex
```
public void vertex(float x,
                   float y,
                   float u,
                   float v)
```
  - vertex
```
public void vertex(float x,
                   float y,
                   float z)
```
  - vertex
```
public void vertex(float x,
                   float y,
                   float z,
                   float u,
                   float v)
```
  - normal
```
public void normal(float nx,
                   float ny,
                   float nz)
```
  - attribPosition
```
public void attribPosition(java.lang.String name,
                           float x,
                           float y,
                           float z)
```
  - attribNormal
```
public void attribNormal(java.lang.String name,
                         float nx,
                         float ny,
                         float nz)
```
  - attribColor
```
public void attribColor(java.lang.String name,
                        int color)
```
  - attrib
```
public void attrib(java.lang.String name,
                   float... values)
```
  - attrib
```
public void attrib(java.lang.String name,
                   int... values)
```
  - attrib
```
public void attrib(java.lang.String name,
                   boolean... values)
```
  - beginShape
```
public void beginShape()
```
    See Also:
    
    PApplet.endShape()
    
    In brief:
    
    Starts the creation of a new PShape
  - beginShape
```
public void beginShape(int kind)
```
  - endShape
```
public void endShape()
```
    See Also:
    
    PApplet.beginShape()
    
    In brief:
    
    Finishes the creation of a new PShape
  - endShape
```
public void endShape(int mode)
```
  - strokeWeight
```
public void strokeWeight(float weight)
```
  - strokeJoin
```
public void strokeJoin(int join)
```
  - strokeCap
```
public void strokeCap(int cap)
```
  - noFill
```
public void noFill()
```
  - fill
```
public void fill(int rgb)
```
  - fill
```
public void fill(int rgb,
                 float alpha)
```
  - fill
```
public void fill(float gray)
```
  - fill
```
public void fill(float gray,
                 float alpha)
```
  - fill
```
public void fill(float x,
                 float y,
                 float z)
```
  - fill
```
public void fill(float x,
                 float y,
                 float z,
                 float a)
```
  - noStroke
```
public void noStroke()
```
  - stroke
```
public void stroke(int rgb)
```
  - stroke
```
public void stroke(int rgb,
                   float alpha)
```
  - stroke
```
public void stroke(float gray)
```
  - stroke
```
public void stroke(float gray,
                   float alpha)
```
  - stroke
```
public void stroke(float x,
                   float y,
                   float z)
```
  - stroke
```
public void stroke(float x,
                   float y,
                   float z,
                   float alpha)
```
  - noTint
```
public void noTint()
```
  - tint
```
public void tint(int rgb)
```
  - tint
```
public void tint(int rgb,
                 float alpha)
```
  - tint
```
public void tint(float gray)
```
  - tint
```
public void tint(float gray,
                 float alpha)
```
  - tint
```
public void tint(float x,
                 float y,
                 float z)
```
  - tint
```
public void tint(float x,
                 float y,
                 float z,
                 float alpha)
```
  - ambient
```
public void ambient(int rgb)
```
  - ambient
```
public void ambient(float gray)
```
  - ambient
```
public void ambient(float x,
                    float y,
                    float z)
```
  - specular
```
public void specular(int rgb)
```
  - specular
```
public void specular(float gray)
```
  - specular
```
public void specular(float x,
                     float y,
                     float z)
```
  - emissive
```
public void emissive(int rgb)
```
  - emissive
```
public void emissive(float gray)
```
  - emissive
```
public void emissive(float x,
                     float y,
                     float z)
```
  - shininess
```
public void shininess(float shine)
```
  - bezierDetail
```
public void bezierDetail(int detail)
```
  - bezierVertex
```
public void bezierVertex(float x2,
                         float y2,
                         float x3,
                         float y3,
                         float x4,
                         float y4)
```
  - bezierVertex
```
public void bezierVertex(float x2,
                         float y2,
                         float z2,
                         float x3,
                         float y3,
                         float z3,
                         float x4,
                         float y4,
                         float z4)
```
  - quadraticVertex
```
public void quadraticVertex(float cx,
                            float cy,
                            float x3,
                            float y3)
```
  - quadraticVertex
```
public void quadraticVertex(float cx,
                            float cy,
                            float cz,
                            float x3,
                            float y3,
                            float z3)
```
  - curveDetail
```
public void curveDetail(int detail)
```
  - curveTightness
```
public void curveTightness(float tightness)
```
  - curveVertex
```
public void curveVertex(float x,
                        float y)
```
  - curveVertex
```
public void curveVertex(float x,
                        float y,
                        float z)
```
  - draw
```
public void draw(PGraphics g)
```
    Called by the following (the shape() command adds the g) PShape s = loadShape("blah.svg"); shape(s);
  - getParent
```
public PShape getParent()
```
  - getChildCount
```
public int getChildCount()
```
    In brief:
    
    Returns the number of children
  - getChildren
```
public PShape[] getChildren()
```
  - getChild
```
public PShape getChild(int index)
```
    ( begin auto-generated from PShape_getChild.xml ) Extracts a child shape from a parent shape. Specify the name of the shape with the target parameter. The shape is returned as a PShape object, or null is returned if there is an error. ( end auto-generated )
    
    Parameters:
    
    index - the layer position of the shape to get
    
    See Also:
    
    addChild(PShape)
    
    In brief:
    
    Returns a child element of a shape as a PShape object
    
    Usage:
    
    web_application
  - getChild
```
public PShape getChild(java.lang.String target)
```
    Parameters:
    
    target - the name of the shape to get
  - findChild
```
public PShape findChild(java.lang.String target)
```
    Same as getChild(name), except that it first walks all the way up the hierarchy to the eldest grandparent, so that children can be found anywhere.
  - addChild
```
public void addChild(PShape who)
```
    Parameters:
    
    who - any variable of type PShape
    
    See Also:
    
    getChild(int)
    
    In brief:
    
    Adds a new child
  - addChild
```
public void addChild(PShape who,
                     int idx)
```
    Parameters:
    
    idx - the layer position in which to insert the new child
  - removeChild
```
public void removeChild(int idx)
```
    Remove the child shape with index idx.
  - addName
```
public void addName(java.lang.String nom,
                    PShape shape)
```
    Add a shape to the name lookup table.
  - getChildIndex
```
public int getChildIndex(PShape who)
```
    Returns the index of child who.
  - getTessellation
```
public PShape getTessellation()
```
  - getFamily
```
public int getFamily()
```
    The shape type, one of GROUP, PRIMITIVE, PATH, or GEOMETRY.
  - getKind
```
public int getKind()
```
  - getParams
```
public float[] getParams()
```
  - getParams
```
public float[] getParams(float[] target)
```
  - getParam
```
public float getParam(int index)
```
  - setPath
```
public void setPath(int vcount,
                    float[][] verts)
```
  - getVertexCount
```
public int getVertexCount()
```
    See Also:
    
    getVertex(int), setVertex(int, float, float)
    
    In brief:
    
    Returns the total number of vertices as an int
  - getVertex
```
public PVector getVertex(int index)
```
    Parameters:
    
    index - the location of the vertex
    
    See Also:
    
    setVertex(int, float, float), getVertexCount()
    
    In brief:
    
    Returns the vertex at the index position
  - getVertex
```
public PVector getVertex(int index,
                         PVector vec)
```
    Parameters:
    
    vec - PVector to assign the data to
  - getVertexX
```
public float getVertexX(int index)
```
  - getVertexY
```
public float getVertexY(int index)
```
  - getVertexZ
```
public float getVertexZ(int index)
```
  - setVertex
```
public void setVertex(int index,
                      float x,
                      float y)
```
    Parameters:
    
    index - the location of the vertex
    
    x - the x value for the vertex
    
    y - the y value for the vertex
    
    See Also:
    
    getVertex(int), getVertexCount()
    
    In brief:
    
    Sets the vertex at the index position
  - setVertex
```
public void setVertex(int index,
                      float x,
                      float y,
                      float z)
```
    Parameters:
    
    z - the z value for the vertex
  - setVertex
```
public void setVertex(int index,
                      PVector vec)
```
    Parameters:
    
    vec - the PVector to define the x, y, z coordinates
  - getNormal
```
public PVector getNormal(int index)
```
  - getNormal
```
public PVector getNormal(int index,
                         PVector vec)
```
  - getNormalX
```
public float getNormalX(int index)
```
  - getNormalY
```
public float getNormalY(int index)
```
  - getNormalZ
```
public float getNormalZ(int index)
```
  - setNormal
```
public void setNormal(int index,
                      float nx,
                      float ny,
                      float nz)
```
  - setAttrib
```
public void setAttrib(java.lang.String name,
                      int index,
                      float... values)
```
  - setAttrib
```
public void setAttrib(java.lang.String name,
                      int index,
                      int... values)
```
  - setAttrib
```
public void setAttrib(java.lang.String name,
                      int index,
                      boolean... values)
```
  - getTextureU
```
public float getTextureU(int index)
```
  - getTextureV
```
public float getTextureV(int index)
```
  - setTextureUV
```
public void setTextureUV(int index,
                         float u,
                         float v)
```
  - setTextureMode
```
public void setTextureMode(int mode)
```
  - setTexture
```
public void setTexture(PImage tex)
```
  - getFill
```
public int getFill(int index)
```
  - setFill
```
public void setFill(boolean fill)
```
  - setFill
```
public void setFill(int fill)
```
    ( begin auto-generated from PShape_setFill.xml ) The setFill() method defines the fill color of a PShape. This method is used after shapes are created or when a shape is defined explicitly (e.g. createShape(RECT, 20, 20, 80, 80)) as shown in the above example. When a shape is created with beginShape() and endShape(), its attributes may be changed with fill() and stroke() within beginShape() and endShape(). However, after the shape is created, only the setFill() method can define a new fill value for the PShape. ( end auto-generated )
    
    Parameters:
    
    fill -
    
    In brief:
    
    Set the fill value
  - setFill
```
public void setFill(int index,
                    int fill)
```
  - getTint
```
public int getTint(int index)
```
  - setTint
```
public void setTint(boolean tint)
```
  - setTint
```
public void setTint(int fill)
```
  - setTint
```
public void setTint(int index,
                    int tint)
```
  - getStroke
```
public int getStroke(int index)
```
  - setStroke
```
public void setStroke(boolean stroke)
```
  - setStroke
```
public void setStroke(int stroke)
```
    ( begin auto-generated from PShape_setStroke.xml ) The setStroke() method defines the outline color of a PShape. This method is used after shapes are created or when a shape is defined explicitly (e.g. createShape(RECT, 20, 20, 80, 80)) as shown in the above example. When a shape is created with beginShape() and endShape(), its attributes may be changed with fill() and stroke() within beginShape() and endShape(). However, after the shape is created, only the setStroke() method can define a new stroke value for the PShape. ( end auto-generated )
    
    Parameters:
    
    stroke -
    
    In brief:
    
    Set the stroke value
  - setStroke
```
public void setStroke(int index,
                      int stroke)
```
  - getStrokeWeight
```
public float getStrokeWeight(int index)
```
  - setStrokeWeight
```
public void setStrokeWeight(float weight)
```
  - setStrokeWeight
```
public void setStrokeWeight(int index,
                            float weight)
```
  - setStrokeJoin
```
public void setStrokeJoin(int join)
```
  - setStrokeCap
```
public void setStrokeCap(int cap)
```
  - getAmbient
```
public int getAmbient(int index)
```
  - setAmbient
```
public void setAmbient(int ambient)
```
  - setAmbient
```
public void setAmbient(int index,
                       int ambient)
```
  - getSpecular
```
public int getSpecular(int index)
```
  - setSpecular
```
public void setSpecular(int specular)
```
  - setSpecular
```
public void setSpecular(int index,
                        int specular)
```
  - getEmissive
```
public int getEmissive(int index)
```
  - setEmissive
```
public void setEmissive(int emissive)
```
  - setEmissive
```
public void setEmissive(int index,
                        int emissive)
```
  - getShininess
```
public float getShininess(int index)
```
  - setShininess
```
public void setShininess(float shine)
```
  - setShininess
```
public void setShininess(int index,
                         float shine)
```
  - getVertexCodes
```
public int[] getVertexCodes()
```
  - getVertexCodeCount
```
public int getVertexCodeCount()
```
  - getVertexCode
```
public int getVertexCode(int index)
```
    One of VERTEX, BEZIER_VERTEX, CURVE_VERTEX, or BREAK.
  - isClosed
```
public boolean isClosed()
```
  - contains
```
public boolean contains(float x,
                        float y)
```
    Return true if this x, y coordinate is part of this shape. Only works with PATH shapes or GROUP shapes that contain other GROUPs or PATHs.
  - translate
```
public void translate(float x,
                      float y)
```
    ( begin auto-generated from PShape_translate.xml ) Specifies an amount to displace the shape. The x parameter specifies left/right translation, the y parameter specifies up/down translation, and the z parameter specifies translations toward/away from the screen. Subsequent calls to the method accumulates the effect. For example, calling translate(50, 0) and then translate(20, 0) is the same as translate(70, 0). This transformation is applied directly to the shape, it's not refreshed each time draw() is run.
    
    Using this method with the z parameter requires using the P3D parameter in combination with size. ( end auto-generated )
    
    Parameters:
    
    x - left/right translation
    
    y - up/down translation
    
    See Also:
    
    rotate(float), scale(float), resetMatrix()
    
    In brief:
    
    Displaces the shape
    
    Usage:
    
    web_application
  - translate
```
public void translate(float x,
                      float y,
                      float z)
```
    Parameters:
    
    z - forward/back translation
  - rotateX
```
public void rotateX(float angle)
```
    ( begin auto-generated from PShape_rotateX.xml ) Rotates a shape around the x-axis the amount specified by the angle parameter. Angles should be specified in radians (values from 0 to TWO_PI) or converted to radians with the radians() method.
    
    Shapes are always rotated around the upper-left corner of their bounding box. Positive numbers rotate objects in a clockwise direction. Subsequent calls to the method accumulates the effect. For example, calling rotateX(HALF_PI) and then rotateX(HALF_PI) is the same as rotateX(PI). This transformation is applied directly to the shape, it's not refreshed each time draw() is run.
    
    This method requires a 3D renderer. You need to use P3D as a third parameter for the size() function as shown in the example above. ( end auto-generated )
    
    Parameters:
    
    angle - angle of rotation specified in radians
    
    See Also:
    
    rotate(float), rotateY(float), rotateZ(float), scale(float), translate(float, float), resetMatrix()
    
    In brief:
    
    Rotates the shape around the x-axis
    
    Usage:
    
    web_application
  - rotateY
```
public void rotateY(float angle)
```
    ( begin auto-generated from PShape_rotateY.xml ) Rotates a shape around the y-axis the amount specified by the angle parameter. Angles should be specified in radians (values from 0 to TWO_PI) or converted to radians with the radians() method.
    
    Shapes are always rotated around the upper-left corner of their bounding box. Positive numbers rotate objects in a clockwise direction. Subsequent calls to the method accumulates the effect. For example, calling rotateY(HALF_PI) and then rotateY(HALF_PI) is the same as rotateY(PI). This transformation is applied directly to the shape, it's not refreshed each time draw() is run.
    
    This method requires a 3D renderer. You need to use P3D as a third parameter for the size() function as shown in the example above. ( end auto-generated )
    
    Parameters:
    
    angle - angle of rotation specified in radians
    
    See Also:
    
    rotate(float), rotateX(float), rotateZ(float), scale(float), translate(float, float), resetMatrix()
    
    In brief:
    
    Rotates the shape around the y-axis
    
    Usage:
    
    web_application
  - rotateZ
```
public void rotateZ(float angle)
```
    ( begin auto-generated from PShape_rotateZ.xml ) Rotates a shape around the z-axis the amount specified by the angle parameter. Angles should be specified in radians (values from 0 to TWO_PI) or converted to radians with the radians() method.
    
    Shapes are always rotated around the upper-left corner of their bounding box. Positive numbers rotate objects in a clockwise direction. Subsequent calls to the method accumulates the effect. For example, calling rotateZ(HALF_PI) and then rotateZ(HALF_PI) is the same as rotateZ(PI). This transformation is applied directly to the shape, it's not refreshed each time draw() is run.
    
    This method requires a 3D renderer. You need to use P3D as a third parameter for the size() function as shown in the example above. ( end auto-generated )
    
    Parameters:
    
    angle - angle of rotation specified in radians
    
    See Also:
    
    rotate(float), rotateX(float), rotateY(float), scale(float), translate(float, float), resetMatrix()
    
    In brief:
    
    Rotates the shape around the z-axis
    
    Usage:
    
    web_application
  - rotate
```
public void rotate(float angle)
```
    ( begin auto-generated from PShape_rotate.xml ) Rotates a shape the amount specified by the angle parameter. Angles should be specified in radians (values from 0 to TWO_PI) or converted to radians with the radians() method.
    
    Shapes are always rotated around the upper-left corner of their bounding box. Positive numbers rotate objects in a clockwise direction. Transformations apply to everything that happens after and subsequent calls to the method accumulates the effect. For example, calling rotate(HALF_PI) and then rotate(HALF_PI) is the same as rotate(PI). This transformation is applied directly to the shape, it's not refreshed each time draw() is run. ( end auto-generated )
    
    Parameters:
    
    angle - angle of rotation specified in radians
    
    See Also:
    
    rotateX(float), rotateY(float), rotateZ(float), scale(float), translate(float, float), resetMatrix()
    
    In brief:
    
    Rotates the shape
    
    Usage:
    
    web_application
  - rotate
```
public void rotate(float angle,
                   float v0,
                   float v1,
                   float v2)
```
  - scale
```
public void scale(float s)
```
    ( begin auto-generated from PShape_scale.xml ) Increases or decreases the size of a shape by expanding and contracting vertices. Shapes always scale from the relative origin of their bounding box. Scale values are specified as decimal percentages. For example, the method call scale(2.0) increases the dimension of a shape by 200%. Subsequent calls to the method multiply the effect. For example, calling scale(2.0) and then scale(1.5) is the same as scale(3.0). This transformation is applied directly to the shape, it's not refreshed each time draw() is run.
    
    Using this method with the z parameter requires using the P3D parameter in combination with size. ( end auto-generated )
    
    Parameters:
    
    s - percentate to scale the object
    
    See Also:
    
    rotate(float), translate(float, float), resetMatrix()
    
    In brief:
    
    Increases and decreases the size of a shape
    
    Usage:
    
    web_application
  - scale
```
public void scale(float x,
                  float y)
```
  - scale
```
public void scale(float x,
                  float y,
                  float z)
```
    Parameters:
    
    x - percentage to scale the object in the x-axis
    
    y - percentage to scale the object in the y-axis
    
    z - percentage to scale the object in the z-axis
  - resetMatrix
```
public void resetMatrix()
```
    ( begin auto-generated from PShape_resetMatrix.xml ) Replaces the current matrix of a shape with the identity matrix. The equivalent function in OpenGL is glLoadIdentity(). ( end auto-generated )
    
    See Also:
    
    rotate(float), scale(float), translate(float, float)
    
    In brief:
    
    Replaces the current matrix of a shape with the identity matrix
    
    Usage:
    
    web_application
  - applyMatrix
```
public void applyMatrix(PMatrix source)
```
  - applyMatrix
```
public void applyMatrix(PMatrix2D source)
```
  - applyMatrix
```
public void applyMatrix(float n00,
                        float n01,
                        float n02,
                        float n10,
                        float n11,
                        float n12)
```
  - applyMatrix
```
public void applyMatrix(PMatrix3D source)
```
  - applyMatrix
```
public void applyMatrix(float n00,
                        float n01,
                        float n02,
                        float n03,
                        float n10,
                        float n11,
                        float n12,
                        float n13,
                        float n20,
                        float n21,
                        float n22,
                        float n23,
                        float n30,
                        float n31,
                        float n32,
                        float n33)
```
  - colorMode
```
public void colorMode(int mode)
```
    Set the pivot point for all transformations.
  - colorMode
```
public void colorMode(int mode,
                      float max)
```
    Parameters:
    
    max - range for all color elements
  - colorMode
```
public void colorMode(int mode,
                      float maxX,
                      float maxY,
                      float maxZ)
```
    Parameters:
    
    maxX - range for the red or hue depending on the current color mode
    
    maxY - range for the green or saturation depending on the current color mode
    
    maxZ - range for the blue or brightness depending on the current color mode
  - colorMode
```
public void colorMode(int mode,
                      float maxX,
                      float maxY,
                      float maxZ,
                      float maxA)
```
    Parameters:
    
    maxA - range for the alpha

Class PShape

Advanced

Field Summary

Fields inherited from interface processing.core.PConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIMITIVE

PATH

GEOMETRY

OUTSIDE_BEGIN_END_ERROR

INSIDE_BEGIN_END_ERROR

NO_SUCH_VERTEX_ERROR

NO_VERTICES_ERROR

NOT_A_SIMPLE_VERTEX

PER_VERTEX_UNSUPPORTED

width

height

depth

colorMode

colorModeX

colorModeY

colorModeZ

colorModeA

Constructor Detail

PShape

PShape

PShape

PShape

Method Detail

setFamily

setKind

setName

getName

isVisible

setVisible

disableStyle

Advanced

enableStyle

getWidth

getHeight

getDepth

is2D

is3D

set3D

textureMode

texture

noTexture

beginContour

endContour

vertex

vertex

vertex

vertex

normal

attribPosition

attribNormal

attribColor

attrib

attrib

attrib

beginShape

beginShape

endShape

endShape

strokeWeight

strokeJoin

strokeCap

noFill

fill

fill

fill

fill

fill

fill

noStroke

stroke

stroke

stroke