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)
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
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 EDA_RECT	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 ()
template<class T >
T *	FirstOfKind () const
bool	HasType (KICAD_T aType) const
	Checks if there is at least one item of requested kind. More...
virtual const VIEW_GROUP::ITEMS	updateDrawList () const override
	Layer on which the group is drawn. More...
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...
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	ClearViewPrivData ()
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)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

Protected Types
typedef std::vector< VIEW_ITEM * >	ITEMS

Protected Attributes
OPT< VECTOR2I >	m_referencePoint
std::deque< EDA_ITEM * >	m_items
bool	m_isHover
int	m_layer
	Container for storing VIEW_ITEMs. More...
ITEMS	m_groupItems

Detailed Description

Definition at line 36 of file selection.h.

Member Typedef Documentation

CITER

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

Definition at line 60 of file selection.h.

ITEMS

typedef std::vector<VIEW_ITEM*> KIGFX::VIEW_GROUP::ITEMS

protectedinherited

Definition at line 119 of file view_group.h.

ITER

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

Definition at line 59 of file selection.h.

Constructor & Destructor Documentation

SELECTION() [1/2]

SELECTION::SELECTION ( )

inline

Definition at line 39 of file selection.h.

                :
            KIGFX::VIEW_GROUP::VIEW_GROUP()
    {
        m_isHover = false;
    }

References m_isHover.

SELECTION() [2/2]

SELECTION::SELECTION ( const SELECTION &  aOther )

inline

Definition at line 45 of file selection.h.

                                         :
            KIGFX::VIEW_GROUP::VIEW_GROUP()
    {
        m_items = aOther.m_items;
        m_isHover = aOther.m_isHover;
    }

References m_isHover, and m_items.

Member Function Documentation

Add() [1/2]

void VIEW_GROUP::Add ( VIEW_ITEM *  aItem )

virtualinherited

Add an item to the group.

Parameters

aItem

is the item to be added.

Definition at line 56 of file view_group.cpp.

{
    m_groupItems.push_back( aItem );
}

References KIGFX::VIEW_GROUP::m_groupItems.

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::AddLine(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PNS_KICAD_IFACE::DisplayItem(), PNS_KICAD_IFACE::DisplayRatline(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_SELECTION_TOOL::EnterGroup(), and BOARD_EDITOR_CONTROL::PlaceTarget().

Add() [2/2]

virtual void SELECTION::Add ( EDA_ITEM *  aItem )

inlinevirtual

Definition at line 77 of file selection.h.

    {
        // We're not sorting here; this is just a time-optimized way to do an
        // inclusion check.  std::lower_bound will return the first i >= aItem
        // and the second i > aItem check rules out i == aItem.
        ITER i = std::lower_bound( m_items.begin(), m_items.end(), aItem );

        if( i == m_items.end() || *i > aItem )
            m_items.insert( i, aItem );
    }

References m_items.

Referenced by EE_GRID_HELPER::BestSnapAnchor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), PCB_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceComponent(), DRAWING_TOOL::PlaceImportedGraphics(), and GERBVIEW_SELECTION_TOOL::select().

AreAllItemsIdentical()

bool SELECTION::AreAllItemsIdentical ( ) const

inline

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

    {
        return ( std::all_of( m_items.begin() + 1, m_items.end(),
                        [&]( const EDA_ITEM* r )
                        {
                            return r->Type() == m_items.front()->Type();
                        } ) );
    }

References m_items.

Referenced by SCH_EDIT_TOOL::Properties().

begin() [1/2]

ITER SELECTION::begin ( )

inline

Definition at line 62 of file selection.h.

{ return m_items.begin(); }

References m_items.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), and EDIT_TOOL::FilletTracks().

begin() [2/2]

CITER SELECTION::begin ( ) const

inline

Definition at line 64 of file selection.h.

{ return m_items.cbegin(); }

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

    {
        m_items.clear();
    }

References m_items.

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

ClearReferencePoint()

void SELECTION::ClearReferencePoint ( )

inline

Definition at line 269 of file selection.h.

    {
        m_referencePoint = NULLOPT;
    }

