DgnTool.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    <DgnView/IViewManager.h>
#include    <DgnPlatform/DgnViewport.h>
#include    <DgnPlatform/DgnPlatform.h>
#include    <DgnView/DgnDisplay.h>

typedef struct mdlDesc      MdlDesc;

typedef struct inputq_element Inputq_element;
DGNPLATFORM_TYPEDEFS (DgnTool)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

enum KeyModifierMasks
    {
    KEYMODIFIER_ShiftKey   = 0x0004,
    KEYMODIFIER_ControlKey = 0x0008,
    KEYMODIFIER_AltKey     = 0x0010,
    };

enum CoordinateLockOverrides
    {
    OVERRIDE_COORDINATE_LOCK_None = 0,
    OVERRIDE_COORDINATE_LOCK_Axis = (1<<0),
    OVERRIDE_COORDINATE_LOCK_ACS  = (1<<1),
    OVERRIDE_COORDINATE_LOCK_Grid = (1<<2),     // also overrides unit lock
    OVERRIDE_COORDINATE_LOCK_All  = 0xffff,
    };

/*=================================================================================**/
/*=================================================================================**/
struct DgnButtonEvent
{
public:
/*=================================================================================**/
enum CoordSource
    {
    FROM_User           = 0,    
    FROM_Precision      = 1,    
    FROM_TentativePoint = 2,    
    FROM_ElemSnap       = 3,    
    };

protected:
    DPoint3d            m_point;
    DPoint3d            m_rawPoint;
    DPoint3d            m_viewPoint;
    IndexedViewportP    m_viewport;
    CoordSource         m_coordsFrom;   // how were the coordinate values in m_point generated?
    int                 m_inputSource;
    UInt32              m_keyModifiers;

public:
    bool IsValid() const {return NULL != m_viewport;}
    void Invalidate() {m_viewport = NULL;}

