Path Class Reference

Creation, manipulation and use of Paths. A path is an arbitary collection of MoveTo, LineTo and CurveTo segments Public Member variables :- BOOL IsFilled - TRUE if this path if filled, FALSE otherwise. More...

#include <paths.h>

List of all members.

Public Member Functions
	Path ()
	constructor - just sets a few things to sensible values
	~Path ()
	Destructor - releases the memory that the path has been using to store coords in.
BOOL	CopyPathDataFrom (Path *SrcPath)
	Copy the coords, verbs and flags from the SrcPath to this path. You must already have initialised this path by calling Path::Initialise(). Pass it an Initial size big enough the hold the path you want to copy.
BOOL	CopyPathDataFrom (DocCoord *Coords, PathVerb *Verbs, INT32 NumCoords, BOOL Filled=FALSE, BOOL Stroked=TRUE)
	Copy the specified coords and verbs to this path. The path's flags will be the defaults as specified in the constructors. You must already have initialised this path by calling Path::Initialise(). Pass it an Initial size big enough to hold the path you want to copy.
BOOL	CreatePathFromDocRect (DocRect *pRect)
	Creates a filled path from a given DocRect.
BOOL	Initialise (INT32 InitialSize=24, INT32 BlockSize=12)
	Allocates memory in the path for the three arrays - The Verbs, Coordinates and the Flags.
BOOL	FindStartOfPath ()
	Sets Pos to the first element in the path.
void	FindStartOfSubPath ()
	Searches backwards from the current position until it finds the start of the sub path that the current position is in.
void	FindStartOfSubPath (INT32 *Index) const
	Searches backwards from the current position from Index until it find the start of the subpath (always a moveto).
void	FindEndOfSubPath ()
	Searches forwards until it finds the end of the current sub-path. ie pos will point at the last element in the sub path.
void	FindEndOfSubPath (INT32 *Index) const
	Searches forwards until it finds the end of the current sub-path. ie Index will point at the last element in the sub path.
void	FindEndElOfSubPath (INT32 *Index) const
	Searches forwards until it finds the last element of the current sub-path. ie 0 1 2 3 {MT,CT,CT,CT} => Index = 3. See Also: FindEndOfSubPath (Note equivelent).
void	ExpandRange (INT32 *start, INT32 *end, INT32 num)
	given the region [*start, *end] expand the region in both directions by num elements. The region will not be expanded beyond its outer limits described by the set {moveto,.....,endofsubpath}.
BOOL	FindNext ()
	Finds the next path element in this path. The position will become invalid if you try to search past the start of the path. This can be checked by using Pos->IsValid.
BOOL	FindNext (INT32 *Index) const
	Finds the next path element in this path. The position will become invalid if you try to search past the start of the path. This can be checked by using Pos->IsValid.
BOOL	FindPrev ()
	Finds the prev path element in this path starting the search from CurrentPos.
BOOL	FindPrev (INT32 *Index) const
	Finds the previous path element in this path starting from the value (index).
BOOL	FindPrevEndPoint (INT32 *index) const
	Finds the previous path endpoint in this path.
BOOL	FindNextEndPoint (INT32 *index) const
	Finds the next path endpoint in this path.
BOOL	GetSubPathEnds (DocCoord *start, DocCoord *end)
	This function returns whether the path is open or closed. This is independent of the IsFilled flag, because some programs allow open paths to be filled. Basically, if there's no gap in the subpath, it's closed, otherwise it's open. These are the same rules as ArtWorks followed. Initial implementation just scans the subpath and checks the last element in the subpath.
BOOL	FindNearestPoint (DocCoord pos, UINT32 flags, INT32 *position)
	This function searches for a point in the path which is both selected and lies inside the largest blob bounding rectangle surrounding 'pos'. Points checked for are as follows... if ENDPOINTS is set check all selected endpoints in this path. if CONTROLPOINTS is set check all control points lying directly next to selected endpoints The rules are that control points are only enabled when a single end point is selected and hence a maximum of 2 control points will be checked. If any of these points are close enough to be clicked on, the function returns TRUE, with position holding the index to the point that was clicked.
BOOL	PointCloseToLine (DocCoord pos, INT32 *position)
	This function takes the coordinate pos, and sees if it is close to a line (close enough to drag the line around). It returns TRUE if the point is close enough, and position is an index to the element that it was closest to.
BOOL	ClosestSelectedEndpoint (DocCoord pos, INT32 *position, double *distance)
	This function finds the closest selected line end to the cursor position passed in. If the path has no selected line ends, the function returns FALSE.
BOOL	FindNextSelected (INT32 *Index)
	Searches the point set {*index, usedslots-1} for a selected end point and returns its index if found.
BOOL	FindSelectionLimits (INT32 index, INT32 *p, INT32 *q)
	Finds the next connected region of selected control handles.
INT32	FindOppositeControlPoint (INT32 ThisIndex)
	Given a bezier control point, this function returns the index of the control point that is opposite this one (with an endpoint between). This routine takes closed paths into account.
INT32	FindPrevControlPoint (INT32 position)
	This routine will scan back from an endpoint to find the attached bezier control point. It takes account of closed and open paths and complex paths, and will wrap around the path if necessary.
INT32	FindNextControlPoint (INT32 position)
	This routine will scan forwards from an endpoint to find the attached bezier control point. It takes account of closed and open paths and complex paths, and will wrap around the path if necessary.
double	SqrDistanceToPoint (const DocCoord pt, INT32 *NearEl, double *mu)
	Finds the distance to the closest point on the path. For efficiency it does not evaluate the closest point. Use this routine in conjunction with ClosestPoint to find the actual closest point.
DocCoord	ClosestPointTo (const double t, const INT32 index)
	This function returns the point at which the closest distance on the path occurs.
BOOL	IsPointCloseTo (const DocCoord ICoord, INT32 range, INT32 *NearElement, double *mu)
	This routine can be used to determin whether a point is close enough to a path to allow some action to occur. The range input parameter can be used to determin the size of the sensitive area.
double	SqrLength ()
	Find the length of a path in millipoints. The length is calculated by flattening the path and finding straight line segment lengths and so is a discrete numeric approximation to a line integral.
double	GetPathLength (double dFlatness=64.0)
	Find the length of a path in millipoints.
double	DistReparameterise (const double sqrdist, INT32 *Element)
DocCoord	ConvSqrDistToCoord (const double sqrdist)
	Finds the coordinate which is dist units along 'this' path.
INT32	BreakInTwo (Path *pChildPath)
	Tests a path to see if it is valid. This is only built into DEBUG versions of Camelot so always surround calls to it with an ifdef _DEBUG block. If the path is not valid in some way, this function will dump an explanation to the debug terminal and return FALSE.This function will attempt to break the current path at its first selected point. All selected points should still be in place in both parent and child.
INT32	NumSplinters ()
	Returns the number of splinters a selected path will be broken into when calls to BreakPath is called. Splinters include opened subpaths, ie if the algorithm will open a closed subpath, this is classed as a spinter along with breaking a path in two.
BOOL	DistanceTo (INT32 index, double t, double *distance, double dFlatness=64.0)
	This function takes a description of a point lying on a path. The point is described by (i,t) where i is the index of the element t lies in, and t is a parametric variable 0<=t<=1. The function calculates the distance along this path to the point described by (i,t). This routine complements SqrDistanceToPoint() which calculates the pair (i,t) for a given coordinate close to the path.
BOOL	DistanceTo (DocCoord Coord, double *dist, double dFlatness=64.0)
	This function takes as input a coordinate (usually a mouse click point). It will calculate the closest point on the path to this coordinate and return the distance along the path from its start point to this coordinate.
BOOL	SplitAtPoint (const DocCoord &SplitPoint, INT32 *SplitAt, INT32 *NewElements)
	This function takes a coordinate (typically not on but) close to this path and splits the path at a calculated point on the path which happens to be closest to the input coord. By Split I mean a new coordinate in will appear in the path, but the path will not have changed its shape in anyway.
BOOL	GetPointAtDistance (MILLIPOINT Distance, DocCoord *pPoint, double *pTangent=NULL, UINT32 *pPressure=NULL)
	Gets the coordinate of a point a certain distance along this path.
BOOL	GetDistanceToPoint (DocCoord Point, MILLIPOINT *Distance)
	Gets the distance along the path for a given point.
void	Scale (const DocCoord dcOrigin, const double dDPI=96.0)
	This function is called on a path specified in DocCoords, to convert it into pixel coordinates.
INT32	GetPathPosition ()
	Find out where in the path we are.
void	SetPathPosition (INT32)
	Sets the current path position to the value supplied. This represents the Coord number in the path.
BOOL	IsInPath ()
	Determine if the path current position is still inside the path.
PathVerb	GetVerb () const
	finds the verb associated with the path position
DocCoord	GetCoord () const
	finds the DocCoord associated with the path position
PathFlags	GetFlags () const
	finds the flags associated with the path position
PathWidth	GetWidth () const
	Fetches width values from the path.
PathTypeEnum	GetPathType () const
	This determines whether the path is a line or a shape. It does this by seeing if it has a PT_CLOSEFIGURE bit set in its last verb.
INT32	GetPathByteLength () const
	Calculates the length of the path in bytes. This figures includes the size of the 3 arrays (Coordinates, Verbs and Flags) only.
INT32	GetNumElements () const
	This function counts the number of elements in the path. This ignores MoveTos, hence giving you the total number of visible path elements (i.e. all the lines and curves).
INT32	GetNumCoords () const
	This returns the number of coordinates that make the path up.
INT32	GetNumEndPoints () const
	Goes through the path and counts all open ends in the path. For example, a straight line has 2 open ends, a closed shape has no open ends and a complex path could have any number of open ends. You should use this function before calling GetAllOpenEnds that will fill an array for their coords for you.
INT32	GetAllOpenEnds (INT32 MaxElements, DocCoord *EndCoords) const
	Goes through the path and copies the coordinates of all the Open ends of the path into the array, until MaxElements elements have been added to the array. Call GetNumEndPoints to find out how big to make your array in the first place.
INT32	GetNumSelEndPoints () const
	determine how many selected endpoints there are within this path. Useful indirectly for finding whether there's a subselection.
INT32	GetNumSubpaths () const
	Gets the number of subpaths in this path.
DocRect	GetBoundingRect () const
	Calculates the bounding rectangle of the paths coordinates. This is calculated on the fly, so don't over use it.
DocRect	GetBlobRect () const
	Calculates the bounding rectangle of the paths coordinates expanded by the current blob size. This is calculated on the fly, so don't over use it.
BOOL	GetTrueBoundingRect (DocRect *pRect, MILLIPOINT LineWidth=0, CCAttrMap *pAttrMap=NULL)
	Calculate the bounding rectangle of a path using GDraw.
DocCoord	GetEndPoint ()
	Finds the endpoint of a given path element and returns it. For MoveTos and LineTos, the point returned will be its associated coord, but for a CurveTo the last coord will be returned.
DocCoord	GetControl1 ()
	Finds the first control point of a bezier.
DocCoord	GetControl2 ()
	Finds the second control point of a Bezier.
DocCoord *	GetCoordArray () const
	Gives you access to the coordinate array. This array is simply a list of all the coordinates in the path, in order. This should be very useful if you need to perform transformations or other actions that effect all the coordinates. The coordinates are in the corect order for the NT PolyDraw() function handle.
PathVerb *	GetVerbArray () const
	This array holds a list of all the path elements used in the path. The structure used is the same as the NT structure and can in fact be passed striaght on to the NT PolyDraw function. The verbs must be one of the following PC_MoveTo, PC_LineTo or PC_CurveTo. LineTo and CurveTo verbs can be combined with a ClosePath Flag.
PathFlags *	GetFlagArray () const
	This array holds a set of flags for each and every coordinate in the path. These flags are used to record information specific to each coordinate, such as its selection state, to determine if it should smooth this part of the path etc.
PathWidth *	GetWidthArray ()
	The array holds the width of all the points in the path. DO NOT MODIFY THE CONTENTS OF THE ARRAY.
void	GetPathArrays (PathVerb **pV, DocCoord **pC=NULL, PathFlags **pF=NULL)
	Easy way of getting the path pointers into variables. Combines three function calls into one.
void	GetFlags (PathFlags *NewFlags)
	returns all the flags for the current path position
void	SetFlags (const PathFlags &NewFlags)
	Sets the flags at the current path position to the flags provided.
void	InitialiseFlags ()
	This generates a legal path flags array based on the all path verbs. It sets all flags to default values and then scans all end points setting their end point flag to TRUE.
void	InitialiseFlags (const INT32 Startindex, const INT32 Len)
	This generates a legal path flags array based on the path verbs within the specified region. It sets all flags to default values and then scans all end points setting their end point flag to TRUE.
void	InitialiseFlags (PathVerb *pVerbs, PathFlags *pFlags, const INT32 Len)
	This generates a legal path flags array based on the path verbs in pVerbs within the specified region. It sets all flags in pFlags to default values and then scans all end points setting their end point flag to TRUE.
BOOL	InsertMoveTo (DocCoord p1, PathFlags *NewFlags=NULL)
	Inserts a MoveTo element into the middle of the Path and asks for extra memory if we need it. It will return FALSE if we fail to get the memory.
BOOL	InsertLineTo (DocCoord p1, PathFlags *NewFlags=NULL)
	Inserts a LineTo into the path at the Current Path Position.
BOOL	InsertCurveTo (DocCoord p1, DocCoord p2, DocCoord p3, PathFlags *NewFlags=NULL)
	Inserts a Curve into the path at the Current Path Position.
BOOL	CloseSubPath ()
	To indicate that a path is closed with a line, you should call CloseSubPath with the Current Path Position indicator somewhere inside the sub-path that you want closed. This function will adjust the verb of the last line segment in the sub-path by adding the PT_CLOSEFIGURE element into as described in the NT Prog Reference guides for the PolyDraw() function (page 304 of book 4 at last count) The Current Path Position is left on the element at the end of the subpath.
BOOL	InsertSection (INT32 StartSlot, INT32 NumSlots)
	This routine is the corollary to DeleteSection - it inserts a section into the path at a given position and a given size, but does not put any data into the path. Note that this routine is likely to move the path data around in memory, so after calling it you should re-read any pointers to the path you might have had.
BOOL	AddMoveTo (DocCoord p1, PathFlags *NewFlags=NULL)
	Adds a new MoveTo to the end of the path.
BOOL	AddLineTo (DocCoord p1, PathFlags *NewFlags=NULL)
	Adds a new LineTo to the end of the path.
BOOL	AddCurveTo (DocCoord p1, DocCoord p2, DocCoord p3, PathFlags *NewFlags=NULL)
	Adds a Curve to the end of the path.
BOOL	AddCurveTo (DocCoord p1, PathFlags *NewFlags=NULL)
	Adds a straight line version of a curve to the end of the path. The control points are positioned 1/3 and 2/3 along the line between its end points.
BOOL	DeleteSection (INT32 StartSlot, INT32 NumSlots)
	Deletes sections out of the middle of the path. Used by DeleteElement and for Deleting sub paths etc.
BOOL	DeleteElement ()
	Deletes the element at the Current Path Position. May free some memory if the path gets to have too much unused space in the path. The Current Path Position points at the slot before the one being deleted.
BOOL	DeleteFromElement (INT32 ElementNum)
	Deletes all the elements in the path from ElementNum to the end of the path.
BOOL	ClearPath ()
	Empties the path of all its entries and tries to free up excessive amounts of unused memory left over at the end. It does keep some memory though, ready for a new path to be put into it. It also now resets CurrentPos back to zero.
BOOL	ClearPath (BOOL compress)
	Empties the path of all its entries. If compress is TRUE the routine will try to free up excessive amounts of unused memory left over at the end. It also now resets CurrentPos back to zero.
BOOL	Compact ()
	Removes any extraneous unused slots in a path. It will a maximum of 2n-1 slots free where n is the size of an allocation chunk when increasing the buffer (see Path::Initialise).
BOOL	IsSelected ()
	return the Selected flag for the coordinate
BOOL	IsSmooth ()
	returns the Smooth flag for the Current Path Position
BOOL	IsRotate ()
	returns the Rotate flag for the coordinate
BOOL	IsEndPoint ()
	return the IsEndPoint flag for the coordinate
BOOL	IsSubSelection ()
	determine if the path has a subselection
BOOL	IsNearOpenEnd (const DocRect &BlobRect, INT32 *SlotNum)
	Determines if the Coordinate is near any of the path open ends. This function looks through all the open ends in complex paths and returns TRUE if any of them are near the TestCoord.
BOOL	IsOpenEnd (const INT32 index)
	Tests to see if the index provided specifies either the first or last element in an open subpath. ie the index is a true end point.
BOOL	IsComplexPath ()
	Tests to see if the path is a complex path (ie it has multiple sub-paths).
BOOL	IsIsometric (const Path &OtherPath, Matrix *pTransform, const double &Tolerance=1.0) const
	Determines whether two paths are isometric. In this context, isometric does not include true isomtric paths with different starting points. This can then be used to provide a transformation of this path, resulting in the given otherPath.
INT32	CalcCRC ()
	Calculates a cyclic redundancy check value for a path. This CRC is invariant under translation only. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not.
INT32	CalcRegionCRC (const INT32 StartIndex, const INT32 EndIndex)
	Calculates a cyclic redundancy check value for a path region. This CRC is only invariant under translation. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not.
INT32	CalcSelectedCRC ()
	Calculates a cyclic redundancy check value for a paths selected coordinates. This CRC is invariant under translation only. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not.
INT32	CalcSelPointsCRC (const INT32 StartIndex, const INT32 EndIndex)
	Calculates a cyclic redundancy check value for a paths selected coordinates. This CRC is invariant under translation only. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not.
