Namespaces

Doc /

#include “cinder/svg/Svg.h”

Typedefs:

DocRef

Class Hierarchy:

Represents an SVG Document. See SVG Document Structure http://www.w3.org/TR/SVG/struct.html .

Public Member Functions

Doc ()
Doc (const fs::path &filePath)
Doc (DataSourceRef dataSource, const fs::path &filePath=fs::path())
int32_t

getWidth () const

Returns the width of the document in pixels.
int32_t

getHeight () const

Returns the height of the document in pixels.
ivec2

getSize () const

Returns the size of the document in pixels.
float

getAspectRatio () const

Returns the aspect ratio of the Doc (width / height)
Area

getBounds () const

Returns the bounds of the Doc (0,0,width,height)
float

getDpi () const

Returns the document's dots-per-inch. Currently hardcoded to 72.
Node *

nodeUnderPoint (const vec2 &pt)

Returns the top-most Node which contains pt . Returns NULL if no Node contains the point.
std::shared_ptr< Surface8u >

loadImage (fs::path relativePath)

Utility function to load an image relative to the document. Caches results.
const T *

find (const std::string &id) const

Recursively searches for a child element of type svg::T named id . Returns NULL on failure to find the object or if it is not of type T.
T *

find (const std::string &id)

Recursively searches for a child element of type svg::T named id . Returns NULL on failure to find the object or if it is not of type T.
const Node *

findNode (const std::string &id, bool recurse=true) const

Recursively searches for a child element named id . Returns NULL on failure.
Node *

findNode (const std::string &id, bool recurse=true)

Recursively searches for a child element named id . Returns NULL on failure.
const T *

findByIdContains (const std::string &idPartial) const

Recursively searches for a child element of type svg::T whose name contains idPartial . Returns NULL on failure to find the object or if it is not of type T.
const Node *

findNodeByIdContains (const std::string &idPartial, bool recurse=true) const

Recursively searches for a child element whose name contains idPartial . Returns NULL on failure. (null_ptr later?)
const Node *

findInAncestors (const std::string &elementId) const

Finds the node with ID elementId amongst this Node 's ancestors. Returns NULL on failure.
const Node &

getChild (const std::string &id) const

Returns a reference to the child named id . Throws svg::ExcChildNotFound if not found.
Node &

getChild (const std::string &id)

Returns a reference to the child named id . Throws svg::ExcChildNotFound if not found.
const Node &

getChild (size_t index) const

Returns a reference to the child at index . Throws svg::ExcChildNotFound if index is out of range.
Node &

getChild (size_t index)

Returns a reference to the child at index . Throws svg::ExcChildNotFound if index is out of range.
const Node &

operator/ (const std::string &id) const

Returns a reference to the child named id . Throws svg::ExcChildNotFound if not found.
Shape2d

getShape () const

Returns the merged Shape2d for all children of the group.
void

appendMergedShape2d (Shape2d *appendTo) const

Appends the merged Shape2d for the group to appentTo .
const std::list< Node * > &

getChildren () const

Returns a reference to the list of the Group 's children.
std::list< Node * > &

getChildren ()

Returns a reference to the list of the Group 's children.
void

iterate (const std::function< void(Node *)> &fn)

Recursively iterates all Nodes in Group or Doc , passing each to fn to be optionally manipulated.
class Doc *

getDoc () const

Returns the svg::Doc this Node is an element of.
const Node *

getParent () const

Returns the immediate parent of this node.
const std::string &

getId () const

Returns the ID of this Node when present.
std::string

getDomPath () const

Returns a DOM-style path to this node.
const Style &

getStyle () const

Returns the style elements defined on this Node but not inherited from ancestors.
void

setStyle (const Style &style)

Sets the style defined on this Node but not inherited from ancestors.
Style

calcInheritedStyle () const

Returns the node's Style , including attributes inherited from its ancestors for attributes it does not specify.
bool

containsPoint (const vec2 &) const

