SELECTION Class Reference

#include <selection.h>

Inheritance diagram for SELECTION:

Public Types
using	ITER = std::deque< EDA_ITEM * >::iterator
using	CITER = std::deque< EDA_ITEM * >::const_iterator

Public Member Functions
	SELECTION ()
	SELECTION (const SELECTION &aOther)
SELECTION &	operator= (const SELECTION &aOther)
bool	operator== (const SELECTION &aOther)
ITER	begin ()
ITER	end ()
CITER	begin () const
CITER	end () const
void	SetIsHover (bool aIsHover)
bool	IsHover () const
virtual void	Add (EDA_ITEM *aItem)
virtual void	Remove (EDA_ITEM *aItem)
virtual void	Clear () override
	Remove all the stored items from the group. More...
virtual unsigned int	GetSize () const override
	Return the number of stored items. More...
virtual KIGFX::VIEW_ITEM *	GetItem (unsigned int aIdx) const override
bool	Contains (EDA_ITEM *aItem) const
bool	Empty () const
	Checks if there is anything selected. More...
int	Size () const
	Returns the number of selected parts. More...
const std::deque< EDA_ITEM * >	GetItems () const
EDA_ITEM *	GetLastAddedItem () const
const std::vector< EDA_ITEM * >	GetItemsSortedByTypeAndXY (bool leftBeforeRight=true, bool topBeforeBottom=true) const
	Returns a copy of this selection of items sorted by their X then Y position. More...
const std::vector< EDA_ITEM * >	GetItemsSortedBySelectionOrder () const
virtual VECTOR2I	GetCenter () const
	Returns the center point of the selection area bounding box. More...
virtual const BOX2I	ViewBBox () const override
	Return the bounding box for all stored items covering all its layers. More...
VECTOR2I	GetPosition () const
	Returns the top left point of the selection area bounding box. More...
virtual BOX2I	GetBoundingBox () const
virtual EDA_ITEM *	GetTopLeftItem (bool onlyModules=false) const
EDA_ITEM *	operator[] (const size_t aIdx) const
EDA_ITEM *	Front () const
std::deque< EDA_ITEM * > &	Items ()
const std::deque< EDA_ITEM * > &	Items () const
template<class T >
T *	FirstOfKind () const
bool	HasType (KICAD_T aType) const
	Checks if there is at least one item of requested kind. More...
size_t	CountType (KICAD_T aType) const
virtual const std::vector< KIGFX::VIEW_ITEM * >	updateDrawList () const override
bool	HasReferencePoint () const
VECTOR2I	GetReferencePoint () const
void	SetReferencePoint (const VECTOR2I &aP)
void	ClearReferencePoint ()
bool	AreAllItemsIdentical () const
	Checks if all items in the selection are the same KICAD_T type. More...
bool	OnlyContains (std::vector< KICAD_T > aList) const
	Checks if all items in the selection have a type in aList. More...
virtual void	Add (VIEW_ITEM *aItem)
	Add an item to the group. More...
virtual void	Remove (VIEW_ITEM *aItem)
	Remove an item from the group. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const override
	Draw all the stored items in the group on the given layer. More...
virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return all the layers used by the stored items. More...
virtual void	SetLayer (int aLayer)
	Set layer used to draw the group. More...
void	FreeItems ()
	Free all the items that were added to the group. More...
virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	SetForcedTransparency (double aForcedTransparency)
double	GetForcedTransparency () const
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)
template<typename T >
bool	Set (const wxString &aProperty, T aValue)
wxAny	Get (PROPERTY_BASE *aProperty) const
template<typename T >
T	Get (PROPERTY_BASE *aProperty) const
template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

Protected Attributes
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
int	m_layer
std::vector< VIEW_ITEM * >	m_groupItems

Private Attributes
VIEW_ITEM_DATA *	m_viewPrivData
double	m_forcedTransparency
	Additional transparency for diff'ing items. More...

Detailed Description

Definition at line 37 of file selection.h.

Member Typedef Documentation

CITER

using SELECTION::CITER = std::deque<EDA_ITEM*>::const_iterator

Definition at line 71 of file selection.h.

ITER

using SELECTION::ITER = std::deque<EDA_ITEM*>::iterator

Definition at line 70 of file selection.h.

Constructor & Destructor Documentation

SELECTION() [1/2]

SELECTION::SELECTION ( )

