298 lines
8.1 KiB
C++
298 lines
8.1 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2013-2017 CERN
|
|
* Copyright (C) 2021-2022 KiCad Developers, see AUTHORS.txt for contributors.
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
*
|
|
* 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_H
|
|
#define SELECTION_H
|
|
|
|
#include <optional>
|
|
#include <core/typeinfo.h>
|
|
#include <deque>
|
|
#include <eda_item.h>
|
|
#include <view/view_group.h>
|
|
|
|
|
|
class SELECTION : public KIGFX::VIEW_GROUP
|
|
{
|
|
public:
|
|
SELECTION() :
|
|
KIGFX::VIEW_GROUP::VIEW_GROUP()
|
|
{
|
|
m_isHover = false;
|
|
m_lastAddedItem = nullptr;
|
|
m_orderCounter = 0;
|
|
}
|
|
|
|
SELECTION( const SELECTION& aOther ) :
|
|
KIGFX::VIEW_GROUP::VIEW_GROUP()
|
|
{
|
|
m_items = aOther.m_items;
|
|
m_itemsOrders = aOther.m_itemsOrders;
|
|
m_isHover = aOther.m_isHover;
|
|
m_lastAddedItem = aOther.m_lastAddedItem;
|
|
m_orderCounter = aOther.m_orderCounter;
|
|
}
|
|
|
|
SELECTION& operator= ( const SELECTION& aOther )
|
|
{
|
|
m_items = aOther.m_items;
|
|
m_itemsOrders = aOther.m_itemsOrders;
|
|
m_isHover = aOther.m_isHover;
|
|
m_lastAddedItem = aOther.m_lastAddedItem;
|
|
m_orderCounter = aOther.m_orderCounter;
|
|
return *this;
|
|
}
|
|
|
|
bool operator==( const SELECTION& aOther );
|
|
|
|
using ITER = std::deque<EDA_ITEM*>::iterator;
|
|
using CITER = std::deque<EDA_ITEM*>::const_iterator;
|
|
|
|
ITER begin() { return m_items.begin(); }
|
|
ITER end() { return m_items.end(); }
|
|
CITER begin() const { return m_items.cbegin(); }
|
|
CITER end() const { return m_items.cend(); }
|
|
|
|
void SetIsHover( bool aIsHover )
|
|
{
|
|
m_isHover = aIsHover;
|
|
}
|
|
|
|
bool IsHover() const
|
|
{
|
|
return m_isHover;
|
|
}
|
|
|
|
virtual void Add( EDA_ITEM* aItem );
|
|
|
|
virtual void Remove( EDA_ITEM *aItem );
|
|
|
|
virtual void Clear() override
|
|
{
|
|
m_items.clear();
|
|
m_itemsOrders.clear();
|
|
m_orderCounter = 0;
|
|
}
|
|
|
|
virtual unsigned int GetSize() const override
|
|
{
|
|
return m_items.size();
|
|
}
|
|
|
|
virtual KIGFX::VIEW_ITEM* GetItem( unsigned int aIdx ) const override;
|
|
|
|
bool Contains( EDA_ITEM* aItem ) const;
|
|
|
|
/// Checks if there is anything selected
|
|
bool Empty() const
|
|
{
|
|
return m_items.empty();
|
|
}
|
|
|
|
/// Returns the number of selected parts
|
|
int Size() const
|
|
{
|
|
return m_items.size();
|
|
}
|
|
|
|
const std::deque<EDA_ITEM*> GetItems() const
|
|
{
|
|
return m_items;
|
|
}
|
|
|
|
EDA_ITEM* GetLastAddedItem() const
|
|
{
|
|
return m_lastAddedItem;
|
|
}
|
|
|
|
/**
|
|
* Returns a copy of this selection of items sorted by their X then Y position.
|
|
*
|
|
* @return Vector of sorted items
|
|
*/
|
|
const std::vector<EDA_ITEM*> GetItemsSortedByTypeAndXY( bool leftBeforeRight = true,
|
|
bool topBeforeBottom = true ) const
|
|
{
|
|
std::vector<EDA_ITEM*> sorted_items = std::vector<EDA_ITEM*>( m_items.begin(),
|
|
m_items.end() );
|
|
|
|
std::sort( sorted_items.begin(), sorted_items.end(),
|
|
[&]( EDA_ITEM* a, EDA_ITEM* b )
|
|
{
|
|
if( a->Type() == b->Type() )
|
|
{
|
|
if( a->GetSortPosition().x == b->GetSortPosition().x )
|
|
{
|
|
// Ensure deterministic sort
|
|
if( a->GetSortPosition().y == b->GetSortPosition().y )
|
|
return a->m_Uuid < b->m_Uuid;
|
|
|
|
if( topBeforeBottom )
|
|
return a->GetSortPosition().y < b->GetSortPosition().y;
|
|
else
|
|
return a->GetSortPosition().y > b->GetSortPosition().y;
|
|
}
|
|
else if( leftBeforeRight )
|
|
{
|
|
return a->GetSortPosition().x < b->GetSortPosition().x;
|
|
}
|
|
else
|
|
{
|
|
return a->GetSortPosition().x > b->GetSortPosition().x;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return a->Type() < b->Type();
|
|
}
|
|
} );
|
|
|
|
return sorted_items;
|
|
}
|
|
|
|
const std::vector<EDA_ITEM*> GetItemsSortedBySelectionOrder() const;
|
|
|
|
/// Returns the center point of the selection area bounding box.
|
|
virtual VECTOR2I GetCenter() const;
|
|
|
|
virtual const BOX2I ViewBBox() const override
|
|
{
|
|
BOX2I r;
|
|
r.SetMaximum();
|
|
return r;
|
|
}
|
|
|
|
/// Returns the top left point of the selection area bounding box.
|
|
VECTOR2I GetPosition() const
|
|
{
|
|
return GetBoundingBox().GetPosition();
|
|
}
|
|
|
|
virtual BOX2I GetBoundingBox() const;
|
|
|
|
virtual EDA_ITEM* GetTopLeftItem( bool onlyModules = false ) const
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
EDA_ITEM* operator[]( const size_t aIdx ) const
|
|
{
|
|
if( aIdx < m_items.size() )
|
|
return m_items[ aIdx ];
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
EDA_ITEM* Front() const
|
|
{
|
|
return m_items.size() ? m_items.front() : nullptr;
|
|
}
|
|
|
|
std::deque<EDA_ITEM*>& Items()
|
|
{
|
|
return m_items;
|
|
}
|
|
|
|
const std::deque<EDA_ITEM*>& Items() const
|
|
{
|
|
return m_items;
|
|
}
|
|
|
|
template<class T>
|
|
T* FirstOfKind() const
|
|
{
|
|
for( auto item : m_items )
|
|
{
|
|
if( IsA<T, EDA_ITEM>( item ) )
|
|
return static_cast<T*> ( item );
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
/**
|
|
* Checks if there is at least one item of requested kind.
|
|
*
|
|
* @param aType is the type to check for.
|
|
* @return True if there is at least one item of such kind.
|
|
*/
|
|
bool HasType( KICAD_T aType ) const;
|
|
|
|
size_t CountType( KICAD_T aType ) const;
|
|
|
|
virtual const std::vector<KIGFX::VIEW_ITEM*> updateDrawList() const override;
|
|
|
|
bool HasReferencePoint() const
|
|
{
|
|
return m_referencePoint != std::nullopt;
|
|
}
|
|
|
|
VECTOR2I GetReferencePoint() const
|
|
{
|
|
if( m_referencePoint )
|
|
return *m_referencePoint;
|
|
else
|
|
return GetBoundingBox().Centre();
|
|
}
|
|
|
|
void SetReferencePoint( const VECTOR2I& aP )
|
|
{
|
|
m_referencePoint = aP;
|
|
}
|
|
|
|
void ClearReferencePoint()
|
|
{
|
|
m_referencePoint = std::nullopt;
|
|
}
|
|
|
|
/**
|
|
* Checks if all items in the selection are the same KICAD_T type
|
|
*
|
|
* @return True if all items are the same type, this includes zero or single items
|
|
*/
|
|
bool AreAllItemsIdentical() const;
|
|
|
|
/**
|
|
* Checks if all items in the selection have a type in aList
|
|
* @return False if any item in the selection has a type not included in aList
|
|
*/
|
|
bool OnlyContains( std::vector<KICAD_T> aList ) const;
|
|
|
|
protected:
|
|
std::optional<VECTOR2I> m_referencePoint;
|
|
std::deque<EDA_ITEM*> m_items;
|
|
std::deque<int> m_itemsOrders;
|
|
int m_orderCounter;
|
|
EDA_ITEM* m_lastAddedItem;
|
|
bool m_isHover;
|
|
|
|
// mute hidden overloaded virtual function warnings
|
|
using VIEW_GROUP::Add;
|
|
using VIEW_GROUP::Remove;
|
|
};
|
|
|
|
|
|
#endif
|