MS交互式工具开发--状态机--DgnElementSetTool详解

╰半橙微兮° 2022-10-27 05:22 15阅读 0赞

DgnElementSetTool的基类除了DgnPrimitiveTool以外还有IRedrawOperation和ModifyOp这两个基类，从DgnPrimitiveTool继承了视图及鼠标键盘等交互事件的响应功能，从IRedrawOperation继承实现了元素动态重绘的功能，从ModifyOp继承实现了元素修改逻辑的功能，而DgnElementSetTool自身又添加了元素选取（包括点选、划选框选、选择集以及围栅）的功能。我们首先从工具启动后DgnElementSetTool的成员函数调用顺序看一下DgnElementSetTool的各个成员函数的调用执行流程。

> 当我们实现了一个从DgnElementSetTool派生下来的类以后，与DgnPrimitiveTool一样，我们动态创建一个类的实例化对象，调用基类的成员函数InstallTool来启动我们的工具类。我们在介绍DgnPrimitiveTool的时候InstallTool后台调用的函数只提到了\_OnInstall和\_OnPostInstall函数，**实际上InstallTool只是调用了\_InstallToolImplementation，\_InstallToolImplementation进而调用了\_OnInstall和\_OnPostInstall函数**，这一点我们从…\\DgnView\\DgnTool.h头文件中就能看到。DgnElementSetTool重写了这三个函数，我们先看一下重写的\_InstallToolImplementation函数。这个函数里边会调用\_SetElemSource设置DgnElementSetTool:: m\_elemSource的值，这个值是调用\_GetPreferredElemSource获得的。**\_GetPreferredElemSource通过调用\_AllowFence、\_AllowSelection以及当前围栅、选择集的激活状态判断返回什么值。如果\_AllowFence返回的是USES\_FENCE\_Required，表明必须通过围栅获取元素，则\_GetPreferredElemSource返回SOURCE\_Fence，如果\_AllowFence返回的是USES\_FENCE\_Check，表明可以但不是必须要通过围栅选择元素，这个时候再查看当前是否有围栅激活。如果有的话也是返回SOURCE\_Fence，否则就继续往后判断。接下来就是通过\_AllowSelection的返回值判断是否支持选择集获取元素，流程跟围栅的判断流程类似。最后如果围栅和选择集都不支持的话就返回SOURCE\_Pick**。\_GetPreferredElemSource的伪代码如下所示：

DgnElementSetTool::ElemSource  DgnElementSetTool::_GetPreferredElemSource ()
        {
        switch (_AllowFence ())
            {
            case USES_FENCE_Required:
                return SOURCE_Fence;
    
            case USES_FENCE_Check:
                if (_UseActiveFence () && FenceManager::GetManager().IsFenceActive ())
                    return SOURCE_Fence;
                break;
            }
    
        switch (_AllowSelection ())
            {
            case USES_SS_Required:
                return SOURCE_SelectionSet;
    
            case USES_SS_Check:
                if (SelectionSetManager::GetManager().IsActive ())
                    return SOURCE_SelectionSet;
                break;
    
            default:
                SelectionSetManager::GetManager().EmptyAll ();
                break;
            }
    
        return SOURCE_Pick;
        }

设置好DgnElementSetTool:: m\_elemSource的值后，会调用基类的\_InstallToolImplementation函数，即DgnPrimitiveTool:: \_InstallToolImplementation，这个函数最终调用了我们先前介绍的\_OnInstall和\_OnPostInstall函数。而DgnElementSetTool重写了这两个函数，所以实际上调用了DgnElementSetTool:: \_OnInstall和DgnElementSetTool:: \_OnPostInstall。我们先介绍一下DgnElementSetTool:: **\_OnInstall里边做了哪些操作。这个函数里边通过调用\_GetElemSource获取DgnElementSetTool:: m\_elemSource的值，判断这个值如果是SOURCE\_Fence，但是当前没有围栅激活的话，就返回false，工具就无法激活。同样的如果是SOURCE\_SelectionSet，而当前没有选择集激活的话也是返回false。如果通过这两步的话就返回true，工具就会被激活真正成为当前的工具，继而调用DgnElementSetTool:: \_OnPostInstall。**主要的调用顺序如下所示：