inline

Definition at line 40 of file selection.h.

References m_isHover, m_lastAddedItem, and m_orderCounter.

SELECTION() [2/2]

SELECTION::SELECTION ( const SELECTION &  aOther )

inline

Definition at line 48 of file selection.h.

References m_isHover, m_items, m_itemsOrders, m_lastAddedItem, and m_orderCounter.

Member Function Documentation

Add() [1/2]

void SELECTION::Add ( EDA_ITEM *  aItem )

virtual

Definition at line 42 of file selection.cpp.

References m_items, m_itemsOrders, m_lastAddedItem, and m_orderCounter.

Referenced by EE_GRID_HELPER::BestSnapAnchor(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), ARRAY_CREATOR::Invoke(), SCH_MOVE_TOOL::Main(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_EDIT_TOOL::RepeatDrawItem(), and GERBVIEW_SELECTION_TOOL::select().

Add() [2/2]

void VIEW_GROUP::Add ( VIEW_ITEM *  aItem )

virtualinherited

Add an item to the group.

Definition at line 57 of file view_group.cpp.

References KIGFX::VIEW_GROUP::m_groupItems.

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::AddItem(), PNS_PCBNEW_DEBUG_DECORATOR::AddShape(), PNS_KICAD_IFACE::DisplayItem(), PNS_KICAD_IFACE::DisplayPathLine(), PNS_KICAD_IFACE::DisplayRatline(), PCB_TOOL_BASE::doInteractiveItemPlacement(), and PCB_SELECTION_TOOL::EnterGroup().

AreAllItemsIdentical()

bool SELECTION::AreAllItemsIdentical

(

)

const

Checks if all items in the selection are the same KICAD_T type.

Returns

True if all items are the same type, this includes zero or single items

Definition at line 181 of file selection.cpp.

References m_items.

begin() [1/2]

ITER SELECTION::begin ( )

inline

Definition at line 73 of file selection.h.

References m_items.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), and GetCurrentSelection().

begin() [2/2]

CITER SELECTION::begin ( ) const

inline

Definition at line 75 of file selection.h.

References m_items.

Clear()

virtual void SELECTION::Clear ( )

inlineoverridevirtual

Remove all the stored items from the group.

Reimplemented from KIGFX::VIEW_GROUP.

Definition at line 92 of file selection.h.

References m_items, m_itemsOrders, and m_orderCounter.

Referenced by GERBVIEW_SELECTION_TOOL::clearSelection(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), EE_SELECTION_TOOL::EE_SELECTION_TOOL(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), DRAWING_TOOL::PlaceImportedGraphics(), EE_SELECTION_TOOL::RebuildSelection(), PL_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::Reset(), and GERBVIEW_SELECTION_TOOL::Reset().

ClearReferencePoint()

void SELECTION::ClearReferencePoint ( )

inline

Definition at line 265 of file selection.h.