Returns whether the point pt is inside of the Node 's shape.
void

render (Renderer &renderer) const

Renders the node and its descendants.
Paint

findPaintInAncestors (const std::string &paintName) const

Finds the svg::Paint node with ID elementId amongst this Node 's ancestors. Returns a default svg::Paint instance on failure.
bool

specifiesTransform () const

Returns whether this Node specifies a transformation.
mat3

getTransform () const

Returns the local transformation of this node. Returns identity if the Node 's transform isn't specified.
void

setTransform (const mat3 &transform)

Sets the local transformation of this node.
void

unspecifyTransform ()

Removes the local transformation of this node, effectively making it the identity matrix.
mat3

getTransformInverse () const

Returns the inverse of the local transformation of this node. Returns identity if the Node 's transform isn't specified.
mat3

getTransformAbsolute () const

Returns the absolute transformation of this node, which includes inherited transformations.
mat3

getTransformAbsoluteInverse () const

Returns the inverse of the absolute transformation of this node, which includes inherited transformations.
Rectf

getBoundingBox () const

Returns the local bounding box of the Node . Calculated and cached the first time it is requested.
Rectf

getBoundingBoxAbsolute () const

Returns the absolute bounding box of the Node . Calculated and cached the first time it is requested.
Shape2d

getShapeAbsolute () const

Returns a Shape2d representing the node in absolute coordinates. Not supported for Text .
const Paint &

getFill () const

Returns node's fill, or the first among its ancestors when it has none.
const Paint &

getStroke () const

Returns node's stroke, or the first among its ancestors when it has none.
float

getOpacity () const

Returns node's opacity, or the first among its ancestors when it has none.
float

getFillOpacity () const

Returns node's fill opacity, or the first among its ancestors when it has none.
float

getStrokeOpacity () const

Returns node's stroke opacity, or the first among its ancestors when it has none.
FillRule

getFillRule () const

Returns node's fill rule, or the first among its ancestors when it has none.
LineCap

getLineCap () const

Returns node's line cap, or the first among its ancestors when it has none.
LineJoin

getLineJoin () const

Returns node's line join, or the first among its ancestors when it has none.
float

getStrokeWidth () const

Returns node's stroke width, or the first among its ancestors when it has none.
const std::vector< std::string > &

getFontFamilies () const

Returns node's font families, or the first among its ancestors when it has none.
Value

getFontSize () const

Returns node's font size, or the first among its ancestors when it has none.
bool

isVisible () const

Returns whether this Node is visible, or the first among its ancestors when unspecified.
bool

isDisplayNone () const

Returns whether the Display property of this Node is set to 'None', preventing rendering of the node and its children.

Static Public Member Functions

DocRef

create (const fs::path &filePath)
DocRef

create (DataSourceRef dataSource, const fs::path &filePath=fs::path())
DocRef

createFromSvgz (DataSourceRef dataSource, const fs::path &filePath=fs::path())

Protected Member Functions

Node *

nodeUnderPoint (const vec2 &absolutePoint, const mat3 &parentInverseMatrix) const
Shape2d

getMergedShape2d () const
Rectf

calcBoundingBox () const
bool

isDrawable () const
void

parse (const XmlTree &xml)
void

startRender (Renderer &renderer, const Style &style) const
void

finishRender (Renderer &renderer, const Style &style) const
void

parseStyle (const std::string &value)
Paint

parsePaint (const char *value, bool *specified, const Node *parentNode)
mat3

parseTransform (const std::string &value)
bool

parseTransformComponent (const char **c, mat3 *result)
std::string

findStyleValue (const std::string &styleString, const std::string &key)

Protected Attributes

std::list< Node * >

mChildren
std::shared_ptr< Group >

mDefs
Node *

mParent
std::string

mId
Style

mStyle
bool

mSpecifiesTransform
mat3

mTransform
bool

mBoundingBoxCached
Rectf

mBoundingBox

Namespaces

Classes

Modules

Guides

Reference

Doc /

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes