DgnElementSetTool.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include    "DgnTool.h"
#include    "IRedraw.h"
#include    <DgnPlatform/Locate.h>
#include    <DgnPlatform/IModifyElement.h>

DGNPLATFORM_TYPEDEFS (DgnElementSetTool)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
class ModifyOp : public IModifyElement
{

private:
    bool                m_wantGGLock:1;
    bool                m_wantMakeCopy:1;
    ElementCopyContextP m_ccP;

protected:
    virtual void _SetWantMakeCopy (bool val) override {m_wantMakeCopy = val;}

    virtual void _SetWantGGLock (bool val) override {m_wantGGLock = val;}

    virtual bool _WantMakeCopy() const override {return m_wantMakeCopy;}

    virtual bool _WantCheckGGLock() const override {return m_wantGGLock;}

    DGNVIEW_EXPORT virtual DgnModelRefP _GetDestinationModelRef ();

    DGNVIEW_EXPORT virtual ElementCopyContextP _GetCopyContext ();

    DGNVIEW_EXPORT virtual void _ClearCopyContext ();

    DGNVIEW_EXPORT virtual StatusInt _DoOperationForModify (EditElementHandleR eeh) override;

    DGNVIEW_EXPORT virtual StatusInt _OnPreElementModify (EditElementHandleR eeh);

    DGNVIEW_EXPORT virtual void _ResetStop () override;

    DGNVIEW_EXPORT virtual bool _CheckStop () override;

public:
    ModifyOp() {m_wantGGLock = m_wantMakeCopy = false; m_ccP = NULL;}
    DGNVIEW_EXPORT virtual ~ModifyOp ();

}; // ModifyOp

