blndtool.cpp

Go to the documentation of this file.

// $Id: blndtool.cpp 1401 2006-07-03 11:17:52Z alex $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */
// Implementation of the blend tool

/*
*/

#include "camtypes.h"
//#include "oilfiles.h"
//#include "docview.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "selop.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "csrstack.h"
//#include "markn.h"
//#include "spread.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "nodepath.h"
#include "progress.h"
#include "nodeblnd.h"
#include "nodebldr.h"
//#include "simon.h"
#include "blobs.h"
//#include "blndres.h"
//#include "bevres.h"
#include "objchge.h"
//#include "resource.h"
//#include "will.h"
#include "filltool.h"
#include "bubbleid.h"
//#include "becomea.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "attrmap.h"
#include "ndbldpth.h"
#include "pathedit.h"
#include "keypress.h"
#include "vkextra.h"

#include "blndtool.h"
//#include "ezmodule.h"
#include "opbevel.h"

//#include "will2.h"
#include "biasgdgt.h"
#include "opcntr.h"
//#include "cntrtool.h"
#include "shapeops.h"
#include "biasdlg.h"

//#include "will.h"


// for bevels & shadows
#include "nbevcont.h"
#include "nodecont.h"

#include "nodecntr.h"
#include "ncntrcnt.h"
#include "opbevel.h"
#include "layer.h"
#include "ophist.h"

DECLARE_SOURCE( "$Revision: 1401 $" );
                                                
CC_IMPLEMENT_MEMDUMP(BlendTool,Tool_v1)
CC_IMPLEMENT_DYNCREATE(BlendInfoBarOp,InformationBarOp)
CC_IMPLEMENT_MEMDUMP(BlendToolRef,CC_CLASS_MEMDUMP)
CC_IMPLEMENT_DYNCREATE(OpBlendNodes,SelOperation)
CC_IMPLEMENT_DYNCREATE(OpRemoveBlend,SelOperation)
CC_IMPLEMENT_DYNCREATE(OpAddBlendPath,SelOperation)
CC_IMPLEMENT_DYNCREATE(OpDetachBlendPath,SelOperation)
CC_IMPLEMENT_DYNCREATE(OpChangeBlend,SelOperation)
CC_IMPLEMENT_DYNCREATE(OpBlendOneToOne,OpChangeBlend)
CC_IMPLEMENT_DYNCREATE(OpBlendAntialias,OpChangeBlend)
CC_IMPLEMENT_DYNCREATE(OpBlendTangential,OpChangeBlend)
CC_IMPLEMENT_DYNCREATE(OpChangeBlendSteps,SelOperation)
CC_IMPLEMENT_DYNCREATE(ChangeBlendAction,Action)
CC_IMPLEMENT_DYNCREATE(ChangeBlenderAction,Action)
CC_IMPLEMENT_DYNCREATE(ChangeBlendStepsAction,Action)
CC_IMPLEMENT_DYNCREATE(RemapBlendAction,Action)
CC_IMPLEMENT_DYNCREATE(InitBlendersAction,Action)
CC_IMPLEMENT_MEMDUMP(ChangeBlendOpParam,OpParam)
CC_IMPLEMENT_MEMDUMP(ChangeBlenderOpParam,OpParam)
CC_IMPLEMENT_DYNCREATE(InvalidateBoundsAction,Action)
CC_IMPLEMENT_DYNCREATE(OpChangeBlendDistance, SelOperation)
CC_IMPLEMENT_DYNCREATE(OpEditBlendEndObject, SelOperation)
CC_IMPLEMENT_MEMDUMP(BlenderInfoItem,ListItem);



// Must come after the last CC_IMPLEMENT.. macro
#define new CAM_DEBUG_NEW     

// These are still char* while we wait for resource technology to be developed for modules
TCHAR* BlendTool::FamilyName    = _T("Blend Tools");
TCHAR* BlendTool::ToolName      = _T("Blend Tool");
TCHAR* BlendTool::Purpose       = _T("Blend manipulation");
TCHAR* BlendTool::Author        = _T("Mark Neves");

// Init those other useful static vars
BlendInfoBarOp* BlendTool::pBlendInfoBarOp          = NULL;
BlendToolRef*   BlendTool::pRefStart                = NULL;
BlendToolRef*   BlendTool::pRefEnd                  = NULL;
Cursor*         BlendTool::pcNormalCursor           = NULL;
Cursor*         BlendTool::pcBlendableCursor        = NULL;
Cursor*         BlendTool::pcBlendableBlobCursor    = NULL;
Cursor*         BlendTool::pcBlendableRemapCursor   = NULL;
Cursor*         BlendTool::pcCurrentCursor          = NULL;
INT32           BlendTool::CurrentCursorID          = 0;
UINT32          BlendTool::StatusID                 = _R(IDS_BLENDSTATUS_FINDSTART);

