工具框架

    int TOOL_NAME::someAction( const TOOL_EVENT& aEvent )
    {
        auto& frame = *getEditFrame<PCB_EDIT_FRAME>();

        // 设置工具提示和光标 (实际上看起来像十字准线)
        frame.SetToolID( ID_LOCAL_RATSNEST_BUTT,
                wxCURSOR_PENCIL, _( "Select item to move left" ) );
        getViewControls()->ShowCursor( true );

        // 激活该工具，现在它将是第一个接收事件的工具。
        // 如果您正在为单个操作 (例如放大) 编写处理程序，
        // 那么它将是第一个接收事件的工具，
        // 而不是需要更多事件才能操作 (例如拖动组件) 的交互式工具。

        Activate();

        // 主事件循环
        while( OPT_TOOL_EVENT evt = Wait() )
        {
            if( evt->IsCancel() || evt->IsActivate() )
            {
                // 交互式工具结束
                break;
            }
            else if( evt->IsClick( BUT_LEFT ) )
            {
                // 在这里做点什么
            }
            // 其他事件...
        }

        // 将印刷电路板框架重置为我们拿到它时的状态
        frame.SetToolID( ID_NO_TOOL_SELECTED, wxCURSOR_DEFAULT, wxEmptyString );
        getViewControls()->ShowCursor( false );

        return 0;
    }

class TOOL_NAME: public PCB_TOOL
{
public:
    TOOL_NAME() :
        PCB_TOOL( "pcbnew.MyNewTool" ),
        m_menu( *this )
    {}

private:
    TOOL_MENU m_menu;
}

class USELESS_TOOL : public PCB_TOOL
{
public:
    USELESS_TOOL();
    ~USELESS_TOOL();

    ///> 对模型/视图更改做出反应
    void Reset( RESET_REASON aReason ) override;

    ///> 基本初始化
    bool Init() override;

    ///> 将处理程序绑定到相应的 TOOL_ACTIONs
    void setTransitions() override;

private:
    ///> “向左移动选定项” 交互式工具
    int moveLeft( const TOOL_EVENT& aEvent );

    ///> 执行左移操作的内部函数
    void moveLeftInt();

    ///> 添加固定大小的圆
    int fixedCircle( const TOOL_EVENT& aEvent );

    ///> 该工具显示的菜单模型。
    TOOL_MENU m_menu;
};

#include "useless_tool.h"

#include <class_draw_panel_gal.h>
#include <view/view_controls.h>
#include <view/view.h>
#include <tool/tool_manager.h>
#include <board_commit.h>

// 用于框架工具 ID 值
#include <pcbnew_id.h>

// 用于操作图标
#include <bitmaps.h>

// 项目工具可以作用于
#include <class_board_item.h>
#include <class_drawsegment.h>

// 访问其他 PCB 操作和工具
#include "pcb_actions.h"
#include "selection_tool.h"


/*
  * 特定于工具的操作定义
  */
TOOL_ACTION PCB_ACTIONS::uselessMoveItemLeft(
        "pcbnew.UselessTool.MoveItemLeft",
        AS_GLOBAL, MD_CTRL + MD_SHIFT + int( 'L' ),
        _( "将项目左移" ), _( "选择并向左移动项目" ) );

TOOL_ACTION PCB_ACTIONS::uselessFixedCircle(
        "pcbnew.UselessTool.FixedCircle",
        AS_GLOBAL, MD_CTRL + MD_SHIFT + int( 'C' ),
        _( "固定圆" ), _( "在固定位置添加固定大小的圆" ),
        add_circle_xpm );

/*
  * USELESS_TOOL 实现
  */

USELESS_TOOL::USELESS_TOOL() :
        PCB_TOOL( "pcbnew.UselessTool" ),
        m_menu( *this )
{
}


USELESS_TOOL::~USELESS_TOOL()
{}


void USELESS_TOOL::Reset( RESET_REASON aReason )
{
}


bool USELESS_TOOL::Init()
{
    auto& menu = m_menu.GetMenu();

    // 添加我们自己工具的操作
    menu.AddItem( PCB_ACTIONS::uselessFixedCircle );
    // 添加 PCB_EDITOR_CONTROL's 的区域取消填充所有操作
    menu.AddItem( PCB_ACTIONS::zoneUnfillAll );

    // 添加标准缩放和栅格工具动作
    m_menu.AddStandardSubMenus( *getEditFrame<PCB_BASE_FRAME>() );

    return true;
}

void USELESS_TOOL::moveLeftInt()
{
    // 我们将调用选择工具上的操作来获取当前选择。
    // 选择工具将处理项目的歧义消除
    PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
    assert( selectionTool );

    // 调用操作
    m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
    m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true );
    selectionTool->SanitizeSelection();

    const SELECTION& selection = selectionTool->GetSelection();

    // 未选择任何内容，返回到事件循环
    if( selection.Empty() )
        return;

    BOARD_COMMIT commit( this );

    // 迭代 BOARD_ITEM* 容器，移动每个项目
    for( auto item : selection )
    {
        commit.Modify( item );
        item->Move( wxPoint( -5 * IU_PER_MM, 0 ) );
    }

    // push commit - 如果选择为空，则这是无操作
    commit.Push( "Move left" );
}

int USELESS_TOOL::moveLeft( const TOOL_EVENT& aEvent )
{
    auto& frame = *getEditFrame<PCB_EDIT_FRAME>();

    // 设置工具提示和光标 (实际上看起来像十字准线)
    frame.SetToolID( ID_NO_TOOL_SELECTED,
            wxCURSOR_PENCIL, _( "选择要向左移动的项目" ) );

    getViewControls()->ShowCursor( true );

    Activate();

    // 只要工具处于活动状态，就处理工具事件
    while( OPT_TOOL_EVENT evt = Wait() )
    {
        if( evt->IsCancel() || evt->IsActivate() )
        {
            // 交互式工具结束
            break;
        }
        else if( evt->IsClick( BUT_RIGHT ) )
        {
            m_menu.ShowContextMenu();
        }
        else if( evt->IsClick( BUT_LEFT ) )
        {
            // 调用主操作逻辑
            moveLeftInt();

            // 保持显示编辑光标
            getViewControls()->ShowCursor( true );
        }
    }

    // 将 PCB 框架重置为我们得到的原样
    frame.SetToolID( ID_NO_TOOL_SELECTED, wxCURSOR_DEFAULT, wxEmptyString );
    getViewControls()->ShowCursor( false );

    // 退出操作
    return 0;
}


int USELESS_TOOL::fixedCircle( const TOOL_EVENT& aEvent )
{
    // 要添加的新圆 (理想情况下使用智能指针)
    PCB_SHAPE* circle = new PCB_SHAPE;

    // 设置圆形属性
    circle->SetShape( S_CIRCLE );
    circle->SetWidth( 5 * IU_PER_MM );
    circle->SetStart( wxPoint( 50 * IU_PER_MM, 50 * IU_PER_MM ) );
    circle->SetEnd( wxPoint( 80 * IU_PER_MM, 80 * IU_PER_MM ) );
    circle->SetLayer(  LAYER_ID::F_SilkS );

    // 把圆形交到 BOARD 上
    BOARD_COMMIT commit( this );
    commit.Add( circle );
    commit.Push( _( "画一个圆形" ) );

    return 0;
}


void USELESS_TOOL::setTransitions()
{
    Go( &USELESS_TOOL::fixedCircle, PCB_ACTIONS::uselessFixedCircle.MakeEvent() );
    Go( &USELESS_TOOL::moveLeft,    PCB_ACTIONS::uselessMoveItemLeft.MakeEvent() );
}