sch_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) 2019 CERN
 * Copyright The KiCad Developers, see AUTHORS.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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef SCH_SELECTION_TOOL_H
#define SCH_SELECTION_TOOL_H
 
#include <project/sch_project_settings.h>
#include <tool/selection_tool.h>
#include <tool/action_menu.h>
#include <tool/tool_menu.h>
#include <tools/sch_selection.h>
#include <sch_collectors.h>
#include <sch_symbol.h>
#include <gal/cursors.h>
 
class SCH_BASE_FRAME;
class SCH_GROUP;
class SCH_ITEM;
class SCH_TABLE;
class EE_GRID_HELPER;
class SCH_TABLECELL;
 
namespace KIGFX
{
class GAL;
 
namespace PREVIEW
{
class SELECTION_AREA;
}
}
 
 
class SCH_CONDITIONS : public SELECTION_CONDITIONS
{
public:
    static SELECTION_CONDITION SingleSymbol;
    static SELECTION_CONDITION SingleSymbolOrPower;
    static SELECTION_CONDITION SingleMultiBodyStyleSymbol;
    static SELECTION_CONDITION SingleMultiUnitSymbol;
    static SELECTION_CONDITION SingleMultiFunctionPin;
    static SELECTION_CONDITION SingleNonExcludedMarker;
    static SELECTION_CONDITION MultipleSymbolsOrPower;
    static SELECTION_CONDITION AllPins;
    static SELECTION_CONDITION AllPinsOrSheetPins;
    static SELECTION_CONDITION HasLockedItems;
    static SELECTION_CONDITION HasUnlockedItems;
};
 
 
class SCH_SELECTION_TOOL : public SELECTION_TOOL
{
public:
    SCH_SELECTION_TOOL();
    ~SCH_SELECTION_TOOL();

    bool Init() override;

    void Reset( RESET_REASON aReason ) override;


    int Main( const TOOL_EVENT& aEvent );
 
    void OnIdle( wxIdleEvent& aEvent );

    void ZoomFitCrossProbeBBox( const BOX2I& aBBox );

    /**
     * Enter the group at the head of the current selection.
     */
    void EnterGroup() override;

    void ExitGroup( bool aSelectGroup = false ) override;


     */
    SCH_GROUP* GetEnteredGroup() { return m_enteredGroup; }

    SCH_SELECTION& GetSelection();


     *
     * @param aPromoteCellSelections [optional] If true, cell selections are promoted to their parent
     *
     * @param aPromoteGroups [optional] If true, group selections are promoted the items within the group
     */
    SCH_SELECTION& RequestSelection( const std::vector<KICAD_T>& aScanTypes = { SCH_LOCATE_ANY_T },
                                     bool aPromoteCellSelections = false,
                                     bool aPromoteGroups = false );


     * @param aItem [out, optional] The newly selected item if only one was selected, otherwise
     *              unchanged.
     * @param aSelectionCancelledFlag [out] Allows the function to inform its caller that a
     *                                selection was canceled (for instance, by clicking outside of
     *                                the disambiguation menu).
     * @param aCheckLocked Indicates if locked items should be excluded.
     * @param aAdd Indicates if found item(s) should be added to the selection.
     * @param aSubtract Indicates if found item(s) should be subtracted from the selection.
     * @param aExclusiveOr Indicates if found item(s) should be toggle in the selection.
     * @return true if the selection was modified.
     */
    bool SelectPoint( const VECTOR2I& aWhere, const std::vector<KICAD_T>& aScanTypes = { SCH_LOCATE_ANY_T },
                      EDA_ITEM** aItem = nullptr, bool* aSelectionCancelledFlag = nullptr, bool aCheckLocked = false,
                      bool aAdd = false, bool aSubtract = false, bool aExclusiveOr = false );

    /**
     * Finds a connected item at a point (usually the cursor position).  Iterative process with a
     * decreasing slop factor.
     * @param aPosition Cursor position from which the search should be made.
     * @return a connected item or nullptr.
     */
    EDA_ITEM* GetNode( const VECTOR2I& aPosition );


    int SelectNode( const TOOL_EVENT& aEvent );

    int SelectConnection( 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 );

    int SelectAll( const TOOL_EVENT& aEvent );

    int UnselectAll( const TOOL_EVENT& aEvent );

    int SelectNext( const TOOL_EVENT& aEvent );

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