//#define Swap(a,b)       { (a)^=(b), (b)^=(a), (a)^=(b); }

#define SWAP(type,a,b) { type x=a; a=b; b=x; }

/********************************************************************************************

>   BlendTool::BlendTool()

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Purpose:    Default Constructor.
                Other initialisation is done in BlendTool::Init which is called by the Tool Manager
    SeeAlso:    BlendTool::Init

********************************************************************************************/

BlendTool::BlendTool()
{
    pcCurrentCursor = NULL;
}

/********************************************************************************************

>   BlendTool::~BlendTool()

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Purpose:    Destructor.

********************************************************************************************/

BlendTool::~BlendTool()
{
    if (pRefStart != NULL)
    {
        delete pRefStart;
        pRefStart = NULL;
    }

    if (pRefEnd != NULL)
    {
        delete pRefEnd;
        pRefEnd = NULL;
    }
}


/********************************************************************************************

>   BOOL BlendTool::Init( INT32 Pass )

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Returns:    FALSE if it does not want to be created, TRUE otherwise
    Purpose:    Used to check if the Tool was properly constructed
    SeeAlso:    BlendTool::BlendTool

********************************************************************************************/

BOOL BlendTool::Init()
{
    // Declare all your ops here and only succeed if all declarations succeed

    BOOL ok = ( OpBlendNodes::Declare()         && 
                OpRemoveBlend::Declare()        && 
                OpAddBlendPath::Declare()       && 
                OpDetachBlendPath::Declare()    && 
                OpChangeBlend::Declare()        && 
                OpBlendOneToOne::Declare()      &&
                OpBlendAntialias::Declare()     &&
                OpChangeBlendSteps::Declare());

    if (!ok) return FALSE;

    // We need two BlendToolRef objects
    BlendTool::pRefStart = new BlendToolRef;
    BlendTool::pRefEnd   = new BlendToolRef;

    ok = (BlendTool::pRefStart != NULL && BlendTool::pRefEnd != NULL);

    // This section reads in the infobar definition and creates an instance of
    // BlendInfoBarOp.  Also pBlendInfoBarOp, the ptr to the tool's infobar, is set up
    // after the infobar is successfully read and created.
    if (ok)
    {
        pBlendInfoBarOp = new BlendInfoBarOp();
        ok = (pBlendInfoBarOp != NULL);
#if 0
        CCResTextFile       file;               // Resource File
        BlendInfoBarOpCreate BarCreate;         // Object that creates BlendInfoBarOp objects

                ok = file.open(_R(IDM_BLEND_BAR), _R(IDT_INFO_BAR_RES));        // Open resource
        if (ok) ok = DialogBarOp::ReadBarsFromFile(file,BarCreate); // Read and create info bar
        if (ok) file.close();                                       // Close resource

        ENSURE(ok,"Unable to load blendbar.ini from resource\n"); 

        if (ok)
        {
            // Info bar now exists.  Now get a pointer to it
            String_32 str = String_32(_R(IDS_BLNDTOOL_INFOBARNAME));
            DialogBarOp* pDialogBarOp = DialogBarOp::FindDialogBarOp(str);

                    ok = (pDialogBarOp != NULL);
            if (ok) ok = pDialogBarOp->IsKindOf(CC_RUNTIME_CLASS(BlendInfoBarOp));
            if (ok) pBlendInfoBarOp = (BlendInfoBarOp*)pDialogBarOp;

            ENSURE(ok,"Error finding the blend tool info bar");
        }
#endif
    }

    return (ok);
}


/********************************************************************************************

>   void BlendTool::Describe(void *InfoPtr)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Inputs:     InfoPtr -   A pointer to a tool info block. It is passed cast to void* as
                            the version of the tool is unknown at this point. Later versions 
                            of the Tool class may have more items in this block, that this 
                            tool will not use
    Outputs:    InfoPtr -   The structure pointed to by InfoPtr will have had all the info
                            that this version of the Tool knows about
    Purpose:    Allows the tool manager to extract information about the tool

********************************************************************************************/

void BlendTool::Describe(void *InfoPtr)
{
    // Cast structure into the latest one we understand.
    ToolInfo_v1 *Info = (ToolInfo_v1 *) InfoPtr;

    Info->InfoVersion = 1;
    
    Info->InterfaceVersion = GetToolInterfaceVersion();  // You should always have this line.
        
    // These are all arbitrary at present.
    Info->Version = 1;
    Info->ID      = GetID();
    Info->TextID  = _R(IDS_BLEND_TOOL);

    Info->Family  = FamilyName;
    Info->Name    = ToolName;
    Info->Purpose = Purpose;
    Info->Author  = Author;

    Info->BubbleID = _R(IDBBL_BLEND_TOOLBOX);
}

