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) const
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.
virtual unsigned int	GetSize () const override
	Return the number of stored items.
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.
int	Size () const
	Returns the number of selected parts.
const std::deque< EDA_ITEM * >	GetItems () const
EDA_ITEM *	GetLastAddedItem () 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.
std::vector< EDA_ITEM * >	GetItemsSortedBySelectionOrder () const
virtual VECTOR2I	GetCenter () const
	Returns the center point of the selection area bounding box.
virtual const BOX2I	ViewBBox () const override
	Return the bounding box for all stored items covering all its layers.
VECTOR2I	GetPosition () const
	Returns the top left point of the selection area bounding box.
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.
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.
bool	OnlyContains (std::vector< KICAD_T > aList) const
	Checks if all items in the selection have a type in aList.
virtual void	Add (VIEW_ITEM *aItem)
	Add an item to the group.
virtual void	Remove (VIEW_ITEM *aItem)
	Remove an item from the group.
virtual void	ViewDraw (int aLayer, VIEW *aView) const override
	Draw all the stored items in the group on the given layer.
std::vector< int >	ViewGetLayers () const override
	Return the all the layers within the VIEW the object is painted on.
virtual void	SetLayer (int aLayer)
	Set layer used to draw the group.
void	FreeItems ()
	Free all the items that were added to the group.
bool	IsSCH_ITEM () const
bool	IsBOARD_ITEM () const
virtual double	ViewGetLOD (int aLayer, const VIEW *aView) const
	Return the level of detail (LOD) of the item.
VIEW_ITEM_DATA *	viewPrivData () const
void	SetForcedTransparency (double aForcedTransparency)
double	GetForcedTransparency () const
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue, bool aNotify=true)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue, bool aNotify=true)
template<typename T >
bool	Set (const wxString &aProperty, T aValue, bool aNotify=true)
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

Static Protected Member Functions
static double	lodScaleForThreshold (const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
	Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

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

Static Protected Attributes
static constexpr double	LOD_HIDE = std::numeric_limits<double>::max()
	Return this constant from ViewGetLOD() to hide the item unconditionally.
static constexpr double	LOD_SHOW = 0.0
	Return this constant from ViewGetLOD() to show the item unconditionally.

Private Attributes
bool	m_isSCH_ITEM
bool	m_isBOARD_ITEM
VIEW_ITEM_DATA *	m_viewPrivData
double	m_forcedTransparency
	Additional transparency for diff'ing items.

Detailed Description

Definition at line 38 of file selection.h.

Member Typedef Documentation

CITER

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

Definition at line 72 of file selection.h.

ITER

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

Definition at line 71 of file selection.h.

Constructor & Destructor Documentation

SELECTION() [1/2]

SELECTION::SELECTION ( )

inline

Definition at line 41 of file selection.h.

References m_isHover, m_lastAddedItem, and m_orderCounter.

SELECTION() [2/2]

SELECTION::SELECTION ( const SELECTION &  aOther )

inline

Definition at line 49 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_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), PCB_TEST_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), PCB_CONTROL::InteractiveDelete(), ARRAY_TOOL::onDialogClosed(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceTuningPattern(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), GERBVIEW_SELECTION_TOOL::select(), and PCB_POINT_EDITOR::updateItem().

Add() [2/2]

void VIEW_GROUP::Add ( VIEW_ITEM *  aItem )

virtualinherited

Add an item to the group.

Definition at line 58 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(), SCH_SELECTION_TOOL::EnterGroup(), 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 201 of file selection.cpp.

References m_items.

begin() [1/2]

ITER SELECTION::begin ( )

inline

Definition at line 74 of file selection.h.

References m_items.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), GetCurrentSelection(), and DIALOG_EXPORT_STEP::onExportButton().

begin() [2/2]

CITER SELECTION::begin ( ) const

inline

Definition at line 76 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 93 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::drawOneBezier(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceTuningPattern(), SCH_SELECTION_TOOL::RebuildSelection(), PL_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), SCH_SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_SELECTION_TOOL::SCH_SELECTION_TOOL(), PCB_TEST_SELECTION_TOOL::selectPoint(), and SYMBOL_EDITOR_EDIT_TOOL::Undo().

ClearReferencePoint()

void SELECTION::ClearReferencePoint

(

)

Definition at line 184 of file selection.cpp.

References m_referencePoint.

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

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 155 of file selection.cpp.

References m_items.

