ee_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 (C) 2019-2021 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, 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 KICAD_SCH_SELECTION_TOOL_H
#define KICAD_SCH_SELECTION_TOOL_H

#include <tool/selection_tool.h>
#include <tool/action_menu.h>
#include <tool/tool_menu.h>
#include <tools/ee_selection.h>
#include <ee_collectors.h>
#include <sch_symbol.h>
#include <gal/cursors.h>

class SCH_BASE_FRAME;
class SCH_ITEM;

namespace KIGFX
{
 class GAL;
}


class EE_CONDITIONS : public SELECTION_CONDITIONS
{
public:
 static SELECTION_CONDITION SingleSymbol;
 static SELECTION_CONDITION SingleSymbolOrPower;
 static SELECTION_CONDITION SingleDeMorganSymbol;
 static SELECTION_CONDITION SingleMultiUnitSymbol;
 static SELECTION_CONDITION SingleNonExcludedMarker;
};


class EE_SELECTION_TOOL : public SELECTION_TOOL, public TOOL_INTERACTIVE
{
public:
 EE_SELECTION_TOOL();
 ~EE_SELECTION_TOOL();

 bool Init() override;

 void Reset( RESET_REASON aReason ) override;

 int UpdateMenu( const TOOL_EVENT& aEvent );

 int Main( const TOOL_EVENT& aEvent );

 void OnIdle( wxIdleEvent& aEvent );

 EE_SELECTION& GetSelection();

 EE_SELECTION& RequestSelection( const KICAD_T* aFilterList = EE_COLLECTOR::AllItems );

 bool SelectPoint( const VECTOR2I& aWhere, const KICAD_T* aFilterList = EE_COLLECTOR::AllItems,
 EDA_ITEM** aItem = nullptr, bool* aSelectionCancelledFlag = nullptr,
 bool aCheckLocked = false, bool aAdd = false, bool aSubtract = false,
 bool aExclusiveOr = false );

 int AddItemToSel( const TOOL_EVENT& aEvent );
 void AddItemToSel( EDA_ITEM* aItem, bool aQuietMode = false );
 int AddItemsToSel( const TOOL_EVENT& aEvent );
 void AddItemsToSel( EDA_ITEMS* aList, bool aQuietMode = false );

 int RemoveItemFromSel( const TOOL_EVENT& aEvent );
 void RemoveItemFromSel( EDA_ITEM* aItem, bool aQuietMode = false );
 int RemoveItemsFromSel( const TOOL_EVENT& aEvent );
 void RemoveItemsFromSel( EDA_ITEMS* aList, bool aQuietMode = false );

 void RemoveItemsFromSel( std::vector<KIID>* aList, bool aQuietMode = false );

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

 void SelectHighlightItem( EDA_ITEM* aItem ) { highlight( aItem, SELECTED ); }

 EDA_ITEM* GetNode( VECTOR2I aPosition );

 int SelectNode( const TOOL_EVENT& aEvent );

 int SelectConnection( const TOOL_EVENT& aEvent );

 int ClearSelection( const TOOL_EVENT& aEvent );

 int SelectAll( const TOOL_EVENT& aEvent );

 void ClearSelection();

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

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

 int SelectionMenu( const TOOL_EVENT& aEvent );

 void RebuildSelection();

 bool CollectHits( EE_COLLECTOR& aCollector, const VECTOR2I& aWhere,
 const KICAD_T* aFilterList = EE_COLLECTOR::AllItems );

private:
 void narrowSelection( EE_COLLECTOR& collector, const VECTOR2I& aWhere, bool aCheckLocked, bool aSelectPoints );

 bool selectPoint( EE_COLLECTOR& aCollector, EDA_ITEM** aItem = nullptr,
 bool* aSelectionCancelledFlag = nullptr, bool aAdd = false,
 bool aSubtract = false, bool aExclusiveOr = false );

 bool selectMultiple();

 bool doSelectionMenu( EE_COLLECTOR* aItems );

 void onDisambiguationExpire( wxTimerEvent& aEvent );

 int disambiguateCursor( const TOOL_EVENT& aEvent );

 void select( EDA_ITEM* aItem );

 void unselect( EDA_ITEM* aItem );

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

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

 void updateReferencePoint();

 bool selectionContains( const VECTOR2I& aPoint ) const;

 void setTransitions() override;

private:

 SCH_BASE_FRAME* m_frame; // Pointer to the parent frame
 EE_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_convert; // Fixed DeMorgan filter (for symbol editor)
};

#endif //KICAD_SCH_SELECTION_TOOL_H