/********************************************************************************************

>   virtual void BlendTool::SelectChange(BOOL isSelected)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Inputs:     isSelected  - TRUE  = tool has been selected
                            - FALSE = tool has been deselected
    Outputs:    -
    Returns:    -
    Purpose:    Starts up and closes down the blend tool
    Errors:     Debug warning if creating the cursor fails.
    SeeAlso:    -

********************************************************************************************/

void BlendTool::SelectChange(BOOL isSelected)
{
    if (isSelected)
    {
        if (!CreateCursors()) return;
        CurrentCursorID = CursorStack::GPush(pcNormalCursor, FALSE);        // Push cursor but don't display now
        pcCurrentCursor = pcNormalCursor;

        // Create and display the tool's info bar
        pBlendInfoBarOp->Create();
        m_EditEndObject = FALSE;
        // Which blobs do I want displayed
        BlobManager* BlobMgr = GetApplication()->GetBlobManager();
        if (BlobMgr != NULL)
        {
            // Decide which blobs we will display
            BlobStyle MyBlobs;
            
            MyBlobs.Object = TRUE;
            MyBlobs.Tiny = FALSE;

            BlobMgr->ToolInterest(MyBlobs);
        }

        Document* pDoc = Document::GetCurrent();
        if (pDoc != NULL)
            BlobMgr->RenderToolBlobsOn(this, pDoc->GetSelectedSpread(),NULL);
    }
    else
    {
        // Deselection - destroy the tool's cursors, if they exist.
        if (pcCurrentCursor != NULL)
        {
            CursorStack::GPop(CurrentCursorID);
            pcCurrentCursor = NULL;
            CurrentCursorID = 0;
        }
        DestroyCursors();

        // we need to close down any profile dialogs that are currently open ....
        pBlendInfoBarOp->CloseProfileDialog (pBlendInfoBarOp->m_BiasGainGadgetPosition);
        pBlendInfoBarOp->CloseProfileDialog (pBlendInfoBarOp->m_BiasGainGadgetAttribute);
        
        // BEFORE we do the next call !!!! Cause otherwise pBlendInfoBarOp will
        // have been "deleted", and the above will access violate!

        // ensure any tool object blobs are removed.
        BlobManager* BlobMgr = GetApplication()->GetBlobManager();
        if (BlobMgr != NULL)
        {
            BlobStyle bsRemoves;
            bsRemoves.ToolObject = TRUE;
            BlobMgr->RemoveInterest(bsRemoves);
        }

        // Remove the info bar from view by deleting the actual underlying window
        pBlendInfoBarOp->Delete();

        Document* pDoc = Document::GetCurrent();
        if (pDoc != NULL)
            BlobMgr->RenderToolBlobsOff(this, pDoc->GetSelectedSpread(),NULL);
    }
}

/********************************************************************************************

>   BOOL BlendTool::CreateCursors()

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Inputs:     -
    Outputs:    -
    Returns:    TRUE if all the blend tool cursors have been successfully created
    Purpose:    Creates all the blend tool cursors
    SeeAlso:    -

********************************************************************************************/

BOOL BlendTool::CreateCursors()
{
    // This tool has just been selected.  Create the cursors.
    pcNormalCursor          = new Cursor(this, _R(IDC_BLENDNORMALCURSOR));
    pcBlendableCursor       = new Cursor(this, _R(IDC_BLENDABLECURSOR));
    pcBlendableBlobCursor   = new Cursor(this, _R(IDC_BLENDABLEBLOBCURSOR));
    pcBlendableRemapCursor  = new Cursor(this, _R(IDC_BLENDABLEREMAPCURSOR));

    if ( pcNormalCursor         ==NULL || !pcNormalCursor->IsValid()            ||
         pcBlendableCursor      ==NULL || !pcBlendableCursor->IsValid()         ||
         pcBlendableBlobCursor  ==NULL || !pcBlendableBlobCursor->IsValid()     ||
         pcBlendableRemapCursor ==NULL || !pcBlendableRemapCursor->IsValid()
       )
    {
        DestroyCursors();
        return FALSE;
    }
    else
        return TRUE;
}

/********************************************************************************************

>   void BlendTool::DestroyCursors()

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Destroys all the blend tool cursors
    SeeAlso:    -

********************************************************************************************/

void BlendTool::DestroyCursors()
{
    if (pcNormalCursor          != NULL) delete pcNormalCursor;
    if (pcBlendableCursor       != NULL) delete pcBlendableCursor;
    if (pcBlendableBlobCursor   != NULL) delete pcBlendableBlobCursor;
    if (pcBlendableRemapCursor  != NULL) delete pcBlendableRemapCursor;
}

