pcb_picker_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 CERN
 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef PCB_PICKER_TOOL_H
#define PCB_PICKER_TOOL_H
 
#include <layer_ids.h>
#include <tool/picker_tool.h>
#include <tools/pcb_tool_base.h>
 
class PCB_PICKER_TOOL : public PCB_TOOL_BASE, public PICKER_TOOL_BASE
{
public:
    class RECEIVER
    {
    public:
        virtual void UpdatePickedPoint( const std::optional<VECTOR2I>& aPoint ) = 0;
        virtual void UpdatePickedItem( const EDA_ITEM* aItem ) = 0;
 
    protected:
        ~RECEIVER() = default;
    };
 
    struct INTERACTIVE_PARAMS
    {
        RECEIVER* m_Receiver = nullptr;
        wxString  m_Prompt;
        std::function<bool(EDA_ITEM*)> m_ItemFilter = nullptr;
    };
 
    PCB_PICKER_TOOL();
    virtual ~PCB_PICKER_TOOL() = default;
 
    bool Init() override;
 
    int Main( const TOOL_EVENT& aEvent );
 
    inline void SetLayerSet( LSET aLayerSet ) { m_layerMask = aLayerSet; }
 
    int SelectPointInteractively( const TOOL_EVENT& aEvent );
    int SelectItemInteractively( const TOOL_EVENT& aEvent );
 
protected:
    void setTransitions() override;
 
    void setControls();
 
    void reset() override;
 
private:
    LSET                  m_layerMask;
};
 
#endif /* PCB_PICKER_TOOL_H */