OpSliceTranslate Class Reference

This is the Slice tool's Translate operation, which is similar in behaviour to OpTranslateTrans, except that we inform the user during the drag if the current selection's bounds overlap those of an unselected named set (button). When doing an immediate transform the params to DoWithParams() are :- Param1 - All the standard transform data Param2 - A pointer to a DocCoord that holds to offset translate by. More...

#include <slicetool.h>

Inheritance diagram for OpSliceTranslate:

List of all members.

Public Member Functions
	OpSliceTranslate ()
	Constructor.
virtual BOOL	ShouldPointerBeOffset ()
	Tells the base class of the operation that we want our mouse coords to be left alone.
virtual void	DragStarted (TransformData *, DragTool *, TransformBoundingData *, DocCoord, Spread *, ClickModifiers, DocCoord ClickOffset=DocCoord(0, 0), Node *NodeToTrans=NULL, DragType dragtype=DRAGTYPE_AUTOSCROLL)
	When we start a drag, we want to compile a list of bounding boxes which belong to non-selected named sets, eg if there is a group of objects called 'Button One' and it is not selected, we want to add its overall bounding box to a list, so we can collision detect against it later.
virtual void	DragFinished (DocCoord, ClickModifiers, Spread *, BOOL, BOOL bSolidDrag)
	Called when the selection-drag finishes, either normally or having been cancelled by the user. Performs tidy-up when the drag is over.
Static Public Member Functions
static BOOL	Declare ()
	Adds the operation to the list of all known operations.
Protected Member Functions
void	CompileCollisionBoxList ()
	Make a list of the overall bounding rects of all named sets which have no members selected. These are used to collision detect against during the drag.
BOOL	TestBoundingBoxCollision (DocRect *pTestRect, Spread *pSpread)
	Test the given bounding rect against the list of bounding rects, m_lBoxes, and return TRUE if it overlaps any of them.
BOOL	SnapRectToBoxList (Spread *pSpread, DocRect *pDocRect, const DocCoord &PrevCoord, const DocCoord &CurCoord)
Protected Attributes
List	m_lBoxes
BOOL	m_bDrawingBlobs
DocRect	m_DragRect
Private Member Functions
	CC_DECLARE_DYNCREATE (OpSliceTranslate)
virtual void	InitTransformImmediate (OpParam *)
	Sets up the transform ready for an immediate translation. This is called from DoWithParam().
virtual void	InitTransformOnDrag (DocCoord, ClickModifiers)
	Sets up the parameters needed to build the transform matrix at the start of the drag. The base class version of this function does nothing.
virtual void	UpdateTransformOnDrag (DocCoord, Spread *, ClickModifiers &)
	Updates the op's state variables (eg selection bounding rect) and its blobs whenever the mouse moves.
virtual void	BuildMatrix ()
	Builds the transform matrix required to rotate the selection about the point CentreOfRot by the required number of degrees.
virtual void	ConstrainDrag (DocCoord *)
	Will constrain the mouse position to lie along rays from the centre of rotation at the constrain angle apart (45 degrees by default).
virtual BOOL	CanChangeSpread ()
	Tell the baseclass functions whether to draw drag feedback only on the start spread or to allow drag rendering to be done on other spreads too.
Private Attributes
DocCoord	LastPos
DocCoord	OriginalGridOffset

---

Detailed Description

This is the Slice tool's Translate operation, which is similar in behaviour to OpTranslateTrans, except that we inform the user during the drag if the current selection's bounds overlap those of an unselected named set (button). When doing an immediate transform the params to DoWithParams() are :- Param1 - All the standard transform data Param2 - A pointer to a DocCoord that holds to offset translate by.

Author:

Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code.

Date:

13/10/1999

Definition at line 498 of file slicetool.h.

---

Constructor & Destructor Documentation

OpSliceTranslate::OpSliceTranslate (   )