/********************************************************************************************

>   BOOL BlendTool::OnKeyPress(KeyPress* pKeyPress)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    1/6/99
    Inputs:     pKeyPress - pointer to a keypress object
    Returns:    TRUE if it handled the keypress, FALSE otherwise
    Purpose:    To handle keypress events for the Blend Tool.

********************************************************************************************/

BOOL BlendTool::OnKeyPress(KeyPress* pKeyPress)
{
#if defined(_DEBUG) && 0
    if (pKeyPress == NULL)
        return FALSE;

    if (pKeyPress->IsRepeat())
        return FALSE;

    if (pKeyPress->IsRelease())
        return FALSE;

    AFp BiasDelta = 0.0;
    AFp GainDelta = 0.0;
    BOOL Reset = FALSE;
    if (*pKeyPress == KeyPress(CAMKEY(Z)))  { BiasDelta = -0.1; TRACEUSER( "Markn", _T("Decrease Bias by 0.1\n"));}
    if (*pKeyPress == KeyPress(CAMKEY(X)))  { BiasDelta =  0.1; TRACEUSER( "Markn", _T("Increase Bias by 0.1\n"));}
    if (*pKeyPress == KeyPress(CAMKEY(N)))  { GainDelta = -0.1; TRACEUSER( "Markn", _T("Decrease Gain by 0.1\n"));}
    if (*pKeyPress == KeyPress(CAMKEY(M)))  { GainDelta =  0.1; TRACEUSER( "Markn", _T("Increase Gain by 0.1\n"));}

    if (*pKeyPress == KeyPress(CAMKEY(R)))  { Reset = TRUE;     TRACEUSER( "Markn", _T("Resetting Bias and Gain\n"));}

    SelRange* pSelRange = GetApplication()->FindSelection();
    Node* pNode = pSelRange->FindFirst();
    while (pNode)
    {
        if (IS_A(pNode,NodeBlend))
        {
            NodeBlend* pNodeBlend = (NodeBlend*)pNode;

            // This alters the Attribute profile, but can easily be modified to alter the Object profile if necessary
            CProfileBiasGain* pProfile = pNodeBlend->GetAttrProfile();
            if (pProfile)
            {
                AFp Bias = pProfile->GetBias() + BiasDelta;
                AFp Gain = pProfile->GetGain() + GainDelta;
                if (Reset)
                    Bias = Gain = 0.0;

                if (Bias < -0.9)    Bias = -0.9;
                if (Bias >  0.9)    Bias =  0.9;
                if (Gain < -0.9)    Gain = -0.9;
                if (Gain >  0.9)    Gain =  0.9;

                pProfile->SetBiasGain(Bias,Gain);
            }
        }
        // Now find the next selected node
        pNode = pSelRange->FindNext(pNode);
    }
#endif // _DEBUG

    return FALSE;
}

/********************************************************************************************

>   void BlendTool::OnClick( DocCoord PointerPos, ClickType Click, ClickModifiers ClickMods,
                        Spread* pSpread )

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Inputs:     PointerPos  -   The DocCoord of the point where the mouse button was clicked
                Click       -   Describes the type of click that was detected. 
                ClickMods   -   Indicates which buttons caused the click and which modifers were
                                pressed at the same time
                pSpread     -   The spread in which the click happened
    Returns:    -
    Purpose:    To handle a Mouse Click event for the Blend Tool.  If the click is over the 
                central blob of a blend on a path then start a EditEnd operation, otherwise
                start a createblend operation.
    SeeAlso:    Tool::MouseClick; ClickType; ClickModifiers

********************************************************************************************/

void BlendTool::OnClick( DocCoord PointerPos, ClickType Click, ClickModifiers ClickMods,
                        Spread* pSpread )
{
    if (ClickMods.Menu) return;                         // Don't do anything if the user clicked the Menu button

    ERROR3IF_PF(pSpread==NULL,("pSpread is NULL"));

    if (Click == CLICKTYPE_DRAG)
    {
        // are we over the middle blob of a blend on a curve?
        BOOL MoveEndObject = EditBlendEnd(pSpread, PointerPos);

        // Diccon  9/99, do we wish to create a blend or move an object?
        if (!MoveEndObject)  // create a blend
        {
            UpdateRef(pRefStart,pSpread,PointerPos);
            UpdateRef(pRefEnd  ,pSpread,PointerPos);
            CheckNodeRemapping(pRefStart,pRefEnd);
            UpdateCursorAndStatus();

            if (pRefStart->pNode != NULL)
            {
                // Start a drag
                OpBlendNodes* pOpBlendNodes = new OpBlendNodes;
                if (pOpBlendNodes != NULL)
                {
                    // Start the drag operation and pass in the Anchor Point to the push operation
                    if  (!pOpBlendNodes->DoDrag(this))
                        delete pOpBlendNodes;
                }
            }
        }
        else  // drag end object
        {   
            OpEditBlendEndObject* pEditEnd = new OpEditBlendEndObject(this);

            if (pEditEnd != NULL)
            {
                StatusID = _R(IDS_BLENDSTATUS_MOVEEND);
                DisplayStatusBarHelp(StatusID);
                pEditEnd->DoDrag(PointerPos, pSpread);
            }
        }
    }
    
    // call the base class ....
    
    DragTool::OnClick (PointerPos, Click, ClickMods, pSpread);
}

