Table of Contents

Packages

• SugTransform:: Sets the transformation matrix

Classes

• SugColor This class represents the a color in the sugar enviornment
• SugDefsElement SugDefsElement is a container element that holds all elements in the definition segment of the svg file
• SugDocument This is the class to represent SVGDocument.
• SugElement SugElement is really the current heart of libsugar.
• SugGroupElement SugDefsElement is a container element that holds all elements in the definition segment of the svg file
• SugLength The class responsible for length and unit conversion.
• SugMatrix The matrix manipulation class.
• SugNode Currently just serves its purpose as SugElement's parent, this is a direct translation of the XML IDL.
• SugPathElement The control class for SVGPath elements.
• SugPathSeg This is the base class of all path segments
• SugPathSegArc The class represents the A,a path command
• SugPathSegCurvetoCubic The class represents the C,c path command
• SugPathSegCurvetoCubicSmooth The class represents the S,s path command
• SugPathSegCurvetoQuadratic The class represents the Q,q path command
• SugPoint This class represents the SVGPoint from the SVG IDL.
• SugPolygonElement The subclass of SugElement responsible for representing SVGPolygon
• SugPolylineElement The subclass of SugElement responsible for representing SVGPolygon
• SugRectElement The subclass of SugElement responsible for representing SVGRect
• SugSvgElement SugDefsElement is a container element that holds all elements in the definition segment of the svg file
• SugSymbolElement SugDefsElement is a container element that holds all elements in the definition segment of the svg file
• SugTextElement The subclass of SugElement responsible for representing SVGRect
• SugTransform SugTranform stores a single transformation as given by an element's tranform attribute
• SugTypes
• SugUseElement SugDefsElement is a container element that holds all elements in the definition segment of the svg file

Functions

• SugColor::SugColor The class constructor.
• SugColor::getBlue Returns the blue variable
• SugColor::getGreen Returns the green variable
• SugColor::getRGB Stores the RGB value of this color in the three SugRealType variables
• SugColor::getRed Returns the red variable
• SugColor::operator SugRealType* Operator overloader to cast this class as a vector of floats
• SugColor::setColor Sets the x variable
• SugColor::setRGB Sets the RGB value of this color from the three SugRealType variables
• SugColor::~SugColor The class destructor
• SugDefsElement::SugDefsElement The class constructor
• SugDefsElement::~SugDefsElement The class destructor
• SugElement::SugElement The class constructor
• SugElement::addAttribute Adds an attribute and it's corresponding value to the attribute map
• SugElement::getColorAttribute Gets the specified attribute's value in color format.
• SugElement::getElementType returns the mElementType, this is later used for casting
• SugElement::getFloatAttribute Gets the specified attribute's value in float format.
• SugElement::getId Returns the id of this element.
• SugElement::getIntegerAttribute Gets the specified attribute's value in integer format.
• SugElement::getPointListAttribute Gets the specified attribute's value in point list format.
• SugElement::getStringAttribute Gets the specified attribute's value in string format.
• SugElement::getTransformListAttribute Gets the "transform" attribute's value in transform list format.
• SugElement::printAttributes Debug function that prints the names and values of all attributes
• SugElement::setElementType sets the mElementType of this class
• SugElement::~SugElement The class destructor
• SugGroupElement::SugGroupElement The class constructor
• SugGroupElement::~SugGroupElement The class destructor
• SugLength::SugLength The class constructor
• SugLength::convertToSpecifiedUnits Converts value to the new unit type
• SugLength::getUnitType Returns the unit type
• SugLength::getValue Returns the value
• SugLength::getValueAsString Returns the value as a string (unused)
• SugLength::getValueInSpecifiedUnits Returns the value in the specified units
• SugLength::newValueSpecifiedUnits Creates a new value with a given unit type
• SugLength::~SugLength The class destructor
• SugMatrix:
  • SugMatrix::SugMatrix The class constructor with helper initializations
  • SugMatrix::SugMatrix The class constructor