/*=================================================================================**/
struct DgnElementSetTool : DgnPrimitiveTool, IRedrawOperation, ModifyOp
{
    DEFINE_T_SUPER (DgnPrimitiveTool)

public:

/*=================================================================================**/
enum ElemSource
    {
    SOURCE_Pick,            
    SOURCE_Fence,           
    SOURCE_SelectionSet,    
    };

/*=================================================================================**/
enum UsesFence
    {
    USES_FENCE_Check,       
    USES_FENCE_Required,    
    USES_FENCE_None,        
    };

/*=================================================================================**/
enum UsesSelection
    {
    USES_SS_Check,          
    USES_SS_Required,       
    USES_SS_None,           
    };

/*=================================================================================**/
enum UsesDragSelect
    {
    USES_DRAGSELECT_Box,    
    USES_DRAGSELECT_Line,   
    USES_DRAGSELECT_None,   
    };

/*=================================================================================**/
enum ClipResult
    {
    CLIP_RESULT_NotSupported,       
    CLIP_RESULT_NewElements,        
    CLIP_RESULT_OriginalElements,   
    };

/*=================================================================================**/
enum RefLocateOption
    {
    REF_LOCATE_Normal           = (0),      
    REF_LOCATE_SelfAttachment   = (1<<0),   
    REF_LOCATE_Editable         = (1<<1),   
    REF_LOCATE_TreatAsElement   = (1<<2),   
    };

/*=================================================================================**/
enum ErrorNums
    {
    ERROR_NUM_NoFence               =  68, 
    ERROR_NUM_NoFenceElems          = 122, 
    ERROR_NUM_NoFenceElemsOutside   = 250, 
    ERROR_NUM_NoSSElems             =  85, 
    ERROR_NUM_NotSuportedElmType    = 609, 
    };

private:

HitSource               m_hitSource;
ElemSource              m_elemSource;
ElementAgenda           m_agenda;
bool                    m_haveAnchor;
bool                    m_overlapInverted;
DPoint3d                m_anchorPt;
DPoint3d                m_dragAnchorPt;
UsesDragSelect          m_defaultDragMode;
UsesDragSelect          m_inDragMode;
bool                    m_initiateDrag;
int                     m_resrved2[8];

protected:


/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _InstallToolImplementation () override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnInstall () override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _OnPostInstall () override;

/*---------------------------------------------------------------------------------**/
virtual void _OnReinitialize () override {CallOnRestartTool ();}


/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void _SetupAndPromptForNextAction ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT void SetupAndPromptForNextActionHelper ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT static void OutputErrorMessage (ErrorNums msg);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _NeedAcceptPoint ();

/*---------------------------------------------------------------------------------**/
virtual bool _NeedPointForDynamics () {return true;}

/*---------------------------------------------------------------------------------**/
virtual bool _NeedPointForSelection () {return true;}

/*---------------------------------------------------------------------------------**/
virtual bool _AcceptIdentifiesNext () {return false;}


/*---------------------------------------------------------------------------------**/
virtual bool _WantDynamics () {return true;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void _OnDynamicFrame (DgnButtonEventCR ev) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _OnRedrawOperation (EditElementHandleR el, ViewContextR context, bool* canUseCached) override;

/*---------------------------------------------------------------------------------**/
virtual void _OnResymbolize (ViewContextR context) override {}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void _OnRedrawInit (ViewContextR context) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void _OnRedrawFinish (ViewContextR context) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _OnRedrawComplete (ViewContextR context) override;



/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _OnDataButton (DgnButtonEventCR ev) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _OnResetButton (DgnButtonEventCR ev) override;


/*---------------------------------------------------------------------------------**/
virtual bool _WantAccuSnap () {return true;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _WantAutoLocate ();

/*---------------------------------------------------------------------------------**/
virtual HitSource _GetHitSource () const {return m_hitSource;}

/*---------------------------------------------------------------------------------**/
virtual void _SetHitSource (HitSource source) {m_hitSource = source;}

/*---------------------------------------------------------------------------------**/
virtual RefLocateOption _GetReferenceLocateOptions () {return (RefLocateOption) (REF_LOCATE_Normal | REF_LOCATE_SelfAttachment);}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _SetLocateCriteria ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnPostLocate (HitPathCP path, WStringR cantAcceptReason);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _SetLocateCursor (bool enableLocate);

/*---------------------------------------------------------------------------------**/
virtual bool    _DoGroups () {return true;}

/*---------------------------------------------------------------------------------**/
virtual size_t _GetAdditionalLocateNumRequired () {return 1;}

/*---------------------------------------------------------------------------------**/
virtual bool    _WantAdditionalLocate (DgnButtonEventCP ev) {return false;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT bool WantAdditionalLocateHelper (DgnButtonEventCP ev);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual HitPathCP   _DoLocate (DgnButtonEventCR ev, bool newSearch, ComponentMode complexComponent);

virtual ComponentMode _GetComponentMode () {return ComponentMode::None;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _LocateOneElement (DgnButtonEventCR ev, bool newSearch);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual EditElementHandleP _BuildLocateAgenda (HitPathCP path, DgnButtonEventCP ev);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _RemoveAgendaElement (EditElementHandleR el);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _BeginPickElements ();


/*---------------------------------------------------------------------------------**/
virtual UsesDragSelect  _AllowDragSelect () {return USES_DRAGSELECT_None;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _DecorateScreen (ViewportR vp) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnModifierKeyTransition (bool wentDown, int key) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT bool OnModifierKeyTransitionHelper (bool wentDown, int key);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnModelStartDrag (DgnButtonEventCR ev) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnModelEndDrag (DgnButtonEventCR ev) override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnModelMotion (DgnButtonEventCR ev) override;

/*---------------------------------------------------------------------------------**/
virtual UsesDragSelect  _IsDragSelectActive () {return m_inDragMode;}

/*---------------------------------------------------------------------------------**/
virtual bool    _GetDragAnchorPoint (DPoint3dP anchorPt) {if (anchorPt) *anchorPt = m_dragAnchorPt; return USES_DRAGSELECT_None != m_inDragMode;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _BuildDragSelectAgenda (FenceParamsP fp, DgnButtonEventCR ev);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _GetDragSelectOverlapMode (DgnButtonEventCR ev);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _GetDragSelectSymbology (UInt32& color, UInt32& fillColor, UInt32& style, UInt32& weight, DgnButtonEventCR ev);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _GetBoxPoints (DPoint3dP shapePointsP, DgnCoordSystem sys, DPoint3dCR activeOrigin, DPoint3dCR activeCorner, ViewportP vp);


/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _NotifyListeners (ElementAgendaR, AgendaOperation, AgendaModify, AgendaEvent, void* eventArg = NULL);

/*---------------------------------------------------------------------------------**/
virtual AgendaOperation _GetAgendaOperation () {return AgendaOperation::NotSpecified;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual AgendaModify _GetAgendaModify ();


/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _UseActiveFence ();

/*---------------------------------------------------------------------------------**/
virtual UsesFence   _AllowFence () {return USES_FENCE_None;}

/*---------------------------------------------------------------------------------**/
virtual UsesSelection   _AllowSelection () {return USES_SS_Check;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual ElemSource  _GetPreferredElemSource ();

/*---------------------------------------------------------------------------------**/
virtual ElemSource  _GetElemSource () const {return m_elemSource;}

/*---------------------------------------------------------------------------------**/
virtual void    _SetElemSource (ElemSource source) {m_elemSource = source;}

/*---------------------------------------------------------------------------------**/
virtual bool    _HiliteFenceElems () {return false;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _HiliteAgendaEntries (bool changed);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _UnHiliteAgendaEntries (bool empty);

/*---------------------------------------------------------------------------------**/
virtual bool    _FilterAgendaEntries () {return false;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _ModifyAgendaEntries ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void    _BuildAgenda (DgnButtonEventCR ev);


/*---------------------------------------------------------------------------------**/
ElementAgendaR  GetElementAgenda () {return m_agenda;}

/*---------------------------------------------------------------------------------**/
virtual bool    _GetAnchorPoint (DPoint3dP anchorPt) {if (anchorPt) *anchorPt = m_anchorPt; return m_haveAnchor;}

/*---------------------------------------------------------------------------------**/
virtual void    _SetAnchorPoint (DPoint3dCP anchorPt) {if (anchorPt) m_anchorPt = *anchorPt; m_haveAnchor = anchorPt ? true : false;}

/*---------------------------------------------------------------------------------**/
virtual bool    _IsModifyOriginal () {return true;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual DgnModelRefP  _GetDestinationModelRef () override;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _IsFenceOverlap ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _IsFenceVoid ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _IsFenceClip ();

/*---------------------------------------------------------------------------------**/
virtual bool    _SetupForModify (DgnButtonEventCR ev, bool isDynamics) {return true;}

/*---------------------------------------------------------------------------------**/
virtual ClipResult  _GetFenceClipResult () {return CLIP_RESULT_NotSupported;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _DoFenceClip ();

/*---------------------------------------------------------------------------------**/
virtual StatusInt   _OnElementModify (EditElementHandleR el) = 0;

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _OnElementModifyClip (EditElementHandleR el, FenceParamsP fp, FenceClipFlags options);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool    _OnModifyComplete (DgnButtonEventCR ev);

/*---------------------------------------------------------------------------------**/
virtual UInt32  _GetGroupOperationCount () {return 1;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void      _PreModifyAgenda (DgnButtonEventCR ev, AgendaOperation agendaOp, AgendaModify agendaModify, bool isGroupOp);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _ModifyAgendaGroup (DgnButtonEventCR ev, AgendaOperation agendaOp, AgendaModify agendaModify, bool isGroupOp, UInt32 iGroupOp, bool redraw);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual void      _PostModifyAgenda (DgnButtonEventCR ev, AgendaOperation agendaOp, AgendaModify agendaModify, bool isGroupOp);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual StatusInt _ProcessAgenda (DgnButtonEventCR ev);

public:

DGNVIEW_EXPORT  DgnElementSetTool (int toolId);

DGNVIEW_EXPORT  DgnElementSetTool ();
DGNVIEW_EXPORT ~DgnElementSetTool ();


}; // DgnElementSetTool


END_BENTLEY_DGNPLATFORM_NAMESPACE