NodeRect Class Reference

A Node rect represents a rectangle object in the tree. It is derived from NodeSimple Shape that contains most of the functionality it needs. Simple Shapes are a group of nodes that are based around a parallelogram. The shape is fitted into a parallelogram so that it can be transformed while keeping its own identity (ie, it does not have to be turned into a NodePath). More...

#include <noderect.h>

Inheritance diagram for NodeRect:

List of all members.

Public Member Functions
	NodeRect ()
	This constructor creates a NodeRect linked to no other with all status flags false and an uninitialized bounding rectangle.
	NodeRect (Node *ContextNode, AttachNodeDirection Direction, BOOL Locked=FALSE, BOOL Mangled=FALSE, BOOL Marked=FALSE, BOOL Selected=FALSE)
	This constructor initialises the nodes flags and links it to ContextNode in the direction specified by Direction. All neccesary tree links are updated.
virtual Node *	SimpleCopy ()
	Makes a copy of all the data in the node.
virtual String	Describe (BOOL Plural, BOOL Verbose)
	To return a description of the NodeRect object in either the singular or the plural. This method is called by the DescribeRange method. The description will always begin with a lower case letter.
void	PreExportRender (RenderRegion *pRegion)
	Output data required to mark this object as a rectangle as opposed to an arbitrary path.
virtual void	CreateShape (DocRect NewRect)
	Creates a rectangle using a path.
virtual void	UpdateShape ()
	Updates rectangle node to fit the current parallelogram.
virtual UINT32	GetNodeSize () const
	For finding the size of the node.
virtual BOOL	SnapToCoords (DocCoord *pDocCoord)
	Snaps the point magnetically to the magnetic coords for a rectangle. These are :- The Centre, The Corners, and the midpoints of its edges.
virtual void	HandleBlobDrag (DocCoord &, Spread *, INT32)
	When a drag is started on one of the paths blobs this is called. It tries to fire up an operation that will perform a drag of all the selected points, including all the EORing of the relavent parts of the curve. If it fails it will inform the user and not bother.
Private Member Functions
	CC_DECLARE_DYNCREATE (NodeRect)

---

Detailed Description

A Node rect represents a rectangle object in the tree. It is derived from NodeSimple Shape that contains most of the functionality it needs. Simple Shapes are a group of nodes that are based around a parallelogram. The shape is fitted into a parallelogram so that it can be transformed while keeping its own identity (ie, it does not have to be turned into a NodePath).

Author:

Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>, Changed by Rik

Date:

22/9/93

Definition at line 122 of file noderect.h.

---

Constructor & Destructor Documentation

NodeRect::NodeRect (   )

This constructor creates a NodeRect linked to no other with all status flags false and an uninitialized bounding rectangle. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 22/9/93 Note: SetUpPath() must be called before the NodeRect is in a state in which it can be used. See also: SetUpPath Definition at line 200 of file noderect.cpp. : NodeSimpleShape() { }

NodeRect::NodeRect (  Node *  ContextNode, AttachNodeDirection  Direction, BOOL  Locked = FALSE, BOOL  Mangled = FALSE, BOOL  Marked = FALSE, BOOL  Selected = FALSE )

This constructor initialises the nodes flags and links it to ContextNode in the direction specified by Direction. All neccesary tree links are updated. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 22/9/93 Parameters: ContextNode,:  Pointer to a node which this node is to be attached to. [INPUTS] Direction: Specifies the direction in which the node is to be attached to the ContextNode. The values this variable can take are as follows: PREV : Attach node as a previous sibling of the context node NEXT : Attach node as a next sibling of the context node FIRSTCHILD: Attach node as the first child of the context node LASTCHILD : Attach node as a last child of the context node BoundingRect: Bounding rectangle The remaining inputs specify the status of the node: Locked: Is node locked ? Mangled: Is node mangled ? Marked: Is node marked ? Selected: Is node selected ? Note: SetUpPath() must be called before the NodeRect is in a state in which it can be used. See also: SetUpPath Returns: Errors: An assertion error will occur if ContextNode is NULL Definition at line 170 of file noderect.cpp. :NodeSimpleShape(ContextNode, Direction, Locked, Mangled, Marked, Selected ) { }

---

Member Function Documentation

NodeRect::CC_DECLARE_DYNCREATE (  NodeRect   )  [private]

void NodeRect::CreateShape (  DocRect  NewRect  )  [virtual]