/********************************************************************************************

>   void BlendTool::OnMouseMove( DocCoord PointerPos,Spread* pSpread, ClickModifiers ClickMods)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    3/10/94
    Inputs:     PointerPos  -   The DocCoord of the point where the mouse has moved to
                pSpread     -   The spread in which the move occurred
    Returns:    TRUE if it handled the Click, FALSE otherwise
    Purpose:    To handle a Mouse Move event for the Blend Tool.
    SeeAlso:    Tool::MouseClick; ClickType; ClickModifiers

********************************************************************************************/

void BlendTool::OnMouseMove(DocCoord PointerPos,Spread* pSpread,ClickModifiers ClickMods)
{
    ERROR3IF_PF(pSpread==NULL,("pSpread is NULL"));

    pRefEnd->Reset();
    UpdateRef(pRefStart,pSpread,PointerPos,FALSE);
    // Diccon added - check first to see if there is a hit on an edit end blob
    m_EditEndObject = EditBlendEndAndUpdateCursor(pSpread, PointerPos);
    // if not then check for new blend/remapping etc.
    if (m_EditEndObject == FALSE)
        UpdateCursorAndStatus();
}


/********************************************************************************************

>   BOOL BlendTool::EditBlendEndAndUpdateCursor(Spread* pSpread, DocCoord PointerPos)

    Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
    Created:    10/9/99
    Inputs:     PointerPos  -   The DocCoord of the point where the mouse has moved to
                pSpread     -   The spread in which the move occurred
    Returns:    TRUE if we can edit and end object, FALSE otherwise
    Purpose:    To determine whether or not the pointer is the central blob of an end object
                of a blend on a curve. If so then we change the cursor and set a flag that 
                allows us to begin an OpEditBlendEndobject if the user clicks and drags.
    SeeAlso:    OnMouseMove, OnClick

********************************************************************************************/

BOOL BlendTool::EditBlendEndAndUpdateCursor(Spread* pSpread, DocCoord PointerPos)
{
    Cursor* pcNewCursor = pcNormalCursor;

    List BlendList;
    // make a list of selected nodes
    BOOL ok = BevelTools::BuildListOfSelectedNodes(&BlendList, CC_RUNTIME_CLASS(NodeBlend), FALSE);
    if (ok)
    {
        ok = FALSE;
        NodeListItem* pListItem = (NodeListItem*)BlendList.GetHead();
        while (pListItem != NULL)
        {
            
            NodeBlend* pNodeBlend = (NodeBlend*)pListItem->pNode;
            Node* pNode = NULL;
            // check to see if there is a hit
            ok = pNodeBlend->HitOnEndDragBlob(PointerPos, &pNode);
            if (ok)
            {
                pcNewCursor = pcBlendableBlobCursor;
                StatusID = _R(IDS_BLENDSTATUS_EDITENDS);                        
                break;
            }
            pListItem = (NodeListItem*)BlendList.GetNext(pListItem);
        }
    }
    BlendList.DeleteAll();

    if (pcCurrentCursor != pcNewCursor)
    {
        // Current cursor has changed
        CursorStack::GSetTop(pcNewCursor, CurrentCursorID);
        pcCurrentCursor = pcNewCursor;
    }
    
    return ok;
}


/********************************************************************************************

>   BOOL BlendTool::EditBlendEnd(Spread* pSpread, DocCoord PointerPos)

    Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
    Created:    10/9/99
    Inputs:     PointerPos  -   The DocCoord of the point where the mouse has moved to
                pSpread     -   The spread in which the move occurred
    Returns:    TRUE if we can edit and end object, FALSE otherwise
    Purpose:    To determine whether or not the pointer is the central blob of an end object
                of a blend on a curve. If so then we change the cursor and set a flag that 
                allows us to begin an OpEditBlendEndobject if the user clicks and drags.
    SeeAlso:    OnMouseMove, OnClick

********************************************************************************************/

