AccuSnap.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    <DgnPlatform/Locate.h>
#include    <DgnView/IViewManager.h>

DGNPLATFORM_TYPEDEFS (AccuSnap)
DGNPLATFORM_TYPEDEFS (TentativePoint)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum AccuSnapEnableFlag
    {
    ACCUSNAP_ENABLE_OffByDefault    = 0,        // off unless modifier key is pressed
    ACCUSNAP_ENABLE_OnByDefault     = 1,        // on unless modifier key is pressed
    ACCUSNAP_ENABLE_Never           = 2,        // AccuSnap is never enabled.
    };

/*=================================================================================**/
CLRPUBLIC struct AccuSnapHandler
{
enum AccuSnapEventHandlerPriority
    {
    ACCUSNAPHANDLER_PRIORITY_Highest  = 1000,
    ACCUSNAPHANDLER_PRIORITY_High     = 750,
    ACCUSNAPHANDLER_PRIORITY_Normal   = 500,
    ACCUSNAPHANDLER_PRIORITY_Low      = 250,
    ACCUSNAPHANDLER_PRIORITY_Lowest   = 0,
    };

enum AsnapStatus
    {
    Ok=0,       
    DontShow=1  
    };

protected:

virtual int _GetHandlerPriority () {return ACCUSNAPHANDLER_PRIORITY_Normal;}

virtual AsnapStatus _ShowElemInfoPopup (DPoint3dCP pt, ViewportP vp, WCharCP string) = 0;

virtual void _RemoveElemInfoPopup () = 0;

virtual AsnapStatus _FlashHitInView (ViewportP vp, HitPathCP path) = 0;

virtual void _UnFlashView (ViewportP) = 0;

};

/*=================================================================================**/
struct  TentativePoint
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    DGNVIEW_EXPORT bool IsActive () const;

    DGNVIEW_EXPORT bool IsSnapped () const;

    DGNVIEW_EXPORT SnapPathP GetCurrSnap () const;

    DGNVIEW_EXPORT DPoint3dCP GetPoint ();

    DGNVIEW_EXPORT void Clear (bool erase);

    DGNVIEW_EXPORT static TentativePoint& GetInstance ();

}; // TentativePoint

/*=================================================================================**/
struct  AccuSnap
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    DGNVIEW_EXPORT bool IsActive (DgnButtonEventCR ev);

    DGNVIEW_EXPORT bool IsHot ();

    DGNVIEW_EXPORT bool UserWantsSnaps ();

    DGNVIEW_EXPORT bool UserWantsLocates ();

    DGNVIEW_EXPORT void EnableSnap (bool yesNo);

    DGNVIEW_EXPORT void EnableLocate (bool yesNo);

    DGNVIEW_EXPORT bool IsSnapEnabled ();

    DGNVIEW_EXPORT bool IsLocateEnabled ();

    DGNVIEW_EXPORT void SetComponentMode (ComponentMode newMode);

    DGNVIEW_EXPORT HitPathP CurrHit ();

    DGNVIEW_EXPORT SnapPathP GetCurrSnapPath ();
    
    DGNVIEW_EXPORT void Clear ();

    DGNVIEW_EXPORT void Suspend (bool doSuspend);

    DGNVIEW_EXPORT SnapStatus ResetButton ();

    DGNVIEW_EXPORT static void AddEventHandler (AccuSnapHandler* accuSnapHandler);

    DGNVIEW_EXPORT static void DropEventHandler (AccuSnapHandler* accuSnapHandler);

    DGNVIEW_EXPORT static AccuSnap& GetInstance ();

}; // AccuSnap

END_BENTLEY_DGNPLATFORM_NAMESPACE