> DgnTool ::InstallTool
> 
> DgnElementSetTool:: \_InstallToolImplementation
> 
> DgnElementSetTool:: \_SetElemSource
> 
> DgnElementSetTool:: \_GetPreferredElemSource
> 
> DgnElementSetTool:: \_AllowFence
> 
> DgnElementSetTool:: \_AllowSelection
> 
> DgnPrimitiveTool:: \_InstallToolImplementation
> 
> DgnElementSetTool:: \_OnInstall
> 
> DgnElementSetTool:: \_OnPostInstall

接下来我们看一下DgnElementSetTool:: \_OnPostInstall函数。函数里边首先判断如果\_GetElemSource返回的结果是SOURCE\_Pick的话就调用\_BeginPickElements函数。**\_BeginPickElements会设置点选元素时搜寻哪些Model，以及设置光标为点选元素状态**。如果\_GetElemSource返回的是SOURCE\_SelectionSet的话，接下来会根据**\_NeedPointForSelection返回的结果判断是否需要用户输入额外的确认点才开始处理选择集元素**。如果我们重写了\_NeedPointForSelection并且返回false（DgnElementSetTool:: \_NeedPointForSelection返回true），则相继调用\_BuildAgenda、\_ProcessAgenda、\_OnModifyComplete对选择集中的元素进行处理。如果返回true的话，则继续往下执行，调用**\_NeedPointForDynamics判断是否需要用户输入额外的确认点来启动动态绘制**。如果重写了\_NeedPointForDynamics并且返回false（DgnElementSetTool:: \_NeedPointForDynamics返回true），就会调用**\_BeginDynamics启动动态绘制**。调用\_BeginDynamics之前会调用\_GetElemSource判断当前是否是通过选择集选择的元素（返回SOURCE\_Pick），如果是会调用\_BuildAgenda来获取选择集中的元素。\_OnPostInstall的伪代码如下所示：