• SugMatrix::flipX Flips the x component of the matrix
• SugMatrix::flipY Flips the y component of the matrix
• SugMatrix::getA Returns the A element of the matrix
• SugMatrix::getB Returns the B element of the matrix
• SugMatrix::getC Returns the C element of the matrix
• SugMatrix::getD Returns the D element of the matrix
• SugMatrix::getE Returns the E element of the matrix
• SugMatrix::getF Returns the F element of the matrix
• SugMatrix::inverse Performs the inverse of a matrix
• SugMatrix::multiply Performs a multiply of two matrices
• SugMatrix::rotate Performs a rotation of the matrix
• SugMatrix::rotateFromVector Performs a rotation of the matrix with a given vector
• SugMatrix::scale Performs a scale the matrix
• SugMatrix::scaleNonUniform Performs a non-uniform scale of the matrix
• SugMatrix::setA Sets the A element of the matrix
• SugMatrix::setABCDEF Sets the A, B, C, D, E, and F elements of the matrix
• SugMatrix::setB Sets the B element of the matrix
• SugMatrix::setC Sets the C element of the matrix
• SugMatrix::setD Sets the D element of the matrix
• SugMatrix::setE Sets the E element of the matrix
• SugMatrix::setF Sets the F element of the matrix
• SugMatrix::skewX Skews the x component of the matrix
• SugMatrix::skewY Skews the y component of the matrix
• SugMatrix::translate Performs a translation of the matrix
• SugMatrix::~SugMatrix The class destructor
• SugNode::SugNode The class constructor
• SugNode::appendChild Appends a child (unused)
• SugNode::getChildNodes Return the vector of child nodes.
• SugNode::getFirstChild Returns the first child.
• SugNode::getLastChild Returns the last child.
• SugNode::getNextSibling Returns the next sibling.
• SugNode::getNodeName Returns the node name.
• SugNode::getNodeType Returns the node type.
• SugNode::getNodeValue Returns the node value.
• SugNode::getParentNode Returns the parent node.
• SugNode::getPreviousSibling Returns the previous sibling.
• SugNode::hasAttributes Returns if the node has attributes
• SugNode::hasChildNodes Returns if the node has children (unused)
• SugNode::insertBefore Inserts a child before another (unused)
• SugNode::removeChild Removes a child (unused)
• SugNode::replaceChild Replaces a child (unused)
• SugNode::setFirstChild Sets the first child.
• SugNode::setLastChild Sets the last child.
• SugNode::setNextSibling Sets the next sibling.
• SugNode::setNodeName Sets the node name.
• SugNode::setNodeType Sets the node type.
• SugNode::setNodeValue Sets the node value.
• SugNode::setParentNode Sets the parent node.
• SugNode::setPreviousSibling Sets the previus sibling.
• SugNode::~SugNode The class destructor
• SugPathElement::SugPathElement The class constructor
• SugPathElement::createSugPathSegArcAbs Factory for ArcAbs
• SugPathElement::createSugPathSegArcRel Factory for ArcRel
• SugPathElement::createSugPathSegCurvetoCubicAbs Factory for CurvetoCubicAbs
• SugPathElement::createSugPathSegCurvetoCubicRel Factory for CurvetoCubicRel
• SugPathElement::createSugPathSegCurvetoCubicSmoothAbs Factory for CurvetoCubicSmoothAbs
• SugPathElement::createSugPathSegCurvetoCubicSmoothRel Factory for CurvetoCubicSmoothRel
• SugPathElement::createSugPathSegCurvetoQuadraticAbs Factory for CurvetoQuadraticAbs
• SugPathElement::createSugPathSegCurvetoQuadraticRel Factory for CurvetoQuadraticRel
• SugPathElement::createSugPathSegCurvetoQuadraticSmoothAbs Factory for CurvetoQuadraticSmoothAbs
• SugPathElement::createSugPathSegCurvetoQuadraticSmoothRel Factory for CurvetoQuadraticSmoothRel
• SugPathElement::createSugPathSegLinetoAbs Factory for LinetoAbs
• SugPathElement::createSugPathSegLinetoHorizontalAbs Factory for LinetoHorizontalAbs
• SugPathElement::createSugPathSegLinetoHorizontalRel Factory for LinetoHorizontalRel
• SugPathElement::createSugPathSegLinetoRel Factory for LinetoRel
• SugPathElement::createSugPathSegLinetoVerticalAbs Factory for LinetoVerticalAbs
• SugPathElement::createSugPathSegLinetoVerticalRel Factory for LinetoVerticalRel
• SugPathElement::createSugPathSegMovetoAbs Factory for MovetoAbs
• SugPathElement::createSugPathSegMovetoRel Factory for MovetoRel
• SugPathElement::createSugPathSetClosePath Factory for ClosePath
• SugPathElement::getPathCommandToken Helper function for the path parsing.
• SugPathElement::getPathCommandsAttribute Gets the specified attribute's value in path command list format.
• SugPathElement::getPathLength Returns the path length
• SugPathElement::getPathSegAtLength This is from the IDL, not sure if it has a use
• SugPathElement::getPathSegList Returns the path segment list
• SugPathElement::getPointAtLength This is from the IDL, not sure if it has a use
• SugPathElement::getTotalLength This is from the IDL, not sure if it has a use
• SugPathElement::setPathSegList Sets the path segment list
• SugPathElement::~SugPathElement The class destructor
• SugPathSeg::SugPathSeg The class constructor
• SugPathSeg::getPathSegType Returns the path segment type.
• SugPathSeg::getPathSegTypeAsLetter This is from the SVG IDL and is currently unused
• SugPathSeg::getX Returns the x component
• SugPathSeg::getY Returns the y component
• SugPathSeg::setPathSegType Sets the path segment type
• SugPathSeg::setPathSetTypeAsLetter Sets the path segment type as letter member, currently unused
• SugPathSeg::setX Sets the x component
• SugPathSeg::setY Sets the y component
• SugPathSeg::~SugPathSeg The class destructor
• SugPathSegArc::SugPathSegArc The class constructor
• SugPathSegArc::getAngle Returns the angle/x-axis-rotation variable
• SugPathSegArc::getLargeArcFlag Returns the large-arc flag
• SugPathSegArc::getR1 Returns the R1/rx variable
• SugPathSegArc::getR2 Returns the R2/ry variable
• SugPathSegArc::getSweepFlag Returns the sweep flag
• SugPathSegArc::setAngle Sets the angle/x-axis-rotation variable
• SugPathSegArc::setLargeArcFlag Sets the large-arc flag
• SugPathSegArc::setR1 Sets the R1/rx variable
• SugPathSegArc::setR2 Sets the R2/ry variable
• SugPathSegArc::setSweepFlag Sets the sweep flag
• SugPathSegArc::~SugPathSegArc The class destructor
• SugPathSegCurvetoCubic::SugPathSegCurvetoCubic The class constructor
• SugPathSegCurvetoCubic::getX1 Returns the x1 variable
• SugPathSegCurvetoCubic::getX2 Returns the x2 variable
• SugPathSegCurvetoCubic::getY1 Returns the y1 variable
• SugPathSegCurvetoCubic::getY2 Returns the y2 variable
• SugPathSegCurvetoCubic::setX1 Sets the x1 variable
• SugPathSegCurvetoCubic::setX2 Sets the x2 variable
• SugPathSegCurvetoCubic::setY1 Sets the y1 variable
• SugPathSegCurvetoCubic::setY2 Sets the y2 variable
• SugPathSegCurvetoCubic::~SugPathSegCurvetoCubic The class destructor
• SugPathSegCurvetoCubicSmooth::SugPathSegCurvetoCubicSmooth The class constructor
• SugPathSegCurvetoCubicSmooth::getX2 Returns the x2 variable
• SugPathSegCurvetoCubicSmooth::getY2 Returns the y2 variable
• SugPathSegCurvetoCubicSmooth::setX2 Sets the x2 variable
• SugPathSegCurvetoCubicSmooth::setY2 Sets the y2 variable
• SugPathSegCurvetoCubicSmooth::~SugPathSegCurvetoCubicSmooth The class destructor
• SugPathSegCurvetoQuadratic::SugPathSegCurvetoQuadratic The class constructor
• SugPathSegCurvetoQuadratic::getX1 Returns the x1 variable
• SugPathSegCurvetoQuadratic::getY1 Returns the y1 variable
• SugPathSegCurvetoQuadratic::setX1 Sets the x1 variable
• SugPathSegCurvetoQuadratic::setY1 Sets the y1 variable
• SugPathSegCurvetoQuadratic::~SugPathSegCurvetoQuadratic The class destructor
• SugPoint::SugPoint The class constructor.
• SugPoint::getX Returns the x variable
• SugPoint::getY Returns the y variable
• SugPoint::setX Sets the x variable
• SugPoint::setY Sets the y variable
• SugPoint::~SugPoint The class destructor
• SugPolygonElement::SugPolygonElement The class constructor
• SugPolygonElement::getPointList Returns the vector of points
• SugPolygonElement::setPointList Sets the vector of points
• SugPolygonElement::~SugPolygonElement The class destructor
• SugPolylineElement::SugPolylineElement The class constructor
• SugPolylineElement::getPointList Returns the vector of points
• SugPolylineElement::setPointList Sets the vector of points
• SugPolylineElement::~SugPolylineElement The class destructor
• SugRectElement::SugRectElement The class constructor
• SugRectElement::getHeight Returns the height variable
• SugRectElement::getRx Returns the rx variable, unused
• SugRectElement::getRy Returns the ry variable, unused
• SugRectElement::getWidth Returns the width variable
• SugRectElement::getX Returns the x variable
• SugRectElement::getY Returns the y variable
• SugRectElement::setHeight Sets the height variable
• SugRectElement::setRx Sets the rx variable, unused
• SugRectElement::setRy Sets the ry variable, unused
• SugRectElement::setWidth Sets the width variable
• SugRectElement::setX Sets the x variable
• SugRectElement::setY Sets the y variable
• SugRectElement::~SugRectElement The class destructor
• SugSvgElement::SugSvgElement The class constructor
• SugSvgElement::~SugSvgElement The class destructor
• SugSymbolElement::SugSymbolElement The class constructor
• SugSymbolElement::~SugSymbolElement The class destructor
• SugTextElement::SugTextElement The class constructor
• SugTextElement::getText Sets the text of this element
• SugTextElement::setText Get the text of this element
• SugTextElement::~SugTextElement The class destructor
• SugTransform::SugTransform The class constructor
• SugTransform::getAngle Returns the angle value of this transform.
• SugTransform::getType Returns the type of this transform.
• SugTransform::getX Returns the X value of this transform.
• SugTransform::getY Returns the Y value of this transform.
• SugTransform::setRotate Sets the rotation angle, x and y.
• SugTransform::setScale Sets the scale x and y.
• SugTransform::setSkewX Sets the skew x angle.
• SugTransform::setSkewY Sets the skew y angle.
• SugTransform::setTransform Parses the given string and sets itself up with the correct data.
• SugTransform::setTranslate Sets the translation x and y.
• SugTransform::~SugTransform The class destructor
• SugTypes::SugTypes Empty, protected constructor.
• SugTypes::~SugTypes Empty, protected destructor.
• SugUseElement::SugUseElement The class constructor
• SugUseElement::~SugUseElement The class destructor
• parseSvgToObject

