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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCB_PICKER_TOOL_H
#define PCB_PICKER_TOOL_H
 
#include <layer_ids.h>
#include <set>
#include <snap/snap_resolver.h>
#include <tool/picker_tool.h>
#include <tools/pcb_selection_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( const LSET& aLayerSet ) { m_layerMask = aLayerSet; }
 
    int SelectPointInteractively( const TOOL_EVENT& aEvent );
    int SelectItemInteractively( const TOOL_EVENT& aEvent );

    inline void SetAreaPreviewHandler( PCB_SELECTION_TOOL::AREA_PREVIEW aHandler )
    {
        m_areaPreviewHandler = aHandler;
    }

    inline void SetConstructionGeometry( bool aEnable ) { m_constructionGeometry = aEnable; }

    inline void SetSuppressedSnaps( std::set<SNAP_CANDIDATE_SUBTYPE> aSubtypes )
    {
        m_suppressedSnaps = std::move( aSubtypes );
    }

    inline void ClearHandlers()
    {
        m_areaPreviewHandler = nullptr;
        PICKER_TOOL_BASE::ClearHandlers();
    }
 
protected:
    void setTransitions() override;

    void setControls();

    void reset() override;
 
private:
    LSET                              m_layerMask;
 
    PCB_SELECTION_TOOL::AREA_PREVIEW  m_areaPreviewHandler;
 
    bool                              m_constructionGeometry = true;
 
    std::set<SNAP_CANDIDATE_SUBTYPE>  m_suppressedSnaps;
};
 
#endif /* PCB_PICKER_TOOL_H */