XLONG	CalcArea ()
	Calculate the area of this path.
INT32	ComparePathToPath (Path *pComparePath, BOOL QuickCheck=TRUE)
	Compares athis path to a passed in path. It firswt does a quick check on the number of coords and if they are equal does a more thoughour check on the verb array and coord array.
void	DumpPath ()
	Dumps the whole path out to the debug terminal.
void	GetDebugDetails (StringBase *Str)
	Dumps the whole path out during tree display debugging.
void	RenderPathBlobs (Spread *pSpread)
	Draws all the selection blobs for a path. Useful for putting the blobs on or taking them back off again. This goes into its own RenderOnTop loop and calls RenderPathBlobs(RenderRegion* pRender).
void	RenderPathBlobs (RenderRegion *pRender)
	Draws all the selection blobs for a path. Useful for putting the blobs on or taking them back off again.
void	RenderPathControlBlobs (Spread *Spread, INT32 EndPtIndex)
	Draws the control points selection blobs for an endpoint on a path. Used by RenderPathBlobs and also the Bezier tool. This goes into its own RenderOnTop loop.
void	RenderPathControlBlobs (RenderRegion *pRender, INT32 EndPtIndex)
	Draws all the control points selection blobs for a path. Used by RenderPathBlobs and also the Bezier tool.
void	RenderPathSelectedControlBlobs (Spread *pSpread, BOOL Removing=TRUE)
	Draws all the control points selection blobs for an entire path. If you are to change the selection flags on a path then call this to remove all selection blobs, do your change, then call this again to draw the new blobs. This goes into its own RenderOnTop loop.
void	RenderPathSelectedControlBlobs (Spread *pSpread, RenderRegion *pRender)
	Draws all the control points selection blobs for an entire path into a specified render region. Called by the above function.
void	RenderSelectedControlBlobsToPendingRegions (Spread *pSpread)
	Draws all the control points selection blobs for an entire path into all the pending render regions.
void	RenderPathPenBlobs (Spread *pSpread)
	Draws all the selection blobs and pen blobs for a path. Useful for putting the blobs on or taking them back off again.
void	RenderPathPenBlobs (RenderRegion *pRegion)
	Draws all the selection blobs and pen blobs for a path. Useful for putting the blobs on or taking them back off again.
void	DrawBlob (RenderRegion *, const DocCoord &, BOOL)
	Draws a single blob, either selected or un-selected.
void	DrawControlBlob (RenderRegion *, const DocCoord &)
	Draws a blob for a Bezier control point.
void	DrawControlLine (RenderRegion *, const DocCoord &, const DocCoord &)
	Draws a line from the Bezier control point to its endpoint.
void	ClearSubSelection ()
	Goes through the path and sets all the IsSelected flags to FALSE, clearing any selected control points in the path.
void	SetAllSubSelection ()
	Goes through the path and sets all the IsSelected flags to TRUE, also selecting all control points in the path.
void	EnsureSelection (BOOL UseStarts)
	Goes through the path ensuring that the selection status of the ends/starts of subpaths equal the selection state of the start/ends of that subpath Also selects/deselectes control points as appropiate.
void	SmoothCurve (BOOL SetRenderFlags=FALSE, BOOL SnapEnds=FALSE, INT32 SnapIndex=0)
	Smooths the path on the areas that have the IsSmooth flag set to TRUE. This can change any or all of the path.
void	CalcDoubleCurve (DocCoord &, DocCoord &, DocCoord &, DocCoord *, DocCoord *)
	Calculates the position of the two control points on either side of p2, using the position of the coords of either side of it to help (p1 & p3).
void	CalcPointCurve (DocCoord &, DocCoord &, DocCoord &, DocCoord *)
	Calculates the position of the control point adjacent to p2 between p2 and p3, using the position of the coords of either side of it to help (p1 & p3).
void	CalcPointLine (DocCoord &, DocCoord &, DocCoord &, DocCoord *)
	Calculates the position of the control point that appears after p2, which is part of the curve ending at p3. The control point should be colinear with p1 & p2 and 1/3 the distance between p2 & p3 from p2!
void	CalcPointEnd (DocCoord &, DocCoord &, DocCoord *)
	Calculates the position of the last control point in the sub-path.
void	CalcRotate (DocCoord &, DocCoord *, DocCoord *, DocCoord &)
void	Reverse ()
	Reverses this path, so that it is rendered and traversed etc in the other direction. This involves reversing the order of all the coords etc in the path.
void	ReverseSection (INT32 StartSlot, INT32 SubPathLen)
	Reverses the direction of the section of the path specified. This is typically used to reverse subpaths of a complex path. It is also called by Reverse, to reverse the entire path.
void	TryToClose ()
	Tries to close the path. If the start coord and the end coord are the same, it will close the path with a PT_CLOSEFIGURE and set the IsFilled flag. It searches all the sub-paths in the path and if any of them are closed, the whole path is marked as filled.
void	RotateElementsLeft (const INT32 Start, const INT32 End, INT32 Rotate)
	Rotates the specified elements in a path by the number of positions indicated. Elements will be rotated from right to left.
BOOL	MergeTwoPaths (const Path &Other)
	Combines the two paths into a single complex path.
BOOL	MergeTwoPaths (DocCoord *OtherCoords, PathVerb *OtherVerbs, PathFlags *OtherFlags, INT32 Length, BOOL Filled)
	Appends the data in the three given arrays to the arrays in this path.
BOOL	SplitAtPoint (const DocCoord SplitPt, INT32 *SplitElement, UINT32 *NumElements, PathVerb *Verbs, DocCoord *Coords)
	This function finds the element (line or curve) on which the closest point to SplitPt occurs. A parameter t describes the point on this element and is used to split the element into two distinct pieces. The verbs and coordinates of these pieces are returned to the caller in the output lists. NumElements will describe how many path components have been created and stored in the lists This will be a value of 2 for lines and 6 for curves.
BOOL	ChangeStartElement (INT32 StartIndex)
	This will rotate the path so that the element that was at StartIndex is now at index 0. You should only call this for closed paths that don't contain subpaths.
void	Translate (const INT32 x, const INT32 y)
	Translate all coordinate within 'this' path.
void	Translate (const DocCoord &coord)
	Translate all coordinate within 'this' path.
INT32	ClipPathToPath (const Path &Src, Path *const pDest, UINT32 Flags, UINT32 Tolerance=100, double SrcFlatness=750.0, double ClipFlatness=750.0)
	This is an interface to Gavin's ClipPathToPath.
BOOL	StrokePathToPath (MILLIPOINT LineWidth=250, LineCapType LineCap=LineCapButt, JointType JoinStyle=MitreJoin, DashType *pDash=NULL, Path *pDest=NULL, double Flatness=200.0, BOOL Close=FALSE)
	Strokes the path, and places result in pDest. If pDest == NULL, the result is placed back in this path.
double	CalculateFlatnessValueFromPath (double DividerValue=375.0, double LowerLimit=1.0, double UpperLimit=375.0)
	To calculate a suitable flatness value to be used with Contouring, Clipping and Stroking. The value is based on the actual size of the paths dimensions.
INT32	InitializeContourValues (UINT32 Width, JoinStyles JoinS=JOIN_ROUND, BOOL IsAnOuterContour=TRUE, double Flatness=200.0, BOOL ClosePath=TRUE, BOOL UseContourMode=TRUE, CapStyles CapS=CAPS_ROUND, UINT32 MitreLimit=751941)
INT32	GetContourForStep (Path *pDest, double StepValue=1.0)
void	ClearNeedToRender ()
	Sets the NeedToRender flags on all of the path elements to FALSE.
BOOL	CopySectionFrom (const Path &Other, INT32 StartIndex, INT32 NumToCopy)
	Copies a specified section from a path to the end of this one.
BOOL	CopySectionTo (Path *Dest, INT32 StartIndex, INT32 NumToCopy)
	Copies a specified section from this path to the end of another path.
BOOL	MergeSectionFrom (INT32 DestinPos, const Path &Source, INT32 SourcePos, INT32 Length)
	Copies a specified section from a source path to a specified position in this path.
BOOL	MergeSectionTo (INT32 SourcePos, INT32 Length, Path *Destin, INT32 DestinPos)
	Copies a specified section from this path to a specific position within another path. A gap is created if necessary to copy the data into.
BOOL	MakePathFromSection (const INT32 Start, const INT32 Length, Path *pDestin)
	Copies a specified section from this path to a specific position within another path. A gap is created if necessary to copy the data into.
BOOL	MakePathFromSubPath (const INT32 lSubpathIndex, Path *pDestin)
	Makes a subpath into a path in its own right.
BOOL	CloneFrom (const Path &Other)
	Replace the data within this path with that of Other path.
BOOL	SimpleJoin (Path *Other, INT32 *, BOOL *, BOOL *Reversed=NULL)
	Joins two paths to form a new, longer path. Both the paths invloved are simple (ie not complex).
BOOL	ComplexJoin (Path *Other, INT32 *, BOOL *)
	Tries to Join the New Path (must be simple) to a complex path.
BOOL	ComplexToSameComplexJoin (Path *Other, INT32 *, BOOL *)
	This path is assumed to be complex and Other is assumed to be a simple path. The start and end point of the Simple Path must be the same as the start or end point of one of the sub paths of this complex path. The function Moves the two sub paths that are touched by the simple path to the end of the path, and inserts the simple path between them. This means that the two touched sub-paths and the new simple path are combined into a single sub path. This may also mean that this complex path is no longer complex.
BOOL	FindJoinedSubPathInfo (const DocCoord &JoinCoord, INT32 *Start, INT32 *Length, BOOL *JoinAtStart)
	This function searchs the path, compareing JoinCoord with the start and end points of each of the Sub-paths in the path. If it is the same as one of the start or end points, then the output params are filled and TRUE is returned.
BOOL	JoinToAnother (Path *OtherPath, INT32 MainIndex, INT32 OtherIndex)
	This routine is used to join the end of a line to the end of another line. It will cope with the various possiblities: That both subpaths are in the same complex paths, that one or other of the subpaths are in different complex paths, and that one of the paths might need reversing. The other path is left untouched. This path will contain all subpaths from that one. This routine assumes that the two subpaths are different - it will not join the start and end of the same subpath.
BOOL	RetroReplaceSection (INT32 StartSlot, INT32 NumSlots, Path *NewPath, BOOL KeepStart)
	Deletes all the elements in the path from StartSlot to StartSlot+NumSlots and then inserts the whole of NewPath into the hole. If the hole is not big enough, then it is made bigger and if it is too big, then it is shrunk.
BOOL	SmoothRegions (const double error, BOOL smoothall, BOOL reselect)
	Given a path, search for regions of interest and smooth these regions. Regions are defined by sequences of connected selected points ie.
BOOL	SmoothSection (INT32 index1, INT32 *index2, const double error, INT32 selection)
	Given a path, search for regions of interest and smooth these regions. Regions are defined by (start/end) selected points with any number of none selected points inbetween. If smoothall is true or there are no selected regions within the path, the whole path is smoothed. You should call this function with a path which you do not mind being corrupted, ie changed in an unpredictable way. The function may successfully smooth a number of regions within the path, then fail on one particular region. The result will be a path with m out of n regions smoothed.Smooth a path between the given section delimited by [index1,index2].
BOOL	Smooth (const double error)
	Smooth a path, using the fitcurve function, which may turn out to be NOT the way to do it but I'll give it a try. You should generally call this funcion with a copy of the path you want to smooth. This smooth function will corrupt the path if it fails. Call the function SmoothSection() describing your entire path if you wish to smooth a path without corrupting anything on failure.
BOOL	Quantise (const double threshold, Path *pOutput)
	Quantise a path. All curves within the path will be approximated by straight lines. pOutput may point at 'this' path ie a path can be quantised to itself. If the quantising fails for some reason, the output path will be unaffected EVEN if you're quantising a path to itself. Note, Quantising differs from flattening in that it will approximate straight lines within a path, generating n colinear points for each line it meets. Whereas flattening does nothing with lines.
BOOL	Flatten (const double flatness, Path *pOutput)
	Flatten a path. All curves within the path will be approximated by straight lines. pOutput may point at 'this' path ie a path can be flattened to itself. If the flattening fails for some reason, the output path will be unaffected even if you are flattening a path to itself.
BOOL	CreateFlatPath (const ProcessFlags &PFlags, const double flatness, Path *pOutput)
	Flatten a path. All curves within the path will be approximated by straight lines. pOutput may point at 'this' path ie a path can be flattened to itself. If the flattening fails for some reason, the output path will be unaffected even if you're flattening a path to itself.
BOOL	MakeSpaceInPath (INT32 NumSlots)
	Checks to see if there is already enough memory available to make the insertion and if not will try to allocate some more memory. If this works it will move the path (after the position indicated by the path class variable CurrentPos) along to make room for the correct number of slots at that point.
BOOL	MakeSpaceInPath (INT32 NumSlots, INT32 Position)
	Checks to see if there is already enough memory available to make the insertion and if not will try to allocate some more memory. If this works it will move the path after the position indicated by Position along to make room for the correct number of slots at that point.
BOOL	MakeSpaceAtEnd (INT32 NumSlots)
	Will make enough room for NumSlots unused slots at the end of the path.
BOOL	OpenGap (INT32 NumSlots)
	Will open a gap of NumSlots size in this path. The gap is positioned at CurrentPos (A path class variable).
BOOL	OpenGap (INT32 NumSlots, INT32 Position)
	Will open up a gap of NumSlots at the position Position within the path. If Position is set to the end of the path ie the same value as usedslots, no data will be moved. FALSE will ofcourse always be returned if there is not enough free space in the form of unused slots on the end of the path for the gap to open. Use MakeSpaceInPath() if you know there isn't enough room. See Also: MakeSpaceInPath, MakeSpaceAtEnd.
BOOL	EnsureVolume (INT32 NumSlots)
	This function ensures there are >= NumSlots in the path arrays. It may try to alter the size of the path arrays by increasing the number of unused slots to satisfy the request. It will never decrease the size of the arrays, if NumSlots < UsedSlots+UnusedSlots then the volume is automatically ensured. This allows path buffers to be resized ready for cloning.
BOOL	ExternalArraysAdded (const INT32 Added)
	A hidden function to adjust the number of elements in a path. This has been added by me as a last resort and should not be used by others. (Hence hidden from the documentation). It is required to cope with changes in the path data external to the path class. This occurs when doing really nasty things like moulding paths.
BOOL	ExternalArraysReplaced (const INT32 Size)
	A hidden function to adjust the number of elements in a path. This has been added by me as a last resort and should not be used by others. (Hence hidden from the documentation).
BOOL	HasWidth ()
	To determine if the path has any width information.
void	MapWidth (ChannelIndex)
	Alters the mapping of the Width Information to one of the ExtraInfo channels.
BOOL	InitExtraInfo (ChannelIndex)
	Allocates memory in the path for the extra info arrays.
BOOL	AddExtraInfo (ChannelIndex, INT32)
	Adds an extra Info Value at the current path position.
void	SyncExtraInfo ()
	Sets the Extra Info Ptr to the current Path Position.
