class SugPathElement

The control class for SVGPath elements.

Inheritance:

Public Methods

[more] SugPathElement ()
The class constructor
[more]SugPathSegArc* createSugPathSegArcAbs (SugRealType newX, SugRealType newY, SugRealType newR1, SugRealType newR2, SugRealType newAngle, bool newLargeArcFlag, bool newSweepFlag)
Factory for ArcAbs
[more]SugPathSegArc* createSugPathSegArcRel (double newX, SugRealType newY, SugRealType newR1, SugRealType newR2, SugRealType newAngle, bool newLargeArcFlag, bool newSweepFlag)
Factory for ArcRel
[more]SugPathSegCurvetoCubic* createSugPathSegCurvetoCubicAbs (SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicAbs
[more]SugPathSegCurvetoCubic* createSugPathSegCurvetoCubicRel (SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicRel
[more]SugPathSegCurvetoCubicSmooth* createSugPathSegCurvetoCubicSmoothAbs (SugRealType newX, SugRealType newY, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicSmoothAbs
[more]SugPathSegCurvetoCubicSmooth* createSugPathSegCurvetoCubicSmoothRel (SugRealType newX, SugRealType newY, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicSmoothRel
[more]SugPathSegCurvetoQuadratic* createSugPathSegCurvetoQuadraticAbs (SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1)
Factory for CurvetoQuadraticAbs
[more]SugPathSegCurvetoQuadratic* createSugPathSegCurvetoQuadraticRel (SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1)
Factory for CurvetoQuadraticRel
[more]SugPathSeg* createSugPathSegCurvetoQuadraticSmoothAbs (SugRealType newX, SugRealType newY)
Factory for CurvetoQuadraticSmoothAbs
[more]SugPathSeg* createSugPathSegCurvetoQuadraticSmoothRel (SugRealType newX, SugRealType newY)
Factory for CurvetoQuadraticSmoothRel
[more]SugPathSeg* createSugPathSegLinetoAbs (SugRealType newX, SugRealType newY)
Factory for LinetoAbs
[more]SugPathSeg* createSugPathSegLinetoHorizontalAbs (SugRealType newX)
Factory for LinetoHorizontalAbs
[more]SugPathSeg* createSugPathSegLinetoHorizontalRel (SugRealType newX)
Factory for LinetoHorizontalRel
[more]SugPathSeg* createSugPathSegLinetoRel (SugRealType newX, SugRealType newY)
Factory for LinetoRel
[more]SugPathSeg* createSugPathSegLinetoVerticalAbs (SugRealType newY)
Factory for LinetoVerticalAbs
[more]SugPathSeg* createSugPathSegLinetoVerticalRel (SugRealType newY)
Factory for LinetoVerticalRel
[more]SugPathSeg* createSugPathSegMovetoAbs (SugRealType newX, SugRealType newY)
Factory for MovetoAbs
[more]SugPathSeg* createSugPathSegMovetoRel (SugRealType newX, SugRealType newY)
Factory for MovetoRel
[more]SugPathSeg* createSugPathSetClosePath ()
Factory for ClosePath
[more]bool getPathCommandsAttribute (char* attrName, vector<SugPathSeg*>& attrValue)
Gets the specified attribute's value in path command list format.
[more]unsigned long getPathLength ()
Returns the path length
[more]unsigned long getPathSegAtLength (SugRealType distance)
This is from the IDL, not sure if it has a use
[more]vector<SugPathSeg*> * getPathSegList ()
Returns the path segment list
[more]SugPoint* getPointAtLength (SugRealType distance)
This is from the IDL, not sure if it has a use
[more]double getTotalLength ()
This is from the IDL, not sure if it has a use
[more]vector<SugPathSeg*> * setPathSegList (vector<SugPathSeg*>* newPathSegList)
Sets the path segment list
[more] ~SugPathElement ()
The class destructor

Protected Fields

[more]unsigned long mPathLength
The path length
[more]vector<SugPathSeg*> mPathSegList
The actual path segments

Protected Methods

[more]char* getPathCommandToken (char** str, char* tok)
Helper function for the path parsing.

Inherited from SugElement:

Public Methods

ovoid addAttribute(char* name, char* value)
obool getColorAttribute(char* attrName, SugColor& attrValue)
oSugTypes::ElementType getElementType()
obool getFloatAttribute(char* attrName, float& attrValue)
oconst char* getId()
obool getIntegerAttribute(char* attrName, int& attrValue)
obool getPointListAttribute(char* attrName, vector<SugPoint>& attrValue)
oconst char* getStringAttribute(char* attrName)
obool getTransformListAttribute(vector<SugTransform>& attrValue)
ovoid printAttributes()
ovoid setElementType(SugTypes::ElementType newType)

Protected Fields

omap<string, string> mAttributes
oSugTypes::ElementType mElementType

Inherited from SugNode:

Public Methods

oSugNode* appendChild(SugNode* newChild)
ovector<SugNode> * getChildNodes()
oSugNode* getFirstChild()
oSugNode* getLastChild()
oSugNode* getNextSibling()
ochar* getNodeName()
ounsigned short getNodeType()
ochar* getNodeValue()
oSugNode* getParentNode()
oSugNode* getPreviousSibling()
obool hasAttributes()
obool hasChildNodes()
oSugNode* insertBefore(SugNode* newChild, SugNode* refChild)
oSugNode* removeChild(SugNode* oldChild)
oSugNode* replaceChild(SugNode* newChild, SugNode* oldChild)
oSugNode* setFirstChild(SugNode* newFirstChild)
oSugNode* setLastChild(SugNode* newLastChild)
oSugNode* setNextSibling(SugNode* newNextSibling)
ochar* setNodeName(char* newNodeName)
ounsigned short setNodeType(unsigned short newNodeType)
ochar* setNodeValue(char* newNodeValue)
oSugNode* setParentNode(SugNode* newParentNode)
oSugNode* setPreviousSibling(SugNode* newPreviousSibling)

Protected Fields

ovector<SugNode> mChildNodes
oSugNode* mFirstChild
oSugNode* mLastChild
oSugNode* mNextSibling
ochar* mNodeName
ounsigned short mNodeType
ochar* mNodeValue
oSugNode* mParentNode
oSugNode* mPreviousSibling

Documentation

The control class for SVGPath elements. This class governs and SVG Path its entirety and is used as one of the classes in the parsed vector.
ounsigned long mPathLength
The path length

ovector<SugPathSeg*> mPathSegList
The actual path segments

ochar* getPathCommandToken(char** str, char* tok)
Helper function for the path parsing. Tokenizes the path no matter what format the string might be in.

Parameters:
str - The string to be tokenized. It is modified in the function.
tok - The token as a result of the call to this function.
Returns:
The same pointer as tok.

ounsigned long getPathLength()
Returns the path length

odouble getTotalLength()
This is from the IDL, not sure if it has a use

oSugPoint* getPointAtLength(SugRealType distance)
This is from the IDL, not sure if it has a use

ounsigned long getPathSegAtLength(SugRealType distance)
This is from the IDL, not sure if it has a use

ovector<SugPathSeg*> * getPathSegList()
Returns the path segment list

ovector<SugPathSeg*> * setPathSegList(vector<SugPathSeg*>* newPathSegList)
Sets the path segment list

oSugPathSeg* createSugPathSetClosePath()
Factory for ClosePath

oSugPathSeg* createSugPathSegMovetoAbs(SugRealType newX, SugRealType newY)
Factory for MovetoAbs

oSugPathSeg* createSugPathSegMovetoRel(SugRealType newX, SugRealType newY)
Factory for MovetoRel

oSugPathSeg* createSugPathSegLinetoAbs(SugRealType newX, SugRealType newY)
Factory for LinetoAbs

oSugPathSeg* createSugPathSegLinetoRel(SugRealType newX, SugRealType newY)
Factory for LinetoRel

oSugPathSegCurvetoCubic* createSugPathSegCurvetoCubicAbs(SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicAbs

oSugPathSegCurvetoCubic* createSugPathSegCurvetoCubicRel(SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicRel

oSugPathSegCurvetoQuadratic* createSugPathSegCurvetoQuadraticAbs(SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1)
Factory for CurvetoQuadraticAbs

oSugPathSegCurvetoQuadratic* createSugPathSegCurvetoQuadraticRel(SugRealType newX, SugRealType newY, SugRealType newX1, SugRealType newY1)
Factory for CurvetoQuadraticRel

oSugPathSegArc* createSugPathSegArcAbs(SugRealType newX, SugRealType newY, SugRealType newR1, SugRealType newR2, SugRealType newAngle, bool newLargeArcFlag, bool newSweepFlag)
Factory for ArcAbs

oSugPathSegArc* createSugPathSegArcRel(double newX, SugRealType newY, SugRealType newR1, SugRealType newR2, SugRealType newAngle, bool newLargeArcFlag, bool newSweepFlag)
Factory for ArcRel

oSugPathSeg* createSugPathSegLinetoHorizontalAbs(SugRealType newX)
Factory for LinetoHorizontalAbs

oSugPathSeg* createSugPathSegLinetoHorizontalRel(SugRealType newX)
Factory for LinetoHorizontalRel

oSugPathSeg* createSugPathSegLinetoVerticalAbs(SugRealType newY)
Factory for LinetoVerticalAbs

oSugPathSeg* createSugPathSegLinetoVerticalRel(SugRealType newY)
Factory for LinetoVerticalRel

oSugPathSegCurvetoCubicSmooth* createSugPathSegCurvetoCubicSmoothAbs(SugRealType newX, SugRealType newY, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicSmoothAbs

oSugPathSegCurvetoCubicSmooth* createSugPathSegCurvetoCubicSmoothRel(SugRealType newX, SugRealType newY, SugRealType newX2, SugRealType newY2)
Factory for CurvetoCubicSmoothRel

oSugPathSeg* createSugPathSegCurvetoQuadraticSmoothAbs(SugRealType newX, SugRealType newY)
Factory for CurvetoQuadraticSmoothAbs

oSugPathSeg* createSugPathSegCurvetoQuadraticSmoothRel(SugRealType newX, SugRealType newY)
Factory for CurvetoQuadraticSmoothRel

obool getPathCommandsAttribute(char* attrName, vector<SugPathSeg*>& attrValue)
Gets the specified attribute's value in path command list format.

Parameters:
The - name of the attribute we are getting the value for.
The - value of the attribute.
Returns:
Boolean value indicating whether or not the attribute exists in this element.

o SugPathElement()
The class constructor

o ~SugPathElement()
The class destructor

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java


This page was generated with the help of DOC++.