DgnRegionElementTool.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/RegionUtil.h>
#include <DgnPlatform/IViewTransients.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================
struct          DgnRegionElementTool : DgnElementSetTool, DgnPlatform::IViewTransients
{
    DEFINE_T_SUPER (DgnElementSetTool)

public:

enum RegionCreateMode
    {
    REGION_CREATE_Elements, 
    REGION_CREATE_ByParams, 
    REGION_CREATE_Points,   
    REGION_CREATE_Fence,    
    };

enum RegionToolPhase
    {
    REGION_PHASE_SelectBoundaries, 
    REGION_PHASE_CreateRegion,     
    REGION_PHASE_ProcessOriginals, 
    };

private:

DgnPlatform::RegionGraphicsContextPtr  m_regionContext;

RegionToolPhase             m_currentPhase;
CurveVectorPtr              m_dynamicFace;
CurveVectorPtr              m_resultFaces;
DPoint3d                    m_graphFrustum[8];
DPoint3d                    m_lastFrustum[8];
DPoint3d                    m_toggleFaceViewPt;
bvector<DPoint3d>           m_regionPoints;
int                         m_resrvedRegionElm[8];

void                DisplayRegionError (bool noError);
void                InitializeRegionContext (ViewportP vp);
void                ValidateRegionViewport (ViewportP vp, bvector<DPoint3d>* seedPoints);
BentleyStatus       SetupRegionContext (ViewportP vp);

void                DisplayRegion (CurveVectorCR region, ViewportP vp, DgnPlatform::DgnDrawMode drawMode);
void                UpdateTransientDisplay (DgnPlatform::DgnDrawMode drawMode);
void                UpdateRegionResultPreview (ViewportP vp);
void                UpdateBooleanResultPreview (ViewportP vp);

BentleyStatus       GetPreSelectedBoundaries ();
BentleyStatus       CreateRegionFromFence (EditElementHandleR eeh);
BentleyStatus       CreateRegionByPoints (EditElementHandleR eeh, DgnButtonEventCP ev);

protected:

DGNVIEW_EXPORT RegionGraphicsContext*    GetRegionContext (); 
DGNVIEW_EXPORT RegionToolPhase           GetCurrentToolPhase (); 
DGNVIEW_EXPORT bool                      IsFloodRegionSelected (); 

DGNVIEW_EXPORT virtual DgnPlatform::RegionParams const& _GetRegionParams () = 0; 
DGNVIEW_EXPORT virtual RegionCreateMode  _GetRegionCreateMode () = 0; 
DGNVIEW_EXPORT virtual BentleyStatus     _OnProcessRegionResult (EditElementHandleR elHandle) = 0; 

DGNVIEW_EXPORT virtual StatusInt         _DoComputeRegionResult (ElementAgendaR result, DgnButtonEventCR ev);

DGNVIEW_EXPORT virtual void              _GetRegionPreviewSymbology (UInt32& lineColorTBGR, UInt32& fillColorTBGR, UInt32& lineWeight, UInt32& lineStyle, ViewportR, DgnDrawMode);

DGNVIEW_EXPORT virtual WCharCP           _GetAssociativeRegionName () {return L"Associative Region";} 
DGNVIEW_EXPORT virtual StatusInt         _OnElementModify (EditElementHandleR eeh) {return ERROR;} 
DGNVIEW_EXPORT virtual bool              _WantProcessOriginals () {return false;} 
DGNVIEW_EXPORT virtual bool              _WantFloodDynamicArea () {return false;} 
DGNVIEW_EXPORT virtual bool              _AllowPhysicallyClosed () {return REGION_CREATE_ByParams == _GetRegionCreateMode ();} 
DGNVIEW_EXPORT virtual bool              _AcceptClosedElement (ElementHandleCR eh, WStringR cantAcceptReason); 

DGNVIEW_EXPORT virtual bool              _IsModifyOriginal () override {return true;} 
DGNVIEW_EXPORT virtual bool              _DoGroups () override {return REGION_CREATE_Elements == _GetRegionCreateMode ();} 
DGNVIEW_EXPORT virtual bool              _WantDynamics () override {return REGION_CREATE_Points == _GetRegionCreateMode ();} 
DGNVIEW_EXPORT virtual bool              _WantAccuSnap () override {return REGION_CREATE_Points == _GetRegionCreateMode ();} 
DGNVIEW_EXPORT virtual bool              _WantAdditionalLocate (DgnButtonEventCP ev) override; 
DGNVIEW_EXPORT virtual bool              _NeedAcceptPoint () override; 
DGNVIEW_EXPORT virtual bool              _AcceptIdentifiesNext () override; 
DGNVIEW_EXPORT virtual UsesDragSelect    _AllowDragSelect () override; 

DGNVIEW_EXPORT virtual bool      _CheckStop () override; 
DGNVIEW_EXPORT virtual void      _ResetStop () override; 

DGNVIEW_EXPORT virtual void      _DrawTransients (ViewContextR context, bool isPreUpdate) override; 
DGNVIEW_EXPORT virtual void      _DecorateScreen (ViewportR vp) override; 

DGNVIEW_EXPORT virtual StatusInt _ProcessAgenda (DgnButtonEventCR ev) override;
DGNVIEW_EXPORT virtual void      _HiliteAgendaEntries (bool changed) override; 
DGNVIEW_EXPORT virtual void      _UnHiliteAgendaEntries (bool empty) override; 

DGNVIEW_EXPORT virtual bool      _OnPostLocate (HitPathCP path, WStringR cantAcceptReason) override; 
DGNVIEW_EXPORT virtual bool      _FilterAgendaEntries () override; 
DGNVIEW_EXPORT virtual void      _SetLocateCriteria () override; 
DGNVIEW_EXPORT virtual void      _SetupAndPromptForNextAction () override; 

DGNVIEW_EXPORT virtual void      _OnDynamicFrame (DgnButtonEventCR ev) override; 
DGNVIEW_EXPORT virtual bool      _OnModelMotion (DgnButtonEventCR ev) override; 
DGNVIEW_EXPORT virtual bool      _OnModifierKeyTransition (bool wentDown, int key) override; 
DGNVIEW_EXPORT virtual bool      _OnModifyComplete (DgnButtonEventCR ev) override; 

DGNVIEW_EXPORT virtual bool      _OnResetButton (DgnButtonEventCR ev) override; 
DGNVIEW_EXPORT virtual bool      _OnDataButton (DgnButtonEventCR ev) override; 
DGNVIEW_EXPORT virtual void      _OnUndoPreviousStep () override; 

DGNVIEW_EXPORT virtual void      _OnCleanup () override; 
DGNVIEW_EXPORT virtual void      _OnPostInstall () override; 

virtual bool CDECL_ATTRIBUTE DummyDgnRegionElementTool1() {return false;}
virtual bool CDECL_ATTRIBUTE DummyDgnRegionElementTool2() {return false;}
virtual bool CDECL_ATTRIBUTE DummyDgnRegionElementTool3() {return false;}
virtual bool CDECL_ATTRIBUTE DummyDgnRegionElementTool4() {return false;}
virtual bool CDECL_ATTRIBUTE DummyDgnRegionElementTool5() {return false;}

public:


DGNVIEW_EXPORT DgnRegionElementTool (); 

}; // DgnRegionElementTool
//@endgroup

END_BENTLEY_DGNPLATFORM_NAMESPACE