pcb_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
 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @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_SELECTION_TOOL_H
#define PCB_SELECTION_TOOL_H
 
#include <functional>
#include <memory>
 
#include <tool/actions.h>
#include <math/vector2d.h>
#include <project/board_project_settings.h>
#include <preview_items/selection_area.h>
#include <tool/action_menu.h>
#include <tool/selection_tool.h>
#include <tool/tool_menu.h>
#include <tools/pcb_selection_conditions.h>
#include <tools/pcb_tool_base.h>
#include <tools/pcb_selection.h>
 
class PCB_BASE_FRAME;
class BOARD_ITEM;
class GENERAL_COLLECTOR;
class PCB_TABLE;
class PCB_TABLECELL;
 
namespace KIGFX
{
    class GAL;
}
 

class PCB_SELECTION_TOOL : public SELECTION_TOOL
{
public:
    using AREA_PREVIEW = std::function<void( KIGFX::PREVIEW::SELECTION_AREA& aArea )>;
 
    PCB_SELECTION_TOOL();
    ~PCB_SELECTION_TOOL();

    bool Init() override;

    void Reset( RESET_REASON aReason ) override;
 
    void OnIdle( wxIdleEvent& aEvent );
 
    bool IsFootprintEditor()
    {
        return m_isFootprintEditor;
    }

    int Main( const TOOL_EVENT& aEvent );

    PCB_SELECTION& GetSelection();

    PCB_SELECTION& RequestSelection( CLIENT_SELECTION_FILTER aClientFilter );

    int CursorSelection( const TOOL_EVENT& aEvent );
 
    int SelectColumns( const TOOL_EVENT& aEvent );
    int SelectRows( const TOOL_EVENT& aEvent );
    int SelectTable( const TOOL_EVENT& aEvent );

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

    int SelectAll( const TOOL_EVENT& aEvent );

    int UnselectAll( const TOOL_EVENT& aEvent );

    int SetSelectRect( const TOOL_EVENT& aEvent );
    int SetSelectPoly( const TOOL_EVENT& aEvent );

    int SelectRectArea( const TOOL_EVENT& aEvent );

    bool DragSelectionArea( TOOL_INTERACTIVE& aTool, AREA_PREVIEW aPreview = nullptr );

    int SelectPolyArea( const TOOL_EVENT& aEvent );

    std::vector<BOARD_ITEM*> CollectPoint( const VECTOR2I& aWhere,
                                           CLIENT_SELECTION_FILTER aClientFilter = nullptr );

    std::vector<BOARD_ITEM*> CollectMultiple( KIGFX::PREVIEW::SELECTION_AREA& aArea );

    void SelectMultiple( KIGFX::PREVIEW::SELECTION_AREA& aArea, bool aSubtractive = false,
                         bool aExclusiveOr = false );

    void FindItem( BOARD_ITEM* aItem );

    void select( EDA_ITEM* aItem ) override;

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

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

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

    void RebuildSelection();
 
    PCB_SELECTION_FILTER_OPTIONS& GetFilter()
    {
        return m_filter;
    }

    void setTransitions() override;

    void zoomFitSelection();

    void ZoomFitCrossProbeBBox( const BOX2I& bbox );

    void EnterGroup() override;

    void ExitGroup( bool aSelectGroup = false ) override;

    PCB_GROUP* GetEnteredGroup() { return m_enteredGroup; }
 
    PCB_LAYER_ID GetActiveLayer() { return m_frame->GetActiveLayer(); }
 
    enum STOP_CONDITION
    {
        STOP_AT_JUNCTION,
        STOP_AT_SEGMENT,
        STOP_AT_PAD,
        STOP_NEVER
    };

    void selectAllConnectedTracks( const std::vector<BOARD_CONNECTED_ITEM*>& aStartItems,
                                   STOP_CONDITION                            aStopCondition );

    void FilterCollectorForLockedItems( GENERAL_COLLECTOR& aCollector );

    static bool HasLockedDescendant( const BOARD_ITEM* aItem );

    static bool isWithinEnteredGroup( BOARD_ITEM* aItem, PCB_GROUP* aEnteredGroup, bool aIsFootprintEditor );

    bool ReportFilteredLockedItems();

    void FilterCollectorForHierarchy( GENERAL_COLLECTOR& aCollector, bool aMultiselect ) const;

    void FilterCollectorForFreePads( GENERAL_COLLECTOR& aCollector,
                                     bool aForcePromotion = false ) const;

    void FilterCollectorForTableCells( GENERAL_COLLECTOR& aCollector ) const;

    void FilterCollectorForMarkers( GENERAL_COLLECTOR& aCollector ) const;

    void FilterCollectedItems( GENERAL_COLLECTOR& aCollector, bool aMultiSelect,
                               PCB_SELECTION_FILTER_OPTIONS* aRejected = nullptr );

    void FilterCollectorForFootprints( GENERAL_COLLECTOR& aCollector,
                                       const VECTOR2I& aWhere ) const;
 
protected:
    KIGFX::PCB_VIEW* view() const
    {
        return static_cast<KIGFX::PCB_VIEW*>( getView() );
    }
 
    KIGFX::VIEW_CONTROLS* controls() const
    {
        return getViewControls();
    }
 
