ArrowRec Class Reference

A class defining a Line ArrowHead Record. More...

#include <arrows.h>

Inheritance diagram for ArrowRec:

List of all members.

Public Member Functions
	ArrowRec ()
	Default constructor for Arrow Record class. Create a NULL Arrow Record.
	ArrowRec (Path *pArrowPath, const DocCoord &Centre, INT32 LineWidth=DEFAULT_ARROW_LINEWIDTH, FIXED16 WidthScale=DEFAULT_ARROW_SIZE, FIXED16 HeightScale=DEFAULT_ARROW_SIZE, BOOL Start=FALSE)
	Constructor for Arrow Record class.
	ArrowRec (const ArrowRec &)
	Copy constructor for Arrows. Makes an ArrowHead identical to the specified one.
	~ArrowRec ()
	Destructor for Arrow Record class. Deletes the arrow path.
BOOL	CreateStockArrow (StockArrow)
	Constructs a Stock ArrowHead.
void	SetArrowSize (FIXED16 Width, FIXED16 Height=0)
	Set the size of the ArrowHead.
INT32	operator== (const ArrowRec &)
	Test to see if this ArrowHead is the same as another.
ArrowRec &	operator= (const ArrowRec &)
	Make one Arrow the same as another.
INT32	operator== (StockArrow)
	Test to see if this ArrowHead is the same as another.
ArrowRec &	operator= (StockArrow)
	Make an arrow into a stock arrow.
Path *	GetArrowPath ()
	Get the path describing the shape of this ArrowHead.
DocCoord	GetArrowCentre ()
	Get the centre of the Arrow (relative to the Arrow Path coordinates).
INT32	GetArrowLineWidth ()
	Get the line width that this arrow was defined for.
FIXED16	GetArrowWidth ()
	Get the width scaling of this arrow head. (How much it is stretched horizontally).
FIXED16	GetArrowHeight ()
	Get the Height scaling of this arrow head. (How much it is stretched Vertically).
BOOL	IsStartArrow ()
	Is this arrow designed to be a Start or End arrow.
BOOL	ShouldScaleWithLineWidth ()
INT32	GetArrowID ()
DocRect	GetArrowBoundingRect (Path *pParent, INT32 LineWidth, BOOL StartArrow)
	Calculates the Union of all the bounds of ArrowHeads on a Path. The path may have many subpaths, so it will union the Bounds of the Arrows on the Start or End of each subpath.
BOOL	GetArrowMatrix (const DocCoord &Centre, const DocCoord &Direction, INT32 LineWidth, Trans2DMatrix *pMatrix)
	Gets a Transform Matrix for this ArrowHead, given the specified position.
BOOL	IsNullArrow ()
void	GetArrowBase (DocCoord *pPoint)
	Gives the base point for this particular arrow (stock arrow) Note : HEAVILY dependent on the stock arrow paths.
Static Public Member Functions
static BOOL	DoesPathNeedArrowHeads (DocCoord *Coords, PathVerb *Verbs, INT32 NumCoords)
	Determines whether a path has any open subpaths which will need arrows drawn onto.
static BOOL	GetFirstArrowPos (BOOL StartArrow, DocCoord *Coords, PathVerb *Verbs, INT32 NumCoords, INT32 *Index, DocCoord *Centre, DocCoord *Direction)
	Scans a path for the first position on a ArrowHead.
static BOOL	GetNextArrowPos (BOOL StartArrow, DocCoord *Coords, PathVerb *Verbs, INT32 NumCoords, INT32 *Index, DocCoord *Centre, DocCoord *Direction)
	Scans a path for the next position on a ArrowHead.
static INT32	GetNumStockArrows ()
static String_256	GetStockArrowName (StockArrow)
	Get a description of a Stock ArrowHead.
static ANGLE	CalcAngle (const DocCoord &Centre, const DocCoord &Direction)
	Calculates the angle of a Line, given the Centre point, and a point specifying the direction. 0 is due East.
Public Attributes
Path *	ArrowShape
DocCoord	Centre
INT32	LineWidth
FIXED16	ArrowWidth
FIXED16	ArrowHeight
BOOL	StartArrow
BOOL	ScaleWithLineWidth
INT32	ArrowID
BOOL	IsNull
BOOL	m_bExtendPath
Private Member Functions
	CC_DECLARE_DYNCREATE (ArrowRec)