void    DgnElementSetTool::_OnPostInstall ()
    {
        …
        if (SOURCE_Pick == _GetElemSource ()){
                _BeginPickElements ();
            }
        else if (SOURCE_SelectionSet == _GetElemSource ()){
            if (!_NeedPointForSelection ()){
    	        …
                _BuildAgenda (ev);
                _ProcessAgenda (ev)
                _OnModifyComplete (ev);
                return;
                }
            else {
                …
            }
        if (!_NeedPointForDynamics ()) {
            if (SOURCE_Pick != _GetElemSource ()) {
    	        …
                _BuildAgenda (ev);
                }
            _BeginDynamics ();
            }
    }

DgnElementSetTool::\_ OnPostInstall函数里边有两个函数我们需要更深入地研究一下，\_ BuildAgenda和\_ ProcessAgenda，\_ ProcessAgenda 我们放到后边介绍\_OnDataButton函数的时候再介绍，我们先看一下\_BuildAgenda。DgnElementSetTool定义了一个**ElementAgenda的私有成员变量m\_agenda，无论是围栅、选择集还是点选的元素，使用DgnElementSetTool提供的拾取元素的接口最终获取到的元素都会放到这个变量里边**，由于是私有成员变量，所以DgnElementSetTool的派生类里边**只能通过GetElementAgenda函数访问**这个成员变量。\_ BuildAgenda根据\_GetElemSource返回的结果判断是通过围栅还是选择集来填充m\_agenda，填充后会继续**调用\_ModifyAgendaEntries对m\_agenda中的元素进行修改筛选**。\_ModifyAgendaEntries会调用\_FilterAgendaEntries，如果重写了**\_FilterAgendaEntries**并且**返回true**（DgnElementSetTool:: \_FilterAgendaEntries返回false）的话，**会将m\_agenda中无效的元素（指调用了EditElementHandle:: Invalidate的元素）剔除掉**，所以这就给了我们一个机会去筛选DgnElementSetTool为我们拾取的元素。最后**调用\_HiliteAgendaEntries高亮最终的ElementAgenda，如果是通过围栅获取的元素，\_HiliteAgendaEntries 会调用\_HiliteFenceElems判断是否高亮围栅选中的元素。**

\_OnInstall和\_OnPostInstall执行之后，工具处与激活状态，等待用户的输入。这个时候我们的鼠标或者键盘在视图中发生的一些事件会触发DgnElementSetTool对应的成员函数，这些成员函数都是虚函数，我们可以在自己的类中重写这些虚函数从而响应这些事件，我们首先介绍一下\_OnPostLocate函数。当光标在视图中移动并且定位到某个元素时，这个函数就会被调用。\_OnPostLocate的函数原型如下所示：

virtual bool    _OnPostLocate (HitPathCP path, WStringR cantAcceptReason);

**通过path参数我们可以获取到当前光标定位到的元素，我们可以在重写的\_OnPostLocate函数中获取元素的属性，然后判断我们的工具是否支持处理定位到的元素。如果不支持，就返回false，这样用户就没办法选中这个元素**。我们还可以**设置cantAcceptReason参数的值，从而提醒用户是什么原因不能选中这个元素**,接下来我们看一下DgnElementSetTool ::\_OnDataButton函数。

> 前面已经提到过单击鼠标左键时\_OnDataButton函数会被调用，DgnElementSetTool中为我们实现了\_OnDataButton函数，这个函数与\_DecorateScreen、\_OnModifierKeyTransition、\_OnModelStartDrag、\_OnModelEndDrag、\_OnModelMotion等函数配合完成了支持点选、划选以及框选的功能。DgnElementSetTool::\_OnDataButton函数中首先会根据m\_agenda中元素个数是否为0或者\_WantAdditionalLocate的返回结果是否为true，判断当前是否需要拾取元素。如果需要拾取元素的话会通过\_GetElemSource的返回的结果判断是要点选元素还是要通过选择集或者围栅来拾取元素。如果是点选元素的话，会调用**\_LocateOneElement**来定位拾取元素，否则会调用前面提到过的**\_BuildAgenda**来拾取元素。如果没有拾取到新的元素的话，会根据\_AllowDragSelect的返回结果判断是否要启用框选或者划选。如果启用框选或者划选的话，那么当光标停止拖拽在**\_OnModelEndDrag**函数中，**\_BuildDragSelectAgenda**会被调用。\_BuildDragSelectAgenda会把框选或者划选的元素加入到m\_agenda中，如果当前处于多选状态下的话，框选或者划选的元素已经在m\_agenda中，这些元素会被反选掉。如果不是在多选状态下的话，m\_agenda首先会被清空，然后再将框选或者划选的元素插入到m\_agenda中，调用\_BuildDragSelectAgenda之后会调用**\_ModifyAgendaEntries**，前面我们提到过\_ModifyAgendaEntries函数，给了我们一个过滤元素的机会。我们继续回到\_OnDataButton函数中，**如果拾取到新的元素的话，会调用****\_WantDynamics判断是否要启动动态绘制。然后会调用\_NeedAcceptPoint****判断是否需要用户再点击左键才开始处理元素，如果返回true的话，\_OnDataButton会直接返回。如果\_NeedAcceptPoint返回false的话，会直接调用\_ProcessAgenda开始执行元素修改的流程。\_ProcessAgenda调用以后，最后调用\_OnModifyComplete。**其中DgnElementSetTool::\_NeedAcceptPoint的实现如下所示，可以看到如果\_WantDynamics返回true，的话其直接返回true，否则会根据m\_agenda中元素的来源判断返回true还是false。

bool    DgnElementSetTool::_NeedAcceptPoint ()
    {
        if (_WantDynamics ())
            return true;
    
        return (SOURCE_Pick != _GetElemSource () || AccuSnap::GetInstance().UserWantsLocates() ? false : true);
    }

\_OnDataButton函数中调用的\_LocateOneElement、\_ProcessAgenda、\_OnModifyComplete我们需要再深入探讨一下。\_LocateOneElement中通过**调用\_WantAdditionalLocate判断是否支持多选**，如果\_WantAdditionalLocate返回false，则会清空m\_agenda。如果返回true的话，会判断第二个参数newSearch的值。newSearch这个参数是用来控制定位元素时是否继续从上次定位到元素的位置往后查找，我们知道虽然在Mstn中我们看到的元素在空间下是杂乱无章的，但是Dgn文件在存储到磁盘上时，是按顺序一个挨着一个存储的。**\_LocateOneElement函数中是通过调用\_DoLocate来定位元素的**，\_DoLocate在搜寻到元素时，**会记录查找到元素的位置**，\_DoLocate有一个参数可以让我们从这个位置继续往后定位搜寻元素。在调用\_DoLocate之前，如果newSearch的值为false的话，表明用户最近拾取的元素不是想要的，需要继续往后定位其他元素，所以这里会**调用\_RemoveAgendaElement从m\_agenda中移除最近一次定位到的元素**。之后就会调用\_DoLocate来定位元素了，\_DoLocate返回定位到的元素，\_LocateOneElement中通过调用**\_BuildLocateAgenda把定位到的元素插入到m\_agenda中**。\_BuildLocateAgenda也是先调用\_WantAdditionalLocate判断是否支持多选，如果支持多选且当前Ctrl键处于按下的状态（通过参数ev->IsControlKey()判断）的话会先查看m\_agenda中是否已经存在要插入的元素，如果存在会调用\_\_RemoveAgendaElement将其移除然后马上返回，这样就实现了反选的功能。如果不存在的话，最后将定位到的元素插入到m\_agenda中，这个时候会**调用\_IsModifyOriginal判断是插入元素本身还是元素的拷贝**。其实我们前面介绍的\_BuildAgenda以及框选划选的时候都会调用\_IsModifyOriginal判断是插入元素本身还是元素的拷贝。另外在点选元素时还会**调用\_DoGroups判断是否与要插入元素同一组的元素也要插入到m\_agenda中**，在调用\_RemoveAgendaElement时，也是会通过\_DoGroups判断是否要移除同一组中的其他元素。 \_LocateOneElement调用\_BuildLocateAgenda之后也会调用\_ModifyAgendaEntries，如前面所述，在这里同样给了我们一个机会去筛选m\_agenda中的元素。

接下来我们看一下\_ProcessAgenda函数，\_ProcessAgenda中会依次调用\_SetupForModify、\_PreModifyAgenda、\_ModifyAgendaGroup、\_PostModifyAgenda。在\_PreModifyAgenda中，会**调用\_IsFenceClip判断是否用围栅对元素进行剪切**，**如果需要的话，会调用\_DoFenceClip来完成**。在\_ModifyAgendaGroup函数中，经过层层调用最终会调用到\_DoOperationForModify、\_OnPreElementModify、\_OnElementModify。在\_OnElementModify函数中如果我们对通过参数传递进来的元素进行修改，并且返回SUCCESS的话，在\_DoOperationForModify中会用修改后的元素替换掉原来的元素，当然前提是\_IsModifyOriginal返回true。否则的话会直接把修改后的元素重新添加到Dgn文件中。

\_OnDataButton函数中调用\_ProcessAgenda之后会调用\_OnModifyComplete。\_OnModifyComplete会先调用\_CheckSingleShot，如果\_CheckSingleShot返回true，则\_OnModifyComplete直接返回。否则会根据\_GetElemSource的返回结果做不同的操作，如果返回SOURCE\_Pick，则会调用\_NeedAcceptPoint和\_AcceptIdentifiesNext，两者都返回ture的话会清空m\_agenda，并调用\_OnDataButton。如果\_GetElemSource的返回结果是SOURCE\_SelectionSet或者SOURCE\_Fence则直接调用**\_ExitTool**退出当前工具。

接下来我们看一下DgnElementSetTool封装的动态绘制功能是如何实现的。前面在介绍DgnPrimitiveTool的时候已经提到只要调用了\_BeginDynamics之后，当我们的光标在视图中移动时，\_OnDynamicFrame会被不停地调用，\_OnPostInstall和\_OnDataButton函数中在适当的时机都会调用到\_BeginDynamics。DgnElementSetTool::\_OnDynamicFrame中首先会判断m\_agenda中是否有元素，如果没有就直接返回。否则继续调用\_SetupForModify，这一点与\_ProcessAgenda类似，区别是调用时第二个参数为true。接下来后台会调用一系列函数，经过层层调用后\_OnRedrawInit、\_OnRedrawOperation、\_OnResymbolize、\_OnRedrawFinish和\_OnRedrawComplete会先后被调用到，其中\_OnRedrawOperation又会调用到\_OnElementModify。所以我们在\_OnElementModify对元素所做的修改，同样的在动态绘制里边也会起作用。在这个过程中m\_agenda中的元素会被复制拷贝一份出来传递给\_OnElementModify，所以动态过程中并不会修改m\_agenda中原有的元素。

目前为止，我们使用了大部分的鼠标相关的事件，其实键盘按键相关的事件处理函数主要有两个\_OnModifierKeyTransition和\_OnKeyTransition。\_OnModifierKeyTransition在Ctrl、Alt或者Shift按下时触发，\_OnKeyTransition是在VK\_TAB, VK\_RETURN, VK\_END, VK\_HOME, VK\_LEFT, VK\_UP, VK\_RIGHT, VK\_DOWN这些按键的其中一个按下时触发。并不是每个交互式工具都需要按键功能，根据情况而定。我们上边提到的框选和划选就是在\_OnModifierKeyTransition函数中通过Alt键来切换的