void	NextExtraInfo ()
DocCoord	SmoothControlPoint (INT32 Index, BOOL StartAndEndSnapped=FALSE, BOOL JoinedToAnother=FALSE, BOOL OtherIsCurve=TRUE, const DocCoord &OtherCoord=DocCoord(0, 0))
	This function will handle the smoothing of a path. It is designed to take account of all the possibilities that might occur (hence the huge list of parameters). The various places where this function might be needed are:Calculates the smoothed position of a control point in a path. The smoothing is calculated based on the endpoint to which the control point is attached, and the endpoints on either side of this point. Since we are guaranteed that one of these segments is a curve (that's where the control point comes from) the other possibilities are: The curve just terminates (at the end of a path); The curve is attached to another curve; It is attached to a line; It is at the end, but the end joins the start of the same path, which could be a line or a curve; and the curve could be at the end, but snapping to a completely separate path segment which might either be a line or curve (this is what the JoinedToAnother, OtherIsCurve and OtherCoord parameters indicate.
BOOL	IsSubPathClosed (INT32 Index)
	Scans to the end of this subpath to see if it has the PT_CLOSEFIGURE flag set.
BOOL	IsClosed ()
	Tells you whether all subpaths of this path are closed.
BOOL	EnsureValid (BOOL *ChangesMade=NULL)
	Will attempt to make a path into a correct state. Checks are :- 1. All subpaths must start with a MoveTo 2. Consecutive MoveTos are removed 3. Zero element paths are unrepairable 4. MoveTos at the end of the path are removed 5. Should be three BezierTos in a row, only the last can be CloseFigure 6. A LineTo to the same location as the previous point is removed.
INT32	GetUsedSlots ()
Public Attributes
BOOL	IsFilled
BOOL	IsStroked
Private Member Functions
BOOL	InsertSectionAtEnd (const Path *Other, INT32 StartPos, INT32 NumSlots)
	Copies a section (usually a sub-path) of a path to the end of another path. This is used extensivly to Join Paths together. If there is not enougth space in this path, then the operation will fail - It will NOT try to make the path bigger. It is up to the caller to ensure that there are sufficent UnUsedSlots in the path before calling.
Private Attributes
INT32	m_ContourWidth
JoinStyles	m_ContourJoinS
CapStyles	m_ContourCapS
double	m_ContourFlatness
UINT32	m_ContourMitreLimit
UINT32	m_ContourLength
BOOL	m_IsAnOuterContour
BOOL	m_DoClosePath
BOOL	m_UseContourMode
MHANDLE	VerbHandle
MHANDLE	CoordHandle
MHANDLE	FlagsHandle
PathExtraInfo *	ExtraInfo
INT32	UnUsedSlots
INT32	UsedSlots
INT32	SlotAllocSize
INT32	SlotInitSize
INT32	CurrentPos

---

Detailed Description

Creation, manipulation and use of Paths. A path is an arbitary collection of MoveTo, LineTo and CurveTo segments Public Member variables :- BOOL IsFilled - TRUE if this path if filled, FALSE otherwise.

Author:

Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>

Date:

28/01/94

Definition at line 253 of file paths.h.

---

Constructor & Destructor Documentation

Path::Path (   )

constructor - just sets a few things to sensible values Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 28/01/94 Definition at line 182 of file paths.cpp. { // We do not have any memory yet UnUsedSlots = 0; UsedSlots = 0; SlotInitSize = 0; SlotAllocSize = 0; // set all the handles to bad in case they are used VerbHandle = BAD_MHANDLE; CoordHandle = BAD_MHANDLE; FlagsHandle = BAD_MHANDLE; // Set the path flags IsFilled = FALSE; IsStroked = TRUE; // Set the current path position CurrentPos = 0; // Setup the Extra Info Channels ExtraInfo = NULL; #if !defined(EXCLUDE_FROM_XARLIB) // Set up the contouring variables // m_pGPC = NULL; // m_pGSC = NULL; m_ContourLength = 0; m_IsAnOuterContour = true; m_DoClosePath = false; // MRH New! m_ContourWidth = 100; m_ContourJoinS = JOIN_MITER; m_ContourCapS = CAPS_BUTT; m_ContourFlatness = 200.0; // Set the mitre limit to 10 shifted 16. It`s done in two parts as it can cause overflow // problems if done as one call. m_ContourMitreLimit = 10; m_ContourMitreLimit <<= 16; m_UseContourMode = TRUE; #endif }

Path::~Path (   )

Destructor - releases the memory that the path has been using to store coords in. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 28/01/94 Definition at line 238 of file paths.cpp. { // Free the memory that the path is using to store its data in if (VerbHandle != BAD_MHANDLE) ReleaseBlock(VerbHandle); if (CoordHandle != BAD_MHANDLE) ReleaseBlock(CoordHandle); if (FlagsHandle != BAD_MHANDLE) ReleaseBlock(FlagsHandle); if (ExtraInfo != NULL) delete ExtraInfo; /* if(m_pGPC != NULL) { delete m_pGPC; m_pGPC = NULL; } if(m_pGSC != NULL) { delete m_pGSC; m_pGSC = NULL; } */ }

---

Member Function Documentation

BOOL Path::AddCurveTo (  DocCoord  p3, PathFlags *  NewFlags = NULL )

Adds a straight line version of a curve to the end of the path. The control points are positioned 1/3 and 2/3 along the line between its end points. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 11/12/94 Parameters: p3  - The endpoint [INPUTS] NewFlags - The flags to set the new coords to Returns: FALSE if there was an error, TRUE otherwise Errors: Can fail if it can not get enough memory to add the curve See also: Path::AddLineTo; Path::AddMoveTo Definition at line 2008 of file paths.cpp. { ERROR1IF( UsedSlots==0,FALSE,"No previous path elements when calling Path::AddCurveTo()" ); // set the current pos. CurrentPos = UsedSlots; // Find the coord of the last point in the path DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); DocCoord prev = Coords[CurrentPos-1]; // Create some temp coords DocCoord p1,p2; // calculate the intermediary control points p1.x = (2*prev.x + p3.x)/3; p1.y = (2*prev.y + p3.y)/3; p2.x = (prev.x + 2*p3.x)/3; p2.y = (prev.y + 2*p3.y)/3; return InsertCurveTo(p1,p2,p3,NewFlags); }

BOOL Path::AddCurveTo (  DocCoord  p1, DocCoord  p2, DocCoord  p3, PathFlags *  NewFlags = NULL )

Adds a Curve to the end of the path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/11/94 Parameters: p1  - The first control point [INPUTS] p2 - The second control point p3 - The endpoint NewFlags - The flags to set the new coords to Returns: FALSE if there was an error, TRUE otherwise Errors: Can fail if it can not get enough memory to add the curve See also: Path::AddLineTo; Path::AddMoveTo Definition at line 1986 of file paths.cpp. { CurrentPos = UsedSlots; return InsertCurveTo(p1,p2,p3,NewFlags); }

BOOL Path::AddExtraInfo (  ChannelIndex  Index, INT32  ExtraValue )

Adds an extra Info Value at the current path position. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 08/06/94 Parameters: -  [INPUTS] Returns: TRUE if all went well, FALSE if not Errors: Can fail if it runs out of memory Definition at line 8215 of file paths.cpp. { ENSURE(ExtraInfo != NULL, "ExtraInfo Pointer is NULL in AddExtraInfo"); return ExtraInfo->Add(Index, ExtraValue); }

BOOL Path::AddLineTo (  DocCoord  p1, PathFlags *  NewFlags = NULL )

Adds a new LineTo to the end of the path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/11/94 Parameters: p1  - the coord to draw the line to [INPUTS] NewFlags - Flags associtaed with the coord Returns: TRUE if it worked, FALSE if it failed to get more memory See also: Path::AddMoveTo; Path::AddCurveTo Definition at line 1961 of file paths.cpp. { CurrentPos = UsedSlots; return InsertLineTo(p1, NewFlags); }

BOOL Path::AddMoveTo (  DocCoord  p1, PathFlags *  NewFlags = NULL )

Adds a new MoveTo to the end of the path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/11/94 Parameters: p1  - the coord to draw the line to [INPUTS] NewFlags - Flags associtaed with the coord Returns: TRUE if it worked, FALSE if it failed to get more memory See also: Path::AddLineTo; Path::AddCurveTo Definition at line 1933 of file paths.cpp. { // Sadly there is no way for the outside world to set the insert position // to the end of the path!! SetPathPosition() for instance sets the currentpos to // usedslots-1, when passed usedslots which means you can never ever call InsertLineTo // and expect a line to be added to the pathend, it will be inserted before the element // which is the last in the path. Ok so this function does the job. CurrentPos = UsedSlots; return InsertMoveTo(p1, NewFlags); }

INT32 Path::BreakInTwo (  Path *  pChildPath  )

Tests a path to see if it is valid. This is only built into DEBUG versions of Camelot so always surround calls to it with an ifdef _DEBUG block. If the path is not valid in some way, this function will dump an explanation to the debug terminal and return FALSE.This function will attempt to break the current path at its first selected point. All selected points should still be in place in both parent and child. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 30/8/94 Parameters: pChildPath,a  pointer to a split path which should have been passed to new() [INPUTS] -  [OUTPUTS] Returns: -1 If unable to claim enough memory to split the path. Note pChildPath is unchanged and 'this' is also unaffected 0 If no selected points were found in the path. 1 Then the current path is opened at the first selected point. pChildPath is unaffected. 2 Then the current path now contains the left child data of the split and pChildPath points at a new path object containing the right child data. Errors: - See also: - Definition at line 8780 of file paths.cpp. { // Get arrays of flags,verbs and points. PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); // p,q indexes to selected point and endof(sub)path INT32 p = -1; INT32 q = -1; INT32 s = 0; // vp,vq local verb holders PathVerb vp; PathVerb vq; while (p++, FindNextSelected(&p)) { q = p; FindEndElOfSubPath(&q); // returns index of last element in this subpath/path if (p>q) return 0; // just a quick check on sanity. s = p; FindStartOfSubPath(&s); // grab the start of the subpath if (p==q) { if (!(Verbs[p] & PT_CLOSEFIGURE)) continue; // ignore selected points at end of open subpaths p=s; } vp = (Verbs[p] & ~PT_CLOSEFIGURE); vq = (Verbs[q]); // Have we found a selected start point? if (vp == PT_MOVETO) { if (vq & PT_CLOSEFIGURE) { // subpath figure is closed, so open the path and resolve flags Verbs[q] &= ~PT_CLOSEFIGURE; if (Flags[q].IsSelected) { Flags[q].IsSelected = FALSE; Flags[q].IsSmooth = FALSE; if (Verbs[q] == PT_BEZIERTO) { Flags[q-1].IsSelected = FALSE; Flags[q-1].IsSmooth = FALSE; } if (Verbs[p+1] == PT_BEZIERTO) Flags[p+1].IsSmooth = FALSE; } return 1; } continue; } // Note these elements should not need to be checked against PT_CLOSEFIGURE as // (p!=q) and q is the following close element. if ((vp == PT_LINETO) || (vp == PT_BEZIERTO)) { // ok, we have a selected element on a lineto/curveto. We need to check // whether we are in a closed subpath or an open one if ( vq & PT_CLOSEFIGURE ) // is this sub path closed? { // We need to reorder the subpath points and open the path. // This involves // (1) insert moveto(p) at p+1 // (2) increment q // (3) remove closefigure at q // (4) replace moveto(s) by lineto(s) // (5) rotate the whole path left/right until element p // lies at element s // subpath figure is closed, so open the path in parent if ((Coords[s].x == Coords[q].x) && (Coords[s].y == Coords[q].y)) { // I'm not totally convinced about this but here goes nothing! // When dealing with a chain of bezier control points, the previous // and following points are selected also. What we select and deselect // depends on which point (the start or end) we want selected when the // path is opened. I thought it would be sensible to leave the end point // selected but the click logic then does not allow you to drag the damn // point around! as it still lies on top of the deselected start point. // So lets try to select the new moveto and see what happens. Flags[p].IsSelected = FALSE; // deselect the current control point Flags[p].IsSmooth = FALSE; if (vp == PT_BEZIERTO) { Flags[p-1].IsSelected = FALSE; Flags[p-1].IsSmooth = FALSE; } CurrentPos = s; DeleteElement(); // Get rid of the original moveto CurrentPos = p; InsertMoveTo(Coords[p-1]); Flags = (PathFlags*) DescribeHandle(FlagsHandle); Verbs = (PathVerb*) DescribeHandle(VerbHandle); Flags[p].IsSelected = TRUE; // make sure the moveto is selected Flags[p].IsSmooth = FALSE; // but not smooth if ((Verbs[p+1] & ~PT_CLOSEFIGURE) == PT_BEZIERTO) Flags[p+1].IsSmooth = FALSE; Verbs[q] &= ~PT_CLOSEFIGURE; // open the subpath. RotateElementsLeft(s,q,p-s); // rotate elements return 1; } else { // this section definitely needs more work! CurrentPos = p+1; if (!InsertMoveTo(Coords[p])) return -1; q++; Verbs = (PathVerb*) DescribeHandle(VerbHandle); Verbs[q] &= ~PT_CLOSEFIGURE; // open the subpath. Verbs[s] = PT_LINETO; // alter move to line RotateElementsLeft(s,q,p-s+1); // rotate elements return 1; } } else { // I need to alter the current path object and create a completely new // path object in the tree. This will contain the split section of the // parent path. This involves // (1) create newpath(p => q) by // (1.1) creating enough space for elements (p-q + 1) // (1.2) copying elements in // (1.3) replacing verb(p) by moveto // (2) removal of elements (p+1 => q) // Initialise the path with enough space for splinter q = UsedSlots-1; if (!pChildPath->Initialise(q-p+1,12)) return -1; // Copy the section out of the current path into the child if (!(CopySectionTo(pChildPath, p, q-p+1))) return -1; // Alter the childs first element once split, to a moveto. PathVerb* pChildVerbs = (PathVerb*) DescribeHandle(pChildPath->VerbHandle); PathFlags* pChildFlags = (PathFlags*) DescribeHandle(pChildPath->FlagsHandle); pChildVerbs[0] = PT_MOVETO; // Make sure the child paths first element is no longer smooth pChildFlags[0].IsSmooth = FALSE; if (pChildVerbs[1] == PT_BEZIERTO) pChildFlags[1].IsSmooth = FALSE; // Make sure the parent subpath start is deselected. It may have been selected // by the previous instructions from a previous iteration. Flags[s].IsSelected = FALSE; if (Verbs[s] == PT_BEZIERTO) Flags[s+1].IsSelected = FALSE; // Remove the parents end point smooth bit, but leave it selected Flags[p].IsSmooth = FALSE; if (vp == PT_BEZIERTO) Flags[p-1].IsSmooth = FALSE; // ok remove the necessary elements from the original path DeleteFromElement(p+1); return 2; } } } return 0; }

XLONG Path::CalcArea (   )

Calculate the area of this path. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 01/03/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Area of path in path units (typically millipoints) Or -1 if no area could be calculated See also: - Definition at line 10290 of file paths.cpp. { // Check whether it's closed! if (!IsFilled) return 0; // First, use ClipPathToPath to get a path that has no self-intersections... // Next flatten it Path FlatPath; FlatPath.Initialise(); BOOL bOK = Flatten(64, &FlatPath); if (!bOK) return -1; // Finally, compute the area under each flattened segment and sum them // (+dx adds to area, -dx subtracts from area) INT32 i = 0; XLONG area = 0; XLONG dx = 0; DocRect bounds = GetBoundingRect(); INT32 baseline = bounds.lo.y; // PathFlags* pFlags = FlatPath.GetFlagArray(); DocCoord* pCoords = FlatPath.GetCoordArray(); PathVerb* pVerbs = FlatPath.GetVerbArray(); DocCoord origin(0,0); for (i=0; i < FlatPath.GetNumCoords(); i++) { if (pVerbs[i] == PT_MOVETO) origin = pCoords[i]; else if (pVerbs[i] == PT_LINETO) { // area of this segment is area of rectangle under origin.y + area of triangle from origin to current point dx = pCoords[i].x - origin.x; area += dx*(XLONG)(origin.y-baseline) + dx*(XLONG)((ABS(pCoords[i].y - origin.y))/2); origin = pCoords[i]; } else if (pVerbs[i] == PT_CLOSEFIGURE) { // do nothing } else ERROR3("Unexpected path verb"); } // Counter-clockwise paths will generate -ve areas return ABS(area); }

INT32 Path::CalcCRC (   )

Calculates a cyclic redundancy check value for a path. This CRC is invariant under translation only. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/94 Parameters: -  [INPUTS] Returns: The CRC checksum for the path, relative to the first coord Definition at line 8024 of file paths.cpp. { return CalcRegionCRC(0,UsedSlots-1); }

void Path::CalcDoubleCurve (  DocCoord &  p1, DocCoord &  p2, DocCoord &  p3, DocCoord *  ControlPoint1, DocCoord *  ControlPoint2 )

Calculates the position of the two control points on either side of p2, using the position of the coords of either side of it to help (p1 & p3). Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/11/93 Parameters: p1,p2,p3  - The End points of the path elements before, after and at the [INPUTS] the current position in the path ControlPoint1,ControlPoint2  - Pointers to the control points on either [OUTPUTS] side of the current point See also: Path::CalcPointLine; Path::CalcPointEnd Definition at line 4797 of file paths.cpp. { // The positions of the two control points adjacent to p2 depend on: // a) The distance from p2 of p1 and p3, and // b) The angle between p1p2p3. The following logic is used: // // The distance from p2 to ControlPoint1 is 1/3 the distance from p2 to p1 // The angle from p2 to ControlPoint1 and the horizontal is 90 degrees from the angle of the line // bisecting the angle p1p2p3. Whether it is -90 or +90 depends on whether the acute angle between p1p2p3 // is negative or positive // Work out the angles double Alpha, Beta, Theta; Alpha = atan2((double)p3.y-p2.y, (double)p3.x-p2.x); // Alpha = angle between line p2p3 and horizontal Beta = atan2((double)p1.y-p2.y, (double)p1.x-p2.x); // beta = angle between line p2p1 and horizontal Theta = (Beta + ((Alpha - Beta)/2.0)); // Theta = bisection of Alpha and Beta // And calculate the distance between the various control points double Distp2p1, Distp2p3, lx, ly; lx = p2.x - p1.x; ly = p2.y - p1.y; Distp2p1 = sqrt( lx*lx + ly*ly ) / 3.0; lx = p2.x - p3.x; ly = p2.y - p3.y; Distp2p3 = sqrt( lx*lx + ly*ly ) / 3.0; if (Alpha - Beta < 0) { // Angle p2p1 is greater than p2p3, so we have to swap the angle used ControlPoint1->x = p2.x + (INT32)(Distp2p1 * cos(Theta + PI/2.0)); ControlPoint1->y = p2.y + (INT32)(Distp2p1 * sin(Theta + PI/2.0)); ControlPoint2->x = p2.x + (INT32)(Distp2p3 * cos(Theta - PI/2.0)); ControlPoint2->y = p2.y + (INT32)(Distp2p3 * sin(Theta - PI/2.0)); } else { ControlPoint1->x = p2.x + (INT32)(Distp2p1 * cos(Theta - PI/2.0)); ControlPoint1->y = p2.y + (INT32)(Distp2p1 * sin(Theta - PI/2.0)); ControlPoint2->x = p2.x + (INT32)(Distp2p3 * cos(Theta + PI/2.0)); ControlPoint2->y = p2.y + (INT32)(Distp2p3 * sin(Theta + PI/2.0)); } // // Work out all the angles // double Alpha, Beta, Theta; // Alpha = atan2( (p3.y-p2.y), (p3.x - p2.x) ); // Beta = atan2( (p2.x - p1.x), (p2.y - p1.y) ); // Theta = (PI/2.0 - Alpha - Beta) / 2.0; // // And calculate the distance between the various control points // double DistA, DistB, lx, ly; // lx = p2.x - p1.x; // ly = p2.y - p1.y; // DistA = sqrt( lx*lx + ly*ly ) / 3.0; // lx = p2.x - p3.x; // ly = p2.y - p3.y; // DistB = sqrt( lx*lx + ly*ly ) / 3.0; // // if (Theta < PI/2.0) // { // // // Set the control point // ControlPoint1->x = p2.x - (INT32)(DistA*sin(Theta+Beta)); // ControlPoint1->y = p2.y - (INT32)(DistA*cos(Theta+Beta)); // ControlPoint2->x = p2.x + (INT32)(DistB*cos(Theta+Alpha)); // ControlPoint2->y = p2.y + (INT32)(DistB*sin(Theta+Alpha)); // } // else // { // // Set the control point // ControlPoint1->x = p2.x + (INT32)(DistA*sin(Theta+Beta)); // ControlPoint1->y = p2.y + (INT32)(DistA*cos(Theta+Beta)); // ControlPoint2->x = p2.x - (INT32)(DistB*cos(Theta+Alpha)); // ControlPoint2->y = p2.y - (INT32)(DistB*sin(Theta+Alpha)); // // } }

void Path::CalcPointCurve (  DocCoord &  p1, DocCoord &  p2, DocCoord &  p3, DocCoord *  ControlPoint )

Calculates the position of the control point adjacent to p2 between p2 and p3, using the position of the coords of either side of it to help (p1 & p3). Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/11/93 Parameters: p1,p2,p3  - The End points of the path elements before, after and at the [INPUTS] the current position in the path ControlPoint  - Pointer to the control point that appears just after p2. [OUTPUTS] imagine the following path structure: moveto p1 curveto pa curveto pb curveto p2 <- This is the endpoint to which the ctrl point is attached curveto pc <- This is the control point being calculated curveto pd curveto p3 See also: Path::CalcPointLine; Path::CalcPointEnd Definition at line 4913 of file paths.cpp. { // Work out all the angles double Alpha, Beta, Theta; Alpha = atan2((double)p3.y-p2.y, (double)p3.x-p2.x); Beta = atan2((double)p1.y-p2.y, (double)p1.x-p2.x); Theta = Beta - ((Beta - Alpha)/2.0); // And calculate the distance between the various control points double Dist, lx, ly; lx = p2.x - p3.x; ly = p2.y - p3.y; Dist = sqrt( lx*lx + ly*ly ) / 3.0; if (Beta - Alpha < 0) Theta += PI/2.0; else Theta -= PI/2.0; ControlPoint->x = p2.x + (INT32)(Dist * cos(Theta)); ControlPoint->y = p2.y + (INT32)(Dist * sin(Theta)); /* if (Theta < PI/2.0) { // Set the control point ControlPoint->x = p2.x - (INT32)(Dist*sin(Theta+Beta)); ControlPoint->y = p2.y - (INT32)(Dist*cos(Theta+Beta)); } else { // Set the control point ControlPoint->x = p2.x + (INT32)(Dist*sin(Theta+Beta)); ControlPoint->y = p2.y + (INT32)(Dist*cos(Theta+Beta)); } */ }

void Path::CalcPointEnd (  DocCoord &  p1, DocCoord &  p2, DocCoord *  ControlPoint )

Calculates the position of the last control point in the sub-path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/11/93 Parameters: p1,p2  - The coords of the last two points in the curve [INPUTS] ControlPoint  - The Coord of the last control point [OUTPUTS] See also: Path::CalcPointLine; Path::CalcPointCurve Definition at line 5009 of file paths.cpp. { ControlPoint->x = p1.x + ((p2.x - p1.x) / 3); ControlPoint->y = p1.y + ((p2.y - p1.y) / 3); }

void Path::CalcPointLine (  DocCoord &  p1, DocCoord &  p2, DocCoord &  p3, DocCoord *  ControlPoint )

Calculates the position of the control point that appears after p2, which is part of the curve ending at p3. The control point should be colinear with p1 & p2 and 1/3 the distance between p2 & p3 from p2! Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/11/93 Parameters: p1,p2,p3  - The End points of the path elements before, after and at the [INPUTS] the current position in the path ControlPoint  - Pointers to the control point between p2 and p3 [OUTPUTS] See also: Path::CalcPointLine; Path::CalcPointEnd Definition at line 4972 of file paths.cpp. { // Calc 1/3 the distance from p2 to p3 double DistA, DistB, lx, ly; lx = p2.x - p3.x; ly = p2.y - p3.y; DistA = sqrt( lx*lx + ly*ly ) / 3.0; // calc the length of p1 to p2 lx = p2.x - p1.x; ly = p2.y - p1.y; DistB = sqrt( lx*lx + ly*ly ); // Calculate the scale factor double Factor = (DistB==0.0) ? 1.0 : (DistA / DistB); lx *= Factor; ly *= Factor; // Calc the position of the new control points ControlPoint->x = p2.x + (INT32)lx; ControlPoint->y = p2.y + (INT32)ly; }

INT32 Path::CalcRegionCRC (  const INT32  StartIndex, const INT32  EndIndex )

Calculates a cyclic redundancy check value for a path region. This CRC is only invariant under translation. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>/Mike Date: 11/11/94 Parameters: StartIndex  = index into coord array to start calculating from [INPUTS] EndIndex = index into coord array to end calculation (inclusive) Returns: The CRC checksum for the region, relative to StartIndex Definition at line 8047 of file paths.cpp. { INT32 TotalCRC = 0; DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); for (INT32 i=StartIndex; i<(EndIndex+1); i++) { // Get the coords relative from the first coord // making this process transparent to translation // Add it in to the CRC total TotalCRC += (Coords[i].x-Coords[StartIndex].x) + (Coords[i].y-Coords[StartIndex].y); } return TotalCRC; }

void Path::CalcRotate (  DocCoord &  p2, DocCoord *  p1, DocCoord *  p3, DocCoord &  MouseOffset )

Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 19/11/93 Parameters: p1,p2,p3  - The End points of the path elements before, after and at the [INPUTS] the current position in the path ControlPoint  - Pointers to the control point between p2 and p3 [OUTPUTS] See also: Path::CalcPointLine; Path::CalcPointEnd Definition at line 5033 of file paths.cpp. { double dx, dy, Length; // Find the length of the vector from the middle to the point not being dragged dx = p2.x - p3->x; dy = p2.y - p3->y; Length = sqrt( dx*dx + dy*dy ); // Move the point being dragged p1->x += MouseOffset.x; p1->y += MouseOffset.y; // Calculate the vector from the point being dragged to the centre double VecLen; dx = p1->x - p2.x; dy = p1->y - p2.y; VecLen = sqrt( dx*dx + dy*dy ); if (VecLen == 0.0) // the dragged point is over the centre point, so leave the other control point where it is return; // Normalise the vector and // Scale the vector by the Length of the other side dx = dx * Length / VecLen; dy = dy * Length / VecLen; // Set the opposite point to the centre offset by the vector p3->x = p2.x - (INT32)dx; p3->y = p2.y - (INT32)dy; }

INT32 Path::CalcSelectedCRC (   )

Calculates a cyclic redundancy check value for a paths selected coordinates. This CRC is invariant under translation only. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/94 Parameters: -  [INPUTS] Returns: The CRC checksum for the path, relative to the first coord Definition at line 8081 of file paths.cpp. { return CalcSelPointsCRC(0,UsedSlots-1); }

INT32 Path::CalcSelPointsCRC (  const INT32  StartIndex, const INT32  EndIndex )

Calculates a cyclic redundancy check value for a paths selected coordinates. This CRC is invariant under translation only. It can be used to determine whether a new path matches that of an old path whose CRC we already know, whether the new path has been translated or not. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>/Mike Date: 11/11/94 Parameters: StartIndex  = index into coord array to start calculating from [INPUTS] EndIndex = index into coord array to end calculation (inclusive) Returns: The CRC checksum for the region, relative to StartIndex Definition at line 8104 of file paths.cpp. { INT32 TotalCRC = 0; DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); for (INT32 i=StartIndex; i<(EndIndex+1); i++) { if (Flags[i].IsSelected) TotalCRC += (Coords[i].x-Coords[StartIndex].x) + (Coords[i].y-Coords[StartIndex].y); } return TotalCRC; }

double Path::CalculateFlatnessValueFromPath (  double  DividerValue = 375.0, double  LowerLimit = 1.0, double  UpperLimit = 375.0 )

To calculate a suitable flatness value to be used with Contouring, Clipping and Stroking. The value is based on the actual size of the paths dimensions. Author: Mark_Howitt (Xara Group Ltd) <camelotdev@xara.com> Date: 25/10/2000 Parameters: Divider  Value which is incorperated into the calculation. [INPUTS] Lower and Upper Limits that the return value should be within. Returns: New calculated flatness value OR 0.0 if the path is empty! Definition at line 5394 of file paths.cpp. { // Check to see if this path is empty, if so then just return 0. if(UsedSlots == 0) return 2.0; // Check to see if we`ve been given suitable values to use! if(LowerLimit < 1.0) { ERROR3("When I said give me a lower limit, I meant one larger than 1!"); LowerLimit = 2.0; } if(UpperLimit < 1.0 || UpperLimit < LowerLimit) { ERROR3("When I said give me an Upper limit, I meant one larger than the Lower limit!"); UpperLimit = 375.0; } if(DividerValue < 1.0) { ERROR3("When I said give me a Divider Value, I meant one greater than 1!"); DividerValue = 375.0; } // Set up the CalcFlatness value double CalcFlatness = 375.0; // Get the smallest dimesion, Width or Height. DocRect drBounds = GetBoundingRect(); double Smallest = drBounds.Height() < drBounds.Width() ? (double)drBounds.Height() : (double)drBounds.Width(); // now make the flatness value equal to the smallest dimesion divided by the passed in DividerValue! CalcFlatness = Smallest / DividerValue; // Check to see if we`re within the specified limits if(LowerLimit > CalcFlatness) CalcFlatness = LowerLimit; if(UpperLimit < CalcFlatness) CalcFlatness = UpperLimit; TRACEUSER( "MarkH", _T("Calculated Flatness = %lf\n"),CalcFlatness); // Return the new calculated flatness value! return CalcFlatness; }

BOOL Path::ChangeStartElement (  INT32  StartIndex  )

This will rotate the path so that the element that was at StartIndex is now at index 0. You should only call this for closed paths that don't contain subpaths. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 8/11/94 Parameters: StartIndex  - The index to the element in the path that you want to be the start [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE otherwise Errors: In debug builds, an error is given if the last coord != first coord Definition at line 9141 of file paths.cpp. { if (StartIndex < 1 || StartIndex >= UsedSlots) { ERROR3_PF(("StartIndex out of range : %ld",StartIndex)); return FALSE; } DocCoord* pCoords = GetCoordArray(); PathVerb* pVerbs = GetVerbArray(); PathFlags* pFlags = GetFlagArray(); ERROR3IF(pCoords[0] != pCoords[UsedSlots-1],"Not closed because first coord != last coord"); // Make sure the last verb has the PT_CLOSEFIGURE flag cleared pVerbs[UsedSlots-1] = pVerbs[UsedSlots-1] & ~PT_CLOSEFIGURE; // Delete the MoveTo CurrentPos = 0; DeleteElement(); ERROR3IF(UnUsedSlots < 1,"DeleteElement() didn't leave me any unused slots"); if (UnUsedSlots < 1) return FALSE; // Rotate the element at StartIndex to index 0 RotateElementsLeft(0,UsedSlots-1,StartIndex-1); // We need a duplicate element type & verb to finish the path off, so copy on end of arrays pCoords[UsedSlots] = pCoords[0]; pVerbs [UsedSlots] = pVerbs [0] | PT_CLOSEFIGURE; // Make sure last verb has also got this flag set pFlags [UsedSlots] = pFlags [0]; // The first element is always a MoveTo pVerbs[0] = PT_MOVETO; // Update the path vars. UsedSlots++; UnUsedSlots--; return TRUE; }

void Path::ClearNeedToRender (   )

Sets the NeedToRender flags on all of the path elements to FALSE. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 24/1/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - Definition at line 9545 of file paths.cpp. { PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); for (INT32 loop = GetNumCoords()-1; loop >= 0 ; loop--) { Flags[loop].NeedToRender = FALSE; } }

BOOL Path::ClearPath (  BOOL  compress  )

Empties the path of all its entries. If compress is TRUE the routine will try to free up excessive amounts of unused memory left over at the end. It also now resets CurrentPos back to zero. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 16/11/94 Parameters: compress  - a boolean, to describe whether to compress the paths memory [INPUTS] or not. Returns: TRUE if it was able to free up the unused parts of the path, FALSE if there was a memory de-alloc error See also: Path::Compact(); Definition at line 2438 of file paths.cpp. { if (UsedSlots>0) { // reset the path definitions UnUsedSlots+=UsedSlots; UsedSlots=0; CurrentPos=0; // make sure we compress memory if necessary if (compress) Compact(); // ignore any error coming from here } return TRUE; }

BOOL Path::ClearPath (   )

Empties the path of all its entries and tries to free up excessive amounts of unused memory left over at the end. It does keep some memory though, ready for a new path to be put into it. It also now resets CurrentPos back to zero. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 16/02/94 Returns: TRUE if it was able to free up the unused parts of the path, FALSE if there was a memory de-alloc error Definition at line 2408 of file paths.cpp. { if (UsedSlots==0) return TRUE; BOOL ok = DeleteSection(0,UsedSlots); if (ok) CurrentPos=0; return ok; }

void Path::ClearSubSelection (   )

Goes through the path and sets all the IsSelected flags to FALSE, clearing any selected control points in the path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/94 Definition at line 3572 of file paths.cpp. { // We need to find all the selected control points in the path and de-select them PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); for (INT32 i=0; i<UsedSlots; i++) Flags[i].IsSelected = FALSE; }

INT32 Path::ClipPathToPath (  const Path &  Src, Path *const   pDest, UINT32  Flags, UINT32  Tolerance = 100, double  SrcFlatness = 750.0, double  ClipFlatness = 750.0 )

This is an interface to Gavin's ClipPathToPath. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 17/1/95 Parameters: Src  = source path to clip [INPUTS] pDest = ptr to path to place the result in Flags = Gavin's ClipPathToPath flags (see below) Tolerence = Two points closer than this value are considered the same point SrcFlatness = the value used to flatten the src path ClipPath = the value used to flatten the clip path If  returned a value >=0, *pDest contains the resultant path. [OUTPUTS] Returns: The length of the resultant path in pDest, or -1 for an error. 'this' path is used as the clip path. Src is clipped to this path and the result is placed in pDest. 'Flags' controls how Src will be clipped to this path (taken from gclip.h - complaints go to Gavin) CLIPPING_STYLE - Clip style 001 - Source AND NOT Clip (subtract Clip from Source) 010 - Source AND Clip (Intersection) 011 - Source 100 - NOT Source AND Clip (subtract Source from Clip) 101 - Source EOR Clip 110 - Clip 111 - Source OR Clip (Union) If stroked then 000 - Source AND Clip (Intersection) ??? - Source AND NOT Clip CLIPPING_SOURCE_WINDING - Source path winding. CLIPPING_CLIP_WINDING - Clip path winding. CLIPPING_IS_STROKED - Source is stroked, not filled CLIPPING_IS_CLOSED - Source path is to be closed (only applicable if stroked). NOTE: The path placed in pDest will not have its flags array initialised. If you require this (e.g. the path is part of a NodePath and is going in the tree) call Path::InitialiseFlags() on pDest. If you don't, the path won't be editable via the bezier tool. Definition at line 5483 of file paths.cpp. { ERROR2IF(pDest == NULL,-1,"pDest == NULL"); // We need a temp path to place the result in (return -1 if it fails to initialise) Path Output; if (!Output.Initialise()) return -1; // Mark Howitt - 1/9/00 // Guessing is not good practice. The major problem in this function is that we need // to allocate memory before we know how much to allocate!!! This results in more memory than needed being used // and also the risk of under estimating leading to failure! // The way to fix this is get Gavin to do the allocation for us and then return the amount. This is currently the // way the contouring code works which results in no guessing and exact memory allocation. NO WASTE! // To quickly fix this problem I`m going to make it so that if it comes back with buffer overflow, we double the // allocation and try again. If this fails after 5 times then return -1 and error2 with failure. This is still not // very good but will fix a majority of the bugs we are seeing. MUST BE REPLACED!!!!! // Try and guess how big the destination path's buffers will have to be in order to take the result. INT32 NewSize = ((UsedSlots + Src.UsedSlots)*2)+1000; // Make sure the destination path is big enough if (!Output.MakeSpaceInPath(NewSize)) return -1; // Set up the params for ClipPathToPath, Gavin-style! PPOINT SPoints,CPoints,OPoints ; PBYTE STypes ,CTypes ,OTypes ; UINT32 SLength,CLength,OLength ; if ( (Flags & 7)==6 && !(Flags & 0x40) ) { SPoints = NULL; STypes = NULL; SLength = 0; } else { SPoints = (PPOINT) Src.GetCoordArray(); STypes = (PBYTE) Src.GetVerbArray(); SLength = Src.UsedSlots; } if ( (Flags & 7)==3 && !(Flags & 0x40) ) { CPoints = NULL; CTypes = NULL; CLength = 0; } else { CPoints = (PPOINT) GetCoordArray(); CTypes = (PBYTE) GetVerbArray(); CLength = UsedSlots; } OPoints = (PPOINT) Output.GetCoordArray(); OTypes = (PBYTE) Output.GetVerbArray(); OLength = NewSize; INT32 len = -2; INT32 Passes = 0; // Mark Howitt 1/9/00 // New loop to help fix under allocation bugs. NEEDS REPLACING WITH BETTER CODE!!! See above! while(len == -2 && Passes++ < 10) { len = ::ClipPathToPath( SPoints,STypes,SLength,SrcFlatness, CPoints,CTypes,CLength,ClipFlatness, Flags,Tolerance, OPoints,OTypes,OLength-10); // -10 to safe guard against possible minor buffer overflow if(len == -1) return -1; else if(len == -2) { // Ok, we under estimated so double it and reset the output path variables! OLength <<= 1; if (!Output.EnsureVolume(OLength)) return -1; Output.ClearPath(); OPoints = (PPOINT) Output.GetCoordArray(); OTypes = (PBYTE) Output.GetVerbArray(); } } // If we get here with len == -2 then we failed in 5 attempts to allocate enough space! if(len < 0) return -1; // Clear pDest and make sure there's enough space in pDest for the result pDest->ClearPath(); if (!pDest->MakeSpaceInPath(len)) return -1; // Copy the resultant path into it. if (!pDest->MergeTwoPaths(Output.GetCoordArray(),Output.GetVerbArray(),Output.GetFlagArray(),len,Src.IsFilled)) return -1; // YES! we have a result return len; }

BOOL Path::CloneFrom (  const Path &  Other  )

Replace the data within this path with that of Other path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 Parameters: Other  = pointer to a path to copy data from [INPUTS] Returns TRUE if successful FALSE if unable in increase the size of this path to cope with all data in 'Other' Definition at line 7277 of file paths.cpp. { // Make space to copy all the data from the other path into this one INT32 SlotsToCopy = Other.UsedSlots; INT32 SlotsToAdd = SlotsToCopy-UsedSlots; if (SlotsToAdd>0) { if (!MakeSpaceAtEnd(SlotsToAdd)) return FALSE; } // We will need all the arrays from the other path DocCoord* SCoords = (DocCoord*) DescribeHandle(Other.CoordHandle); PathVerb* SVerbs = (PathVerb*) DescribeHandle(Other.VerbHandle); PathFlags* SFlags = (PathFlags*) DescribeHandle(Other.FlagsHandle); // Get the destination arrays DocCoord* DCoords = (DocCoord*) DescribeHandle(CoordHandle); PathVerb* DVerbs = (PathVerb*) DescribeHandle(VerbHandle); PathFlags* DFlags = (PathFlags*) DescribeHandle(FlagsHandle); // copy all arrays from the source to destination if (SlotsToCopy>0) { if (SCoords != NULL) memmove((void*)(DCoords), (void*)(SCoords), SlotsToCopy*sizeof(DocCoord)); if (SVerbs != NULL) memmove((void*)(DVerbs), (void*)(SVerbs), SlotsToCopy*sizeof(PathVerb)); if (SFlags != NULL) memmove((void*)(DFlags), (void*)(SFlags), SlotsToCopy*sizeof(PathFlags)); } // Now update the array variables UsedSlots += SlotsToAdd; UnUsedSlots -= SlotsToAdd; CurrentPos = UsedSlots; return TRUE; }

DocCoord Path::ClosestPointTo (  const double  t, const INT32  index )

This function returns the point at which the closest distance on the path occurs. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 22/08/94 Parameters: t  = closest distance parameter [INPUTS] index = closest distance path element index [OUTPUTS]  Returns: DocCoord, the closest point on the path Errors: Ensures the indexed path element is either a lineto or bezierto Definition at line 7004 of file paths.cpp. { // Get the coord list and verb list for this path instance DocCoord* Coords = GetCoordArray(); PathVerb* Verbs = GetVerbArray(); PathVerb Verb = Verbs[index] & ~PT_CLOSEFIGURE; if ((t==0) && (index==0)) return Coords[0]; ENSURE(UsedSlots>1, "Not enough elements in path"); ENSURE(index>=0, "invalid formal parameter: index"); ENSURE((Verb == PT_LINETO) || (Verb == PT_BEZIERTO), "Unable to find point on path. Index does not specify line or curve"); if (index<UsedSlots) { switch (Verb) { case PT_LINETO: return PathUtil::PointOnLine(t,&Coords[index-1]); break; case PT_BEZIERTO: return PathUtil::PointOnCurve(t,&Coords[index-1]); break; } } // code should not really get here! if it does, return the first element // of the curve return (Coords[0]); }

BOOL Path::ClosestSelectedEndpoint (  DocCoord  pos, INT32 *  position, double *  distance )

This function finds the closest selected line end to the cursor position passed in. If the path has no selected line ends, the function returns FALSE. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/94 Parameters: pos  - mouse position to be tested [INPUTS] position  - index to the point that was matched [OUTPUTS] unchanged if no match distance - distance between the specified point and the closest selected endpoint (unchanged if there are none) Returns: TRUE if a match was found, FALSE if not Definition at line 7213 of file paths.cpp. { // Get arrays for this path DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); PathFlags* PFlags = (PathFlags*) DescribeHandle(FlagsHandle); double nearest = 0; double tempdistance = 0; BOOL foundany = FALSE; // Scan from the end of the path to the start. We remember the last point in the subpath // and go back until we hit a MoveTo. then we look at both the elements, and if the // CloseFigure flag isn't set in the end element, the subpath must be open, in which // case we look at the endpoints and see if they are closer to pos than others. INT32 endpoint = UsedSlots-1; for (INT32 i=UsedSlots-1;i>=0;i--) { if (Verbs[i] == PT_MOVETO) { // only check the ends if CLOSEFIGURE is not set in the end verb if (!(Verbs[endpoint] & PT_CLOSEFIGURE)) { // first check the moveto tempdistance = Coords[i].Distance(pos); if ((PFlags[i].IsSelected) && (!foundany || (nearest>tempdistance))) { *position = i; nearest = tempdistance; foundany = TRUE; } // Now check the end point tempdistance = Coords[endpoint].Distance(pos); if ((PFlags[endpoint].IsSelected) && (!foundany || (nearest>tempdistance))) { *position = endpoint; nearest = tempdistance; foundany = TRUE; } } endpoint = i-1; } } return(foundany); }

BOOL Path::CloseSubPath (   )

To indicate that a path is closed with a line, you should call CloseSubPath with the Current Path Position indicator somewhere inside the sub-path that you want closed. This function will adjust the verb of the last line segment in the sub-path by adding the PT_CLOSEFIGURE element into as described in the NT Prog Reference guides for the PolyDraw() function (page 304 of book 4 at last count) The Current Path Position is left on the element at the end of the subpath. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Returns: TRUE if it worked, FALSE if it fails (ie you tried to close a path that only had a PT_MOVETO element in it. Definition at line 2226 of file paths.cpp. { // need to search for either a MoveTo or the end of the path and insert a close // path just before it. We start from the position supplied PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // We are inside the path somewhere while (CurrentPos+1<UsedSlots) { if (Verbs[CurrentPos+1]==PT_MOVETO) { // go back one and close the path ENSURE( Verbs[CurrentPos]!=PT_MOVETO, "You can not close a path at a moveto" ); if (Verbs[CurrentPos]==PT_MOVETO) return FALSE; Verbs[CurrentPos] = Verbs[CurrentPos] | PT_CLOSEFIGURE; return TRUE; } CurrentPos++; } // Make sure we are in the path if (CurrentPos>=UsedSlots) CurrentPos = UsedSlots-1; // We are right at the end of the path, so change the last path element ENSURE( Verbs[CurrentPos]!=PT_MOVETO, "You can not close a path at a moveto" ); if (Verbs[CurrentPos]==PT_MOVETO) return FALSE; Verbs[CurrentPos] = Verbs[CurrentPos] | PT_CLOSEFIGURE; CurrentPos++; return TRUE; }

BOOL Path::Compact (   )

Removes any extraneous unused slots in a path. It will a maximum of 2n-1 slots free where n is the size of an allocation chunk when increasing the buffer (see Path::Initialise). Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: -  [INPUTS] Returns: FALSE if the path failed to compact Definition at line 4025 of file paths.cpp. { // Calculate the buffer reduction factor. INT32 reduction = ((UnUsedSlots / SlotAllocSize)-1)*SlotAllocSize; if (reduction>0) { // reduce the number of free slots NOW, incase m out of the n // following reductions fail. UnUsedSlots -= reduction; if ((DecreaseBlock(VerbHandle, sizeof(PathVerb)*reduction)==FALSE) || (DecreaseBlock(FlagsHandle, sizeof(PathFlags)*reduction)==FALSE) || (DecreaseBlock(CoordHandle, sizeof(DocCoord)*reduction)==FALSE) || (ExtraInfo!=NULL && ExtraInfo->DecreaseExtraBlocks(reduction)==FALSE)) { // Memory shrink failed, so pass that back to the person using the Path // The path should still be useable at this stage so long as all handles // are valid. return FALSE; } } return TRUE; }

INT32 Path::ComparePathToPath (  Path *  pComparePath, BOOL  QuickCheck = TRUE )

Compares athis path to a passed in path. It firswt does a quick check on the number of coords and if they are equal does a more thoughour check on the verb array and coord array. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> howitt Date: 05/12/00 Parameters: A  path to compare against. [INPUTS] A flag to say wether to return as soon as it finds a difference (Default TRUE) Returns: The difference in number of coords + or -. Definition at line 1066 of file paths.cpp. { // Setup a default return value. This is basically the negative value of this paths // number of coords! INT32 ThisPathLength = (INT32)GetNumCoords(); INT32 Difference = -ThisPathLength; // Only do any comparing if we`ve got valid pointers if(pComparePath) { // quick check first! if(ThisPathLength == pComparePath->GetNumCoords()) { // Get the Coord array and Verb array for both paths. DocCoord* SPoint = GetCoordArray(); DocCoord* CPoint = pComparePath->GetCoordArray(); PBYTE SVerb = GetVerbArray(); PBYTE CVerb = pComparePath->GetVerbArray(); // Reset the Difference Value Difference = 0; // Now go throught each element of the arrays calculating the differences for( INT32 i = 0; i < ThisPathLength; i++) { // If either the points OR verbs are different then increment the Diff counter if(SPoint[i] != CPoint[i] || SVerb[i] != CVerb[i]) { Difference++; if(QuickCheck) break; } } } else { // Ok! there`s different so calcualte the difference Difference = ThisPathLength - (INT32)pComparePath->GetNumCoords(); } } // return the Differance return Difference; }

BOOL Path::ComplexJoin (  Path *  Other, INT32 *  OtherStartSlot, BOOL *  IsOtherReversed )

Tries to Join the New Path (must be simple) to a complex path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/94 Parameters: Other  - The New path that needs Joining in [INPUTS] OtherStartSlot  - The Slot number in the combined path where the path [OUTPUTS] Other starts. IsOtherReversed - TRUE if the 'Other' path was reversed during the joining process. FALSE if it was not Returns: TRUE if it worked, FALSE if it failed Definition at line 6412 of file paths.cpp. { // We have not reversed the other path yet *IsOtherReversed = FALSE; // Do we need to reverse any elements of this path INT32 StartSlot = 0; INT32 NumSlots = 0; INT32 JoinStart = 0; INT32 JoinLen = 0; BOOL JoinedAtStart = FALSE; BOOL JoinFound = FALSE; DocCoord* OtherCoords = (DocCoord*) DescribeHandle(Other->CoordHandle); // Find out if we need to reverse this path to help with the joining if (FindJoinedSubPathInfo(OtherCoords[0], &StartSlot, &NumSlots, &JoinedAtStart)) { // We found a join JoinFound = TRUE; JoinStart = StartSlot; JoinLen = NumSlots; // Maybe need to reverse this path if (JoinedAtStart) ReverseSection(StartSlot, NumSlots); } // And check to see if the other end needs checking as well. if (FindJoinedSubPathInfo(OtherCoords[Other->UsedSlots-1], &StartSlot, &NumSlots, &JoinedAtStart)) { // We found a join JoinFound = TRUE; JoinStart = StartSlot; JoinLen = NumSlots; // Reverse the joining path always Other->Reverse(); // We have reversed the other path *IsOtherReversed = TRUE; // and maybe reverse this path if (JoinedAtStart) ReverseSection(StartSlot, NumSlots); } // If we found a join then everything is fabby if (JoinFound) { // Make sure that there is room in the path to copy one of the sub-paths CurrentPos = UsedSlots; if (!MakeSpaceInPath(JoinLen)) return FALSE; // copy the sub path if (!InsertSectionAtEnd(this, JoinStart, JoinLen)) return FALSE; // delete the original version of the sub path DeleteSection(JoinStart, JoinLen); // Make sure that there is enough room for the new path CurrentPos = UsedSlots; if (!MakeSpaceInPath(Other->UsedSlots-1)) return FALSE; // copy the new path *OtherStartSlot = UsedSlots-1; if (!InsertSectionAtEnd(Other, 1, Other->UsedSlots-1)) return FALSE; } else { // We did not find a join return FALSE; } // See if we can close anything TryToClose(); // Must have worked, so Move the insertion point to the end and return happy CurrentPos = UsedSlots; return TRUE; }

BOOL Path::ComplexToSameComplexJoin (  Path *  Other, INT32 *  OtherStartSlot, BOOL *  IsOtherReversed )

This path is assumed to be complex and Other is assumed to be a simple path. The start and end point of the Simple Path must be the same as the start or end point of one of the sub paths of this complex path. The function Moves the two sub paths that are touched by the simple path to the end of the path, and inserts the simple path between them. This means that the two touched sub-paths and the new simple path are combined into a single sub path. This may also mean that this complex path is no longer complex. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/94 Parameters: Other  - The path to Join with this complex path. [INPUTS] OtherStartSlot  - The Slot number in the combined path where the path [OUTPUTS] Other starts. IsOtherReversed - TRUE if the 'Other' path was reversed during the joining process. FALSE if it was not Definition at line 6520 of file paths.cpp. { INT32 BackStartSlot, BackNumSlots; INT32 FrontStartSlot, FrontNumSlots; BOOL FrontJoinedAtStart, BackJoinedAtStart; // We have not reversed the other path yet *IsOtherReversed = FALSE; // Get a few arrays DocCoord* OtherCoords = (DocCoord*) DescribeHandle(Other->CoordHandle); // First we have to gather data about the subpaths we are joined to if (!FindJoinedSubPathInfo(OtherCoords[0], &FrontStartSlot, &FrontNumSlots, &FrontJoinedAtStart)) return FALSE; // And the other sub path, Fail if we there is no intersection if (!FindJoinedSubPathInfo(OtherCoords[Other->UsedSlots-1], &BackStartSlot, &BackNumSlots, &BackJoinedAtStart)) return FALSE; // If this was trying to join a sub path to the other end of the same sub path // then we need to use a different function if (FrontStartSlot == BackStartSlot) return ComplexJoin(Other, OtherStartSlot, IsOtherReversed); // Build a path to store the combined paths in Path InsertPath; InsertPath.Initialise(FrontNumSlots+BackNumSlots+Other->UsedSlots); // Reverse the first subpath if we need to if (FrontJoinedAtStart) ReverseSection(FrontStartSlot, FrontNumSlots); // Reverse the Second subpath if we need to if (!BackJoinedAtStart) ReverseSection(BackStartSlot, BackNumSlots); // Make copys of all the path sections // The path joined to the start of the new path if (!InsertPath.InsertSectionAtEnd(this, FrontStartSlot, FrontNumSlots)) return FALSE; // followed by the new path *OtherStartSlot = InsertPath.UsedSlots-1; if (!InsertPath.InsertSectionAtEnd(Other, 1, Other->UsedSlots-1)) return FALSE; // followed by the path joined to the end of the new path if (!InsertPath.InsertSectionAtEnd(this, BackStartSlot+1, BackNumSlots-1)) return FALSE; // Get rid of the original sub-path DeleteSection(FrontStartSlot, FrontNumSlots); // Go find the Other Coords array again as it may have moved OtherCoords = (DocCoord*) DescribeHandle(Other->CoordHandle); // Find the location of the Second path again, as deleting the first path may have moved it if (!FindJoinedSubPathInfo(OtherCoords[Other->UsedSlots-1], &BackStartSlot, &BackNumSlots, &BackJoinedAtStart)) return FALSE; // Get rid of the second sub-path DeleteSection(BackStartSlot, BackNumSlots); // Make enough space in the path to store a copy of the two subpaths and the new path CurrentPos = UsedSlots; if (!MakeSpaceInPath(InsertPath.UsedSlots)) return FALSE; // copy the Insert Path to the end of the original path *OtherStartSlot += UsedSlots; if (!InsertSectionAtEnd(&InsertPath, 0, InsertPath.UsedSlots)) return FALSE; // Must have worked, so return happy CurrentPos = UsedSlots; return TRUE; }

DocCoord Path::ConvSqrDistToCoord (  const double  sqrdist  )

Finds the coordinate which is dist units along 'this' path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 1/11/94 Parameters: sqrdist  = squared distance along the path [INPUTS] [OUTPUTS]  Returns: a doccoord which is dist units along the path Definition at line 7971 of file paths.cpp. { INT32 Index; double mu = DistReparameterise(sqrdist, &Index); return ClosestPointTo(mu, Index); }

BOOL Path::CopyPathDataFrom (  DocCoord *  Coords, PathVerb *  Verbs, INT32  NumCoords, BOOL  Filled = FALSE, BOOL  Stroked = TRUE )

Copy the specified coords and verbs to this path. The path's flags will be the defaults as specified in the constructors. You must already have initialised this path by calling Path::Initialise(). Pass it an Initial size big enough to hold the path you want to copy. BOOL Path::CopyPathDataFrom( DocCoord* Coords, PathVerb* Verbs, INT32 NumCoords, BOOL IsFilled = FALSE, BOOL IsStroked = TRUE) Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 03/02/94 Parameters: Coords  - The path coords you want to copy [INPUTS] Verbs - The verbs you want to copy NumCoords - The number of coords to copy IsFilled - Is the path filled ? IsStroked - Is the path stroked ? Returns: TRUE if it worked, FALSE otherwise. Can fail if there is not enough space in the path to copy the data into. Definition at line 452 of file paths.cpp. { // Check that this path has enough slots if (UsedSlots+UnUsedSlots < NumCoords) { // There is not enough space in this path to copy the SrcPath to TRACEUSER( "Simon", _T("Not enough space in path to copy data to\n") ); return FALSE; } // copy the data across memcpy((void*)DescribeHandle(VerbHandle), (void*)Verbs, (size_t)NumCoords*sizeof(PathVerb)); memcpy((void*)DescribeHandle(CoordHandle), (void*)Coords, (size_t)NumCoords*sizeof(DocCoord)); // Every point on the path has the default constructor flags set PathFlags f; PathFlags* pFlags = (PathFlags*) DescribeHandle(FlagsHandle); for (INT32 i = 0; i< NumCoords; i++) { pFlags[i] = f; } // Set the vars that tell us how much mem has been used UnUsedSlots = (UsedSlots+UnUsedSlots) - NumCoords; UsedSlots = NumCoords; // Keep track of the current path position CurrentPos = 0; IsFilled = Filled; IsStroked = Stroked; // Well, as far as I can tell its worked return TRUE; }

BOOL Path::CopyPathDataFrom (  Path *  SrcPath  )

Copy the coords, verbs and flags from the SrcPath to this path. You must already have initialised this path by calling Path::Initialise(). Pass it an Initial size big enough the hold the path you want to copy. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 28/01/94 Parameters: SrcPath  - The path that you want to copy data from [INPUTS] Returns: TRUE if it worked, FALSE otherwise. Can fail if there is not enough space in the path to copy SrcPaths data into. Definition at line 383 of file paths.cpp. { // Ensure that a non-null path is being used. if ( SrcPath == NULL ) return FALSE; // Find out how much space we need to alloc in this new path INT32 NumCoords = SrcPath->GetNumCoords(); if (UsedSlots+UnUsedSlots < NumCoords) { // There is not enough space in this path to copy the SrcPath to //if (IsUserName("Rik")) TRACE( _T("Not enough space in path to copy data to\n") ); ERROR3 ("Not enough space in path to copy data to!"); return FALSE; } // copy the data across memcpy((void*)DescribeHandle(VerbHandle), (void*)DescribeHandle(SrcPath->VerbHandle), (size_t)NumCoords*sizeof(PathVerb)); memcpy((void*)DescribeHandle(CoordHandle), (void*)DescribeHandle(SrcPath->CoordHandle), (size_t)NumCoords*sizeof(DocCoord)); memcpy((void*)DescribeHandle(FlagsHandle), (void*)DescribeHandle(SrcPath->FlagsHandle), (size_t)NumCoords*sizeof(PathFlags)); // If the source path has extra info in it then we need to copy that too if (SrcPath->ExtraInfo != NULL) ExtraInfo->CopyExtraInfo(SrcPath->ExtraInfo); // Set the vars that tell us how much mem has been used UnUsedSlots = (UsedSlots+UnUsedSlots) - NumCoords; UsedSlots = NumCoords; // copy any other flags of value IsFilled = SrcPath->IsFilled; IsStroked = SrcPath->IsStroked; // Keep track of the current path position CurrentPos = 0; // Well, as far as I can tell its worked return TRUE; }

BOOL Path::CopySectionFrom (  const Path &  Other, INT32  StartIndex, INT32  NumToCopy )

Copies a specified section from a path to the end of this one. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 22/7/94 Parameters: Other  - A reference to another path to merge with this one [INPUTS] Returns: TRUE if the merge was a success, FALSE if it failed (lack of memory) Definition at line 6017 of file paths.cpp. { return MergeSectionFrom(UsedSlots, Other, StartIndex, NumToCopy); }

BOOL Path::CopySectionTo (  Path *  Dest, INT32  StartIndex, INT32  NumToCopy )

Copies a specified section from this path to the end of another path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 08/09/94 Parameters: Dest  - A pointer to another path to add the data to [INPUTS] Returns: TRUE if the copy was a success, FALSE if it failed (lack of memory) Definition at line 6035 of file paths.cpp. { return MergeSectionTo(StartIndex, NumToCopy, Dest, Dest->UsedSlots); }

BOOL Path::CreateFlatPath (  const ProcessFlags &  PFlags, const double  flatness, Path *  pOutput )

Flatten a path. All curves within the path will be approximated by straight lines. pOutput may point at 'this' path ie a path can be flattened to itself. If the flattening fails for some reason, the output path will be unaffected even if you're flattening a path to itself. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 25/10/94 Parameters: PFlags  = process flags, to control the path processor function [INPUTS] (see classes ProcessPath and ProcessFlags) flatness = How flat the curves should be (around 64 is good) pOutput  = will contain the flattened path [OUTPUTS] Returns: BOOL = TRUE if the path was flattened successfully = FALSE then output path will be unaffected Definition at line 7885 of file paths.cpp. { // create a flattening object ProcessFlatten FlattenObj(flatness); // INT32 numcoords = pOutput->GetNumCoords(); // ok, generate a flattened path on the end of Output return FlattenObj.FlattenPath(PFlags, this, pOutput); }

BOOL Path::CreatePathFromDocRect (  DocRect *  pRect  )

Creates a filled path from a given DocRect. Author: Mark_Howitt (Xara Group Ltd) <camelotdev@xara.com> Date: 20/7/99 Parameters: BOOL  to say whether or not it was successful [OUTPUTS] Definition at line 506 of file paths.cpp. { DocCoord TopLeft(pRect->lo.x,pRect->hi.y); DocCoord TopRight(pRect->hi.x,pRect->hi.y); DocCoord BottomLeft(pRect->lo.x,pRect->lo.y); DocCoord BottomRight(pRect->hi.x,pRect->lo.y); InsertMoveTo(TopLeft); InsertLineTo(TopRight); InsertLineTo(BottomRight); InsertLineTo(BottomLeft); InsertLineTo(TopLeft); IsFilled = TRUE; return TRUE; }

BOOL Path::DeleteElement (   )

Deletes the element at the Current Path Position. May free some memory if the path gets to have too much unused space in the path. The Current Path Position points at the slot before the one being deleted. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Definition at line 2325 of file paths.cpp. { // Dereference the pointers PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); // Saftey Checks ENSURE( CurrentPos<UsedSlots, "PathPosition is off end of path in Path::DeleteElement" ); ENSURE( CurrentPos>=0, "PathPosition is off beginning of path in Path::DeleteElement" ); ENSURE( ((PathFlags*) DescribeHandle(FlagsHandle))[CurrentPos].IsEndPoint==TRUE, "Delete Element called when Path Position was not on an endpoint"); // Find the start of the element INT32 StartSlot = CurrentPos; // Work out how many slots we need to delete INT32 NumSlots; if ((Verbs[CurrentPos] & (~PT_CLOSEFIGURE)) == PT_BEZIERTO) { NumSlots = 3; StartSlot -= 2; } else { NumSlots = 1; } // Delete the element BOOL RetVal = DeleteSection(StartSlot, NumSlots); // tidy up the Current Path Position CurrentPos = StartSlot-1; if (CurrentPos<0) CurrentPos = 0; return RetVal; }

BOOL Path::DeleteFromElement (  INT32  ElementNum  )

Deletes all the elements in the path from ElementNum to the end of the path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 13/4/94 Parameters: ElementNum  - the number of the element to start deleting from. [INPUTS] Returns: TRUE if the deletion was a success Definition at line 2378 of file paths.cpp. { // Find out how many slots there are from ElementNum to the end INT32 SlotsToDelete = UsedSlots-ElementNum; // go and delete the end of the path BOOL RetVal = DeleteSection(ElementNum, SlotsToDelete); // Set the current Path position to just after the path, ready for further additions CurrentPos = UsedSlots; return RetVal; }

BOOL Path::DeleteSection (  INT32  StartSlot, INT32  NumSlots )

Deletes sections out of the middle of the path. Used by DeleteElement and for Deleting sub paths etc. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/94 Parameters: StartSlot  - The slot number to start deleting from [INPUTS] NumSlots - The number of slots to delete Returns: TRUE if it worked, FALSE if it failed Definition at line 2277 of file paths.cpp. { // Saftey Checks ENSURE( StartSlot<UsedSlots, "PathPosition is off end of path in Path::DeleteElement" ); ENSURE( StartSlot>=0, "PathPosition is off beginning of path in Path::DeleteElement" ); ENSURE( NumSlots>0, "Trying to delete Zero slots from the path!" ); if (NumSlots==0) return TRUE; // Find out how much memory to move about and adjust the element counters INT32 SlotsToMove = UsedSlots-StartSlot-NumSlots; // and move it all about if we need to if (SlotsToMove>0) { // Dereference the pointers PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); memmove((void*)(&Verbs[StartSlot]), (void*)(&Verbs[StartSlot+NumSlots]), SlotsToMove*sizeof(PathVerb)); memmove((void*)(&Flags[StartSlot]), (void*)(&Flags[StartSlot+NumSlots]), SlotsToMove*sizeof(PathFlags)); memmove((void*)(&Coords[StartSlot]), (void*)(&Coords[StartSlot+NumSlots]), SlotsToMove*sizeof(DocCoord)); if (ExtraInfo != NULL) ExtraInfo->ShiftDownExtraInfo(StartSlot, NumSlots, SlotsToMove); } // Update the path details UsedSlots -= NumSlots; UnUsedSlots += NumSlots; return Compact(); }

BOOL Path::DistanceTo (  DocCoord  Coord, double *  dist, double  dFlatness = 64.0 )

This function takes as input a coordinate (usually a mouse click point). It will calculate the closest point on the path to this coordinate and return the distance along the path from its start point to this coordinate. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 14/06/95 Parameters: Coord  - A coordinate [INPUTS] distance  - a 72000 inch measurement [OUTPUTS] Returns: TRUE if distance was calculated FALSE if not Definition at line 9677 of file paths.cpp. { Path TempPath; INT32 SplitAt; INT32 NumNewEl; if (!TempPath.Initialise(GetNumCoords(),24)) return FALSE; if (!TempPath.CopyPathDataFrom(this)) return FALSE; if (!TempPath.SplitAtPoint(Coord, &SplitAt, &NumNewEl)) return FALSE; ProcessLength LengthObj(dFlatness); if (!LengthObj.PathLength(&TempPath, dist, SplitAt)) return FALSE; return TRUE; }

BOOL Path::DistanceTo (  INT32  index, double  t, double *  distance, double  dFlatness = 64.0 )

This function takes a description of a point lying on a path. The point is described by (i,t) where i is the index of the element t lies in, and t is a parametric variable 0<=t<=1. The function calculates the distance along this path to the point described by (i,t). This routine complements SqrDistanceToPoint() which calculates the pair (i,t) for a given coordinate close to the path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 14/06/95 Parameters: index  = an index into the path arrays describing the first coordinate [INPUTS] of an element. t = a parameter 0..1 describing a point on the path element distance-  a 72000 inch measurement [OUTPUTS] Returns: TRUE if distance was calculated FALSE if not See also: SqrDistanceToPoint Definition at line 9579 of file paths.cpp. { PathVerb* InVerbs = GetVerbArray(); PathVerb vb = InVerbs[index] & ~PT_CLOSEFIGURE; DocCoord* InCoords = GetCoordArray(); double LoDist = 0.0; double HiDist = 0.0; if (GetNumCoords()==0) return FALSE; // If t is near 1 then we can skip forward to the next segment // this is to avoid math problems with splitting beziers near their ends INT32 IndexEP = index; if (t>=0.99995 && vb==PT_BEZIERTO) { // Move up to next complete segment if (IndexEP != GetNumCoords()-1) { if (!FindNextEndPoint(&IndexEP)) return FALSE; t = 0.0; } } // find the length to the path up to the start of the nearest element // specified by index. ProcessLength LengthObj(dFlatness); if (!LengthObj.PathLength(this, &LoDist, IndexEP-1)) return FALSE; // ok we need to evaluate the distance along the // path element i at parameter 0<=t<1 switch (vb) { case PT_LINETO: { double TotalLength = InCoords[index-1].Distance(InCoords[index]); HiDist = TotalLength * t; } break; case PT_BEZIERTO: { if ((t>0.00005) && (t<0.99995)) // avoids problems at the extremes. { UINT32 NumElements; PathVerb NewVerbs[6]; DocCoord NewCoords[6]; Path TempPath; BOOL ok = TempPath.Initialise(12,12); if (ok) ok = PathUtil::SplitCurve(t, &InCoords[index-1], &NumElements, NewVerbs, NewCoords); if (ok) ok = TempPath.CopyPathDataFrom(NewCoords, NewVerbs, 3); if (ok) { TempPath.SetPathPosition(0); ok = TempPath.InsertMoveTo(InCoords[index-1]); } if (ok) { ProcessLength LengthObj2(64); ok = LengthObj2.PathLength(&TempPath, &HiDist); } if (!ok) return FALSE; } } break; default: ERROR3("Unable to find point on path. Index does not specify line or curve"); break; } *distance = LoDist+HiDist; return TRUE; }

double Path::DistReparameterise (  const double  sqrdist, INT32 *  Element )

Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 1/11/94 Parameters: sqrdist  = squared distance along the path [INPUTS] Element  = index of element which bounds dist [OUTPUTS] as a half open interval, (El.Plo < dist <= El.Phi) Returns: a double, being the parameter along the returned element, which is dist units along the whole path. See also: ConvDistToCoord() ClosestPointTo() Definition at line 7997 of file paths.cpp. { // set up a distance object and call its processor double Acc = 64; ProcessDistance DistanceObj(Acc); return DistanceObj.PathDistance(sqrdist, this, Element); }

void Path::DrawBlob (  RenderRegion *  pRender, const DocCoord &  Coord, BOOL  DrawSelected )

Draws a single blob, either selected or un-selected. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/02/94 Parameters: pRender  - Render region to draw to [INPUTS] Coord - the coord that the blob should be centred on DrawSelected - Draw a selected blob or an unselected blob Definition at line 3486 of file paths.cpp. { #if !defined(EXCLUDE_FROM_RALPH) if (DrawSelected) { // Set the colours to draw the selected blob colours pRender->SetLineColour(COLOUR_BEZIERBLOB); pRender->SetFillColour(COLOUR_TRANS); // Draw a Selected blob to the render region pRender->DrawBlob(Coord, BT_SELECTED); } else { // Draw an UnSelected Blob to the render region // Set the colours back // pRender->SetLineColour(COLOUR_UNSELECTEDBLOB); pRender->SetLineColour(COLOUR_NONE); pRender->SetFillColour(COLOUR_UNSELECTEDBLOB); pRender->DrawBlob(Coord, BT_UNSELECTED); } #endif }

void Path::DrawControlBlob (  RenderRegion *  pRender, const DocCoord &  Coord )

Draws a blob for a Bezier control point. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/02/94 Parameters: pRender  - Render region to draw to [INPUTS] Coord - the coord that the blob should be centred on Definition at line 3523 of file paths.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // Draw a Control blob to the render region // pRender->SetLineColour(COLOUR_BEZIERBLOB); pRender->SetLineColour(COLOUR_NONE); // A line colour leads to bad rendering probs // on some video drivers. Best solution is not // to use one. pRender->SetFillColour(COLOUR_BEZIERBLOB); pRender->DrawBlob(Coord, BT_UNSELECTED); #endif }

void Path::DrawControlLine (  RenderRegion *  pRender, const DocCoord &  Start, const DocCoord &  End )

Draws a line from the Bezier control point to its endpoint. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/02/94 Parameters: pRender  - Render region to draw to [INPUTS] Coord - the coord that the blob should be centred on Definition at line 3549 of file paths.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // Draw a line to the render region pRender->SetLineColour(COLOUR_BEZIERLINE); pRender->DrawLine( Start, End ); #endif }

void Path::DumpPath (   )

Dumps the whole path out to the debug terminal. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 01/02/94 Definition at line 2841 of file paths.cpp. { #ifdef _DEBUG TRACE( _T("\nStarting Path Dump\n") ); TRACE( _T("[%d=PT_MOVETO, %d=PT_LINETO, %d=PT_BEZIERTO, %d=PT_CLOSEFIGURE]\n"), PT_MOVETO, PT_LINETO, PT_BEZIERTO, PT_CLOSEFIGURE ); TRACE( _T("UsedSlots=%ld, UnUsedSlots=%ld, CurrentPos=%ld\n"), UsedSlots, UnUsedSlots, CurrentPos ); TRACE( _T("Path Size in Bytes=%ld\n"), GetPathByteLength() ); TRACE( _T("\tVerb\tCoord\n") ); // de-reference the pointers PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); // loop through all the coords, displaying their type and position for (INT32 i=0; i<UsedSlots; i++) { TRACE( _T("%d\t%d\t(%ld, %ld)"), i, Verbs[i], Coords[i].x, Coords[i].y ); if (Flags[i].IsSmooth) TRACE( _T("\tS")); else TRACE( _T("\t ")); if (Flags[i].IsRotate) TRACE( _T("R")); else TRACE( _T(" ")); if (Flags[i].IsEndPoint) TRACE( _T("E")); else TRACE( _T(" ")); if (Flags[i].IsSelected) TRACE( _T("(sel)")); TRACE( _T("\n")); } #endif }

void Path::EnsureSelection (  BOOL  UseStarts  )

Goes through the path ensuring that the selection status of the ends/starts of subpaths equal the selection state of the start/ends of that subpath Also selects/deselectes control points as appropiate. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 5/1/95 Parameters: UseStarts  - TRUE if the selection state of the start of subpaths should be used [INPUTS] the set the ends. FALSE if the end sel state should be used to set the starts Definition at line 3597 of file paths.cpp. { #if !defined(EXCLUDE_FROM_RALPH) PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // Ensure the selection state of the sub paths const INT32 NumCoords = GetNumCoords(); if (UseStarts) { INT32 Start = 0; INT32 End = 0; while (End < NumCoords-1) { FindEndElOfSubPath(&End); if (Verbs[End] & PT_CLOSEFIGURE) Flags[End].IsSelected = Flags[Start].IsSelected; Start = ++End; } } else { INT32 Close = NumCoords-1; INT32 Offset = NumCoords-1; while (Offset > -1) { FindStartOfSubPath(&Offset); if (Verbs[Close] & PT_CLOSEFIGURE) Flags[Offset].IsSelected = Flags[Close].IsSelected; Close = Offset-1; Offset = Close; } } // Now set the selection state of the control points.depending on their endpoints for (INT32 loop = 0; loop < NumCoords; loop++) { if (!Flags[loop].IsEndPoint) { ERROR3IF(loop==0, "Path started with a non-endpoint!"); ERROR3IF(Verbs[loop]!=PT_BEZIERTO, "Found an non-endpoint that wasn't a Bezier"); if (loop > 0) { if (Flags[loop-1].IsEndPoint) Flags[loop].IsSelected = Flags[loop-1].IsSelected; else Flags[loop].IsSelected = Flags[loop+1].IsSelected; } } } #endif }

BOOL Path::EnsureValid (  BOOL *  ChangesMade = NULL  )

Will attempt to make a path into a correct state. Checks are :- 1. All subpaths must start with a MoveTo 2. Consecutive MoveTos are removed 3. Zero element paths are unrepairable 4. MoveTos at the end of the path are removed 5. Should be three BezierTos in a row, only the last can be CloseFigure 6. A LineTo to the same location as the previous point is removed. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/1/95 Parameters: Pointer  to a BOOL to return a result in (you can pass in NULL) [INPUTS] ChangesMade  will be TRUE if changes have been made to the path, FALSE if otherwise [OUTPUTS] Returns: TRUE for success, FALSE for failure (see below) ERRORs: FALSE is returned if the path was knackered OR if we encountered an error in trying to repair it. (SetError will have been called) Definition at line 9381 of file paths.cpp. { BOOL PathOK = FALSE; BOOL Temp; BOOL* pChangeFlag; pChangeFlag = (ChangesMade == NULL) ? &Temp : ChangesMade; *pChangeFlag = FALSE; while (!PathOK) { // Recache the path pointers as things may have moved PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); INT32 NumCoords = GetNumCoords(); // (3) Check for zero element path if (NumCoords == 0) { TRACEALL( _T("Empty path detected\n") ); Error::SetError(_R(IDE_INVALID_PATH)); return FALSE; } INT32 Counter = 0; while (Counter < NumCoords) { // Recache the path pointers in case the previous pass caused the arrays to move Verbs = (PathVerb*) DescribeHandle(VerbHandle); Coords = (DocCoord*) DescribeHandle(CoordHandle); Flags = (PathFlags*) DescribeHandle(FlagsHandle); // (1) Check that all subpaths start with a MoveTo if ( (Counter == 0) || (Verbs[Counter-1] & PT_CLOSEFIGURE) ) { if ((Verbs[Counter] & ~PT_CLOSEFIGURE) != PT_MOVETO) { // Insert a MoveTo at the same location as this point TRACEALL( _T("Inserting a MoveTo at %d\n"), Counter ); SetPathPosition(Counter); *pChangeFlag = TRUE; if (!InsertMoveTo(Coords[Counter])) return FALSE; break; } } // (2) Check there are no two consecutive MoveTos if ( (Counter != NumCoords-1) && (Verbs[Counter] == PT_MOVETO) ) { if (Verbs[Counter+1] == PT_MOVETO) { // Remove this MoveTo TRACEALL( _T("Removing a MoveTo at %d\n"), Counter ); SetPathPosition(Counter); *pChangeFlag = TRUE; if (!DeleteElement()) return FALSE; break; } } // (4) Check for trailing moveto at the end of a path if ( (Counter == NumCoords-1) && (Verbs[Counter] == PT_MOVETO) ) { // Remove this MoveTo TRACEALL( _T("Removing a MoveTo at the end (%d)\n"), Counter ); SetPathPosition(Counter); *pChangeFlag = TRUE; if (!DeleteElement()) return FALSE; break; } switch (Verbs[Counter] & ~PT_CLOSEFIGURE) { case PT_MOVETO: // MoveTos shouldn't have CloseFigures if (Verbs[Counter] != PT_MOVETO) { TRACEALL( _T("Detected a MoveTo+CloseFigure combination\n at %d"), Counter ); Verbs[Counter] = PT_MOVETO; *pChangeFlag = TRUE; } Counter++; break; case PT_LINETO: // If the coord of this is the same as the last (which must be a MoveTo) then delete it if ((Counter > 0) && (Coords[Counter] == Coords[Counter-1]) && (Verbs[Counter-1] == PT_MOVETO)) { TRACEALL( _T("Removing a LineTo at %d\n"), Counter ); SetPathPosition(Counter); *pChangeFlag = TRUE; // If the LineTo has the PT_CLOSEFIGURE bit set, ensure that the element // before it has this bit set. // If we don't then it is possible for shapes to become lines. if ((Verbs[Counter] & PT_CLOSEFIGURE) && (Verbs[Counter-1] != PT_MOVETO)) Verbs[Counter-1] |= PT_CLOSEFIGURE; // Delete the surplus LineTo element if (!DeleteElement()) return FALSE; Counter = NumCoords+1; // So we go round the entire path again } else { // This point should be endpoint if (!Flags[Counter].IsEndPoint) { TRACEALL( _T("Fixing endpoint status at %d\n"), Counter ); *pChangeFlag = TRUE; Flags[Counter].IsEndPoint = TRUE; } Counter ++; } break; case PT_BEZIERTO: // (5) Should be three BezierTos in a row, only the last can be CloseFigure if (Counter >= NumCoords-2) { TRACEALL( _T("Path ends with a short Bezier section\n") ); return FALSE; } if ( (Verbs[Counter] != PT_BEZIERTO) || (Verbs[Counter+1] != PT_BEZIERTO) || ((Verbs[Counter] & ~PT_CLOSEFIGURE) != PT_BEZIERTO) ) { TRACEALL( _T("InvalidBezier section detected starting at %d\n"), Counter ); return FALSE; } Flags[Counter++].IsEndPoint = FALSE; Flags[Counter++].IsEndPoint = FALSE; Flags[Counter++].IsEndPoint = TRUE; break; default: TRACEALL( _T("This path is *very* corrupt (Invalid verb found)\n") ); return FALSE; } if (Counter == NumCoords) PathOK = TRUE; } } return TRUE; }

BOOL Path::EnsureVolume (  INT32  NumSlots  )

This function ensures there are >= NumSlots in the path arrays. It may try to alter the size of the path arrays by increasing the number of unused slots to satisfy the request. It will never decrease the size of the arrays, if NumSlots < UsedSlots+UnusedSlots then the volume is automatically ensured. This allows path buffers to be resized ready for cloning. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 02/02/95 Parameters: NumSlots  - The minimum number of slots you need in the path arrays [INPUTS] Returns: TRUE if it was able to find the memory, FALSE if it failed Definition at line 4104 of file paths.cpp. { INT32 Slots=NumSlots-UsedSlots; if (Slots>0) return MakeSpaceAtEnd(Slots); return TRUE; }

void Path::ExpandRange (  INT32 *  start, INT32 *  end, INT32  num )

given the region [*start, *end] expand the region in both directions by num elements. The region will not be expanded beyond its outer limits described by the set {moveto,.....,endofsubpath}. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 3/11/94 Parameters: start  = pointer to an index holding the region start [INPUTS] end = pointer to an index holding the region end num = number of endpoints to expand the region by start  = will be updated [OUTPUTS] end = will be updated Definition at line 3784 of file paths.cpp. { ENSURE( (*start)<UsedSlots, "start index was not valid in ExpandRange" ); ENSURE( (*start)>=0, "start index less than zero in ExpandRange" ); ENSURE( (*end)<UsedSlots, "end index was not valid in ExpandRange" ); ENSURE( (*end)>=0, "end index less than zero in ExpandRange" ); PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // clamp the indexes INT32 starti = *start; INT32 endi = *end; if (starti<0) starti = 0; if (endi<0) endi = 0; if (starti >= UsedSlots) starti = UsedSlots-1; if (endi >= UsedSlots) endi = UsedSlots-1; INT32 prev = starti; INT32 next = endi; while (num>0) { if (Verbs[starti] != PT_MOVETO) { if (FindPrev(&prev)) { if (Flags[prev].IsEndPoint) starti = prev; } } if (FindNextEndPoint(&next)) { if ((Flags[next].IsEndPoint) && (Verbs[next] != PT_MOVETO)) endi = next; } num-=1; } *start = starti; *end = endi; }

BOOL Path::ExternalArraysAdded (  const INT32  Added  )

A hidden function to adjust the number of elements in a path. This has been added by me as a last resort and should not be used by others. (Hence hidden from the documentation). It is required to cope with changes in the path data external to the path class. This occurs when doing really nasty things like moulding paths. BOOL Path::ExternalArraysAdded(const INT32 Added) Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 16/12/94 Parameters: Added  = the number of new elements added to path arrays. [INPUTS] Returns: TRUE if the external arrays have been validated FALSE if the external array additions have been ignored Definition at line 5968 of file paths.cpp. { ERROR1IF(Added<1 || Added>UnUsedSlots, FALSE, "Path::ExternalArraysAdded() called with illegal additon"); UsedSlots+=Added; UnUsedSlots-=Added; return TRUE; }

BOOL Path::ExternalArraysReplaced (  const INT32  Size  )

A hidden function to adjust the number of elements in a path. This has been added by me as a last resort and should not be used by others. (Hence hidden from the documentation). BOOL Path::ExternalArraysReplaced(const INT32 Size) Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 16/12/94 Parameters: Size  = the number of elements replaced in the path arrays [INPUTS] Returns: TRUE if the external arrays have been validated FALSE if the external array replacements have been ignored Definition at line 5994 of file paths.cpp. { ERROR1IF(Size<1 || Size>(UsedSlots+UnUsedSlots), FALSE, "Path::ExternalArraysCloned() called with an illegal clone"); UnUsedSlots = (UsedSlots+UnUsedSlots)-Size; UsedSlots = Size; return TRUE; }

void Path::FindEndElOfSubPath (  INT32 *  Index  )  const

Searches forwards until it finds the last element of the current sub-path. ie 0 1 2 3 {MT,CT,CT,CT} => Index = 3. See Also: FindEndOfSubPath (Note equivelent). Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 12/09/94 Parameters: Index  - The position in the path to start looking from [INPUTS] Index  - the position of the last element of the subpath, ie the final bezier [OUTPUTS] control point, or the final line to etc. Definition at line 9235 of file paths.cpp. { ENSURE( (*Index)<UsedSlots, "Path position was not valid in FindEndOfSubPath" ); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); do { (*Index)++; } while (((*Index)<UsedSlots) && (Verbs[(*Index)]!=PT_MOVETO)); (*Index)--; }

void Path::FindEndOfSubPath (  INT32 *  Index  )  const

Searches forwards until it finds the end of the current sub-path. ie Index will point at the last element in the sub path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Parameters: Index  - The position in the path to start looking from [INPUTS] Index  - the position of the end of the subpath [OUTPUTS] Definition at line 653 of file paths.cpp. { ENSURE( (*Index)<UsedSlots, "Path position was not valid in FindEndOfSubPath" ); // I am already in a path, so start working backwards until I find the moveto PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); INT32 PrevIndex; do { PrevIndex = (*Index); FindNext(Index); } while (((*Index)<UsedSlots) && (Verbs[(*Index)]!=PT_MOVETO)); // So we have either fallen off the end of the world, or we are now on a MoveTo // either way we need the info from the previous position (*Index) = PrevIndex; }

void Path::FindEndOfSubPath (   )

Searches forwards until it finds the end of the current sub-path. ie pos will point at the last element in the sub path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Parameters: Pos  - The position in the path to start looking from [INPUTS] Pos  - the position of the end of the subpath [OUTPUTS] Definition at line 621 of file paths.cpp. { ENSURE( CurrentPos<UsedSlots, "Path position was not valid in FindEndOfSubPath" ); // I am already in a path, so start working backwards until I find the moveto PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); INT32 PrevIndex; do { PrevIndex = CurrentPos; FindNext(); } while ((CurrentPos<UsedSlots) && (Verbs[CurrentPos]!=PT_MOVETO)); // So we have either fallen off the end of the world, or we are now on a MoveTo // either way we need the info from the previous position CurrentPos = PrevIndex; }

BOOL Path::FindJoinedSubPathInfo (  const DocCoord &  JoinCoord, INT32 *  Start, INT32 *  Length, BOOL *  JoinAtStart )

This function searchs the path, compareing JoinCoord with the start and end points of each of the Sub-paths in the path. If it is the same as one of the start or end points, then the output params are filled and TRUE is returned. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/94 Parameters: JoinCoord  - The Coord to compare with the start and end points od sub paths [INPUTS] Start  - Pointer to an INT32 to hold the starting slot number of the sub path [OUTPUTS] Length - The number of slots in the found Sub Path JoinAtStart - TRUE if JoinCoord intersected the start of the Sub Path, FALSE otherwise Returns: TRUE if an intersection was found, FALSE if not Definition at line 6619 of file paths.cpp. { // We will need all the arrays for both paths DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // walk through all the coords, looking for start and end points in SubPaths INT32 EndPos = UsedSlots-1; for (INT32 i=UsedSlots-1; i>=0; i--) { // See if we are at the start of a sub path if (Verbs[i] == PT_MOVETO) { // Set these to the start and end positions of the sub path *Start = i; *Length = EndPos - i + 1; // We are, so check the start and end of the sub path against the coord if (Coords[i] == JoinCoord) { // This is Joined at the start, so set the values and return *JoinAtStart = TRUE; return TRUE; } if (Coords[EndPos] == JoinCoord) { // This is Joined at the End, so set the values and return *JoinAtStart = FALSE; return TRUE; } EndPos = i-1; } } // We did not find an intersection with the subpaths, so fail return FALSE; }

BOOL Path::FindNearestPoint (  DocCoord  pos, UINT32  flags, INT32 *  position )

This function searches for a point in the path which is both selected and lies inside the largest blob bounding rectangle surrounding 'pos'. Points checked for are as follows... if ENDPOINTS is set check all selected endpoints in this path. if CONTROLPOINTS is set check all control points lying directly next to selected endpoints The rules are that control points are only enabled when a single end point is selected and hence a maximum of 2 control points will be checked. If any of these points are close enough to be clicked on, the function returns TRUE, with position holding the index to the point that was clicked. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/94 Parameters: pos  - mouse position to be tested [INPUTS] flags - POINTFLAG_ENDPOINTS = look at endpoints POINTFLAG_CONTROLPOINTS - look at control points (the flag POINTFLAG_ENDSFIRST has been removed and has no effect - the endpoints are always scanned first) Parameters: position  - index to the point that was matched [OUTPUTS] unchanged if no match Returns: TRUE if a match was found, FALSE if not Definition at line 6752 of file paths.cpp. { #if !defined(EXCLUDE_FROM_XARLIB) // If neither ENDPOINTS or CONTROLPOINTS flags are set, return FALSE since the caller // obviously doesn't want to look at anything! if (!(flags & (POINTFLAG_ENDPOINTS | POINTFLAG_CONTROLPOINTS))) return (FALSE); // Always set POINTFLAG_ENDSFIRST flags |= POINTFLAG_ENDSFIRST; // Get arrays for this path DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); PathFlags* PFlags = (PathFlags*) DescribeHandle(FlagsHandle); // Get a pointer to the DocView so we can do blob proximity checks DocView* pDocView = DocView::GetSelected(); ERROR3IF(pDocView == NULL, "Path::FindNearestPoint: Can't find selected DocView"); if (pDocView == NULL) return(FALSE); DocRect BlobRect; // INT32 numloops; // Now to calculate a rectangle around the pointer position which is // the same size as the biggest possible blob. We then go through the // path and see if any of the coordinates fall into that rectangle. // This is a very cunning reversal of the normal logic - go through the // path, find a blob rectangle for each point, then see if the pointer // coordinate falls inside it. The only problem with this method is that // it assumes that all blobs are the same size, but since this is only // for click detection, and we need a little bit of leeway, I think // it's all right. Anyway, the usual code for this also makes this assumption, // although it doesn't rely on it. OSRenderRegion::GetBlobRect(pDocView->GetViewScale(), pos, BT_SELECTEDLARGEST, &BlobRect); // Now BlobRect holds a rectangle around the pointer position. // We have to first go through and look at the endpoints, counting them as we go INT32 EndCount = 0; INT32 EndIndex = 0; INT32 i; for (i=0; i<UsedSlots; i++) { // check to see if it's an endpoint, and if we want this kind of point if ((PFlags[i].IsEndPoint && (flags & POINTFLAG_ENDPOINTS))) { if (BlobRect.ContainsCoord(Coords[i])) { *position = i; return(TRUE); } } if (PFlags[i].IsEndPoint && PFlags[i].IsSelected && ((Verbs[i] & PT_CLOSEFIGURE) == 0)) { EndCount++; EndIndex = i; } } // Now we've scanned the path for endpoints, let's look at any adjacent control points // if EndCount == 1, EndIndex is the index of the selected enpoint, ie there is only one // selected endpoint and its control handles will be enabled. if ( (EndCount==1) && (flags & POINTFLAG_CONTROLPOINTS) ) { INT32 Index = FindPrevControlPoint(EndIndex); if (Index>=0) { // There is a previous control point, so look at it (and the one before it) if (BlobRect.ContainsCoord(Coords[Index])) { *position = Index; return TRUE; } if (BlobRect.ContainsCoord(Coords[Index-1])) { *position = Index-1; return TRUE; } } // Now look at the next control point (if it's there) Index = FindNextControlPoint(EndIndex); if (Index>=0) { // Look at the next one if (BlobRect.ContainsCoord(Coords[Index])) { *position = Index; return TRUE; } if (BlobRect.ContainsCoord(Coords[Index+1])) { *position = Index+1; return TRUE; } } } #endif return FALSE; }

BOOL Path::FindNext (  INT32 *  Index  )  const

Finds the next path element in this path. The position will become invalid if you try to search past the start of the path. This can be checked by using Pos->IsValid. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Parameters: Index  is a pointer to an index into the path to start from [INPUTS] Index  will point at the next element in the path [OUTPUTS] Returns: TRUE if valid next element found FALSE if there is no next element, Index is set to NumCoords See also: Path::FindPrev Definition at line 855 of file paths.cpp. { ENSURE( (*Index)<=UsedSlots, "Path position was not valid in FindNext" ); ENSURE( (*Index)>=0, "Path Position less than zero!" ); // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // Move to the next path element if ((Verbs[(*Index)] & (~PT_CLOSEFIGURE))==PT_BEZIERTO) (*Index) += 3; else (*Index) ++; // Check to see if we fell off the end of the path if ((*Index)>=UsedSlots) { (*Index) = UsedSlots; return FALSE; } // we did it, so return happy return TRUE; }

BOOL Path::FindNext (  void   )

Finds the next path element in this path. The position will become invalid if you try to search past the start of the path. This can be checked by using Pos->IsValid. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 See also: Path::FindPrev Definition at line 733 of file paths.cpp. { ENSURE( CurrentPos<=UsedSlots, "Path position was not valid in FindNext" ); ENSURE( CurrentPos>=0, "Path Position less than zero!" ); // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // Move to the next path element if ((Verbs[CurrentPos] & (~PT_CLOSEFIGURE))==PT_BEZIERTO) CurrentPos += 3; else CurrentPos ++; // Check to see if we fell off the end of the path if (CurrentPos>=UsedSlots) { CurrentPos = UsedSlots; return FALSE; } // we did it, so return happy return TRUE; }

INT32 Path::FindNextControlPoint (  INT32  Index  )

This routine will scan forwards from an endpoint to find the attached bezier control point. It takes account of closed and open paths and complex paths, and will wrap around the path if necessary. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 23/8/94 Parameters: Index  gives the endpoint whose next control point I want [INPUTS] -  [OUTPUTS] Returns: Index to the control point (or -1 if none) Errors: - See also: - Definition at line 3432 of file paths.cpp. { // DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); // PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // See if this is the end of a path (no more elements or next point is moveto) if (Index+1 == UsedSlots || Verbs[Index+1] == PT_MOVETO) { // This is the last element, so see if we should wrap around if (Verbs[Index] & PT_CLOSEFIGURE) { // The path is closed, so we have to scan backwards to find the start INT32 i=Index; FindStartOfSubPath(&i); // i points at start of subpath // return next control point if next element is a bezier, -1 otherwise if (Verbs[i+1] == PT_BEZIERTO) return i+1; return -1; } else { // Path is open, so no next control point return -1; } } else { // This element isn't the last in this subpath, so look at next element // if not bezier, return -1, otherwise return next element if (Verbs[Index+1] == PT_BEZIERTO) return Index+1; return -1; } return -1; }

BOOL Path::FindNextEndPoint (  INT32 *  index  )  const

Finds the next path endpoint in this path. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 3/11/94 Parameters: Index  = pointer to a INT32 indicating where to start from [INPUTS] Outpus: Index = points to an index which is the next element Returns: TRUE if the next end point has been found FALSE if there are no more end points in this path See also: Path::FindPrevEndPoint Definition at line 774 of file paths.cpp. { ENSURE( (*index)<=UsedSlots, "Path position was not valid in FindNextEndPoint" ); ENSURE( (*index)>=0, "Path Position less than zero in FindNextEndPoint" ); // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); (*index)++; if ((*index) >= UsedSlots) { ((*index) = UsedSlots-1); return FALSE; } if ((Verbs[(*index)] & (~PT_CLOSEFIGURE))==PT_BEZIERTO) (*index) += 2; return TRUE; }

BOOL Path::FindNextSelected (  INT32 *  Index  )

Searches the point set {*index, usedslots-1} for a selected end point and returns its index if found. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 01/09/94 Parameters: Index  - The position in the path to start looking from [INPUTS] Index  - the position of the next selected element [OUTPUTS] Returns: TRUE if there exists a selected point at or beyond index FALSE if there is no more selected points along the path Definition at line 9199 of file paths.cpp. { ENSURE( (*Index)<=UsedSlots, "Path position was not valid in FindNextSelected" ); ENSURE( (*Index)>=0, "Path Position less than zero in FindNextSelected" ); PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); while ( ((*Index)<UsedSlots) && !( (Flags[(*Index)].IsSelected) && (Flags[*Index].IsEndPoint) ) ) (*Index)++; return ((*Index)<UsedSlots); }

INT32 Path::FindOppositeControlPoint (  INT32  ThisIndex  )

Given a bezier control point, this function returns the index of the control point that is opposite this one (with an endpoint between). This routine takes closed paths into account. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 18/8/94 Returns: The index of the control point opposite the indexed one (or -1) Definition at line 1219 of file paths.cpp. { // Get arrays of flags and verbs PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // If this isn't a control point, ensure! ENSURE(!Flags[ThisIndex].IsEndPoint,"Point is not a control point in FindOppositeControlPoint"); // First see if this is the first or second control point in a curve element. If the // previous point is an endpoint, then this is the first control point if (Flags[ThisIndex-1].IsEndPoint) { // if the previous endpoint is a moveto, we might have to wrap if (Verbs[ThisIndex-1] == PT_MOVETO) { INT32 i; for (i = ThisIndex;i<UsedSlots && Verbs[i]!=PT_MOVETO;i++); // ; deliberate i--; // Now i gives us the endpoint of the subpath // If the path is closed and the last point is a curve, return the opposite point // otherwise return -1 if ((Verbs[i] & PT_CLOSEFIGURE) && ((Verbs[i] & ~PT_CLOSEFIGURE)==PT_BEZIERTO)) return i-1; else return -1; } else { if ((Verbs[ThisIndex-1] & ~PT_CLOSEFIGURE) == PT_BEZIERTO) return ThisIndex-2; else return -1; } } else { // This is the second control point. If the next point has the CloseFigure flag // set we'll have to scan back. Otherwise, return ThisIndex+2 unless the next element // isn't a curve, or there is no next element. if (Verbs[ThisIndex+1] & PT_CLOSEFIGURE) { // The path is closed - scan back for the moveto INT32 i; for (i=ThisIndex;Verbs[i] != PT_MOVETO;i--); // ; deliberate // Move to the next point - if it's a BezierTo we return it, otherwise return -1 if (Verbs[i+1] == PT_BEZIERTO) return i+1; else return -1; } else { // The path isn't closed here, so see if there's another element if (ThisIndex+2 >= UsedSlots || Verbs[ThisIndex+2] != PT_BEZIERTO) { // No next element so return -1 return -1; } else { // Next element is also a curve so return index of control point return ThisIndex+2; } } } }

BOOL Path::FindPrev (  INT32 *  index  )  const

Finds the previous path element in this path starting from the value (index). Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 3/11/94 Parameters: Index  is a pointer to an index into the path to start from [INPUTS] Index  will point at the previous element in the path [OUTPUTS] Returns: TRUE if valid previous element found FALSE if there is no previous element See also: Path::FindNext Definition at line 948 of file paths.cpp. { ENSURE( (*index)<=UsedSlots, "Path position was not valid in FindPrev" ); ENSURE( (*index)>=0, "Path Position less than zero!" ); // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // Move to the prev path element if ((*index)==UsedSlots) { // The current pos is at the end of the path, so move to the last element in the path (*index) --; } else { // see if we were now in the middle of a curve (*index)--; if ((Verbs[(*index)] & (~PT_CLOSEFIGURE))==PT_BEZIERTO) (*index) -= 2; } // Make sure we are still in bounds if ((*index)<0) { // we are not, so set the current pos back to the start and fail (*index) = 0; return FALSE; } // we are in the path, so succeed return TRUE; }

BOOL Path::FindPrev (   )

Finds the prev path element in this path starting the search from CurrentPos. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if valid previous element found FALSE if there is no previous element See also: Path::FindNext Definition at line 896 of file paths.cpp. { ENSURE( CurrentPos<=UsedSlots, "Path position was not valid in FindPrev" ); ENSURE( CurrentPos>=0, "Path Position less than zero!" ); // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); // Move to the prev path element if (CurrentPos==UsedSlots) { // The current pos is at the end of the path, so move to the last element in the path CurrentPos --; } else { // see if we were now in the middle of a curve CurrentPos--; if ((Verbs[CurrentPos] & (~PT_CLOSEFIGURE))==PT_BEZIERTO) CurrentPos -= 2; } // Make sure we are still in bounds if (CurrentPos<0) { // we are not, so set the current pos back to the start and fail CurrentPos = 0; return FALSE; } // we are in the path, so succeed return TRUE; }

INT32 Path::FindPrevControlPoint (  INT32  Index  )

This routine will scan back from an endpoint to find the attached bezier control point. It takes account of closed and open paths and complex paths, and will wrap around the path if necessary. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 23/8/94 Parameters: Index  gives the endpoint whose previous control point I want [INPUTS] -  [OUTPUTS] Returns: Index to the control point (or -1 if none) Errors: - See also: - Definition at line 3382 of file paths.cpp. { // DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); // PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); INT32 i; if (Verbs[Index] == PT_MOVETO) { // This is the start of a path - if the path is open, return -1 // otherwise return the index of the last control point. If the last // element is a line, return -1 i = Index; FindEndOfSubPath(&i); // If the last segment isn't a bezier, return -1 if (Verbs[i] != PT_BEZIERTO) return -1; // if the CLOSEFIGURE flag is set in the final element, return i+1 // otherwise return -1 if (Verbs[i+2] & PT_CLOSEFIGURE) return i+1; return -1; } else { // It isn't the start of a path, so see what kind of endpoint this is // and if it is a bezier, return the control point, otherwise return -1 if ((Verbs[Index] & ~PT_CLOSEFIGURE) == PT_BEZIERTO) return Index-1; return -1; } }

BOOL Path::FindPrevEndPoint (  INT32 *  index  )  const

Finds the previous path endpoint in this path. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 5/1/95 Parameters: Index  = pointer to a INT32 indicating where to start from [INPUTS] Outpus: Index = points to an index which is the previous endpoint Returns: TRUE if the previous end point has been found FALSE if there are no more end points in this path Errors: ERROR2's if Index is beyond the end of the path, OR before the start See also: Path::FindNextEndPoint Definition at line 814 of file paths.cpp. { ERROR2IF(*index > UsedSlots, FALSE, "Path position was not valid in FindPrevEndPoint" ); ERROR2IF(*index < 0, FALSE, "Path Position less than zero in FindPrevEndPoint" ); // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); if ((Verbs[*index] & (~PT_CLOSEFIGURE))==PT_BEZIERTO) *index -= 3; else *index -= 1; if (*index < 0) { *index = 0; return FALSE; } return TRUE; }

BOOL Path::FindSelectionLimits (  INT32  index, INT32 *  p, INT32 *  q )

Finds the next connected region of selected control handles. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 3/11/94 Parameters: index  = search start point [INPUTS] p  = index of first selected point in region [OUTPUTS] q = index of last selected point in region Returns: TRUE if the point set {index,....,UsedSlots-1} contains a set of selected control handles {p,...,q} where p and q are the limits of the selection and all points between are selected. FALSE if no points are selected within the region. Definition at line 3722 of file paths.cpp. { ENSURE( index<UsedSlots, "Path position was not valid in FindSelectionLimits" ); ENSURE( index>=0, "Path Position less than zero in FindSelectionLimits" ); INT32 start = index; // clamp the index if (start<0) start=0; if (start>=UsedSlots) start=UsedSlots-1; if (!FindNextSelected(&start)) return FALSE; INT32 end = start; INT32 search = start; PathFlags* Flags = (PathFlags*) DescribeHandle(FlagsHandle); PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); BOOL done = FALSE; while (FindNextEndPoint(&search) && (!done)) { if ((Flags[search].IsSelected) && (Flags[search].IsEndPoint)) { if (Verbs[search] != PT_MOVETO) end = search; else done = TRUE; } else done = TRUE; } *p = start; *q = end; return TRUE; }

BOOL Path::FindStartOfPath (   )

Sets Pos to the first element in the path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Parameters: Pos  - Holds the position of the start of the path [OUTPUTS] Definition at line 536 of file paths.cpp. { // set the position to the start of the path CurrentPos = 0; // see if this a valid path position if (UsedSlots==0) return FALSE; else return TRUE; }

void Path::FindStartOfSubPath (  INT32 *  Index  )  const

Searches backwards from the current position from Index until it find the start of the subpath (always a moveto). Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/94 Parameters: Index  - the index of the current element (pointer!) [INPUTS] Index  - Holds the position of the start of the sub path [OUTPUTS] Returns: Errors: ENSUREs if the start of the path does not seem to be a MoveTo Definition at line 592 of file paths.cpp. { ENSURE( ((*Index)<UsedSlots && (Index)>=0), "Path position was not valid in FindStartOfSubPath" ); // I am already in a path, so start working backwards until I find the moveto PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); while (((*Index)>0) && (Verbs[*Index]!=PT_MOVETO)) (*Index)--; // The index will either be pointing at a moveto or the begining of the path // Either way, it should be a moveto ENSURE( (Verbs[(*Index)]==PT_MOVETO), "Did not find a start to this sub path" ); }

void Path::FindStartOfSubPath (   )

Searches backwards from the current position until it finds the start of the sub path that the current position is in. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Errors: ENSUREs if the start of the path does not seem to be a MoveTo Definition at line 563 of file paths.cpp. { ENSURE( CurrentPos<UsedSlots, "Path position was not valid in FindStartOfSubPath" ); // I am already in a path, so start working backwards until I find the moveto PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); while ((CurrentPos>0) && (Verbs[CurrentPos]!=PT_MOVETO)) CurrentPos--; // The index will either be pointing at a moveto or the begining of the path // Either way, it should be a moveto ENSURE( (Verbs[CurrentPos]==PT_MOVETO), "Did not find a start to this sub path" ); }

BOOL Path::Flatten (  const double  flatness, Path *  pOutput )

Flatten a path. All curves within the path will be approximated by straight lines. pOutput may point at 'this' path ie a path can be flattened to itself. If the flattening fails for some reason, the output path will be unaffected even if you are flattening a path to itself. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 25/10/94 Parameters: flatness  = How flat the curves should be (around 64 is good) [INPUTS] pOutput  = will contain the flattened path [OUTPUTS] Returns: BOOL = TRUE if the path was flattened successfully = FALSE then output path will be unaffected Definition at line 7854 of file paths.cpp. { // when flattening, flatten curves but dont quantise lines ProcessFlags FlatFlags(TRUE,FALSE); return CreateFlatPath(FlatFlags, flatness, pOutput); }

INT32 Path::GetAllOpenEnds (  INT32  MaxElements, DocCoord *  EndCoords )  const

Goes through the path and copies the coordinates of all the Open ends of the path into the array, until MaxElements elements have been added to the array. Call GetNumEndPoints to find out how big to make your array in the first place. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 12/4/94 Parameters: MaxElements  - The maximum number of coords that can be written to the [INPUTS] array Coords  - A array of DocCoords [OUTPUTS] Returns: The number of coords in the array See also: Path::GetNumEndPoints Definition at line 1482 of file paths.cpp. { // de-reference the verb array PathVerb* Verbs = (PathVerb*) DescribeHandle(VerbHandle); DocCoord* Coords = (DocCoord*) DescribeHandle(CoordHandle); INT32 Count = 0; for (INT32 i=0; i<UsedSlots; i++) { if (Verbs[i]==PT_MOVETO) { // Count this moveto EndCoords[Count] = Coords[i]; Count++; // Check to see we have hit the maximum allowed entries if (Count==MaxElements) return Count; if ((i>0) && (Verbs[i-1]&PT_CLOSEFIGURE)) { // The previous element was a close figure, so it corresponding MoveTo // should not count Count--; } else { // The previous elment was not a close figure, so it was an Open End EndCoords[Count] = Coords[i-1]; Count++; // Check to see we have hit the maximum allowed entries if (Count==MaxElements) return Count; } } } // Check to see if the very last element in the path was a close figure or not if (Verbs[UsedSlots-1] & PT_CLOSEFIGURE) Count--; else { EndCoords[Count] = Coords[UsedSlots-1]; Count++; } // return the number of coords we are stored return Count; }

DocRect Path::GetBlobRect (   )  const

Calculates the bounding rectangle of the paths coordinates expanded by the current blob size. This is calculated on the fly, so don't over use it. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/12/94 Returns: The bounding box of the path and blobs Definition at line 1715 of file paths.cpp. { // If the path is