DocRect	FindBoundsAt (const DocCoord &Centre, const DocCoord &Direction, INT32 LineWidth)
	Finds the Bounds of this ArrowHead at the Specified position.

---

Detailed Description

A class defining a Line ArrowHead Record.

Author:

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

Date:

4/4/95

Definition at line 159 of file arrows.h.

---

Constructor & Destructor Documentation

ArrowRec::ArrowRec (   )

Default constructor for Arrow Record class. Create a NULL Arrow Record. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 See also: - Definition at line 135 of file arrows.cpp. { ArrowShape = NULL; Centre = DocCoord(0,0); LineWidth = DEFAULT_ARROW_LINEWIDTH; ArrowWidth = 3; ArrowHeight = 3; StartArrow = FALSE; ScaleWithLineWidth = TRUE; ArrowID = 0; m_bExtendPath = TRUE; IsNull = TRUE; }

ArrowRec::ArrowRec (  Path *  pArrowPath, const DocCoord &  ArrowCentre, INT32  ArrowLineWidth = DEFAULT_ARROW_LINEWIDTH, FIXED16  ArrowWidthScale = DEFAULT_ARROW_SIZE, FIXED16  ArrowHeightScale = DEFAULT_ARROW_SIZE, BOOL  Start = FALSE )

Constructor for Arrow Record class. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: pArrowPath  - The Path describing the shape of the ArrowHead. [INPUTS] Centre - The arrowhead centre (relative to the path coords). LineWidth - The line width that the Arrow head was designed for. WidthScale - The amount to scale the Arrow Width by (ie. Aspect Ratio) HeightScale - The amount to scale the Arrow Height by (ie. Aspect Ratio) Returns: Errors: - See also: - Definition at line 174 of file arrows.cpp. { ArrowShape = pArrowPath; Centre = ArrowCentre; LineWidth = ArrowLineWidth; ArrowWidth = ArrowWidthScale; ArrowHeight = ArrowHeightScale; StartArrow = Start; ScaleWithLineWidth = TRUE; ArrowID = -1; m_bExtendPath = TRUE; IsNull = FALSE; }

ArrowRec::ArrowRec (  const ArrowRec &  OtherArrow  )

Copy constructor for Arrows. Makes an ArrowHead identical to the specified one. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 See also: - Definition at line 208 of file arrows.cpp. { *this = OtherArrow; }

ArrowRec::~ArrowRec (   )

Destructor for Arrow Record class. Deletes the arrow path. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 See also: - Definition at line 225 of file arrows.cpp. { if (ArrowShape != NULL) delete ArrowShape; }

---

Member Function Documentation

ANGLE ArrowRec::CalcAngle (  const DocCoord &  ArrowCentre, const DocCoord &  Direction )  [static]

