ofPathfile

ofPath::Commandstruct

Types

Type enum

Type

Enumerator
moveTo
lineTo
curveTo
bezierTo
quadBezierTo
arc
arcNegative
close

Attributes

type variable

Type type

to variable

ofPoint to

cp1 variable

ofPoint cp1

cp2 variable

ofPoint cp2

radiusX variable

float radiusX

radiusY variable

float radiusY

angleBegin variable

float angleBegin

angleEnd variable

float angleEnd

Functions

Command ()

Command(Type type)

for close

Command(Type type, const ofPoint &p)

for lineTo and curveTo

Command(Type type, const ofPoint &p, const ofPoint &cp1, const ofPoint &cp2)

for bezierTo

Command(Type type, const ofPoint ¢re, float radiusX, float radiusY, float angleBegin, float angleEnd)

for arc

ofPathclass

ofPath is a way to create a path or multiple paths consisting of points. It allows you to combine multiple paths consisting of points into a single vector data object that can be drawn to the screen, manipulated point by point, or manipulated with it's child subpaths. It is better at representing and manipulating complex shapes than the ofPolyline and more easily represents multiple child lines or shapes as either ofSubPath or ofPolyline instances. By default ofPath uses ofSubPath instances. Closing the path automatically creates a new path:

for( int i = 0; i < 5; i++) {
    // create a new ofSubPath
    path.arc( i * 50 + 20, i * 50 + 20, i * 40 + 10, i * 40 + 10, 0, 360); 
    path.close();
}

To use ofPolyline instances, simply set the mode to POLYLINES

path.setMode(POLYLINES);

Create and remove paths and sub paths

ofPath ()

ofPath()

Create a new ofPath instance.

clear ()

void clear()

Remove all subpaths from the ofPath instance.

newSubPath ()

void newSubPath()

Create a new subpath, either an ofPolyline instance or an ofSubPath instance. All points added after a call to ofSubPath will be done in the newly created subpath. Calling close() automatically calls create newSubPath(), ensuring that the closed path doesn't have new points added to it.

close ()

void close()

Close the current subpath and create a new subpath, either an ofPolyline or ofSubPath by calling newSubPath(), ensuring that the closed path doesn't have new points added to it.

Sub paths

lineTo ()

void lineTo(const ofPoint &p)

Draw a straight line from the current drawing position to the location indicated by p.

void lineTo(float x, float y)

Draw a straight line from the current drawing position to the location indicated by x,y.

void lineTo(float x, float y, float z)

Draw a straight line from the current drawing position to the location indicated by x,y,z.

moveTo ()

void moveTo(const ofPoint &p)

Move the drawing position to p. This means that a subsequent calls to, for instance, lineTo() or curveTo() will connect the location p to the new location.

void moveTo(float x, float y, float z=0)

Move the drawing position to x,y.z. This means that a subsequent calls to, for instance, lineTo() or curveTo() will connect the location x,y,z to the new location.

curveTo ()

void curveTo(const ofPoint &p)

Draws a curve to p from the current drawing position.

void curveTo(float x, float y)

Draws a curve to x,y from the current drawing position.

void curveTo(float x, float y, float z)

Draws a curve to x,y,z from the current drawing position.

bezierTo ()

void bezierTo(const ofPoint &cp1, const ofPoint &cp2, const ofPoint &p)

Create a cubic bezier line from the current drawing point with the 2 control points indicated by ofPoint cp1 and cp2, that ends at ofPoint to.

line.addVertex(ofPoint(200, 400));

line.bezierTo(100, 100, 800, 100, 700, 400);

The control points are shown in red.

void bezierTo(float cx1, float cy1, float cx2, float cy2, float x, float y)

Create a cubic bezier line from the current drawing point with the 2 control points indicated by the coordinates cx1, cy1 and cx2, cy2, that ends at the coordinates x, y.

void bezierTo(float cx1, float cy1, float cz1, float cx2, float cy2, float cz2, float x, float y, float z)