BOOL BlendTool::EditBlendEnd(Spread* pSpread, DocCoord PointerPos)
{
    List BlendList;
    // make a list of selected nodes
    BOOL ok = BevelTools::BuildListOfSelectedNodes(&BlendList, CC_RUNTIME_CLASS(NodeBlend), FALSE);
    if (ok)
    {
        ok = FALSE;
        NodeListItem* pListItem = (NodeListItem*)BlendList.GetHead();
        while (pListItem != NULL)
        {
            
            NodeBlend* pNodeBlend = (NodeBlend*)pListItem->pNode;
            Node* pNode = NULL;
            // check to see if there is a hit
            ok = pNodeBlend->HitOnEndDragBlob(PointerPos, &pNode);
            if (ok)
                break;
            pListItem = (NodeListItem*)BlendList.GetNext(pListItem);
        }
    }
    BlendList.DeleteAll();

    return ok;
}



/********************************************************************************************
>   void BlendTool::UpdateRef(  BlendToolRef* pRef,
                                Spread* pSpread, 
                                DocCoord PointerPos,
                                BOOL CheckNodeUnderPoint = TRUE)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    10/10/94
    Inputs:     pRef                = ptr to a reference struct to update
                pSpread             = ptr to spread click occurred
                PointerPos          = the DocCoord of the click
                CheckNodeUnderPoint = TRUE to revert to click-detection search for underlying node
    Outputs:    The members of pRef are updated.
    Returns:    -
    Purpose:    This will update the blend tool ref depending on the current pointer pos.
                If CheckNodeUnderPoint is TRUE, then the routine will revert to a click-detection search
                to find out which node lies under the given point.  This is potentially very time-consuming.
    Errors:     -
    SeeAlso:    -
********************************************************************************************/

void BlendTool::UpdateRef(BlendToolRef* pRef,Spread* pSpread, DocCoord PointerPos,BOOL CheckNodeUnderPoint)
{
    ERROR3IF_PF(pRef   ==NULL,("pRef is NULL"));
    ERROR3IF_PF(pSpread==NULL,("pSpread is NULL"));

    // Reset the reference
    pRef->Reset();

    // See if point is over a blob of a selected path
    // if IsPointOverPathBlob() fails, it inits pNode to NULL and Index to -1
    if (!IsPointOverPathBlob(&PointerPos,pRef))
    {
        // Reset the reference in case above call altered it
        pRef->Reset();

        // See if point is over a blob is a selected blend
        // if IsPointOverBlendBlob() fails, it inits pNode & pNodeBlend to NULL and Index to -1
        if (!IsPointOverBlendBlob(&PointerPos,pRef))
        {
            // Reset the reference in case above call altered it
            pRef->Reset();

            if (CheckNodeUnderPoint)
            {
                // See if we are over an object
                NodeRenderableInk* pNodeUnderPoint = FindObject(pSpread,PointerPos);

                if (pNodeUnderPoint != NULL)
                {
                    BecomeA TestBecomeA(BECOMEA_TEST, CC_RUNTIME_CLASS(NodePath));
                    // We are over an object. Can we blend it?
                    if (pNodeUnderPoint->CanBecomeA(&TestBecomeA))
                    {
                        // We are over a NodePath or a node that can become a NodePath
                        pRef->pNode = pNodeUnderPoint;
                    }
                }
            }
        }
    }

    // Set the spread and pointer pos members
    pRef->pSpread    = pSpread;
    pRef->PointerPos = PointerPos;
}

/********************************************************************************************
>   void BlendTool::UpdateCursorAndStatus()

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    10/10/94
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    This will update the cursor and status line text depending on the data in the 
                two blend tool references within BlendTool.

                Copes with the following scenarios:
                    Pointer over an object
                    Dragging to another object
                    Pointer over a selected path's blob
                    Dragging to another blob in a selected path
                    Pointer over a blend blob
                    Dragging to a corresponding blend blob for remapping

    Errors:     -
    SeeAlso:    -
********************************************************************************************/