Referenced by ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::Duplicate(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_SELECTION_TOOL::Main(), EDIT_TOOL::Remove(), and SCH_EDIT_TOOL::Swap().

Empty()

bool SELECTION::Empty ( ) const

inline

Checks if there is anything selected.

Definition at line 110 of file selection.h.

References m_items.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeSymbols(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), PCB_TEST_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), SCH_INSPECTION_TOOL::DiffSymbol(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doAddRowBelow(), COMMON_TOOLS::doCenter(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doDeleteColumns(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doDeleteRows(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doMergeCells(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::doUnmergeCells(), COMMON_TOOLS::doZoomFit(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SELECTION_CONDITIONS::Empty(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), SELECTION_CONDITIONS::hasTypeFunc(), SELECTION_CONDITIONS::hasTypesFunc(), SCH_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), SCH_DESIGN_BLOCK_CONTROL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), SCH_SELECTION_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(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), 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(), SCH_SELECTION_TOOL::RequestSelection(), EDIT_TOOL::Rotate(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_CONDITIONS::sameNetFunc(), CLIPBOARD_IO::SaveSelection(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectCursor(), PCB_PICKER_TOOL::SelectItemInteractively(), SCH_INSPECTION_TOOL::ShowDatasheet(), GROUP_TOOL::Ungroup(), GERBVIEW_SELECTION_TOOL::unselect(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), PCB_CONTROL::UpdateMessagePanel(), and EDIT_TOOL::updateModificationPoint().

end() [1/2]

ITER SELECTION::end ( )

inline

Definition at line 75 of file selection.h.

References m_items.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), GetCurrentSelection(), and DIALOG_EXPORT_STEP::onExportButton().

end() [2/2]

CITER SELECTION::end ( ) const

inline

Definition at line 77 of file selection.h.

References m_items.

FirstOfKind()

template<class T >

T * SELECTION::FirstOfKind ( ) const

inline

Definition at line 188 of file selection.h.

References m_items, and T.

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 211 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(), PCB_POINT_EDITOR::OnSelectionChange(), DRAWING_TOOL::PlaceTuningPattern(), PNS_KICAD_IFACE::SetView(), PCB_POINT_EDITOR::updateItem(), and PNS_KICAD_IFACE::~PNS_KICAD_IFACE().

Front()

EDA_ITEM * SELECTION::Front ( ) const

inline

Definition at line 172 of file selection.h.

References m_items.

Referenced by SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::CleanupSheetPins(), PL_SELECTION_TOOL::ClearSelection(), PCB_TEST_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), CONVERT_TOOL::CreatePolys(), SCH_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), SCH_INSPECTION_TOOL::DiffSymbol(), PL_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), EDIT_TOOL::DragArcTrack(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::EditPageNumber(), SCH_LINE_WIRE_BUS_TOOL::getBusForUnfolding(), GERBVIEW_SELECTION::GetCenter(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), EE_GRID_HELPER::GetSelectionGrid(), GRID_HELPER::GetSelectionGrid(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_EDIT_TOOL::JustifyText(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), 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(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_PICKER_TOOL::SelectItemInteractively(), SCH_SELECTION_TOOL::SelectNext(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::selectSameSheet(), SCH_INSPECTION_TOOL::ShowDatasheet(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), SCH_DRAWING_TOOLS::SyncSheetsPins(), 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 120 of file inspectable.h.

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

Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 100 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(), PROPERTIES_PANEL::getItemValue(), PCBEXPR_VAR_REF::GetValue(), and SCHEMATIC::SCHEMATIC().

Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 108 of file inspectable.h.

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

GetBoundingBox()

BOX2I SELECTION::GetBoundingBox ( ) const

virtual

Reimplemented in SCH_SELECTION, and PCB_SELECTION.

Definition at line 132 of file selection.cpp.

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

Referenced by COMMON_TOOLS::doCenter(), COMMON_TOOLS::doZoomFit(), GetPosition(), and GetReferencePoint().

GetCenter()

VECTOR2I SELECTION::GetCenter ( ) const

virtual

Returns the center point of the selection area bounding box.

Reimplemented in GERBVIEW_SELECTION.

Definition at line 92 of file selection.cpp.

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

Referenced by EDIT_TOOL::Flip(), 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 165 of file view_item.h.

Referenced by KIGFX::SCH_PAINTER::draw(), EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), 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(), EDIT_TOOL::Flip(), SCH_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_LEGACY::Format(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), SCH_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_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 121 of file selection.h.

References m_items.

Referenced by PL_EDIT_TOOL::Copy(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), 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(), ROUTER_TOOL::InlineDrag(), PCB_EDIT_FRAME::RebuildAndRefresh(), SCH_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectUnconnected(), PCB_SELECTION_TOOL::unrouteSegment(), and PCB_SELECTION_TOOL::unrouteSelected().

GetItemsSortedBySelectionOrder()

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

(

)

const

Definition at line 263 of file selection.cpp.

References m_items, and m_itemsOrders.

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

GetItemsSortedByTypeAndXY()

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

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

Returns

std::vector of sorted items

Definition at line 221 of file selection.cpp.

References m_items.

Referenced by SCH_MOVE_TOOL::doMoveSelection(), and PCB_SELECTION_TOOL::unrouteSegment().

GetLastAddedItem()

EDA_ITEM * SELECTION::GetLastAddedItem ( ) const

inline

Definition at line 126 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 152 of file selection.h.

References GetBoundingBox(), and BOX2< Vec >::GetPosition().

GetReferencePoint()

VECTOR2I SELECTION::GetReferencePoint

(

)

const

Definition at line 169 of file selection.cpp.

References BOX2< Vec >::Centre(), GetBoundingBox(), and m_referencePoint.

Referenced by EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), SCH_DRAWING_TOOLS::ImportSheet(), 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 100 of file selection.h.

References m_items.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), PL_SELECTION_TOOL::ClearSelection(), PCB_TEST_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), SCH_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), EDIT_TOOL::DeleteItems(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditPageNumber(), SCH_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PCB_SELECTION_TOOL::FindItem(), EDIT_TOOL::Flip(), SCH_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_LEGACY::Format(), SCH_EDIT_TOOL::JustifyText(), SCH_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SELECTION_TOOL::RequestSelection(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), SCH_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, SCH_SELECTION, and PL_SELECTION.

Definition at line 159 of file selection.h.

HasReferencePoint()

bool SELECTION::HasReferencePoint ( ) const

inline

Definition at line 211 of file selection.h.

References m_referencePoint.

Referenced by EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), 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 143 of file selection.cpp.

References m_items.

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

IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 102 of file view_item.h.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GRID_HELPER::BestSnapAnchor(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), PCB_BASE_FRAME::FocusOnItem(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), KIGFX::PCB_VIEW::Remove(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EDIT_TOOL::Swap(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::UnselectAll(), KIGFX::PCB_VIEW::Update(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

IsHover()

bool SELECTION::IsHover ( ) const

inline

Definition at line 84 of file selection.h.

References m_isHover.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeSymbols(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::copyToClipboardAsText(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDIT_TOOL::EditPageNumber(), SCH_EDIT_TABLE_TOOL::EditTable(), PCB_EDIT_TABLE_TOOL::EditTable(), EDIT_TOOL::Flip(), SCH_EDIT_TOOL::Increment(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), 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(), SCH_EDIT_TOOL::SetAttribute(), SCH_EDIT_TOOL::Swap(), and SYMBOL_EDITOR_EDIT_TOOL::Swap().

IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 101 of file view_item.h.

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and KIGFX::SCH_VIEW::Update().

Items() [1/2]

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

inline

Definition at line 177 of file selection.h.

References m_items.

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TABLE_TOOL::EditTable(), PCB_EDIT_TABLE_TOOL::EditTable(), PCB_SELECTION_CONDITIONS::HasLockedItems(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), ROUTER_TOOL::restoreSelection(), PCB_TEST_SELECTION_TOOL::selectPoint(), and EDIT_TOOL::updateModificationPoint().

Items() [2/2]

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

inline

Definition at line 182 of file selection.h.

References m_items.

lodScaleForThreshold()

double VIEW_ITEM::lodScaleForThreshold ( const KIGFX::VIEW *  aView, int  aWhatIu, int  aThresholdIu  )

staticprotectedinherited

Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

This is useful when a level-of-detail is defined in terms of a threshold size (i.e. 'only draw X when it will be bigger than Y size on screen').

E.g. if aWhatIu is 1000 and aThresholdIu is 100, then the item will be the same size as the threshold at 0.1 scale. Returning that 0.1 as the LoD will hide the item when the scale is less than 0.1 - i.e. smaller than the threshold.

Because even at zoom 1.0, 1mm in KiCad may not be exactly 1mm on a physical screen, the threshold may not be exact in practice.

Definition at line 39 of file view_item.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::RENDER_SETTINGS::IsPrinting(), KIGFX::VIEW_ITEM::LOD_HIDE, and KIGFX::VIEW_ITEM::LOD_SHOW.

Referenced by SCH_LINE::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), PAD::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

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 211 of file selection.cpp.

References m_items.

Referenced by SCH_EDIT_TOOL::Swap().

operator=()

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

inline

Definition at line 59 of file selection.h.

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

operator==()

bool SELECTION::operator==

(

const SELECTION &

aOther

)

const

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 164 of file selection.h.

References m_items.

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::drawOneBezier(), SCH_GROUP_TOOL::Group(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), SCH_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 64 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, bool  aNotify = true  )

inlineinherited

Definition at line 77 of file inspectable.h.

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

Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 60 of file inspectable.h.

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

Set() [3/3]

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

inlineinherited

Definition at line 43 of file inspectable.h.

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

Referenced by SCH_PROPERTIES_PANEL::valueChanged(), and PCB_PROPERTIES_PANEL::valueChanged().

SetForcedTransparency()

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

inlineinherited

Definition at line 160 of file view_item.h.

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 79 of file selection.h.

References m_isHover.

Referenced by SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), PL_SELECTION_TOOL::ClearSelection(), PCB_TEST_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), PL_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::ReselectItem(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectTableCells(), and SCH_SELECTION_TOOL::selectTableCells().

SetLayer()

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

inlinevirtualinherited

Set layer used to draw the group.

Definition at line 94 of file view_group.h.

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

SetReferencePoint()

void SELECTION::SetReferencePoint

(

const VECTOR2I &

aP

)

Definition at line 178 of file selection.cpp.

References m_referencePoint.

Referenced by EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::DrawTable(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), API_HANDLER_PCB::handleInteractiveMoveItems(), 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 SCH_SELECTION_TOOL::updateReferencePoint().

Size()

int SELECTION::Size ( ) const

inline

Returns the number of selected parts.

Definition at line 116 of file selection.h.

References m_items.

Referenced by ROUTER_TOOL::CanInlineDrag(), PAD_TOOL::copyPadSettings(), SELECTION_CONDITIONS::countFunc(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), 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(), SELECTION_CONDITIONS::lessThanFunc(), SCH_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SELECTION_CONDITIONS::moreThanFunc(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::placeBoardItems(), PCB_CONTROL::PlaceLinkedDesignBlock(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), PROPERTIES_PANEL::rebuildProperties(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), CLIPBOARD_IO::SaveSelection(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_CONTROL::SaveToLinkedDesignBlock(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PCB_SELECTION_TOOL::selectNet(), SCH_SELECTION_TOOL::SelectNext(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), SCH_SELECTION_TOOL::SyncSelection(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), SCH_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 SCH_SELECTION, and PCB_SELECTION.

Definition at line 190 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 144 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 108 of file view_group.cpp.

References KIGFX::GAL::AdvanceDepth(), KIGFX::PAINTER::Draw(), KIGFX::VIEW::GetGAL(), KIGFX::VIEW::GetPainter(), IsClearanceLayer(), KIGFX::VIEW::IsHiddenOnOverlay(), KIGFX::VIEW::IsLayerVisible(), IsPadCopperLayer(), IsViaCopperLayer(), IsZoneFillLayer(), LAYER_CLEARANCE_START, KIGFX::GAL_SCOPED_ATTRS::LAYER_DEPTH, LAYER_ID_COUNT, LAYER_PAD_COPPER_START, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_SELECT_OVERLAY, LAYER_VIA_COPPER_START, LAYER_ZONE_START, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_GROUP::m_layer, KIGFX::VIEW::SortLayers(), and KIGFX::VIEW_GROUP::updateDrawList().

ViewGetLayers()

std::vector< int > VIEW_GROUP::ViewGetLayers ( ) const

overridevirtualinherited

Implements KIGFX::VIEW_ITEM.

Definition at line 204 of file view_group.cpp.

References KIGFX::VIEW_GROUP::m_layer.

ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer, const 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.

Use LOD_HIDE and LOD_SHOW constants to hide or show the item unconditionally.

Use lodScaleForThreshold() to calculate the LOD scale for when the item passes a certain threshold size on screen.

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 shows the item, because the actual zoom level (or VIEW scale) is always > 0

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

Definition at line 149 of file view_item.h.

Referenced by PCB_GRID_HELPER::computeAnchors(), 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 155 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsHiddenOnOverlay(), KIGFX::VIEW::IsVisible(), 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

LOD_HIDE

constexpr double KIGFX::VIEW_ITEM::LOD_HIDE = std::numeric_limits<double>::max()

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to hide the item unconditionally.

Definition at line 174 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and ZONE::ViewGetLOD().

LOD_SHOW

constexpr double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to show the item unconditionally.

Definition at line 179 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::lodScaleForThreshold(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and ZONE::ViewGetLOD().

m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 204 of file view_item.h.

Referenced by KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()().

m_groupItems

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

protectedinherited

Definition at line 109 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_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 202 of file view_item.h.

m_isHover

bool SELECTION::m_isHover

protected

Definition at line 239 of file selection.h.

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

m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 201 of file view_item.h.

m_items

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

protected

Definition at line 235 of file selection.h.

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

m_itemsOrders

std::deque<int> SELECTION::m_itemsOrders

protected

Definition at line 236 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 238 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 108 of file view_group.h.

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

m_orderCounter

int SELECTION::m_orderCounter

protected

Definition at line 237 of file selection.h.

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

m_referencePoint

std::optional<VECTOR2I> SELECTION::m_referencePoint

protected

Definition at line 234 of file selection.h.

Referenced by ClearReferencePoint(), GetReferencePoint(), HasReferencePoint(), and SetReferencePoint().

m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 203 of file view_item.h.

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

---

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

• selection.h
• selection.cpp