Create a cubic bezier line in 3D space from the current drawing point with the 2 control points indicated by the coordinates cx1, cy1, cz1 and cx2, cy2, cz2, that ends at the coordinates x, y, z.

quadBezierTo ()

void quadBezierTo(const ofPoint &cp1, const ofPoint &cp2, const ofPoint &p)

Create a quadratic bezier line in 3D space from the current drawing point with the beginning indicated by the coordinates cx1, cy1, cz1, the control point at cx2, cy2, cz2, and that ends at the coordinates x, y, z.

void quadBezierTo(float cx1, float cy1, float cx2, float cy2, float x, float y)

Creates a quadratic bezier line in 2D space from the current drawing point with the beginning indicated by the point p1, the control point at p2, and that ends at the point p3.

void quadBezierTo(float cx1, float cy1, float cz1, float cx2, float cy2, float cz2, float x, float y, float z)

Creates a quadratic bezier line in 3D space from the current drawing point with the beginning indicated by the coordinates cx1, cy1, the control point at cx2, cy2, and that ends at the coordinates x, y.

arc ()

void arc(const ofPoint ¢re, float radiusX, float radiusY, float angleBegin, float angleEnd)

Create an arc at centre, which has the radiusX, radiusY, and begins at angleBegin and ends at angleEnd. To draw a circle with a radius of 50 pixels at 100, 100:

Note: angleBegin needs to be larger than angleEnd, i.e. 0,180 is ok, while 180,0 is not.

void arc(const ofPoint ¢re, float radiusX, float radiusY, float angleBegin, float angleEnd, bool clockwise)

void arc(float x, float y, float radiusX, float radiusY, float angleBegin, float angleEnd)

Create an arc at x,y, which has the radiusX, radiusY, and begins at angleBegin and ends at angleEnd. To draws a shape with a radius of 200 pixels at 300, 300:

path.moveTo(300, 300);

path.arc( 300, 300, 200, 200, 0, 271); // note 271, not 270 for precision

Note: angleBegin needs to be larger than angleEnd, i.e. 0, 180 is ok, while 180,0 is not.

void arc(float x, float y, float z, float radiusX, float radiusY, float angleBegin, float angleEnd)

Create an arc at x,y,z, which has the radiusX, radiusY, and begins at angleBegin and ends at angleEnd.

arcNegative ()

void arcNegative(const ofPoint ¢re, float radiusX, float radiusY, float angleBegin, float angleEnd)

void arcNegative(float x, float y, float radiusX, float radiusY, float angleBegin, float angleEnd)

void arcNegative(float x, float y, float z, float radiusX, float radiusY, float angleBegin, float angleEnd)

triangle ()

void triangle(float x1, float y1, float x2, float y2, float x3, float y3)

void triangle(float x1, float y1, float z1, float x2, float y2, float z2, float x3, float y3, float z3)

void triangle(const ofPoint &p1, const ofPoint &p2, const ofPoint &p3)

circle ()

void circle(float x, float y, float radius)

void circle(float x, float y, float z, float radius)

void circle(const ofPoint &p, float radius)

ellipse ()

void ellipse(float x, float y, float width, float height)

void ellipse(float x, float y, float z, float width, float height)

void ellipse(const ofPoint &p, float width, float height)

rectangle ()

void rectangle(const ofRectangle &r)

void rectangle(const ofPoint &p, float w, float h)

void rectangle(float x, float y, float w, float h)

void rectangle(float x, float y, float z, float w, float h)

rectRounded ()

void rectRounded(const ofRectangle &b, float r)

void rectRounded(const ofPoint &p, float w, float h, float r)

void rectRounded(float x, float y, float w, float h, float r)

void rectRounded(const ofPoint &p, float w, float h, float topLeftRadius, float topRightRadius, float bottomRightRadius, float bottomLeftRadius)

void rectRounded(const ofRectangle &b, float topLeftRadius, float topRightRadius, float bottomRightRadius, float bottomLeftRadius)

void rectRounded(float x, float y, float z, float w, float h, float topLeftRadius, float topRightRadius, float bottomRightRadius, float bottomLeftRadius)

Winding Mode