void BlendTool::UpdateCursorAndStatus()
{
    ERROR3IF_PF(pRefStart==NULL,("pRefStart is NULL"));
    ERROR3IF_PF(pRefEnd  ==NULL,("pRefEnd   is NULL"));

    // Default to standard pointer and status line text
    Cursor* pcNewCursor = pcNormalCursor;
    StatusID = _R(IDS_BLENDSTATUS_FINDSTART);   // StatusID is a member var

    if (pRefStart->RemapRef > 0)
    {
        // The pointer is either over a blend blob, or user started a drag over a blend blob
        pcNewCursor = pcBlendableBlobCursor;
        StatusID = _R(IDS_BLENDSTATUS_REMAPSTART);

        if (pRefStart->RemapRef == pRefEnd->RemapRef && pRefStart->AStartNode != pRefEnd->AStartNode)
        {
            // Dragged to a corresponding blob in the other blend
            StatusID = _R(IDS_BLENDSTATUS_REMAPEND);
            pcNewCursor = pcBlendableRemapCursor;
        }
    }
    else if (pRefStart->pNode != NULL)
    {
        if (pRefEnd->pSpread == NULL)
        {
            if (pRefStart->Index >= 0)
            {
                // We are over a blob of a selected path
                pcNewCursor = pcBlendableBlobCursor;
                StatusID    = _R(IDS_BLENDSTATUS_OVERBLOB);
            }
            else
            {
                // We are over a blendable node
                pcNewCursor = pcBlendableCursor;
                StatusID    = _R(IDS_BLENDSTATUS_FINDEND);
            }
        }
        else if (pRefStart->pSpread == pRefEnd->pSpread)
        {
            // Dragging, and start and end are in the same spread
            if (pRefStart->pNode != pRefEnd->pNode && pRefEnd->pNode != NULL)
            {
                StatusID = _R(IDS_BLENDSTATUS_OVEREND);

                if (pRefEnd->Index >= 0 && pRefStart->Index >= 0)
                    // We are over a blob of a selected path, for both start & end objects
                    // so display the remap cursor
                    pcNewCursor = pcBlendableRemapCursor;
                else
                    // We are over a blendable node
                    pcNewCursor = pcBlendableCursor;
            }
            else
                StatusID = _R(IDS_BLENDSTATUS_FINDEND);
        }
    }

    if (pcCurrentCursor != pcNewCursor)
    {
        // Current cursor has changed
        CursorStack::GSetTop(pcNewCursor, CurrentCursorID);
        pcCurrentCursor = pcNewCursor;
    }

    // Always update the status bar text
    DisplayStatusBarHelp(StatusID);
}

/********************************************************************************************

>   virtual BOOL BlendTool::GetStatusLineText(  String_256* ptext, 
                                                Spread* pSpread,
                                                DocCoord DocPos, 
                                                ClickModifiers ClickMods)
    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    19/12/94
    Inputs:     pStr        - ptr to string to place text in
                pSpread     - ptr to the spread in question
                DocPos      - position of mouse in doc (in spread coords)
                ClickMods   - mouse click modifiers
    Outputs:    *pStr - text for status line
    Returns:    TRUE if outputting valid text
    Purpose:    generate up-to-date text for the status line (called on idles)

********************************************************************************************/

BOOL BlendTool::GetStatusLineText(String_256* pStr,Spread* pSpread,DocCoord DocPos,ClickModifiers ClickMods)
{
    *pStr = String_256(StatusID);
    return TRUE;
}


/********************************************************************************************

>   void BlendTool::UpdateInfobar()

    Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
    Created:    16/11/99
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Asks the infobar to update itself
    SeeAlso:    -

********************************************************************************************/

void BlendTool::UpdateInfobar()
{
    pBlendInfoBarOp->UpdateInfoBarState();
}




/********************************************************************************************

>   BOOL BlendTool::IsPointOverPathBlob(DocCoord* pPointerPos,BlendToolRef* pRef)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    10/10/94
    Inputs:     pPointerPos = ptr to position of mouse in DocCoords
                pRef        = ptr to blend tool ref to update
    Outputs:    Updates pRef->pNode and pRef->pIndex if a path blob was found.
                Also, if blob found, *pPointerPos is snapped to coord of blob
    Returns:    TRUE if the coord is over a blob of a selected path
    Purpose:    Scans for selected paths.  If the coord is over a selected path's blob,
                it returns TRUE and pRef->pNode points to the path, and pRef->Index contains
                the element index of the blob.
                Also, *pPointerPos is snapped to the coord of the centre of the blob, if found.

********************************************************************************************/

BOOL BlendTool::IsPointOverPathBlob(DocCoord* pPointerPos,BlendToolRef* pRef)
{
    if (pRef == NULL) return FALSE;

    // Find the selected range of objects
    SelRange* pSelRange = GetApplication()->FindSelection();
    Node* pNode = pSelRange->FindFirst();

    BOOL BlobFound = FALSE;

    // Scan the selection for NodePath objects
    while (!BlobFound && pNode != NULL && pNode->FindParent() != NULL)
    {
        // Only look at selected NodePaths that are NOT selected inside another node.
        if (IS_A(pNode,NodePath) && IS_A(pNode->FindParent(),Layer))
        {
            NodePath* pNodePath = (NodePath*)pNode;

            if (pNodePath->GetUnionBlobBoundingRect().ContainsCoord(*pPointerPos))
            {
                // Get a pointer to the Path object within the NodePath
                Path* pPath = &(pNodePath->InkPath);

                // Is it over a blob? (Only check end points. Forget about control points)
                BlobFound = pPath->FindNearestPoint(*pPointerPos,POINTFLAG_ENDPOINTS,&(pRef->Index));

                // If a blob is found, store ptr to the node
                if (BlobFound)
                {
                    pRef->pNode = pNodePath;
                    pPath->SetPathPosition(pRef->Index);
                    *pPointerPos = pPath->GetCoord();
                }
            }
        }

        // Now find the next selected node
        pNode = pSelRange->FindNext(pNode);
    }

    return BlobFound;
}