Calculates the angle of a Line, given the Centre point, and a point specifying the direction. 0 is due East. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1413 of file arrows.cpp. { ANGLE Angle; // Calculate the angle of the arrow from the line angle const INT32 dx = Direction.x - ArrowCentre.x; const INT32 dy = Direction.y - ArrowCentre.y; if ( (dy==0) && (dx==0) ) { return FALSE; // Too small } double LineAngle; if ( (dx>=0) && (dy>=0) ) LineAngle = -PI + atan2( (double)dy, (double)dx ); else if ( (dx<0) && (dy>=0) ) LineAngle = -atan2( (double)dy, (double)-dx ); else if ( (dx<0) && (dy<0) ) LineAngle = atan2( (double)-dy, (double)-dx ); else if ( (dx>=0) && (dy<0) ) LineAngle = PI - atan2( (double)-dy, (double)dx ); else { TRACE( wxT("invalid angle in CalcAngle\n") ); // this should be impossible return FALSE; } Angle = 360 * (LineAngle / (2*PI)); // Convert from radians to degrees return Angle; }

ArrowRec::CC_DECLARE_DYNCREATE (  ArrowRec   )  [private]

BOOL ArrowRec::CreateStockArrow (  StockArrow  ArrowType  )

Constructs a Stock ArrowHead. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: ArrowType  - The StockArrow number of the ArrowHead to create. [INPUTS] Returns: FALSE, if failed to create the arrow path. Errors: Out of Memory. See also: StockArrow Definition at line 245 of file arrows.cpp. { if (ArrowShape != NULL) { delete ArrowShape; ArrowShape = NULL; } BOOL ok; Path* pPath; const INT32 Size = 3; const INT32 Width = (72000/2)*3; if (ArrowType >= NUM_STOCK_ARROWS) ArrowType = SA_STRAIGHTARROW; // Set the ArrowID ArrowID = ArrowType; switch (ArrowType) { case SA_STRAIGHTARROW: /* STRAIGHT -9 54 m -9 0 l -9 -54 l 117 0 l -9 54 l -9 54 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(4); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord( -9000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( -9000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord(117000, 0)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = FALSE; break; case SA_ANGLEDARROW: /* ANGLED -26.999 53.999 m -9 0 l -26.999 -54.001 l 135 0 l -26.999 53.999 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(5); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord(-27000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( -9000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord(-27000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord(135000, 0)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = FALSE; break; case SA_ROUNDEDARROW: /* ROUND -9 0 m -9 -45 l -9 -51.708 2.808 -56.580 9 -54 c 117 -9 l 120.916 -7.369 126 -4.242 126 0 c 126 4.242 120.916 7.369 117 9 c 9 54 l 2.808 56.580 -9 51.708 -9 45 c -9 0 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(17); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo( DocCoord( -9000, 0)); if (ok) ok = pPath->InsertLineTo( DocCoord( -9000, -45000)); if (ok) ok = pPath->InsertCurveTo(DocCoord( -9000, -51708), DocCoord( 2808, -56580), DocCoord( 9000, -54000)); if (ok) ok = pPath->InsertLineTo( DocCoord( 117000, -9000)); if (ok) ok = pPath->InsertCurveTo(DocCoord( 120916, -7369), DocCoord( 126000, -4242), DocCoord( 126000, 0)); if (ok) ok = pPath->InsertCurveTo(DocCoord( 126000, 4242), DocCoord( 120916, 7369), DocCoord( 117000, 9000)); if (ok) ok = pPath->InsertLineTo( DocCoord( 9000, 54000)); if (ok) ok = pPath->InsertCurveTo(DocCoord( 2808, 56580), DocCoord( -9000, 51708), DocCoord( -9000, 45000)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = FALSE; break; case SA_SPOT: /* BLOB -54 0 m -54 29.807 -29.807 54 0 54 c 29.807 54 54 29.807 54 0 c 54 -29.807 29.807 -54 0 -54 c -29.807 -54 -54 -29.807 -54 0 c */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(14); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo( DocCoord( -54000, 0)); if (ok) ok = pPath->InsertCurveTo(DocCoord( -54000, 29807), DocCoord( -29807, 54000), DocCoord( 0, 54000)); if (ok) ok = pPath->InsertCurveTo(DocCoord( 29807, 54000), DocCoord( 54000, 29807), DocCoord( 54000, 0)); if (ok) ok = pPath->InsertCurveTo(DocCoord( 54000, -29807), DocCoord( 29807, -54000), DocCoord( 0, -54000)); if (ok) ok = pPath->InsertCurveTo(DocCoord( -29807, -54000), DocCoord( -54000, -29807), DocCoord( -54000, 0)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = TRUE; break; case SA_DIAMOND: /* DIAMOND -63 0 m 0 63 l 63 0 l 0 -63 l -63 0 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(5); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord(-63000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord( 0, 63000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord( 0, -63000)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = TRUE; break; case SA_ARROWFEATHER: /* FEATHER 18 -54 m 108 -54 l 63 0 l 108 54 l 18 54 l -36 0 l 18 -54 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(7); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord( 18000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord(108000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord(108000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 18000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord(-36000, 0)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = TRUE; break; case SA_ARROWFEATHER2: /* FEATHER3 -35.998 0 m 18 -54 l 54 -54 l 18 -18 l 27 -18 l 63 -54 l 99 -54 l 63 -18 l 72 -18 l 108 -54 l 144 -54 l 90 0 l 144 54 l 108 54 l 72 18 l 63 18 l 99 54 l 63 54 l 27 18 l 18 18 l 54 54 l 18 54 l -35.998 0 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(23); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord( -36000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord( 18000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 54000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 18000, -18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 27000, -18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 99000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, -18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 72000, -18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 108000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 144000, -54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 90000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord( 144000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 108000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 72000, 18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, 18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 99000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 27000, 18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 18000, 18000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 54000, 54000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 18000, 54000)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(0,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = TRUE; break; case SA_HOLLOWDIAMOND: /* HOLLOW 0 45 m -45 0 l 0 -45 l 45 0 l 0 45 l 0 63 m -63 0 l 0 -63 l 63 0 l 0 63 l */ pPath = new Path(); if (pPath == NULL) return FALSE; ok = pPath->Initialise(10); if (ok) pPath->FindStartOfPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord( 0, 45000)); if (ok) ok = pPath->InsertLineTo(DocCoord(-45000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord( 0, -45000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 45000, 0)); if (ok) ok = pPath->CloseSubPath(); if (ok) ok = pPath->InsertMoveTo(DocCoord( 0, 63000)); if (ok) ok = pPath->InsertLineTo(DocCoord(-63000, 0)); if (ok) ok = pPath->InsertLineTo(DocCoord( 0, -63000)); if (ok) ok = pPath->InsertLineTo(DocCoord( 63000, 0)); if (ok) ok = pPath->CloseSubPath(); if (!ok) { delete pPath; return FALSE; } pPath->IsFilled = TRUE; pPath->IsStroked = FALSE; ArrowShape = pPath; Centre = DocCoord(-45000,0); LineWidth = Width; ArrowWidth = INT32(Size); ArrowHeight = INT32(Size); IsNull = FALSE; StartArrow = TRUE; break; default: ArrowShape = NULL; Centre = DocCoord(0,0); LineWidth = DEFAULT_ARROW_LINEWIDTH; ArrowWidth = 3; ArrowHeight = 3; StartArrow = FALSE; ScaleWithLineWidth = TRUE; ArrowID = SA_NULLARROW; IsNull = TRUE; break; } return TRUE; }

BOOL ArrowRec::DoesPathNeedArrowHeads (  DocCoord *  Coords, PathVerb *  Verbs, INT32  NumCoords )  [static]

Determines whether a path has any open subpaths which will need arrows drawn onto. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1276 of file arrows.cpp. { // Scan for subpaths, and check to see if they're closed or not. BOOL FoundCloseFigure = TRUE; for (INT32 coord=0; coord<NumCoords; coord++) { if (Verbs[coord] == PT_MOVETO) { if (!FoundCloseFigure) return TRUE; // Got a MOVETO before a CLOSEFIGURE, // so must be at least one open subpath FoundCloseFigure = FALSE; } if (Verbs[coord] & PT_CLOSEFIGURE) { FoundCloseFigure = TRUE; } } if (!FoundCloseFigure) return TRUE; return FALSE; }

DocRect ArrowRec::FindBoundsAt (  const DocCoord &  ArrowCentre, const DocCoord &  Direction, INT32  ParentLineWidth )  [private]

Finds the Bounds of this ArrowHead at the Specified position. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: Centre,The  Centre point (in Spread Coords) of the Arrow. [INPUTS] Direction, A Spread coord specifying the arrow direction (Relative to Centre). ParentLineWidth, The LineWidth of the Path. Returns: The Bounds of the arrow at this position. Errors: - See also: - Definition at line 1132 of file arrows.cpp. { DocRect Bounds(0,0,0,0); // Find a matrix to transform the ArrowHead to this Position. Trans2DMatrix Trans; GetArrowMatrix(ArrowCentre, Direction, ParentLineWidth, &Trans); // Note: // We should really be able to ask Gavin to Calculate the Bounds, // and pass him this Transform Matrix, but he can't do this at the // moment, so we'll have to actually transform the path into // a tempory path, and then ask him to calc the bounds of that. // Make a tempory path to transform Path* TransPath = new Path(); if (TransPath == NULL) return Bounds; // Copy the path data from the ArrorHead into our tempory path. BOOL ok = TransPath->Initialise(ArrowShape->GetNumCoords()); if (ok) ok = TransPath->CopyPathDataFrom(ArrowShape); if (!ok) { // Tidy up if we failed delete TransPath; return Bounds; } // Go transform the Tempory path Trans.Transform(TransPath->GetCoordArray(), TransPath->GetNumCoords() ); BOOL GDrawResult = FALSE; // Find out what the paths bounding rect is, taking into account // any bezier curve thingies. GDrawContext *GD = GRenderRegion::GetStaticDrawContext(); if (GD != NULL) GDrawResult = GD->CalcStrokeBBox((POINT*)TransPath->GetCoordArray(), TransPath->GetVerbArray(), TransPath->GetNumCoords(), (RECT *)(&Bounds), TRUE, 0, CAPS_ROUND, JOIN_ROUND, NULL) == 0; // If Gavin failed, then use backup technique of getting coord array bounds if (!GDrawResult) Bounds = TransPath->GetBoundingRect(); // Delete the temporary transformed path delete TransPath; return Bounds; }

void ArrowRec::GetArrowBase (  DocCoord *  pPoint  )

Gives the base point for this particular arrow (stock arrow) Note : HEAVILY dependent on the stock arrow paths. Author: David_McClarnon (Xara Group Ltd) <camelotdev@xara.com> Date: 25/2/99 Parameters: The  doccoord to put the point into [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1464 of file arrows.cpp. { if (!pPoint) return; DocRect ArrowRect = ArrowShape->GetBoundingRect(); switch (ArrowID) { case SA_STRAIGHTARROW: pPoint->x = -9000; pPoint->y = 0; break; case SA_ANGLEDARROW: pPoint->x = -9000; pPoint->y = 0; break; case SA_ROUNDEDARROW: pPoint->x = -9000; pPoint->y = 0; break; case SA_SPOT: pPoint->x = -30000; pPoint->y = (ArrowRect.hi.y + ArrowRect.lo.y) / 2; break; case SA_DIAMOND: pPoint->x = -54000; pPoint->y = (ArrowRect.hi.y + ArrowRect.lo.y) / 2; break; case SA_ARROWFEATHER: pPoint->x = -30000; pPoint->y = (ArrowRect.hi.y + ArrowRect.lo.y) / 2; break; case SA_ARROWFEATHER2: pPoint->x = -30000; pPoint->y = (ArrowRect.hi.y + ArrowRect.lo.y) / 2; break; case SA_HOLLOWDIAMOND: pPoint->x = -54000; pPoint->y = (ArrowRect.hi.y + ArrowRect.lo.y) / 2; break; default: pPoint->x = ArrowRect.lo.x; pPoint->y = (ArrowRect.hi.y + ArrowRect.lo.y) / 2; break; } }

DocRect ArrowRec::GetArrowBoundingRect (  Path *  pParent, INT32  ParentLineWidth, BOOL  StartArrow )

Calculates the Union of all the bounds of ArrowHeads on a Path. The path may have many subpaths, so it will union the Bounds of the Arrows on the Start or End of each subpath. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: pParent,The  Path to get the Arrow Bounds of. [INPUTS] ParentLineWidth, The current applied LineWidth of the Path. StartArrow, TRUE = Calc StartArrow Bounds, FALSE = Calc EndArrow Bounds. Returns: The Union of all the bounds of ArrowHeads on this Path. Errors: - See also: - Definition at line 1073 of file arrows.cpp. { if (IsNullArrow()) return DocRect(0,0,0,0); // Hopefully we won't be asked for our bounds // if we are NULL. But just in case ... // We will now try and find the total bounds of the ArrowHeads, // on this path. The path may be made up of many subpaths, so // we'll need to union the bounds of each ArrowHead on the end // of each subpath. DocRect Bounds(0,0,0,0); INT32 PathIndex = 0; DocCoord ArrowCentre; DocCoord ArrowDirection; DocCoord* Coords = pParent->GetCoordArray(); PathVerb* Verbs = pParent->GetVerbArray(); INT32 NumCoords = pParent->GetNumCoords(); // Find the first position of an ArrowHead BOOL GotPos = GetFirstArrowPos(StartArrow, Coords, Verbs, NumCoords, &PathIndex, &ArrowCentre, &ArrowDirection); while (GotPos) { // Union all the Bounds of the Arrows on each subpath Bounds = Bounds.Union(FindBoundsAt(ArrowCentre, ArrowDirection, ParentLineWidth)); // Find the next Arrow position (if there are any more subpaths) GotPos = GetNextArrowPos(StartArrow, Coords, Verbs, NumCoords, &PathIndex, &ArrowCentre, &ArrowDirection); } // Return the Union of all the arrow bounds return Bounds; }

DocCoord ArrowRec::GetArrowCentre (   )

Get the centre of the Arrow (relative to the Arrow Path coordinates). Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - See also: - Definition at line 969 of file arrows.cpp. { return Centre; }

FIXED16 ArrowRec::GetArrowHeight (   )

Get the Height scaling of this arrow head. (How much it is stretched Vertically). Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - See also: - Definition at line 1022 of file arrows.cpp. { return ArrowHeight; }

INT32 ArrowRec::GetArrowID (   )

Definition at line 1049 of file arrows.cpp. { return ArrowID; }

INT32 ArrowRec::GetArrowLineWidth (   )

Get the line width that this arrow was defined for. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - See also: - Definition at line 986 of file arrows.cpp. { return LineWidth; }

BOOL ArrowRec::GetArrowMatrix (  const DocCoord &  ArrowCentre, const DocCoord &  Direction, INT32  ParentLineWidth, Trans2DMatrix *  pMatrix )

Gets a Transform Matrix for this ArrowHead, given the specified position. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1206 of file arrows.cpp. { if (IsNullArrow()) return FALSE; TRACEUSER( "DavidM", wxT("ArrowRec::GetArrowMatrix %d\n"), m_bExtendPath ); ANGLE RotateAngle = CalcAngle(ArrowCentre, Direction); // Now we work how much we need to scale the path DocRect ArrowBounds = ArrowShape->GetBoundingRect(); double TempLineWidth = ParentLineWidth; if (TempLineWidth == 0) TempLineWidth = ZEROWIDTH_ARROW_LINEWIDTH; BOOL DoScale = ScaleWithLineWidth; FIXED16 xscale = DoScale ? ((ArrowWidth.MakeDouble() * TempLineWidth) / LineWidth) : (ArrowWidth); FIXED16 yscale = DoScale ? ((ArrowHeight.MakeDouble() * TempLineWidth) / LineWidth) : (ArrowWidth); // move the centre of the arrow DocRect ArrowRect = ArrowShape->GetBoundingRect(); DocCoord centre; if (!m_bExtendPath) { centre.x = ArrowRect.hi.x; centre.y = (ArrowRect.lo.y + ArrowRect.hi.y) / 2; } else { centre = Centre; } Matrix Mat = Matrix(-centre.x, -centre.y); // Move shape to origin Mat *= Matrix(xscale, yscale); // Scale it Mat *= Matrix(RotateAngle); // Rotate it Mat *= Matrix(ArrowCentre); // Move it to the line point Trans2DMatrix Trans(Mat); *pMatrix = Trans; return TRUE; }

Path * ArrowRec::GetArrowPath (   )

Get the path describing the shape of this ArrowHead. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - See also: - Definition at line 952 of file arrows.cpp. { return ArrowShape; }

FIXED16 ArrowRec::GetArrowWidth (   )

Get the width scaling of this arrow head. (How much it is stretched horizontally). Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - See also: - Definition at line 1004 of file arrows.cpp. { return ArrowWidth; }

BOOL ArrowRec::GetFirstArrowPos (  BOOL  StartArrow, DocCoord *  Coords, PathVerb *  Verbs, INT32  NumCoords, INT32 *  Index, DocCoord *  Centre, DocCoord *  Direction )  [static]

Scans a path for the first position on a ArrowHead. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1320 of file arrows.cpp. { *Index = 0; // Start at the beginning of the path // And scan for open subpaths return GetNextArrowPos(StartArrow, Coords, Verbs, NumCoords, Index, Centre, Direction); }

BOOL ArrowRec::GetNextArrowPos (  BOOL  StartArrow, DocCoord *  Coords, PathVerb *  Verbs, INT32  NumCoords, INT32 *  Index, DocCoord *  Centre, DocCoord *  Direction )  [static]

Scans a path for the next position on a ArrowHead. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1346 of file arrows.cpp. { INT32 coord = *Index; INT32 StartPos = -1; // Look for next subpath start while (coord<NumCoords) { if (Verbs[coord] == PT_MOVETO) { if (StartPos != -1) break; // Break out, We've found an open subpath !! StartPos = coord; // Remember the Subpath start pos } if (Verbs[coord] & PT_CLOSEFIGURE) { StartPos = -1; // Look for next subpath } coord++; } if (StartPos != -1) { // We've found an open subpath !! if (StartArrow) { *Centre = Coords[StartPos]; *Direction = Coords[StartPos+1]; // move the centre back by the direction & the size of the arrow } else { *Centre = Coords[coord-1]; *Direction = Coords[coord-2]; } *Index = coord; return TRUE; } // There are no more open subpaths return FALSE; }

static INT32 ArrowRec::GetNumStockArrows (   )  [inline, static]

Definition at line 224 of file arrows.h. { return NUM_STOCK_ARROWS; }

String_256 ArrowRec::GetStockArrowName (  StockArrow  ArrowType  )  [static]

Get a description of a Stock ArrowHead. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - Errors: - See also: - Definition at line 720 of file arrows.cpp. { String_256 ArrowName = String_256(_R(IDS_K_ARROWS_DEFAULTARROW)); switch (ArrowType) { case SA_STRAIGHTARROW: ArrowName.Load(_R(IDS_K_ARROWS_STRAIGHTARROW)); break; case SA_ANGLEDARROW: ArrowName.Load(_R(IDS_K_ARROWS_ANGLEDARROW)); break; case SA_ROUNDEDARROW: ArrowName.Load(_R(IDS_K_ARROWS_ROUNDEDARROW)); break; case SA_SPOT: ArrowName.Load(_R(IDS_K_ARROWS_SPOT)); break; case SA_DIAMOND: ArrowName.Load(_R(IDS_K_ARROWS_DIAMOND)); break; case SA_ARROWFEATHER: ArrowName.Load(_R(IDS_K_ARROWS_ARROWFEATHER)); break; case SA_ARROWFEATHER2: ArrowName.Load(_R(IDS_K_ARROWS_ARROWFEATHER2)); break; case SA_HOLLOWDIAMOND: ArrowName.Load(_R(IDS_K_ARROWS_HOLLOWDIAMOND)); break; default: ArrowName = ""; break; } return ArrowName; }

BOOL ArrowRec::IsNullArrow (   )  [inline]

Definition at line 221 of file arrows.h. { return (ArrowShape == NULL || IsNull); }

BOOL ArrowRec::IsStartArrow (   )

Is this arrow designed to be a Start or End arrow. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 12/4/95 Returns: - See also: - Definition at line 1039 of file arrows.cpp. { return StartArrow; }

ArrowRec & ArrowRec::operator= (  StockArrow  ArrowType  )

Make an arrow into a stock arrow. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 858 of file arrows.cpp. { // Now try and create a new one CreateStockArrow(ArrowType); return (*this); }

ArrowRec & ArrowRec::operator= (  const ArrowRec &  OtherArrow  )

Make one Arrow the same as another. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - Errors: - See also: - Definition at line 798 of file arrows.cpp. { if (ArrowShape != NULL) { delete ArrowShape; // Get rid of existing arrow path ArrowShape = NULL; } if (OtherArrow.ArrowShape != NULL) { // Now try and create a new one ArrowShape = new Path(); if (ArrowShape == NULL) return (*this); // Copy the path data from the Other Arrow into our new path. BOOL ok = ArrowShape->Initialise(OtherArrow.ArrowShape->GetNumCoords()); if (ok) ok = ArrowShape->CopyPathDataFrom(OtherArrow.ArrowShape); if (!ok) { // Tidy up if we failed delete ArrowShape; ArrowShape = NULL; } } Centre = OtherArrow.Centre; LineWidth = OtherArrow.LineWidth; ArrowWidth = OtherArrow.ArrowWidth; ArrowHeight = OtherArrow.ArrowHeight; StartArrow = OtherArrow.StartArrow; ArrowID = OtherArrow.ArrowID; ScaleWithLineWidth = OtherArrow.ScaleWithLineWidth; m_bExtendPath = OtherArrow.m_bExtendPath; IsNull = OtherArrow.IsNull; return (*this); }

INT32 ArrowRec::operator== (  StockArrow  ArrowType  )

Test to see if this ArrowHead is the same as another. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] Returns: - Errors: - See also: - Definition at line 931 of file arrows.cpp. { ArrowRec TempArrow; TempArrow.CreateStockArrow(ArrowType); TempArrow.m_bExtendPath = m_bExtendPath; return (*this == TempArrow); }

INT32 ArrowRec::operator== (  const ArrowRec &  OtherArrow  )

Test to see if this ArrowHead is the same as another. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Parameters: -  [INPUTS] Returns: - Errors: - See also: - Definition at line 880 of file arrows.cpp. { if (ArrowShape == NULL && OtherArrow.ArrowShape == NULL) return TRUE; if (ArrowShape == NULL || OtherArrow.ArrowShape == NULL) return FALSE; INT32 NumCoords = ArrowShape->GetNumCoords(); INT32 OtherNumCoords = OtherArrow.ArrowShape->GetNumCoords(); if (NumCoords != OtherNumCoords) return FALSE; DocCoord* Coords = ArrowShape->GetCoordArray(); PathVerb* Verbs = ArrowShape->GetVerbArray(); DocCoord* OtherCoords = OtherArrow.ArrowShape->GetCoordArray(); PathVerb* OtherVerbs = OtherArrow.ArrowShape->GetVerbArray(); for (INT32 i=0; i<NumCoords; i++) { if (Coords[i] != OtherCoords[i] || Verbs[i] != OtherVerbs[i]) return FALSE; } TRACEUSER( "DavidM", wxT("ArrowRec::operator == %d %d\n"), m_bExtendPath, OtherArrow.m_bExtendPath); return (Centre == OtherArrow.Centre && LineWidth == OtherArrow.LineWidth && ArrowWidth == OtherArrow.ArrowWidth && ArrowHeight == OtherArrow.ArrowHeight && StartArrow == OtherArrow.StartArrow && m_bExtendPath == OtherArrow.m_bExtendPath); }

void ArrowRec::SetArrowSize (  FIXED16  Width, FIXED16  Height = 0 )

Set the size of the ArrowHead. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 4/4/95 Returns: - Errors: - See also: - Definition at line 779 of file arrows.cpp. { ArrowWidth = Width; ArrowHeight = (Height > 0) ? Height : Width; }

BOOL ArrowRec::ShouldScaleWithLineWidth (   )

Definition at line 1044 of file arrows.cpp. { return ScaleWithLineWidth; }

---

Member Data Documentation

FIXED16 ArrowRec::ArrowHeight

Definition at line 238 of file arrows.h.

INT32 ArrowRec::ArrowID

Definition at line 242 of file arrows.h.

Path* ArrowRec::ArrowShape

Definition at line 234 of file arrows.h.

FIXED16 ArrowRec::ArrowWidth

Definition at line 237 of file arrows.h.

DocCoord ArrowRec::Centre

Definition at line 235 of file arrows.h.

BOOL ArrowRec::IsNull

Definition at line 245 of file arrows.h.

INT32 ArrowRec::LineWidth

Definition at line 236 of file arrows.h.

BOOL ArrowRec::m_bExtendPath

Definition at line 252 of file arrows.h.

BOOL ArrowRec::ScaleWithLineWidth

Definition at line 241 of file arrows.h.

BOOL ArrowRec::StartArrow

Definition at line 240 of file arrows.h.

---

The documentation for this class was generated from the following files:

• Kernel/arrows.h (r1785/r751)
• Kernel/arrows.cpp (r1785/r1282)

---