setPolyWindingMode ()

void setPolyWindingMode(ofPolyWindingMode mode)

Set the way that the points in the sub paths are connected.

OpenGL can only render convex polygons which means that any shape that isn't convex, i.e. that has points which are concave, going inwards, need to be tessellated into triangles so that OpenGL can render them. If you're using filled shapes with your ofPath this is done automatically for you.

The possible options you can pass in are:

OF_POLY_WINDING_ODD
OF_POLY_WINDING_NONZERO
OF_POLY_WINDING_POSITIVE
OF_POLY_WINDING_NEGATIVE
OF_POLY_WINDING_ABS_GEQ_TWO

getWindingMode ()

ofPolyWindingMode getWindingMode() const

Get the poly winding mode currently in use.

Drawing Mode

setFilled ()

void setFilled(bool hasFill)

Set whether the path should be drawn as wireframes or filled.

setStrokeWidth ()

void setStrokeWidth(float width)

Set the stroke width of the line if the ofPath is to be drawn not in wireframe.

setColor ()

void setColor(const ofColor &color)

Set the color of the path. This affects both the line if the path is drawn as wireframe and the fill if the path is drawn with fill. All subpaths are affected.

setHexColor ()

void setHexColor(int hex)

Set the color of the path. This affects both the line if the path is drawn as wireframe and the fill if the path is drawn with fill. All subpaths are affected.

setFillColor ()

void setFillColor(const ofColor &color)

Set the fill color of the path. This has no affect if the path is drawn as wireframe.

setFillHexColor ()

void setFillHexColor(int hex)

Set the fill color of the path. This has no affect if the path is drawn as wireframe.

setStrokeColor ()

void setStrokeColor(const ofColor &color)

Set the stroke color of the path. This has no affect if the path is drawn filled.

setStrokeHexColor ()

void setStrokeHexColor(int hex)

Set the stroke color of the path. This has no affect if the path is drawn filled.

isFilled ()

bool isFilled() const

Get whether the path is using a fill or not.

The default value is true

getFillColor ()

ofColor getFillColor() const

Get the ofColor fill of the ofPath.

getStrokeColor ()

ofColor getStrokeColor() const

Get the stroke color of the ofPath.

getStrokeWidth ()

float getStrokeWidth() const

Get the stroke width of the ofPath.

The default value is `0

hasOutline ()

bool hasOutline() const

setCurveResolution ()

void setCurveResolution(int curveResolution)

getCurveResolution ()

int getCurveResolution() const

setCircleResolution ()

void setCircleResolution(int circleResolution)

getCircleResolution ()

int getCircleResolution() const

setArcResolution () Use setCircleResolution instead.

void setArcResolution(int res)

getArcResolution () Use getCircleResolution instead.

int getArcResolution()

setUseShapeColor ()

void setUseShapeColor(bool useColor)

getUseShapeColor ()

bool getUseShapeColor() const

Drawing

draw ()

void draw() const

Draws the path at 0,0. Calling draw() also calls tessellate()

void draw(float x, float y) const

Draws the path at x,y. Calling draw() also calls tessellate()

Functions

getOutline ()

ofPolyline getOutline()

Get an ofPolyline representing the outline of the ofPath.

ofPolyline getOutline() const

tessellate ()

void tessellate()

getTessellation ()

ofMesh getTessellation()

ofMesh getTessellation() const

simplify ()

void simplify(float tolerance=0.3)

flagShapeChanged ()

void flagShapeChanged()

hasChanged ()

bool hasChanged()

translate ()

void translate(const ofPoint &p)

rotate ()

void rotate(float az, const ofVec3f &axis)

scale ()

void scale(float x, float y)

Change the size of either the ofPolyline or ofSubPath instances that the ofPath contains. These changes are non-reversible, so for instance scaling by 0,0 zeros out all data.

Path Mode

Mode enum

Mode

Enumerator
COMMANDS
POLYLINES

setMode ()

void setMode(Mode mode)

getMode ()

Mode getMode()

Path Commands

getCommands ()

Command getCommands()

Command getCommands() const