    void SetPoint (DPoint3dCP pt) {m_point = *pt;}
    DPoint3dCP GetPoint() const {return &m_point;}
    DPoint3dCP GetRawPoint() const {return &m_rawPoint;}
    DPoint3dCP GetViewPoint() const {return &m_viewPoint;}
    void SetViewport (IndexedViewportP viewport) { m_viewport = viewport; }
    IndexedViewportP GetViewport() const {return m_viewport;}
    DGNVIEW_EXPORT int GetViewNum() const;
    CoordSource GetCoordSource() const {return m_coordsFrom;}
    int GetButtonSource() const {return m_inputSource;}
    DGNVIEW_EXPORT bool IsControlKey () const;
    DGNVIEW_EXPORT bool IsShiftKey () const;
    DGNVIEW_EXPORT bool IsAltKey () const;
    UInt32 GetKeyModifiers () const {return m_keyModifiers;}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnTouchEvent : DgnButtonEvent
{
public:
    enum TouchFlags
        {
        TOUCHFLAGS_Move       = 0x0001,
        TOUCHFLAGS_Down       = 0x0002,
        TOUCHFLAGS_Up         = 0x0004,
        TOUCHFLAGS_InRange    = 0x0008,
        TOUCHFLAGS_Primary    = 0x0010,
        TOUCHFLAGS_NoCoalesce = 0x0020,
        TOUCHFLAGS_Pen        = 0x0040,
        TOUCHFLAGS_Palm       = 0x0080,
        };

    //=======================================================================================
    // Note, this structure is identical to the Windows structure TOUCHINPUT. See Windows documentation for meaning of members.
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================
    struct TouchInput
        {
        long    m_x;
        long    m_y;
        void*   m_hSource;
        ULong   m_dwID;
        ULong   m_dwFlags;
        ULong   m_dwMask;
        ULong   m_dwTime;
        ULong*  m_dwExtraInfo;
        ULong   m_cxContact;
        ULong   m_cyContact;

        DGNVIEW_EXPORT DPoint3d GetViewPoint(IndexedViewportR) const;
        bool IsUp () const     {return TO_BOOL(m_dwFlags & TOUCHFLAGS_Up);}
        bool IsDown() const    {return TO_BOOL(m_dwFlags & TOUCHFLAGS_Down);}
        bool IsMove ()const    {return TO_BOOL(m_dwFlags & TOUCHFLAGS_Move);}
        bool IsPrimary ()const {return TO_BOOL(m_dwFlags & TOUCHFLAGS_Primary);}
        };

protected:
    UInt             m_numTouches;
    TouchInput       m_touches[5];

public:

    size_t GetNumTouches() const {return m_numTouches;}
    TouchInput const* GetTouches() const {return m_touches;}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnGestureEvent : DgnButtonEvent
{
    enum GestureIds
    {
        GESTUREID_Begin        = 1,
        GESTUREID_End          = 2,
        GESTUREID_Zoom         = 3,
        GESTUREID_Pan          = 4,
        GESTUREID_Rotate       = 5,
        GESTUREID_TwoFingerTap = 6,
        GESTUREID_PressAndTap  = 7,
        GESTUREID_Rollover     = GESTUREID_PressAndTap,
    };

    //=======================================================================================
    // Note, this structure is identical to the Windows structure GESTUREINFO. See Windows documentation for meaning of members.
    // @remark Required library : DgnView<ApiNumber>.lib  i.e. DgnView2.lib
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================
    struct GestureInfo
    {
        UInt    m_cbSize;
        ULong   m_dwFlags;
        ULong   m_dwID;
        void*   m_hwndTarget;
        short   m_ptsLocationX;
        short   m_ptsLocationY;
        ULong   m_dwInstanceID;
        ULong   m_dwSequenceID;
        UInt64  m_ullArguments;
        UInt    m_cbExtraArgs;

    DGNVIEW_EXPORT DPoint3d GetViewPoint (IndexedViewportR) const;
    DGNVIEW_EXPORT double   GetDistance () const;
    };

    //=======================================================================================
    // Note, this structure is identical to the Windows structure GESTURECONFIG. See Windows documentation for meaning of members.
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================
    struct GestureConfig 
    {
        ULong m_dwID;   
        ULong m_dwWant; 
        ULong m_dwBlock;
    };

protected:
    GestureInfo      m_info;

public:
    GestureInfo const& GetInfo() const {return m_info;}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DgnFlickEvent : DgnButtonEvent
{
    enum FlickDirection
    {
        FLICKDIRECTION_Right     = 0,
        FLICKDIRECTION_UpRight   = 1,
        FLICKDIRECTION_Up        = 2,
        FLICKDIRECTION_UpLeft    = 3,
        FLICKDIRECTION_Left      = 4,
        FLICKDIRECTION_DownLeft  = 5,
        FLICKDIRECTION_Down      = 6,
        FLICKDIRECTION_DownRight = 7,
    };

protected:
    FlickDirection m_direction; 

public:
    FlickDirection GetFlickDirection () const {return m_direction;}
};

/*=================================================================================**/
struct DgnMouseWheelEvent : public DgnButtonEvent
    {
private:
    long  m_wheelDelta;

public:
    long GetWheelDelta () const {return m_wheelDelta;}
};

/*=================================================================================**/
struct Dgn3DInputEvent
    {
private:
    UInt32      m_time;
    DVec3d      m_rotDirection;
    double      m_rotMagnitude;
    DVec3d      m_translation;

public:
    UInt32      GetTime() const         {return m_time;}
    DVec3dCR    GetRotation() const     {return m_rotDirection;}
    double      GetRotMagnitude() const {return m_rotMagnitude;}
    DVec3dCR    GetTranslation() const  {return  m_translation;}
};

struct DgnPrimitiveTool;
struct DgnViewTool;
struct ToolAdmin;
struct MstnToolAdmin;

/*=================================================================================**/
struct DgnTool : RefCountedBase
{
protected:
    int          m_toolId;
    int          m_toolPrompt;
    MdlDesc*     m_mdlDesc;
    UInt32       m_currentQualifierMask;
    bool         m_modifierKeyWentDown;
    int          m_modifierKey;
    int          m_resrved[8];

public:


void SetToolId (int id) {m_toolId = id;}

void SetToolPrompt (int prompt) {m_toolPrompt = prompt;}

int GetToolId () {return m_toolId;}

int GetToolPrompt () {return m_toolPrompt;}

protected:

void SetCmdName (int id, int prompt) {SetToolId (id); SetToolPrompt (prompt);}

virtual void _GetToolName (WStringR name) {name = NULL;}

virtual bool _PopulateToolSettings () {return false;}

/*---------------------------------------------------------------------------------**/
virtual StatusInt _InstallToolImplementation () = 0;

virtual bool _OnInstall () {return true;}

/*---------------------------------------------------------------------------------**/
virtual void _OnPostInstall () {}

/*---------------------------------------------------------------------------------**/
virtual void _ExitTool () = 0;

/*---------------------------------------------------------------------------------**/
virtual void _OnReinitialize () {}

/*---------------------------------------------------------------------------------**/
virtual void _OnCleanup () {}



/*---------------------------------------------------------------------------------**/
virtual void _DecorateScreen (ViewportR vp) {}


/*---------------------------------------------------------------------------------**/
virtual bool _OnResetButton (DgnButtonEventCR ev) = 0;
virtual bool _OnResetButtonUp (DgnButtonEventCR ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnDataButton (DgnButtonEventCR ev) = 0;
virtual bool _OnDataButtonUp (DgnButtonEventCR ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnModelMotion (DgnButtonEventCR ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnModelNoMotion (DgnButtonEventCR ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnModelMotionStopped (DgnButtonEventCR ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnModelStartDrag (DgnButtonEventCR ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnModelEndDrag (DgnButtonEventCR ev) {return _OnDataButton (ev);}


/*---------------------------------------------------------------------------------**/
virtual bool _OnMouseWheel (DgnMouseWheelEvent const* ev) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool _OnModifierKeyTransition (bool wentDown, int key) {return false;}

/*---------------------------------------------------------------------------------**/
virtual bool    _OnKeyTransition (bool wentDown, int key, bool shiftIsDown, bool ctrlIsDown) { return false; }

virtual bool _On3DInputEvent (Dgn3DInputEvent const&) {return false;}


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

/*---------------------------------------------------------------------------------**/
virtual StatusInt _PerformEditAction (int index) {return ERROR;}

virtual void _OverrideViewCursors (ViewportR, DgnDisplay::CursorP& active, DgnDisplay::CursorP& inactive) {}


virtual bool    _OnPreFilterButtonEvent (ViewportP, bool& testDefault) {return false;}
virtual DgnDisplay::CursorP _GetCursorForInactiveView (bool& allowDynamics, ViewportP) {return NULL;}
virtual bool    _OnTouch (DgnTouchEventCR ev) {return false;}
virtual bool    _OnGestureNotify (IndexedViewportR, intptr_t) {return false;}
virtual bool    _OnGesture (DgnGestureEventCR ev) {return false;}
virtual bool    _OnFlick (DgnFlickEventCR ev) {return false;}
virtual long    _OnTabletQuerySystemGestureStatus (DgnButtonEventCR ev) {return NULL;}
virtual bool CDECL_ATTRIBUTE    DummyDgnTool1() {return false;}
virtual bool CDECL_ATTRIBUTE    DummyDgnTool2() {return false;}
virtual bool CDECL_ATTRIBUTE    DummyDgnTool3() {return false;}
virtual bool CDECL_ATTRIBUTE    DummyDgnTool4() {return false;}
virtual bool CDECL_ATTRIBUTE    DummyDgnTool5() {return false;}

public:

DGNVIEW_EXPORT DgnTool (int toolId, int toolPrompt);

/*---------------------------------------------------------------------------------**/
StatusInt InstallTool () {return _InstallToolImplementation ();}

/*---------------------------------------------------------------------------------**/
MdlDesc* GetMdlDesc () {return m_mdlDesc;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT void GetCurrentDgnButtonEvent (DgnButtonEventR ev);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT void SetAdjustedDataPoint (DgnButtonEventCR ev);

/*---------------------------------------------------------------------------------**/
void ResetCurrentQualifierMask (UInt32 mask) {m_currentQualifierMask = mask; m_modifierKeyWentDown = false; m_modifierKey = 0;}

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT void GetModifierKeyTransitionState (int* modifierKeyP, bool* modifierKeyWentDownP, UInt32* currentQualifierMaskP);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT void SetModifierKeyTransitionState (int* modifierKeyP, bool* modifierKeyWentDownP, UInt32* currentQualifierMaskP);

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT static DgnViewTool* GetActiveViewTool ();

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT static DgnPrimitiveTool* GetActivePrimitiveTool ();

}; // DgnTool

/*=================================================================================**/
struct DgnViewTool : public DgnTool
{

protected:


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

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


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

/*---------------------------------------------------------------------------------**/
virtual void _OnSelectedViewChange (int oldViewIndex, int newViewIndex) {}
virtual bool _OnPreFilterButtonEvent (ViewportP, bool& testDefault) override {testDefault=false; return false;}

public:

DgnViewTool (int toolName, int toolPrompt) : DgnTool (toolName, toolPrompt) {}

/*=================================================================================**/
enum PreferredView
    {
    PREFERRED_VIEW_None     = (0),      
    PREFERRED_VIEW_Unparsed = (1<<0),   
    PREFERRED_VIEW_Selected = (1<<1),   
    PREFERRED_VIEW_Single   = (1<<2),   
    };

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT static IndexedViewportP GetPreferredViewport (PreferredView* sourceFoundP, WCharCP unparsedP, PreferredView sourceToSearch);

}; // DgnViewTool

/*=================================================================================**/
struct DgnPrimitiveTool : public DgnTool
{

private:

bool            m_dynamicsStarted;
int             m_resrved1[8];

protected:

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

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

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

/*---------------------------------------------------------------------------------**/
virtual void _OnRestartTool () = 0;

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

/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT virtual bool _CheckSingleShot (); // start default command if tool started in single shot mode...

/*---------------------------------------------------------------------------------**/
virtual void _OnUndoPreviousStep () {}

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



/*---------------------------------------------------------------------------------**/
DGNVIEW_EXPORT bool GetDynamicsStarted ();

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

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

/*---------------------------------------------------------------------------------**/
virtual void _OnDynamicFrame (DgnButtonEventCR ev) {}

/*---------------------------------------------------------------------------------**/
virtual IDrawElementAgenda* _GetDrawDynamicsTxnChanges () {return NULL;}


public:

DGNVIEW_EXPORT DgnPrimitiveTool (int toolId, int toolPrompt);

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

}; // DgnPrimitiveTool


END_BENTLEY_DGNPLATFORM_NAMESPACE