    bool Selectable( const EDA_ITEM* aItem, const VECTOR2I* aPos = nullptr, bool checkVisibilityOnly = false ) const;

    void GuessSelectionCandidates( SCH_COLLECTOR& collector, const VECTOR2I& aPos );

    void RebuildSelection();

    bool CollectHits( SCH_COLLECTOR& aCollector, const VECTOR2I& aWhere,
                      const std::vector<KICAD_T>& aScanTypes = { SCH_LOCATE_ANY_T } );

    void SyncSelection( const std::optional<SCH_SHEET_PATH>& targetSheetPath, SCH_ITEM* focusItem,
                        const std::vector<SCH_ITEM*>& items );
 
    SCH_SELECTION_FILTER_OPTIONS& GetFilter() { return m_filter; }

    void FilterSelectionForLockedItems();
 
protected:
    SELECTION& selection() override { return m_selection; }
 
private:
    OPT_TOOL_EVENT autostartEvent( TOOL_EVENT* aEvent, EE_GRID_HELPER& aGrid, SCH_ITEM* aItem );
 
    enum class STOP_CONDITION
    {
        STOP_AT_JUNCTION,   
        STOP_AT_PIN,        
        STOP_NEVER          
    };
 
    std::set<SCH_ITEM*> expandConnectionWithGraph( const SCH_SELECTION& aItems,
                                                   STOP_CONDITION aStopCondition );
    std::set<SCH_ITEM*> expandConnectionGraphically( const SCH_SELECTION& aItems );

    void narrowSelection( SCH_COLLECTOR& collector, const VECTOR2I& aWhere, bool aCheckLocked,
                          bool aSelectedOnly = false,
                          SCH_SELECTION_FILTER_OPTIONS* aRejected = nullptr );

    bool selectPoint( SCH_COLLECTOR& aCollector, const VECTOR2I& aWhere, EDA_ITEM** aItem = nullptr,
                      bool* aSelectionCancelledFlag = nullptr, bool aAdd = false, bool aSubtract = false,
                      bool aExclusiveOr = false );

    bool selectMultiple();
 
    bool selectLasso();
 
    int SetSelectRect( const TOOL_EVENT& aEvent );
    int SetSelectPoly( const TOOL_EVENT& aEvent );
 
    void SelectMultiple( KIGFX::PREVIEW::SELECTION_AREA& aArea, bool aSubtractive = false,
                         bool aExclusiveOr = false );

    bool selectTableCells( SCH_TABLE* aTable );

    void InitializeSelectionState( SCH_TABLE* aTable );

    void SelectCellsBetween( const VECTOR2D& start, const VECTOR2D& end, SCH_TABLE* aTable );

    int disambiguateCursor( const TOOL_EVENT& aEvent );

    void select( EDA_ITEM* aItem ) override;

    void unselect( EDA_ITEM* aItem ) override;

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

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

    void updateReferencePoint();

    bool selectionContains( const VECTOR2I& aPoint ) const;

    int updateSelection( const TOOL_EVENT& aEvent );

    bool itemPassesFilter( EDA_ITEM* aItem, SCH_SELECTION_FILTER_OPTIONS* aRejected = nullptr );

    void filterCollectorForHierarchy( SCH_COLLECTOR& aCollector, bool aMultiselect ) const;
    void filterCollectedItems( SCH_COLLECTOR& aCollector, bool aMultiSelect );

    void setTransitions() override;
 
private:
    SCH_BASE_FRAME* m_frame;     // Pointer to the parent frame
    SCH_SELECTION   m_selection; // Current state of selection
 
    KICURSOR m_nonModifiedCursor; // Cursor in the absence of shift/ctrl/alt
 
    bool m_isSymbolEditor; // True when the symbol editor is the parent frame
    bool m_isSymbolViewer; // True when the symbol browser is the parent frame
    int  m_unit;           // Fixed unit filter (for symbol editor)
    int  m_bodyStyle;      // Fixed DeMorgan filter (for symbol editor)
 
    SCH_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.
 
    SCH_SELECTION_FILTER_OPTIONS m_filter;
 
    SELECTION_MODE m_selectionMode; // Current selection mode
 
    SCH_TABLECELL* m_previous_first_cell; // First selected cell for shift+click selection range
};
 
#endif //SCH_SELECTION_TOOL_H