Referenced by PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), PL_EDIT_TOOL::Main(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EDIT_TOOL::Rotate(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and EE_SELECTION_TOOL::selectPoint().

Contains()

bool SELECTION::Contains

(

EDA_ITEM *

aItem

)

const

Definition at line 84 of file selection.cpp.

References m_items.

Referenced by EDIT_TOOL::FilletTracks(), PCB_EDIT_FRAME::RebuildAndRefresh(), and PCB_SELECTION_TOOL::select().

CountType()

size_t SELECTION::CountType

(

KICAD_T

aType

)

const

Definition at line 156 of file selection.cpp.

References m_items.

Referenced by EDIT_TOOL::Remove().

Empty()

bool SELECTION::Empty ( ) const

inline

Checks if there is anything selected.

Definition at line 109 of file selection.h.

References m_items.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeSymbols(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EE_INSPECTION_TOOL::DiffSymbol(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SELECTION_CONDITIONS::Empty(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), SELECTION_CONDITIONS::hasTypeFunc(), SELECTION_CONDITIONS::hasTypesFunc(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::onlyTypesFunc(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), PROPERTIES_PANEL::rebuildProperties(), GROUP_TOOL::RemoveFromGroup(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EDIT_TOOL::Rotate(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_CONDITIONS::sameNetFunc(), CLIPBOARD_IO::SaveSelection(), EE_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectCursor(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), SCH_EDIT_TOOL::SetAttribute(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_EDIT_TOOL::ToggleAttribute(), GROUP_TOOL::Ungroup(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_EDIT_TOOL::UnsetAttribute(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), PCB_CONTROL::UpdateMessagePanel(), and EDIT_TOOL::updateModificationPoint().

end() [1/2]

ITER SELECTION::end ( )

inline

Definition at line 74 of file selection.h.

References m_items.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), and GetCurrentSelection().

end() [2/2]

CITER SELECTION::end ( ) const

inline

Definition at line 76 of file selection.h.

References m_items.

FirstOfKind()

template<class T >

T * SELECTION::FirstOfKind ( ) const

inline

Definition at line 224 of file selection.h.

Referenced by BOARD_EDITOR_CONTROL::EditFpInFpEditor(), and GLOBAL_EDIT_TOOL::ExchangeFootprints().

FreeItems()

void VIEW_GROUP::FreeItems ( )

inherited

Free all the items that were added to the group.

Definition at line 191 of file view_group.cpp.

References KIGFX::VIEW_GROUP::Clear(), KIGFX::VIEW_GROUP::GetItem(), and KIGFX::VIEW_GROUP::GetSize().

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::Clear(), PNS_KICAD_IFACE::EraseView(), PNS_KICAD_IFACE::SetView(), and PNS_KICAD_IFACE::~PNS_KICAD_IFACE().

Front()

EDA_ITEM * SELECTION::Front ( ) const

inline

Definition at line 208 of file selection.h.

Referenced by PCB_POINT_EDITOR::addCornerCondition(), SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::CleanupSheetPins(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), CONVERT_TOOL::CreatePolys(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), EE_INSPECTION_TOOL::DiffSymbol(), PL_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::EditPageNumber(), EDIT_TOOL::Flip(), GERBVIEW_SELECTION::GetCenter(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), PROPERTIES_PANEL::rebuildProperties(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), CLIPBOARD_IO::SaveSelection(), EE_SELECTION_TOOL::SelectConnection(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_SELECTION_TOOL::selectSameSheet(), EE_INSPECTION_TOOL::ShowDatasheet(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), and GERBVIEW_SELECTION::ViewBBox().

Get() [1/3]

template<typename T >

std::optional< T > INSPECTABLE::Get ( const wxString &  aProperty ) const

inlineinherited

Definition at line 104 of file inspectable.h.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), and PCB_EXPR_VAR_REF::GetValue().

Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

GetBoundingBox()

BOX2I SELECTION::GetBoundingBox ( ) const

virtual

Reimplemented in EE_SELECTION.

Definition at line 133 of file selection.cpp.

References m_items, and BOX2< Vec >::Merge().

Referenced by PCB_SELECTION_TOOL::doSyncSelection(), EDIT_TOOL::MoveExact(), and PCB_SELECTION_TOOL::zoomFitSelection().

GetCenter()

VECTOR2I SELECTION::GetCenter ( ) const

virtual

Returns the center point of the selection area bounding box.

Reimplemented in GERBVIEW_SELECTION.

Definition at line 93 of file selection.cpp.

References m_items, BOX2< Vec >::Merge(), SCH_LABEL_LOCATE_ANY_T, and SCH_TEXT_T.

Referenced by EDIT_TOOL::Flip(), ARRAY_CREATOR::Invoke(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and EDIT_TOOL::updateModificationPoint().

GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 150 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and EDA_ITEM::operator=().

GetItem()

KIGFX::VIEW_ITEM * SELECTION::GetItem ( unsigned int  aIdx ) const

overridevirtual

Reimplemented from KIGFX::VIEW_GROUP.

Definition at line 75 of file selection.cpp.

References m_items.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), BOARD_INSPECTION_TOOL::DiffFootprint(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Flip(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PCB_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EE_SELECTION_TOOL::RequestSelection(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires().

GetItems()

const std::deque< EDA_ITEM * > SELECTION::GetItems ( ) const

inline

Definition at line 120 of file selection.h.

References m_items.

Referenced by PL_EDIT_TOOL::Copy(), ZONE_CREATE_HELPER::createNewZone(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_EDIT_FRAME::RebuildAndRefresh(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectUnconnected(), and PCB_SELECTION_TOOL::unrouteSelected().

GetItemsSortedBySelectionOrder()

const std::vector< EDA_ITEM * > SELECTION::GetItemsSortedBySelectionOrder

(

)

const

Definition at line 201 of file selection.cpp.

References m_items, and m_itemsOrders.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::RouteSelected(), and SCH_EDIT_TOOL::Swap().

GetItemsSortedByTypeAndXY()

const std::vector< EDA_ITEM * > SELECTION::GetItemsSortedByTypeAndXY ( bool  leftBeforeRight = true, bool  topBeforeBottom = true  ) const

inline

Returns a copy of this selection of items sorted by their X then Y position.

Returns

Vector of sorted items

Definition at line 135 of file selection.h.

References m_items.

Referenced by SCH_MOVE_TOOL::Main().

GetLastAddedItem()

EDA_ITEM * SELECTION::GetLastAddedItem ( ) const

inline

Definition at line 125 of file selection.h.

References m_lastAddedItem.

Referenced by BOARD_EDITOR_CONTROL::doCrossProbePcbToSch().

GetPosition()

VECTOR2I SELECTION::GetPosition ( ) const

inline

Returns the top left point of the selection area bounding box.

Definition at line 188 of file selection.h.

GetReferencePoint()

VECTOR2I SELECTION::GetReferencePoint ( ) const

inline

Definition at line 252 of file selection.h.

Referenced by EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), and CLIPBOARD_IO::SaveSelection().

GetSize()

virtual unsigned int SELECTION::GetSize ( ) const

inlineoverridevirtual

Return the number of stored items.

Reimplemented from KIGFX::VIEW_GROUP.

Definition at line 99 of file selection.h.

References m_items.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), EDIT_TOOL::DeleteItems(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditPageNumber(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FindItem(), EDIT_TOOL::Flip(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::RepeatDrawItem(), EE_SELECTION_TOOL::RequestSelection(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), EE_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), SCH_DRAWING_TOOLS::TwoClickPlace(), and PCB_CONTROL::UpdateMessagePanel().

GetTopLeftItem()

virtual EDA_ITEM * SELECTION::GetTopLeftItem ( bool  onlyModules = false ) const

inlinevirtual

Reimplemented in PCB_SELECTION, EE_SELECTION, and PL_SELECTION.

Definition at line 195 of file selection.h.

HasReferencePoint()

bool SELECTION::HasReferencePoint ( ) const

inline

Definition at line 247 of file selection.h.

Referenced by EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), SCH_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), CLIPBOARD_IO::SaveSelection(), EDIT_TOOL::updateModificationPoint(), and PL_EDIT_TOOL::updateModificationPoint().

HasType()

bool SELECTION::HasType

(

KICAD_T

aType

)

const

Checks if there is at least one item of requested kind.

Parameters

aType

is the type to check for.

Returns

True if there is at least one item of such kind.

Definition at line 144 of file selection.cpp.

References m_items.

Referenced by POSITION_RELATIVE_TOOL::PositionRelative(), and EDIT_TOOL::Remove().

IsHover()

bool SELECTION::IsHover ( ) const

inline

Definition at line 83 of file selection.h.

References m_isHover.

Referenced by SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::AutoplaceFields(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), EDIT_TOOL::Flip(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

Items() [1/2]

std::deque< EDA_ITEM * > & SELECTION::Items ( )

inline

Definition at line 213 of file selection.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), PCB_SELECTION_CONDITIONS::HasLockedItems(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), SCH_EDITOR_CONTROL::Paste(), POSITION_RELATIVE_TOOL::PositionRelative(), and SCH_EDIT_TOOL::Properties().

Items() [2/2]

const std::deque< EDA_ITEM * > & SELECTION::Items ( ) const

inline

Definition at line 218 of file selection.h.

OnlyContains()

bool SELECTION::OnlyContains

(

std::vector< KICAD_T >

aList

)

const

Checks if all items in the selection have a type in aList.

Returns

False if any item in the selection has a type not included in aList

Definition at line 191 of file selection.cpp.

References m_items.

Referenced by EE_GRID_HELPER::BestDragOrigin().

operator=()

SELECTION & SELECTION::operator= ( const SELECTION &  aOther )

inline

Definition at line 58 of file selection.h.

References m_isHover, m_items, m_itemsOrders, m_lastAddedItem, and m_orderCounter.

operator==()

bool SELECTION::operator==

(

const SELECTION &

aOther

)

Definition at line 32 of file selection.cpp.

References m_isHover, m_items, m_itemsOrders, m_lastAddedItem, and m_orderCounter.

operator[]()

EDA_ITEM * SELECTION::operator[] ( const size_t  aIdx ) const

inline

Definition at line 200 of file selection.h.

Remove() [1/2]

void SELECTION::Remove ( EDA_ITEM *  aItem )

virtual

Definition at line 60 of file selection.cpp.

References m_items, m_itemsOrders, and m_lastAddedItem.

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::PlaceImportedGraphics(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselect().

Remove() [2/2]

void VIEW_GROUP::Remove ( VIEW_ITEM *  aItem )

virtualinherited

Remove an item from the group.

Definition at line 63 of file view_group.cpp.

References alg::delete_matching(), and KIGFX::VIEW_GROUP::m_groupItems.

Set() [1/3]

template<typename T >

bool INSPECTABLE::Set ( const wxString &  aProperty, T  aValue  )

inlineinherited

Definition at line 66 of file inspectable.h.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [2/3]

template<typename T >

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, T  aValue  )

inlineinherited

Definition at line 54 of file inspectable.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [3/3]

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, wxAny &  aValue  )

inlineinherited

Definition at line 42 of file inspectable.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double  aForcedTransparency )

inlineinherited

Definition at line 145 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

SetIsHover()

void SELECTION::SetIsHover ( bool  aIsHover )

inline

Definition at line 78 of file selection.h.

References m_isHover.

Referenced by SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), PL_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::selectMultiple(), and PCB_SELECTION_TOOL::selectMultiple().

SetLayer()

virtual void KIGFX::VIEW_GROUP::SetLayer ( int  aLayer )

inlinevirtualinherited

Set layer used to draw the group.

Definition at line 98 of file view_group.h.

References KIGFX::VIEW_GROUP::m_layer.

Referenced by SELECTION_TOOL::doSelectionMenu(), PNS_PCBNEW_DEBUG_DECORATOR::SetView(), and PNS_KICAD_IFACE::SetView().

SetReferencePoint()

void SELECTION::SetReferencePoint ( const VECTOR2I &  aP )

inline

Definition at line 260 of file selection.h.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Rotate(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), and EE_SELECTION_TOOL::updateReferencePoint().

Size()

int SELECTION::Size ( ) const

inline

Returns the number of selected parts.

Definition at line 115 of file selection.h.

References m_items.

Referenced by PCB_POINT_EDITOR::addCornerCondition(), EE_GRID_HELPER::BestDragOrigin(), ROUTER_TOOL::CanInlineDrag(), PAD_TOOL::copyPadSettings(), SELECTION_CONDITIONS::countFunc(), BOARD_INSPECTION_TOOL::DiffFootprint(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), PL_EDIT_TOOL::DoDelete(), PCB_SELECTION_TOOL::doSyncSelection(), EDIT_TOOL::DragArcTrack(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), PAD_TOOL::EditPad(), EDIT_TOOL::FilletTracks(), GERBVIEW_SELECTION::GetCenter(), DRAWING_TOOL::getSourceZoneForAction(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), SELECTION_CONDITIONS::lessThanFunc(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SELECTION_CONDITIONS::moreThanFunc(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::placeBoardItems(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), PROPERTIES_PANEL::rebuildProperties(), ROUTER_TOOL::RouteSelected(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), SCH_EDIT_TOOL::Swap(), EE_SELECTION_TOOL::SyncSelection(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), EE_SELECTION_TOOL::updateReferencePoint(), GERBVIEW_SELECTION::ViewBBox(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

updateDrawList()

const std::vector< KIGFX::VIEW_ITEM * > SELECTION::updateDrawList ( ) const

overridevirtual

Reimplemented from KIGFX::VIEW_GROUP.

Reimplemented in EE_SELECTION, and PCB_SELECTION.

Definition at line 170 of file selection.cpp.

References m_items.

ViewBBox()

virtual const BOX2I SELECTION::ViewBBox ( ) const

inlineoverridevirtual

Return the bounding box for all stored items covering all its layers.

Reimplemented from KIGFX::VIEW_GROUP.

Reimplemented in GERBVIEW_SELECTION.

Definition at line 180 of file selection.h.

References BOX2< Vec >::SetMaximum().

ViewDraw()

void VIEW_GROUP::ViewDraw ( int  aLayer, VIEW *  aView  ) const

overridevirtualinherited

Draw all the stored items in the group on the given layer.

Parameters

aLayer	is the layer which should be drawn.
aView	is the VIEW that should be used for drawing.

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 107 of file view_group.cpp.

References KIGFX::GAL::AdvanceDepth(), KIGFX::PAINTER::Draw(), KIGFX::VIEW::GetGAL(), KIGFX::VIEW::GetPainter(), KIGFX::VIEW::IsLayerVisible(), IsZoneFillLayer(), LAYER_ID_COUNT, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_PADS_TH, LAYER_SELECT_OVERLAY, LAYER_ZONE_START, KIGFX::VIEW_GROUP::m_layer, KIGFX::GAL::PopDepth(), KIGFX::GAL::PushDepth(), KIGFX::VIEW::SortLayers(), KIGFX::VIEW_GROUP::updateDrawList(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

ViewGetLayers()

void VIEW_GROUP::ViewGetLayers ( int  aLayers[], int &  aCount  ) const

overridevirtualinherited

Return all the layers used by the stored items.

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Implements KIGFX::VIEW_ITEM.

Definition at line 183 of file view_group.cpp.

References KIGFX::VIEW_GROUP::m_layer.

ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Return the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns

the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 134 of file view_item.h.

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Definition at line 140 of file view_item.h.

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Member Data Documentation

m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 159 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), and KIGFX::VIEW_ITEM::SetForcedTransparency().

m_groupItems

std::vector<VIEW_ITEM*> KIGFX::VIEW_GROUP::m_groupItems

protectedinherited

Definition at line 113 of file view_group.h.

Referenced by KIGFX::VIEW_GROUP::Add(), KIGFX::VIEW_GROUP::Clear(), KIGFX::VIEW_GROUP::GetItem(), KIGFX::VIEW_GROUP::GetSize(), KIGFX::VIEW_GROUP::Remove(), KIGFX::VIEW_GROUP::updateDrawList(), and KIGFX::VIEW_GROUP::ViewBBox().

m_isHover

bool SELECTION::m_isHover

protected

Definition at line 289 of file selection.h.

Referenced by IsHover(), operator=(), operator==(), SELECTION(), and SetIsHover().

m_items

std::deque<EDA_ITEM*> SELECTION::m_items

protected

Definition at line 285 of file selection.h.

Referenced by Add(), AreAllItemsIdentical(), begin(), Clear(), Contains(), CountType(), Empty(), end(), GetBoundingBox(), EE_SELECTION::GetBoundingBox(), GetCenter(), GERBVIEW_SELECTION::GetCenter(), GetItem(), GetItems(), GetItemsSortedBySelectionOrder(), GetItemsSortedByTypeAndXY(), PCB_SELECTION::GetSelectionLayers(), GetSize(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), PL_SELECTION::GetTopLeftItem(), HasType(), OnlyContains(), operator=(), operator==(), Remove(), SELECTION(), Size(), EE_SELECTION::updateDrawList(), updateDrawList(), PCB_SELECTION::updateDrawList(), and GERBVIEW_SELECTION::ViewBBox().

m_itemsOrders

std::deque<int> SELECTION::m_itemsOrders

protected

Definition at line 286 of file selection.h.

Referenced by Add(), Clear(), GetItemsSortedBySelectionOrder(), operator=(), operator==(), Remove(), and SELECTION().

m_lastAddedItem

EDA_ITEM* SELECTION::m_lastAddedItem

protected

Definition at line 288 of file selection.h.

Referenced by Add(), GetLastAddedItem(), operator=(), operator==(), Remove(), and SELECTION().

m_layer

int KIGFX::VIEW_GROUP::m_layer

protectedinherited

Definition at line 112 of file view_group.h.

Referenced by KIGFX::VIEW_GROUP::SetLayer(), KIGFX::VIEW_GROUP::ViewDraw(), and KIGFX::VIEW_GROUP::ViewGetLayers().

m_orderCounter

int SELECTION::m_orderCounter

protected

Definition at line 287 of file selection.h.

Referenced by Add(), Clear(), operator=(), operator==(), and SELECTION().

m_referencePoint

std::optional<VECTOR2I> SELECTION::m_referencePoint

protected

Definition at line 284 of file selection.h.

m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 158 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

---

The documentation for this class was generated from the following files:

• selection.h
• selection.cpp