References m_referencePoint, and NULLOPT.

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

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 148 of file view_item.h.

    {
        m_viewPrivData = nullptr;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

Contains()

bool SELECTION::Contains ( EDA_ITEM *  aItem ) const

inline

Definition at line 114 of file selection.h.

    {
        CITER i = std::lower_bound( m_items.begin(), m_items.end(), aItem );

        return !( i == m_items.end() || *i > aItem  );
    }

References m_items.

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

Empty()

bool SELECTION::Empty ( ) const

inline

Checks if there is anything selected.

Definition at line 122 of file selection.h.

    {
        return m_items.empty();
    }

References m_items.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeSymbols(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), EE_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), BOARD_INSPECTION_TOOL::doHideNet(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SELECTION_CONDITIONS::Empty(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SELECTION_CONDITIONS::NotEmpty(), PCB_SELECTION_CONDITIONS::OnlyConnectedItems(), PCB_SELECTION_CONDITIONS::onlyGraphicShapeTypesFunc(), SELECTION_CONDITIONS::onlyTypeFunc(), SELECTION_CONDITIONS::onlyTypesFunc(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), GROUP_TOOL::RemoveFromGroup(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::RequestSelection(), EDIT_TOOL::Rotate(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_CONDITIONS::sameNetFunc(), CLIPBOARD_IO::SaveSelection(), EE_SELECTION_TOOL::SelectConnection(), GERBVIEW_SELECTION_TOOL::selectCursor(), PCB_SELECTION_TOOL::selectCursor(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), EE_INSPECTION_TOOL::ShowDatasheet(), GROUP_TOOL::Ungroup(), GERBVIEW_SELECTION_TOOL::unselect(), BOARD_INSPECTION_TOOL::UpdateSelectionRatsnest(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

end() [1/2]

ITER SELECTION::end ( )

inline

Definition at line 63 of file selection.h.

{ return m_items.end(); }

References m_items.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), and EDIT_TOOL::FilletTracks().

end() [2/2]

CITER SELECTION::end ( ) const

inline

Definition at line 65 of file selection.h.

{ return m_items.cend(); }

References m_items.

FirstOfKind()

template<class T >

T* SELECTION::FirstOfKind ( ) const

inline

Definition at line 214 of file selection.h.

    {
        auto refType = T( nullptr ).Type();

        for( auto item : m_items )
        {
            if( item->Type() == refType )
                return static_cast<T*> ( item );
        }

        return nullptr;
    }

References m_items.

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 197 of file view_group.cpp.

{
    for( unsigned int i = 0 ; i < GetSize(); i++ )
        delete GetItem( i );

    Clear();
}

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

    {
        return m_items.size() ? m_items.front() : nullptr;
    }

References m_items.

Referenced by POINT_EDITOR::addCornerCondition(), SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::CleanupSheetPins(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), BOARD_INSPECTION_TOOL::CrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), PL_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::EditPageNumber(), SCH_EDITOR_CONTROL::FindNext(), EDIT_TOOL::Flip(), GERBVIEW_SELECTION::GetCenter(), SCH_EDITOR_CONTROL::HasMatch(), 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(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), DRAWING_TOOL::PlaceImportedGraphics(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), 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(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), BUS_UNFOLD_MENU::update(), PCB_CONTROL::UpdateMessagePanel(), PL_EDIT_TOOL::updateModificationPoint(), EDIT_TOOL::updateModificationPoint(), and GERBVIEW_SELECTION::ViewBBox().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 84 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
        return object ? aProperty->getter( object ) : wxAny();
    }

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

Referenced by CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 93 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
        return object ? aProperty->get<T>( object ) : T();
    }

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

Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 102 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
        boost::optional<T> ret;

        if( prop )
        {
            void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

            if( object )
                ret = prop->get<T>( object );
        }

        return ret;
    }

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

GetBoundingBox()

virtual EDA_RECT SELECTION::GetBoundingBox ( ) const

inlinevirtual

Reimplemented in EE_SELECTION.

Definition at line 180 of file selection.h.

    {
        EDA_RECT bbox;

        for( EDA_ITEM* item : m_items )
            bbox.Merge( item->GetBoundingBox() );

        return bbox;
    }

References m_items, and EDA_RECT::Merge().

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

GetCenter()

virtual VECTOR2I SELECTION::GetCenter ( ) const

inlinevirtual

Returns the center point of the selection area bounding box.

Reimplemented in GERBVIEW_SELECTION.

