selection_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) 2013-2017 CERN
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 * Copyright (C) 2017-2020 KiCad Developers, see CHANGELOG.TXT for contributors.
 *
 * 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 __SELECTION_TOOL_H
#define __SELECTION_TOOL_H

#include <memory>

#include <math/vector2d.h>
#include <project/board_project_settings.h>
#include <tool/action_menu.h>
#include <tool/tool_menu.h>
#include <tools/pcb_selection_conditions.h>
#include <tools/pcb_tool_base.h>
#include <tools/pcbnew_selection.h>

class PCB_BASE_FRAME;
class BOARD_ITEM;
class GENERAL_COLLECTOR;

namespace KIGFX
{
    class GAL;
}


typedef void (*CLIENT_SELECTION_FILTER)( const VECTOR2I&, GENERAL_COLLECTOR&, SELECTION_TOOL* );


class SELECTION_TOOL : public PCB_TOOL_BASE
{
public:
    SELECTION_TOOL();
    ~SELECTION_TOOL();

    bool Init() override;

    void Reset( RESET_REASON aReason ) override;

    int Main( const TOOL_EVENT& aEvent );

    PCBNEW_SELECTION& GetSelection();

    PCBNEW_SELECTION& RequestSelection( CLIENT_SELECTION_FILTER aClientFilter,
            std::vector<BOARD_ITEM*>* aFiltered = nullptr, bool aConfirmLockedItems = false );

    SELECTION_LOCK_FLAGS CheckLock();

    int CursorSelection( const TOOL_EVENT& aEvent );

    int ClearSelection( const TOOL_EVENT& aEvent );
    void ClearSelection( bool aQuietMode = false );

    int SelectItem( const TOOL_EVENT& aEvent );
    void AddItemToSel( BOARD_ITEM* aItem, bool aQuietMode = false );

    int SelectAll( const TOOL_EVENT& aEvent );

    int SelectItems( const TOOL_EVENT& aEvent );

    int UnselectItem( const TOOL_EVENT& aEvent );
    void RemoveItemFromSel( BOARD_ITEM* aItem, bool aQuietMode = false );

    int UnselectItems( const TOOL_EVENT& aEvent );

    void BrightenItem( BOARD_ITEM* aItem );
    void UnbrightenItem( BOARD_ITEM* aItem );

    void select( BOARD_ITEM* aItem );

    bool Selectable( const BOARD_ITEM* aItem, bool checkVisibilityOnly = false ) const;

    void GuessSelectionCandidates( GENERAL_COLLECTOR& aCollector, const VECTOR2I& aWhere ) const;

    int SelectionMenu( const TOOL_EVENT& aEvent );

    void RebuildSelection();

    SELECTION_FILTER_OPTIONS& GetFilter()
    {
        return m_filter;
    }

    void setTransitions() override;

    void zoomFitSelection();

    BOARD* GetBoard() const
    {
        return board();
    }

    void EnterGroup();

    void ExitGroup( bool aSelectGroup = false );

    void FilterCollectorForGroups( GENERAL_COLLECTOR& aCollector ) const;

    PCB_GROUP* GetEnteredGroup() { return m_enteredGroup; }

    void FilterCollectedItems( GENERAL_COLLECTOR& aCollector );

private:

    bool selectPoint( const VECTOR2I& aWhere, bool aOnDrag = false,
                      bool* aSelectionCancelledFlag = NULL,
                      CLIENT_SELECTION_FILTER aClientFilter = NULL );

    bool selectCursor( bool aForceSelect = false,
                       CLIENT_SELECTION_FILTER aClientFilter = NULL );

    bool selectMultiple();

    bool doSelectionMenu( GENERAL_COLLECTOR* aItems, const wxString& aTitle );

    int expandConnection( const TOOL_EVENT& aEvent );

    int selectNet( const TOOL_EVENT& aEvent );

    enum STOP_CONDITION
    {
        STOP_AT_JUNCTION,
        STOP_AT_PAD,
        STOP_NEVER
    };

    void selectConnectedTracks( BOARD_CONNECTED_ITEM& aSourceItem, STOP_CONDITION aStopCondition );

    void selectAllItemsOnNet( int aNetCode, bool aSelect = true );

    void selectAllItemsOnSheet( wxString& aSheetPath );

    int selectSheetContents( const TOOL_EVENT& aEvent );

    int selectSameSheet( const TOOL_EVENT& aEvent );

    void findCallback( BOARD_ITEM* aItem );

    int find( const TOOL_EVENT& aEvent );

    int filterSelection( const TOOL_EVENT& aEvent );

    bool itemPassesFilter( BOARD_ITEM* aItem );

    BOARD_ITEM* pickSmallestComponent( GENERAL_COLLECTOR* aCollector );

    void unselect( BOARD_ITEM* aItem );

    void highlight( BOARD_ITEM* aItem, int aHighlightMode, PCBNEW_SELECTION* aGroup = nullptr );

    void unhighlight( BOARD_ITEM* aItem, int aHighlightMode, PCBNEW_SELECTION* aGroup = nullptr );

    bool selectionContains( const VECTOR2I& aPoint ) const;

    int updateSelection( const TOOL_EVENT& aEvent );

    int UpdateMenu( const TOOL_EVENT& aEvent );

    const GENERAL_COLLECTORS_GUIDE getCollectorsGuide() const;

private:
    void highlightInternal( BOARD_ITEM* aItem, int aHighlightMode, PCBNEW_SELECTION* aSelectionViewGroup,
        bool isChild);

    void unhighlightInternal( BOARD_ITEM* aItem, int aHighlightMode, PCBNEW_SELECTION* aSelectionViewGroup,
        bool isChild);

    PCB_BASE_FRAME*  m_frame;     // Pointer to the parent frame
    PCBNEW_SELECTION m_selection; // Current state of selection

    SELECTION_FILTER_OPTIONS m_filter;

    bool m_additive;              // Items should be added to selection (instead of replacing)
    bool m_subtractive;           // Items should be removed from selection
    bool m_exclusive_or;          // Items' selection state should be toggled
    bool m_multiple;              // Multiple selection mode is active
    bool m_skip_heuristics;       // Heuristics are not allowed when choosing item under cursor
    bool m_locked;                // Other tools are not allowed to modify locked items

    PCB_GROUP*        m_enteredGroup;          // If non-null, selections are limited to
                                               // members of this group
    KIGFX::VIEW_GROUP m_enteredGroupOverlay;   // Overlay for the entered group's frame.


    class PRIV;
    std::unique_ptr<PRIV> m_priv;
};

#endif /* __SELECTION_TOOL_H */