    PCB_BASE_FRAME* frame() const
    {
        return getEditFrame<PCB_BASE_FRAME>();
    }
 
    PCB_BASE_EDIT_FRAME* editFrame() const
    {
        return getEditFrame<PCB_BASE_EDIT_FRAME>();
    }
 
    BOARD* board() const
    {
        return getModel<BOARD>();
    }
 
    PCB_DRAW_PANEL_GAL* canvas() const
    {
        return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
    }
 
    virtual bool ctrlClickHighlights() override;
 
    SELECTION& selection() override { return m_selection; }
 
private:
    bool selectChartRow( const VECTOR2I& aPosition );

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

    struct POINT_COLLECT
    {
        bool                          m_OnDrag = false;        
        bool                          m_SelectedOnly = false;  
        PCB_SELECTION_FILTER_OPTIONS* m_Rejected = nullptr;    
        size_t                        m_PreFilterCount = 0;    
    };

    bool collectAtPoint( const VECTOR2I& aWhere, GENERAL_COLLECTOR& aCollector,
                         POINT_COLLECT& aOptions, CLIENT_SELECTION_FILTER aClientFilter );

    bool selectCursor( bool aForceSelect = false,
                       CLIENT_SELECTION_FILTER aClientFilter = nullptr );
 
    bool selectTableCells( PCB_TABLE* aTable );

    void initializeTableCellSelectionState( PCB_TABLE* aTable );

    void selectCellsBetween( const VECTOR2D& aStart, const VECTOR2D& aEnd, PCB_TABLE* aTable );

    bool extendTableCellSelectionTo( const VECTOR2I& aPosition );

    bool toggleTableCellSelection( const VECTOR2I& aPosition );

    void collectTableCellsAt( const VECTOR2I& aPosition, GENERAL_COLLECTOR& aCollector );

    PCB_TABLECELL* singleSelectedCell() const;

    int disambiguateCursor( const TOOL_EVENT& aEvent );

    int expandConnection( const TOOL_EVENT& aEvent );

    int unrouteSelected( const TOOL_EVENT& aEvent );

    int unrouteSegment( const TOOL_EVENT& aEvent );

    int selectNet( const TOOL_EVENT& aEvent );

    int selectNetChain( const TOOL_EVENT& aEvent );

    int selectUnconnected( const TOOL_EVENT& aEvent );

    int grabUnconnected( const TOOL_EVENT& aEvent );

    void selectAllConnectedShapes( const std::vector<PCB_SHAPE*>& aStartItems );

    bool isExpandableGraphicShape( const EDA_ITEM* aItem ) const;
 
    /*
     * Select tracks and vias connected to specified board items.
     */
    void selectConnections( const std::vector<BOARD_ITEM*>& aItems );

    void selectAllItemsOnSheet( wxString& aSheetPath );

    int selectSheetContents( const TOOL_EVENT& aEvent );

    int selectSameSheet( const TOOL_EVENT& aEvent );

    int  syncSelection( const TOOL_EVENT& aEvent );
    int  syncSelectionWithNets( const TOOL_EVENT& aEvent );
    void doSyncSelection( const std::vector<BOARD_ITEM*>& aItems, bool aWithNets );

    int filterSelection( const TOOL_EVENT& aEvent );

    bool itemPassesFilter( BOARD_ITEM* aItem, bool aMultiSelect,
                           PCB_SELECTION_FILTER_OPTIONS* aRejected = nullptr );

    void unselect( EDA_ITEM* aItem ) override;

    void highlight( EDA_ITEM* aItem, int aHighlightMode, SELECTION* aGroup = nullptr ) override;

    void unhighlight( EDA_ITEM* aItem, int aHighlightMode, SELECTION* aGroup = nullptr ) override;

    bool selectionContains( const VECTOR2I& aPoint ) const;

    int hitTestDistance( const VECTOR2I& aWhere, BOARD_ITEM* aItem, int aMaxDistance ) const;

    int updateSelection( const TOOL_EVENT& aEvent );
 
    void pruneObscuredSelectionCandidates( GENERAL_COLLECTOR& aCollector ) const;
 
    const GENERAL_COLLECTORS_GUIDE getCollectorsGuide() const;
 
private:
    void highlightInternal( EDA_ITEM* aItem, int aHighlightMode, bool aUsingOverlay );
 
    void unhighlightInternal( EDA_ITEM* aItem, int aHighlightMode, bool aUsingOverlay );
 
private:
    PCB_BASE_FRAME*          m_frame;                // Pointer to the parent frame
    bool                     m_isFootprintEditor;
 
    PCB_SELECTION            m_selection;            // Current state of selection
 
    PCB_SELECTION m_blockedSelection; // Empty selection returned when locked items
                                      // block an action, real selection stays intact
 
    PCB_SELECTION_FILTER_OPTIONS m_filter;
 
    KICURSOR                 m_nonModifiedCursor;    // Cursor in the absence of shift/ctrl/alt
 
    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.
 
    SELECTION_MODE           m_selectionMode;        // Current selection mode
 
    bool                     m_lockedItemsFiltered;
 
    // Anchor cell for shift+click range selection in a PCB_TABLE
    PCB_TABLECELL*           m_previousFirstCell;

    class PRIV;
    std::unique_ptr<PRIV>    m_priv;
};
 
#endif /* PCB_SELECTION_TOOL_H */