Definition at line 139 of file selection.h.

    {
        KICAD_T labelTypes[] = { SCH_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, EOT };
        bool includeLabels = true;

        // If the selection contains at least one non-label then don't include labels when
        // calculating the centerpoint.

        for( EDA_ITEM* item : m_items )
        {
            if( !item->IsType( labelTypes ) )
            {
                includeLabels = false;
                break;
            }
        }

        EDA_RECT bbox;

        for( EDA_ITEM* item : m_items )
        {
            if( !item->IsType( labelTypes ) || includeLabels )
                bbox.Merge( item->GetBoundingBox() );
        }

        return static_cast<VECTOR2I>( bbox.Centre() );
    }

References EDA_RECT::Centre(), EOT, m_items, EDA_RECT::Merge(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, and SCH_LABEL_T.

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

GetItem()

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

inlineoverridevirtual

Reimplemented from KIGFX::VIEW_GROUP.

Definition at line 106 of file selection.h.

    {
        if( aIdx < m_items.size() )
            return m_items[ aIdx ];

        return nullptr;
    }

References m_items.

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::ChangeTextType(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_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(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EE_SELECTION_TOOL::RequestSelection(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

GetItems()

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

inline

Definition at line 133 of file selection.h.

    {
        return m_items;
    }

References m_items.

Referenced by PL_EDIT_TOOL::Copy(), ZONE_CREATE_HELPER::createNewZone(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_EDIT_TOOL::DoDelete(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::filterSelection(), and PCB_SELECTION_TOOL::selectNet().

GetPosition()

VECTOR2I SELECTION::GetPosition ( ) const

inline

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

Definition at line 175 of file selection.h.

    {
        return static_cast<VECTOR2I>( GetBoundingBox().GetPosition() );
    }

References GetBoundingBox().

GetReferencePoint()

VECTOR2I SELECTION::GetReferencePoint ( ) const

inline

Definition at line 259 of file selection.h.

    {
        return *m_referencePoint;
    }

References m_referencePoint.

Referenced by EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::Rotate(), and CLIPBOARD_IO::SaveSelection().

GetSize()

virtual unsigned int SELECTION::GetSize ( ) const

inlineoverridevirtual

Return the number of stored items.

Returns

Number of stored items.

Reimplemented from KIGFX::VIEW_GROUP.

Definition at line 101 of file selection.h.

    {
        return m_items.size();
    }

References m_items.

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::ChangeTextType(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditPageNumber(), GROUP_TOOL::EnterGroup(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::findCallback(), EDIT_TOOL::Flip(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_SELECTION_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EE_SELECTION_TOOL::RequestSelection(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), EE_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), SCH_DRAWING_TOOLS::TwoClickPlace(), and PCB_CONTROL::UpdateMessagePanel().

GetTopLeftItem()

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

inlinevirtual

Reimplemented in EE_SELECTION, PL_SELECTION, and PCB_SELECTION.

Definition at line 190 of file selection.h.

    {
        return nullptr;
    }

HasReferencePoint()

bool SELECTION::HasReferencePoint ( ) const

inline

Definition at line 254 of file selection.h.

    {
        return m_referencePoint != NULLOPT;
    }

References m_referencePoint, and NULLOPT.

Referenced by EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), CLIPBOARD_IO::SaveSelection(), PL_EDIT_TOOL::updateModificationPoint(), and EDIT_TOOL::updateModificationPoint().

HasType()

bool SELECTION::HasType ( KICAD_T  aType ) const

inline

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

    {
        for( auto item : m_items )
        {
            if( item->Type() == aType )
                return true;
        }

        return false;
    }

References m_items.

Referenced by EDIT_TOOL::Remove().

IsHover()

bool SELECTION::IsHover ( ) const

inline

Definition at line 72 of file selection.h.

    {
        return m_isHover;
    }

References m_isHover.

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

Items()

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

inline

Definition at line 208 of file selection.h.

    {
        return m_items;
    }

References m_items.

Referenced by SCH_EDIT_TOOL::Properties().

operator=()

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

inline

Definition at line 52 of file selection.h.

    {
        m_items = aOther.m_items;
        m_isHover = aOther.m_isHover;
        return *this;
    }

References m_isHover, and m_items.

operator[]()

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

inline

Definition at line 195 of file selection.h.

    {
        if( aIdx < m_items.size() )
            return m_items[ aIdx ];

        return nullptr;
    }

References m_items.

Remove() [1/2]

void VIEW_GROUP::Remove ( VIEW_ITEM *  aItem )

virtualinherited

Remove an item from the group.

Parameters

aItem

is the item to be removed.

Definition at line 62 of file view_group.cpp.

{
    for( auto iter = m_groupItems.begin(); iter != m_groupItems.end(); ++iter )
    {
        if( aItem == *iter )
        {
            m_groupItems.erase( iter );
            break;
        }
    }
}

References KIGFX::VIEW_GROUP::m_groupItems.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and BOARD_EDITOR_CONTROL::PlaceTarget().

Remove() [2/2]

virtual void SELECTION::Remove ( EDA_ITEM *  aItem )

inlinevirtual

Definition at line 88 of file selection.h.

    {
        ITER i = std::lower_bound( m_items.begin(), m_items.end(), aItem );

        if( !( i == m_items.end() || *i > aItem  ) )
            m_items.erase( i );
    }

References m_items.

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

Set() [1/3]

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

inlineinherited

Definition at line 40 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

        if( object )
            aProperty->setter( object, aValue );

        return object != nullptr;
    }

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

Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 53 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

        if( object )
            aProperty->set<T>( object, aValue );

        return object != nullptr;
    }

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

Set() [3/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
        void* object = nullptr;

        if( prop )
        {
            object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

            if( object )
                prop->set<T>( object, aValue );
        }

        return object != nullptr;
    }

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

SetIsHover()

void SELECTION::SetIsHover ( bool  aIsHover )

inline

Definition at line 67 of file selection.h.

    {
        m_isHover = aIsHover;
    }

References m_isHover.

Referenced by EE_SELECTION_TOOL::AddItemsToSel(), EE_SELECTION_TOOL::AddItemToSel(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::RemoveItemFromSel(), EE_SELECTION_TOOL::RemoveItemsFromSel(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), PCB_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.

Parameters

aLayer

is the layer used for drawing.

Definition at line 108 of file view_group.h.

    {
        m_layer = aLayer;
    }

References KIGFX::VIEW_GROUP::m_layer.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), PNS_KICAD_IFACE::SetView(), and PNS_PCBNEW_DEBUG_DECORATOR::SetView().

SetReferencePoint()

void SELECTION::SetReferencePoint ( const VECTOR2I &  aP )

inline

Definition at line 264 of file selection.h.

    {
        m_referencePoint = aP;
    }

References m_referencePoint.

Referenced by EDIT_TOOL::copyToClipboard(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::GetAndPlace(), PCB_EDIT_FRAME::OnNetlistChanged(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), PL_EDIT_TOOL::updateModificationPoint(), EDIT_TOOL::updateModificationPoint(), and EE_SELECTION_TOOL::updateReferencePoint().

Size()

int SELECTION::Size ( ) const

inline

Returns the number of selected parts.

Definition at line 128 of file selection.h.

    {
        return m_items.size();
    }

References m_items.

Referenced by POINT_EDITOR::addCornerCondition(), ROUTER_TOOL::CanInlineDrag(), PAD_TOOL::copyPadSettings(), SELECTION_CONDITIONS::countFunc(), BOARD_INSPECTION_TOOL::CrossProbePcbToSch(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), PL_EDIT_TOOL::DoDelete(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), PAD_TOOL::EditPad(), PCB_SELECTION_TOOL::expandConnection(), 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_POINT_EDITOR::Main(), SELECTION_CONDITIONS::moreThanFunc(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::placeBoardItems(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PL_EDIT_TOOL::updateModificationPoint(), EDIT_TOOL::updateModificationPoint(), EE_SELECTION_TOOL::updateReferencePoint(), GERBVIEW_SELECTION::ViewBBox(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

updateDrawList()

virtual const VIEW_GROUP::ITEMS SELECTION::updateDrawList ( ) const

inlineoverridevirtual

Layer on which the group is drawn.

Reimplemented from KIGFX::VIEW_GROUP.

Reimplemented in PCB_SELECTION.

Definition at line 244 of file selection.h.

    {
        std::vector<VIEW_ITEM*> items;

        for( auto item : m_items )
            items.push_back( item );

        return items;
    }

References m_items.

ViewBBox()

virtual const BOX2I SELECTION::ViewBBox ( ) const

inlineoverridevirtual

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

Returns

The current bounding box

Reimplemented from KIGFX::VIEW_GROUP.

Reimplemented in GERBVIEW_SELECTION.

Definition at line 167 of file selection.h.

    {
        BOX2I r;
        r.SetMaximum();
        return r;
    }

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 113 of file view_group.cpp.

{
    KIGFX::GAL* gal = aView->GetGAL();
    PAINTER*    painter = aView->GetPainter();
    bool        isSelection = m_layer == LAYER_SELECT_OVERLAY;

    const std::vector<VIEW_ITEM*> drawList = updateDrawList();

    std::unordered_map<int, std::vector<VIEW_ITEM*>> layer_item_map;

    // Build a list of layers used by the items in the group
    for( VIEW_ITEM* item : drawList )
    {
        int item_layers[VIEW::VIEW_MAX_LAYERS], item_layers_count;
        item->ViewGetLayers( item_layers, item_layers_count );

        for( int i = 0; i < item_layers_count; i++ )
        {
            if( layer_item_map.count( item_layers[i] ) == 0 )
            {
                layer_item_map.emplace( std::make_pair( item_layers[i],
                                                        std::vector<VIEW_ITEM*>() ) );
            }

            layer_item_map[ item_layers[i] ].push_back( item );
        }
    }

    int layers[VIEW::VIEW_MAX_LAYERS] = { 0 };
    int layers_count = 0;

    for( const std::pair<const int, std::vector<VIEW_ITEM*>>& entry : layer_item_map )
        layers[ layers_count++ ] = entry.first;

    aView->SortLayers( layers, layers_count );

    // Now draw the layers in sorted order

    gal->PushDepth();

    for( int i = 0; i < layers_count; i++ )
    {
        int  layer = layers[i];
        bool draw = aView->IsLayerVisible( layer );

        if( isSelection )
        {
            switch( layer )
            {
            case LAYER_PADS_TH:
            case LAYER_PADS_PLATEDHOLES:
            case LAYER_PAD_FR:
            case LAYER_PAD_BK:
                draw = true;
                break;
            default:
                break;
            }
        }

        if( draw )
        {
            gal->AdvanceDepth();

            for( VIEW_ITEM* item : layer_item_map[ layers[i] ] )
            {
                if( !painter->Draw( item, layers[i] ) )
                    item->ViewDraw( layers[i], aView ); // Alternative drawing method
            }
        }
    }

    gal->PopDepth();
}

References KIGFX::GAL::AdvanceDepth(), KIGFX::PAINTER::Draw(), KIGFX::VIEW::GetGAL(), KIGFX::VIEW::GetPainter(), KIGFX::VIEW::IsLayerVisible(), LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_SELECT_OVERLAY, 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 189 of file view_group.cpp.

{
    // Everything is displayed on a single layer
    aLayers[0] = m_layer;
    aCount = 1;
}

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 FP_ZONE, PAD, FOOTPRINT, VIA, GERBER_DRAW_ITEM, FP_TEXT, TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 137 of file view_item.h.

    {
        // By default always show the item
        return 0.0;
    }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::drawItem::operator()(), GRID_HELPER::queryVisible(), EE_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

viewPrivData()

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

inlineinherited

Definition at line 143 of file view_item.h.

    {
        return m_viewPrivData;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::drawItem::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::queryVisitor< Container >::operator()(), KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::changeItemsDepth::operator()(), KIGFX::VIEW::drawItem::operator()(), KIGFX::VIEW::recacheItem::operator()(), KIGFX::VIEW::clearLayerCache::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Member Data Documentation

m_groupItems

ITEMS KIGFX::VIEW_GROUP::m_groupItems

protectedinherited

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

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

m_items

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

protected

Definition at line 290 of file selection.h.

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

m_layer

int KIGFX::VIEW_GROUP::m_layer

protectedinherited

Container for storing VIEW_ITEMs.

Definition at line 124 of file view_group.h.

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

m_referencePoint

OPT<VECTOR2I> SELECTION::m_referencePoint

protected

Definition at line 289 of file selection.h.

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

---

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

• selection.h