/********************************************************************************************

>   BOOL BlendTool::IsPointOverBlendBlob(DocCoord* pPointerPos,NodeRenderableInk** ppNodePath,INT32* pIndex)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    10/11/94
    Inputs:     pPointerPos = ptr to position of mouse in DocCoords
                pRef        = ptr to blend tool ref to update
    Outputs:    Updates pRef->pNode pRef->pNodeBlend and pRef->Index if a blend blob was found.
                Also, if found, *pPointerPos = centre of blob
    Returns:    TRUE if the coord is over a blob of a selected blend
    Purpose:    Scans for selected blends.  If the coord is over a selected blend's blob,
                it returns TRUE and pRef->pNode points to the path, pRef->pNodeBlend points to the blend
                containing the path, and *pIndex contains the element index of the blob.
                Also, if found, *pPointerPos = centre of blob.

********************************************************************************************/

BOOL BlendTool::IsPointOverBlendBlob(DocCoord* pPointerPos,BlendToolRef* pRef)
{
    if (pRef == NULL) return FALSE;

    // Find the selected range of objects
    SelRange* pSelRange = GetApplication()->FindSelection();
    Node* pNode = pSelRange->FindFirst();

    BOOL BlobFound = FALSE;

    // Scan the selection for NodePath objects
    while (pNode != NULL && !BlobFound)
    {
        if (pNode->GetRuntimeClass() == CC_RUNTIME_CLASS(NodeBlend))
        {
            NodeBlend* pNodeBlend = (NodeBlend*)pNode;

            if (pNodeBlend->GetUnionBlobBoundingRect().ContainsCoord(*pPointerPos))
            {
                BlobFound = pNodeBlend->IsPointOverBlob(pPointerPos,
                                                        &(pRef->pBlendPath),
                                                        &(pRef->Index),
                                                        &(pRef->AStartNode),
                                                        &(pRef->RemapRef));

                if (BlobFound)
                {
                    pRef->pNode      = pNodeBlend;
                    pRef->pNodeBlend = pNodeBlend;
//                  *pPointerPos = pRef->pBlendPath->GetPathCoord(pRef->Index);
                }
            }
        }

        // Now find the next selected node
        pNode = pSelRange->FindNext(pNode);
    }

    return BlobFound;
}

/********************************************************************************************

>   void BlendTool::CheckNodeRemapping(BlendToolRef* pRefStart, BlendToolRef* pRefEnd)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    6/12/94
    Inputs:     pRefStart = ptr to start ref
                pRefEnd   = ptr to end ref
    Outputs:    Potentailly updates pRefStart and pRefEnd, so that if they represent a remapping of nodes,
                they have the same remap reference
    Returns:    -
    Purpose:    This checks to see if the two references actually represent a node remapping within a blend.
                In order to cope with multi-stage blends, both references have to be looked at the same time.

                This is not the neatest way of doing it, but it's the quickest and safest method, given that
                it has to work for the gamma release it a few days time.

********************************************************************************************/

void BlendTool::CheckNodeRemapping(BlendToolRef* pRefStart, BlendToolRef* pRefEnd)
{
    ERROR3IF(pRefStart == NULL,"pRefStart == NULL");
    ERROR3IF(pRefEnd   == NULL,"pRefEnd == NULL");
    if (pRefStart == NULL || pRefEnd == NULL)
        return;

    NodeBlend* pNodeBlend = pRefStart->pNodeBlend;

    if (pNodeBlend == NULL || pNodeBlend != pRefEnd->pNodeBlend)
        return;

    Node* pNode = pNodeBlend->FindFirstChild();
    while (pNode != NULL)
    {
        if (IS_A(pNode,NodeBlender))
        {
            NodeBlender* pNodeBlender = (NodeBlender*)pNode;

            BOOL StartFound = pNodeBlender->IsPointOverBlob(&(pRefStart->PointerPos),
                                                            &(pRefStart->pBlendPath),
                                                            &(pRefStart->Index),
                                                            &(pRefStart->AStartNode));

            BOOL EndFound   = pNodeBlender->IsPointOverBlob(&(pRefEnd  ->PointerPos),
                                                            &(pRefEnd  ->pBlendPath),
                                                            &(pRefEnd  ->Index),
                                                            &(pRefEnd  ->AStartNode));

            if (StartFound && EndFound && (pRefStart->AStartNode != pRefEnd->AStartNode))
            {
                pRefStart->RemapRef = pNodeBlender->GetTag();
                pRefEnd  ->RemapRef = pNodeBlender->GetTag();
                return;
            }
        }
        pNode