Variables

• This is a list of all path segment types from the SVG IDL::PATHSEG_ARC_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_ARC_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_CLOSEPATH
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_CUBIC_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_CUBIC_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_CUBIC_SMOOTH_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_CUBIC_SMOOTH_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_QUADRATIC_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_QUADRATIC_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_QUADRATIC_SMOOTH_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_CURVETO_QUADRATIC_SMOOTH_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_LINETO_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_LINETO_HORIZONTAL_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_LINETO_HORIZONTAL_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_LINETO_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_LINETO_VERTICAL_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_LINETO_VERTICAL_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_MOVETO_ABS
• This is a list of all path segment types from the SVG IDL::PATHSEG_MOVETO_REL
• This is a list of all path segment types from the SVG IDL::PATHSEG_UNKNOWN
• SugColor::mRGB The color value
• SugDocument::mDomain The domain tag (unused)
• SugDocument::mReferrer The referrer tag (unused)
• SugDocument::mRootElement The root tag (unused)
• SugDocument::mTitle The title tag (unused)
• SugDocument::mURL The URL tag (unused)
• SugElement::mAttributes A map containing all the attributes of this element.
• SugElement::mElementType This is the element type identifier, this is how we know what to cast our element as (see above)
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_CM
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_EMS
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_EXS
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_IN
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_MM
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_NUMBER
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_PC
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_PERCENTAGE
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_PT
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_PX
• SugLength:: An enumeration of unit types::SVG_LENGTHTYPE_UNKNOWN
• SugLength::mUnitType This unit type corresponding to the enumeration below
• SugLength::mValue The value given by the user
• SugLength::mValueAsString The value as a string (unused)
• SugLength::mValueInSpecifiedUnits The value after it has been translated to a certain unit type
• SugMatrix::mA The A element of the matrix
• SugMatrix::mB The B element of the matrix
• SugMatrix::mC The C element of the matrix
• SugMatrix::mD The D element of the matrix
• SugMatrix::mE The E element of the matrix
• SugMatrix::mF The F element of the matrix
• SugNode::mChildNodes The Node's children (currently unused)
• SugNode::mFirstChild The Node's first child (currently unused)
• SugNode::mLastChild The Node's last child (currently unused)
• SugNode::mNextSibling The Node's next sibling (currently unused)
• SugNode::mNodeName The Node's name (currently unused)
• SugNode::mNodeType The Node's type (currently unused)
• SugNode::mNodeValue The Node's value (currently unused)
• SugNode::mParentNode The Node's parent Node (currently unused)
• SugNode::mPreviousSibling The Node's previous sibling (currently unused)
• SugPathElement::mPathLength The path length
• SugPathElement::mPathSegList The actual path segments
• SugPathSeg::mPathSegTypeAsLetter This is from the SVG IDL and is currently unused
• SugPathSeg::mPathSetType This is the path segment type.
• SugPathSeg::mX All path segments at least have an x and a y.
• SugPathSeg::mY All path segments at least have an x and a y.
• SugPathSegArc::mAngle The angle or x-axis-rotation variable
• SugPathSegArc::mLargeArcFlag The large-arc flag
• SugPathSegArc::mR1 The R1 variable, also known as rx
• SugPathSegArc::mR2 The R2 variable, also known as ry
• SugPathSegArc::mSweepFlag The sweep flag
• SugPathSegCurvetoCubic::mX1 The x1 variable
• SugPathSegCurvetoCubic::mX2 The x2 variable
• SugPathSegCurvetoCubic::mY1 The y1 variable
• SugPathSegCurvetoCubic::mY2 The y2 variable
• SugPathSegCurvetoCubicSmooth::mX2 The x2 variable
• SugPathSegCurvetoCubicSmooth::mY2 The y2 variable
• SugPathSegCurvetoQuadratic::mX1 The x1 variable
• SugPathSegCurvetoQuadratic::mY1 The y1 variable
• SugPoint::mX The x location variable
• SugPoint::mY The y location variable
• SugPolygonElement::mPoints The vector that holds the points of the polygon
• SugPolylineElement::mPoints The vector that holds the points of the polygon
• SugRectElement::mHeight The height variable
• SugRectElement::mRx The rx variable (from the SVG IDL).
• SugRectElement::mRy The ry variable (from the SVG IDL).
• SugRectElement::mWidth The width variable
• SugRectElement::mX The x location variable
• SugRectElement::mY The y location variable
• SugTextElement::mText The string that this text element holds
• SugTransform::mAngle The transformation angle
• SugTransform::mType The type of transform this is
• SugTransform::mX The x value of the transform
• SugTransform::mY The y value of the transform
• SugTypes::ElementType::E_DEFS A definition element
• SugTypes::ElementType::E_G A group element
• SugTypes::ElementType::E_PATH A path element
• SugTypes::ElementType::E_POLYGON A polygon element
• SugTypes::ElementType::E_POLYLINE A polyline element
• SugTypes::ElementType::E_RECT A rectangle element
• SugTypes::ElementType::E_SVG A svg element
• SugTypes::ElementType::E_SYMBOL A symbol element
• SugTypes::ElementType::E_TEXT A text element
• SugTypes::ElementType::E_USE A use element
• SugTypes::TransformType::T_MATRIX A matrix type transform
• SugTypes::TransformType::T_ROTATE A rotate type transform
• SugTypes::TransformType::T_SCALE A scale type transform
• SugTypes::TransformType::T_SKEWX A skew x type transform
• SugTypes::TransformType::T_SKEWY A skew y type transform
• SugTypes::TransformType::T_TRANSLATE A translate type transform
• SugTypes::TransformType::T_UNKNOWN An unknown transform type

Macros

• PARSE_SVG_TO_OBJECT_H
• SUGAR_OBJECTS_H
• SUGCOLOR_H
• SUGDEFSELEMENT_H
• SUGDOCUMENT_H
• SUGELEMENT_H
• SUGGROUPELEMENT_H
• SUGLENGTH_H
• SUGMATRIX_H
• SUGNODE_H
• SUGPATHELEMENT_H
• SUGPATHSEGARC_H
• SUGPATHSEGCURVETOCUBICSMOOTH_H
• SUGPATHSEGCURVETOCUBIC_H
• SUGPATHSEGCURVETOQUADRATIC_H
• SUGPATHSEG_H
• SUGPOINT_H
• SUGPOLYGONELEMENT_H
• SUGPOLYLINEELEMENT_H
• SUGRECTELEMENT_H
• SUGSVGELEMENT_H
• SUGSYMBOLELEMENT_H
• SUGTEXTELEMENT_H
• SUGTRANSFORM_H
• SUGTYPES_H
• SUGUSEELEMENT_H
• SugRealType

Enums, Unions, Structs

• This is a list of all path segment types from the SVG IDL
• SugLength:: An enumeration of unit types
• SugTypes::ElementType
• SugTypes::TransformType

Hierarchy of classes