Creates a rectangle using a path. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>, Changed by Rik Date: 22/9/93 Parameters: DocRect  - representing the rectangle to be created. [INPUTS] Reimplemented from NodeSimpleShape. Definition at line 293 of file noderect.cpp. { // Copy the rectangle into the parallelogram Parallel[0] = DocCoord(NewRect.lo.x, NewRect.hi.y); Parallel[1] = DocCoord(NewRect.hi.x, NewRect.hi.y); Parallel[2] = DocCoord(NewRect.hi.x, NewRect.lo.y); Parallel[3] = DocCoord(NewRect.lo.x, NewRect.lo.y); // build a path InkPath.FindStartOfPath(); // Start at bottom left corner InkPath.InsertMoveTo(Parallel[0]); InkPath.InsertLineTo(Parallel[1]); InkPath.InsertLineTo(Parallel[2]); InkPath.InsertLineTo(Parallel[3]); InkPath.InsertLineTo(Parallel[0]); // Close the path properly InkPath.CloseSubPath(); }

String NodeRect::Describe (  BOOL  Plural, BOOL  Verbose )  [virtual]

To return a description of the NodeRect object in either the singular or the plural. This method is called by the DescribeRange method. The description will always begin with a lower case letter. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 25/6/93 Parameters: Plural,:  Flag indicating if the string description should be plural or [INPUTS] singular. Retuns: Description of the object Returns: Errors: A resource exception will be thrown if a problem occurs when loading the string resource. Reimplemented from Node. Reimplemented in NodeAnimatingBitmap, and NodeBitmap. Definition at line 247 of file noderect.cpp. { if (Plural) return(String(_R(IDS_RECTANGLE_DESCRP))); else return(String(_R(IDS_RECTANGLE_DESCRS))); };

UINT32 NodeRect::GetNodeSize (   )  const [virtual]

For finding the size of the node. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 6/10/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The size of the node in bytes See also: Node::GetSubtreeSize Reimplemented from NodeSimpleShape. Reimplemented in NodeAnimatingBitmap, and NodeBitmap. Definition at line 395 of file noderect.cpp. { return (sizeof(NodeRect)); }

void NodeRect::HandleBlobDrag (  DocCoord &  PointerPos, Spread *  pSpread, INT32  FixedCorner )  [virtual]

When a drag is started on one of the paths blobs this is called. It tries to fire up an operation that will perform a drag of all the selected points, including all the EORing of the relavent parts of the curve. If it fails it will inform the user and not bother. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/93 Parameters: PointerPos  - The position the mouse pointer clicked [INPUTS] pSpread - the spread that the click was on FixedCorner - The corner of the parallelogram that will stay fixed during the drag Reimplemented from NodeSimpleShape. Definition at line 359 of file noderect.cpp. { #if !defined(EXCLUDE_FROM_RALPH) OpEditRectangle* pOpRect = new OpEditRectangle; if (pOpRect == NULL) { // Failed to get the memory to do the job TRACEUSER( "Rik", _T("The Node Rect Edit Operation failed to start\n") ); // Inform the person doing the clicking that life is not looking so good InformError(); } else { // Start the drag operation and pass in the Anchor Point to the operation pOpRect->DoDrag(PointerPos, pSpread, this, FixedCorner); } #endif }

void NodeRect::PreExportRender (  RenderRegion *  pRegion  )  [virtual]

Output data required to mark this object as a rectangle as opposed to an arbitrary path. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/08/94 Parameters: pRegion  - the render region we are exporting to. [INPUTS] Reimplemented from Node. Reimplemented in NodeBitmap. Definition at line 268 of file noderect.cpp. { #ifdef DO_EXPORT if (pRegion->IsKindOf(CC_RUNTIME_CLASS(ArtWorksEPSRenderRegion))) { // Output "ArtWorks rectangle" token EPSExportDC *pDC = (EPSExportDC *) pRegion->GetRenderDC(); pDC->OutputToken(_T("ar")); pDC->OutputNewLine(); } #endif }

Node * NodeRect::SimpleCopy (  void   )  [virtual]

Makes a copy of all the data in the node. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 26/5/93 Returns: Pointer to a Node Reimplemented from NodeSimpleShape. Reimplemented in NodeAnimatingBitmap, and NodeBitmap. Definition at line 217 of file noderect.cpp. { // Make a new NodeSimpleShape and then copy things into it NodeRect* NodeCopy = new NodeRect(); if (NodeCopy) CopyNodeContents(NodeCopy); return NodeCopy; }

BOOL NodeRect::SnapToCoords (  DocCoord *  pDocCoord  )  [virtual]

Snaps the point magnetically to the magnetic coords for a rectangle. These are :- The Centre, The Corners, and the midpoints of its edges. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/94 Parameters: pDocCoord  - the coord to try and snap to [INPUTS] pDocCoord  - The snapped coord, if it was close enough to any of the magnetic [OUTPUTS] points for a rectangle. Returns: TRUE if it was snapped, FALSE if not Reimplemented from NodeSimpleShape. Definition at line 419 of file noderect.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // First try and snap to all the places that the base class snaps for us BOOL IsSnapped = NodeSimpleShape::SnapToCoords(pDocCoord); // if it did not snap in the base class, try the extra points if (IsSnapped==FALSE) { // Try each of the corner of the rectangle for (INT32 i=0; i<4; i++) { if (IsMagneticallyClose(&Parallel[i], pDocCoord)) return TRUE; } } // send the result on return IsSnapped; #else return FALSE; #endif }

void NodeRect::UpdateShape (   )  [virtual]

Updates rectangle node to fit the current parallelogram. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>, Changed by Rik Date: 22/9/93 Reimplemented from NodeSimpleShape. Definition at line 325 of file noderect.cpp. { // make sure the path seems to have the correct number of coords in it ENSURE(InkPath.GetNumCoords()==5, "NodeRect::UpdateShape found its path corrupt" ); // Get the array of coords in the path DocCoord* Coords = InkPath.GetCoordArray(); // Update them to what we now have Coords[0] = Parallel[0]; Coords[1] = Parallel[1]; Coords[2] = Parallel[2]; Coords[3] = Parallel[3]; Coords[4] = Parallel[0]; }

---

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

• Kernel/noderect.h (r1785/r751)
• Kernel/noderect.cpp (r1785/r1315)

---