Constructor. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Definition at line 3508 of file slicetool.cpp. : TransOperation() { //Set status line help StatusHelpID = _R(IDS_TRANSLTRANS_STATUS1); StatusHelpID2 = _R(IDS_TRANSLTRANS_STATUS2); CanScaleLines = FALSE; }

---

Member Function Documentation

void OpSliceTranslate::BuildMatrix (   )  [private, virtual]

Builds the transform matrix required to rotate the selection about the point CentreOfRot by the required number of degrees. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Reimplemented from TransOperation. Definition at line 3778 of file slicetool.cpp. { // Build a translation matrix by takeing the offset from the last mouse position // to the start mouse position Transform = Matrix(LastPos.x-GetStartPos().x, LastPos.y-GetStartPos().y); }

BOOL OpSliceTranslate::CanChangeSpread (   )  [private, virtual]

Tell the baseclass functions whether to draw drag feedback only on the start spread or to allow drag rendering to be done on other spreads too. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 05/June/2006 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if this transform allows the drag to be transferred to another spread Reimplemented from TransOperation. Definition at line 3717 of file slicetool.cpp. { return TRUE; }

OpSliceTranslate::CC_DECLARE_DYNCREATE (  OpSliceTranslate   )  [private]

void OpSliceTranslate::CompileCollisionBoxList (   )  [protected]

Make a list of the overall bounding rects of all named sets which have no members selected. These are used to collision detect against during the drag. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/1999 Parameters: [INPUTS]  Fills  OpSliceTranslate::m_lBoxes with the required [OUTPUTS] list of collision-test bounding boxes. Returns: Errors: See also: Definition at line 3865 of file slicetool.cpp. { // iterate through the current list of named sets. if a named set // has no objects selected, then add its collective bounding rect // to the list of bounding rects, for collision detection. NameGallery * pNameGallery = NameGallery::Instance(); //pNameGallery->ForceUpdate(); SGUsedNames* pNames = pNameGallery ? pNameGallery->GetUsedNames() : NULL; SGNameItem* pItem = pNames ? (SGNameItem*) pNames->GetChild() : NULL; m_lBoxes.DeleteAll(); while (pItem != NULL) { if (pItem->IsNoneSelected()) m_lBoxes.AddTail(new RectListItem(pItem->GetSetBounds())); // get next name. pItem = (SGNameItem*)pItem->GetNext(); } }

void OpSliceTranslate::ConstrainDrag (  DocCoord *  PointerPos  )  [private, virtual]

Will constrain the mouse position to lie along rays from the centre of rotation at the constrain angle apart (45 degrees by default). Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Parameters: PointerPos  - The current position of the mouse that needs to be constrained [INPUTS] PointerPos  - The position of the mouse after it has been constrained [OUTPUTS] Reimplemented from TransOperation. Definition at line 3820 of file slicetool.cpp. { // Lock the mouse to move along the axis or diagonally DocCoord Blobby = GetStartPos(); DocView::ConstrainToAngle(Blobby, PointerPos); }

BOOL OpSliceTranslate::Declare (   )  [static]

Adds the operation to the list of all known operations. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Returns: TRUE if all went OK, False otherwise Reimplemented from TransOperation. Definition at line 3840 of file slicetool.cpp. { return (RegisterOpDescriptor(0, _R(IDS_SLICE_MOVE), CC_RUNTIME_CLASS(OpSliceTranslate), OPTOKEN_SLICE_TRANSLATE, TransOperation::GetState)); }

void OpSliceTranslate::DragFinished (  DocCoord  dcPos, ClickModifiers  ClickMods, Spread *  pSpread, BOOL  bSuccess, BOOL  bSolidDrag )  [virtual]

Called when the selection-drag finishes, either normally or having been cancelled by the user. Performs tidy-up when the drag is over. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com> Date: 15/10/1999 Parameters: dcPos  [INPUTS] ClickMods pSpread bSuccess [OUTPUTS]  Returns: This function calls the base-class for its main functionality. Returns: Errors: See also: Reimplemented from TransOperation. Definition at line 4006 of file slicetool.cpp. { // have we finished drawing blobs, or do we need to erase them? if (m_bDrawingBlobs) { RenderDragBlobs(m_DragRect, StartSpread, bSolidDrag); // erase them. TransOperation::RenderDragBlobs(m_DragRect, StartSpread, bSolidDrag); } m_lBoxes.DeleteAll(); TransOperation::DragFinished(dcPos, ClickMods, pSpread, bSuccess, bSolidDrag); }

void OpSliceTranslate::DragStarted (  TransformData *  TransData, DragTool *  pTool, TransformBoundingData *  pBounds, DocCoord  ClickPos, Spread *  pSpread, ClickModifiers  ClickMods, DocCoord  ClickOffset = DocCoord(0, 0), Node *  NodeToTransform = NULL, DragType  dragtype = DRAGTYPE_AUTOSCROLL )  [virtual]

When we start a drag, we want to compile a list of bounding boxes which belong to non-selected named sets, eg if there is a group of objects called 'Button One' and it is not selected, we want to add its overall bounding box to a list, so we can collision detect against it later. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com> Date: 14/10/1999 Parameters: see  TransOperation::DragStarted [INPUTS] Once that's done we call the base class, to start the drag. Returns: Errors: See also: Definition at line 3962 of file slicetool.cpp. { // compile a list of any names which are *not* used by the current selection, // and use this to compile a list of bounding boxes which we can collision-test // against during the drag, to announce if we cross any other named sets. CompileCollisionBoxList(); m_bDrawingBlobs = FALSE; // call the base-class drag-start routine. TransOperation::DragStarted(TransData, pTool, pBounds, ClickPos, pSpread, ClickMods, ClickOffset, NodeToTransform, dragtype); }

void OpSliceTranslate::InitTransformImmediate (  OpParam *  pOpParam  )  [private, virtual]

Sets up the transform ready for an immediate translation. This is called from DoWithParam(). Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Parameters: pOpParam  - The parameters that were passed into the operation [INPUTS] See also: TransOperation::DoWithParam() Reimplemented from TransOperation. Definition at line 3532 of file slicetool.cpp. { // Set the initial position StartPos = DocCoord(0,0); RawStartPos = StartPos; MagStartPos = StartPos; // and copy the offset to translate by from Param2 DocCoord* Offset = (DocCoord*)(pOpParam->Param2); LastPos.x = Offset->x; LastPos.y = Offset->y; OriginalGridOffset.x=0; OriginalGridOffset.y=0; }

void OpSliceTranslate::InitTransformOnDrag (  DocCoord  PointerPos, ClickModifiers  ClickMods )  [private, virtual]

Sets up the parameters needed to build the transform matrix at the start of the drag. The base class version of this function does nothing. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Parameters: PointerPos  - The position of the mouse at the start of the drag [INPUTS] ClickMods - the keyboard modifiers that were active at the start of the drag Reimplemented from TransOperation. Definition at line 3562 of file slicetool.cpp. { // make a note of the current mouse position LastPos = PointerPos; // Record the offset from the mouse pos to the grid OriginalGridOffset = GetStartPos(); DocView::ForceSnapToGrid(StartSpread, &OriginalGridOffset); OriginalGridOffset = GetStartPos() - OriginalGridOffset; }

BOOL OpSliceTranslate::ShouldPointerBeOffset (   )  [virtual]

Tells the base class of the operation that we want our mouse coords to be left alone. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Returns: FALSE Reimplemented from TransOperation. Definition at line 3799 of file slicetool.cpp. { return FALSE; }

BOOL OpSliceTranslate::SnapRectToBoxList (  Spread *  pSpread, DocRect *  pDocRect, const DocCoord &  PrevCoord, const DocCoord &  CurCoord )  [protected]

This function does not live with all the other snap functions because it's use is restricted solely to the context of this operation. Returns: Errors: See also: All Snap member functions of all classes derived from NodeRenderableBounded. Definition at line 3749 of file slicetool.cpp. { // iterate over our list of rectangles and check pDocRect against each one. BOOL bSnapped = FALSE; RectListItem* pCurListItem = (RectListItem*)m_lBoxes.GetHead(); while (!bSnapped && pCurListItem != NULL) { bSnapped = CSnap::SnapRectToRect(pDocRect, pCurListItem->GetRect()); pCurListItem = (RectListItem*)m_lBoxes.GetNext(pCurListItem); } return bSnapped; }

BOOL OpSliceTranslate::TestBoundingBoxCollision (  DocRect *  pTestRect, Spread *  pSpread )  [protected]

Test the given bounding rect against the list of bounding rects, m_lBoxes, and return TRUE if it overlaps any of them. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/1999 Parameters: pTestRect  the rectangle to test against each member of m_lBoxes. [INPUTS] pSpread a pointer to the current spread, so that we can render the collided rectangle(s?) if necessary. [OUTPUTS]  Returns: TRUE if a collision is detected, FALSE otherwise. TODO: we may want to change this to a void function. Additional: Karim MacDonald 07/02/2000 This function now always returns FALSE, to prevent visual artifacts when dragging with the slice-tool, a result of the re-introduction of a dashed line around the selection during a drag. Returns: Errors: ERROR2 if any parameter is NULL. See also: Definition at line 3914 of file slicetool.cpp. { ERROR2IF(pTestRect == NULL || pSpread == NULL, FALSE, "OpSliceTranslate::TestBoundingBoxCollision- called with a NULL parameter"); // iterate over the list, checking each rect against pTestRect. RectListItem* pListItem = (RectListItem*)m_lBoxes.GetHead(); BOOL bCollision = FALSE; while (!bCollision && pListItem != NULL) { bCollision = pTestRect->IsIntersectedWith(pListItem->GetRect()); // get the next object in the list. if (!bCollision) pListItem = (RectListItem*)m_lBoxes.GetNext(pListItem); } // return bCollision; return FALSE; }

void OpSliceTranslate::UpdateTransformOnDrag (  DocCoord  PointerPos, Spread *  pSpread, ClickModifiers &  ClickMods )  [private, virtual]

Updates the op's state variables (eg selection bounding rect) and its blobs whenever the mouse moves. Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>, from Rik's OpTranslateTrans code. Date: 13/10/1999 Parameters: PointerPos  - The latest position of the mouse [INPUTS] Reimplemented from TransOperation. Definition at line 3589 of file slicetool.cpp. { // get the bounding box of the dragged selection and update it's position. DocCoord Offset = PointerPos - LastPos; DocRect Bounds( BoundingData.x, BoundingData.y, BoundingData.x+BoundingData.Width, BoundingData.y+BoundingData.Height ); Bounds.lo = Bounds.lo + Offset; Bounds.hi = Bounds.hi + Offset; DocRect SnappedBounds = Bounds; // if this drag is not being constrained, then see if we can snap to anything. if (!ClickMods.Constrain) { // Apply snapping to the pointer pos // First apply magnetic snapping alone if (MagneticGripPoint && DocView::SnapSelected(pSpread, &PointerPos, TRUE, FALSE)) { // Magnetic snapping worked! } else { // Magnetic snapping failed! // If magnetic snapping failed then try grid snapping // on the adjusted coordinate if (ClickMods.Alternative1) { PointerPos = PointerPos - OriginalGridOffset; DocView::SnapSelected(pSpread, &PointerPos, FALSE, TRUE); PointerPos = PointerPos + OriginalGridOffset; } // ok, try snapping the selection's bounds to anything in the document, // eg guidelines, other objects etc. else { if (DocView::SnapSelected(pSpread,&SnappedBounds,LastRawPos,RawPos)) PointerPos = PointerPos + (SnappedBounds.lo - Bounds.lo); // right, nothing else has worked - how about trying to snap our bounding // rect to one of the bounding rects in our list? else { if (SnapRectToBoxList(pSpread, &SnappedBounds, LastRawPos, RawPos)) PointerPos = PointerPos + (SnappedBounds.lo - Bounds.lo); } } } } // Update BoundingData's offset information and pass it to Bounds. INT32 dx = PointerPos.x - LastPos.x; INT32 dy = PointerPos.y - LastPos.y; BoundingData.x += dx; BoundingData.y += dy; BoundingData.XYChanged = TRUE; Bounds.lox = BoundingData.x; Bounds.loy = BoundingData.y; Bounds.hix = BoundingData.x + BoundingData.Width; Bounds.hiy = BoundingData.y + BoundingData.Height; // do a collision-detection between the selection bounding rect and a list // of named-set bounding rect's we built at the start of the drag. // highlight our selection bounding rect if we collide. if (TestBoundingBoxCollision(&Bounds, pSpread)) { // new collision? if so, draw fresh blobs. if (!m_bDrawingBlobs) { m_DragRect = Bounds; m_bDrawingBlobs = TRUE; RenderDragBlobs(m_DragRect, StartSpread, FALSE); } // otherwise, update the current blobs. else { // rub out old collision blobs. RenderDragBlobs(m_DragRect, StartSpread, FALSE); // update the record of the selection bounds. m_DragRect = Bounds; // draw new collision blobs. RenderDragBlobs(m_DragRect, StartSpread, FALSE); } } // we're not presently colliding, so if we have to then // rub out any old blobs and invalidate the drag-rect. else { if (m_bDrawingBlobs) { // don't render the blobs from here anymore, and render them off. m_bDrawingBlobs = FALSE; RenderDragBlobs(m_DragRect, StartSpread, FALSE); // invalidate the drag-rect, so that it won't be rendered from RenderDragBlobs(). m_DragRect.hix = m_DragRect.lox - 1; } } // Make a mental note of the current position LastPos = PointerPos; // Update the current spread (must do this if CanChangeSpread returns TRUE) CurrentSpread = pSpread; }

---

Member Data Documentation

DocCoord OpSliceTranslate::LastPos [private]

Definition at line 564 of file slicetool.h.

BOOL OpSliceTranslate::m_bDrawingBlobs [protected]

Definition at line 560 of file slicetool.h.

DocRect OpSliceTranslate::m_DragRect [protected]

Definition at line 561 of file slicetool.h.

List OpSliceTranslate::m_lBoxes [protected]

Definition at line 556 of file slicetool.h.

DocCoord OpSliceTranslate::OriginalGridOffset [private]

Definition at line 565 of file slicetool.h.

---

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

• tools/slicetool.h (r1785/r1282)
• tools/slicetool.cpp (r1785/r1282)

---