#include <pcb_selection_conditions.h>

Inheritance diagram for PCB_SELECTION_CONDITIONS:

Static Public Member Functions
static bool	OnlyConnectedItems (const SELECTION &aSelection)
	Test if selection contains exclusively connected items (pads, tracks, vias, zones). More...

static SELECTION_CONDITION	SameNet (bool aAllowUnconnected=false)
	Create a functor that tests if selection contains items belonging to the same net or are unconnected if aAllowUnconnected == true. More...

static SELECTION_CONDITION	SameLayer ()
	Creates a functor that tests if selection contains items that belong exclusively to the same layer. More...

static SELECTION_CONDITION	OnlyGraphicShapeTypes (const std::set< PCB_SHAPE_TYPE_T > aTypes)
	Create a functor that tests if the selection contains PCB_SHAPE* items of certain shapes. More...

static bool	ShowAlways (const SELECTION &aSelection)
	The default condition function (always returns true). More...

static bool	ShowNever (const SELECTION &aSelection)
	Always returns false. More...

static bool	NotEmpty (const SELECTION &aSelection)
	Test if there are any items selected. More...

static bool	Empty (const SELECTION &aSelection)
	Test if there are no items selected. More...

static bool	Idle (const SELECTION &aSelection)
	Test if there no items selected or being edited. More...

static bool	IdleSelection (const SELECTION &aSelection)
	Test if all selected items are not being edited. More...

static SELECTION_CONDITION	HasType (KICAD_T aType)
	Create a functor that tests if among the selected items there is at least one of a given type. More...

static SELECTION_CONDITION	OnlyType (KICAD_T aType)
	Create a functor that tests if the selected items are only of given type. More...

static SELECTION_CONDITION	OnlyTypes (const KICAD_T aTypes[])
	Create a functor that tests if the selected items are only of given types. More...

static SELECTION_CONDITION	Count (int aNumber)
	Create a functor that tests if the number of selected items is equal to the value given as parameter. More...

static SELECTION_CONDITION	MoreThan (int aNumber)
	Create a functor that tests if the number of selected items is greater than the value given as parameter. More...

static SELECTION_CONDITION	LessThan (int aNumber)
	Create a functor that tests if the number of selected items is smaller than the value given as parameter. More...

Static Private Member Functions
static bool	sameNetFunc (const SELECTION &aSelection, bool aAllowUnconnected)
	< Helper function used by SameNet() More...

static bool	sameLayerFunc (const SELECTION &aSelection)
	Helper function used by OnlyGraphicShapeTypes() More...

static bool	onlyGraphicShapeTypesFunc (const SELECTION &aSelection, const std::set< PCB_SHAPE_TYPE_T > aTypes)

Detailed Description

Definition at line 35 of file pcb_selection_conditions.h.

Member Function Documentation

◆ Count()

SELECTION_CONDITION SELECTION_CONDITIONS::Count ( int aNumber )

staticinherited

Create a functor that tests if the number of selected items is equal to the value given as parameter.

Parameters

aNumber is the number of expected items.

Returns: Functor testing if the number of selected items is equal aNumber.

Definition at line 76 of file selection_conditions.cpp.

 {
     return std::bind( &SELECTION_CONDITIONS::countFunc, _1, aNumber );
 }

References SELECTION_CONDITIONS::countFunc().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), SCH_EDIT_TOOL::Init(), EE_INSPECTION_TOOL::Init(), PAD_TOOL::Init(), CONVERT_TOOL::Init(), EE_SELECTION_TOOL::Init(), BOARD_INSPECTION_TOOL::Init(), EDIT_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ Empty()

bool SELECTION_CONDITIONS::Empty ( const SELECTION & aSelection )

staticinherited

Test if there are no items selected.

Parameters

aSelection is the selection to be tested.

Returns: True if there are no items selected.

Definition at line 40 of file selection_conditions.cpp.

 {
     return aSelection.Empty();
 }

References SELECTION::Empty().

Referenced by PL_SELECTION_TOOL::Init(), and EE_SELECTION_TOOL::Init().

◆ HasType()

SELECTION_CONDITION SELECTION_CONDITIONS::HasType ( KICAD_T aType )

staticinherited

Create a functor that tests if among the selected items there is at least one of a given type.

Parameters

aType is the type that is searched.

Returns: Functor testing for presence of items of a given type.

Definition at line 58 of file selection_conditions.cpp.

 {
     return std::bind( &SELECTION_CONDITIONS::hasTypeFunc, _1, aType );
 }

References SELECTION_CONDITIONS::hasTypeFunc().

Referenced by PAD_TOOL::Init().

◆ Idle()

bool SELECTION_CONDITIONS::Idle ( const SELECTION & aSelection )

staticinherited

Test if there no items selected or being edited.

Parameters

aSelection is the selection to be tested.

Returns: True if there are no items being edited or no items selected.

Definition at line 46 of file selection_conditions.cpp.

 {
     return ( !aSelection.Front() || aSelection.Front()->GetEditFlags() == 0 );
 }

References SELECTION::Front(), and EDA_ITEM::GetEditFlags().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), EE_INSPECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), PL_EDITOR_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

◆ IdleSelection()

bool SELECTION_CONDITIONS::IdleSelection ( const SELECTION & aSelection )

staticinherited

Test if all selected items are not being edited.

Parameters

aSelection is the selection to be tested.

Returns: True if no selected items are being edited.

Definition at line 52 of file selection_conditions.cpp.

 {
     return ( aSelection.Front() && aSelection.Front()->GetEditFlags() == 0 );
 }

References SELECTION::Front(), and EDA_ITEM::GetEditFlags().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), and SCH_EDIT_TOOL::Init().

◆ LessThan()

SELECTION_CONDITION SELECTION_CONDITIONS::LessThan ( int aNumber )

staticinherited

Create a functor that tests if the number of selected items is smaller than the value given as parameter.

Parameters

aNumber is the number used for comparison.

Returns: Functor testing if the number of selected items is smaller than aNumber.

Definition at line 88 of file selection_conditions.cpp.

 {
     return std::bind( &SELECTION_CONDITIONS::lessThanFunc, _1, aNumber );
 }

References SELECTION_CONDITIONS::lessThanFunc().

Referenced by EE_SELECTION_TOOL::Init().

◆ MoreThan()

SELECTION_CONDITION SELECTION_CONDITIONS::MoreThan ( int aNumber )

staticinherited

Create a functor that tests if the number of selected items is greater than the value given as parameter.

Parameters

aNumber is the number used for comparison.

Returns: Functor testing if the number of selected items is greater than aNumber.

Definition at line 82 of file selection_conditions.cpp.

 {
     return std::bind( &SELECTION_CONDITIONS::moreThanFunc, _1, aNumber );
 }

References SELECTION_CONDITIONS::moreThanFunc().

Referenced by SCH_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

◆ NotEmpty()

bool SELECTION_CONDITIONS::NotEmpty ( const SELECTION & aSelection )

staticinherited

Test if there are any items selected.

Parameters

aSelection is the selection to be tested.

Returns: True if there is at least one item selected.

Definition at line 34 of file selection_conditions.cpp.

 {
     return !aSelection.Empty();
 }

References SELECTION::Empty().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), GROUP_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), PCB_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), and PL_EDITOR_FRAME::setupUIConditions().

◆ OnlyConnectedItems()

bool PCB_SELECTION_CONDITIONS::OnlyConnectedItems ( const SELECTION & aSelection )

static

Test if selection contains exclusively connected items (pads, tracks, vias, zones).

Parameters

aSelection is the selection to be tested.

Returns: True if there are only connected items connected.

Definition at line 36 of file pcb_selection_conditions.cpp.

 {
     if( aSelection.Empty() )
         return false;
 
     for( const auto &item : aSelection )
     {
         auto type = item->Type();
 
         if( type != PCB_PAD_T && type != PCB_VIA_T && type != PCB_TRACE_T && type != PCB_ZONE_T )
             return false;
     }
 
     return true;
 }

References SELECTION::Empty(), PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, and PCB_ZONE_T.

◆ OnlyGraphicShapeTypes()

S_C PCB_SELECTION_CONDITIONS::OnlyGraphicShapeTypes ( const std::set< PCB_SHAPE_TYPE_T > aTypes )

static

Create a functor that tests if the selection contains PCB_SHAPE* items of certain shapes.

This implicitly includes an OnlyType( PCB_SHAPE_T ) as part of the test.

Parameters

aTypes is a list of allowed PCB_SHAPE shapes (

See also: PCB_SHAPE_TYPE_T)

Returns: functor testing if selected items match the given list of allowed shapes

Definition at line 65 of file pcb_selection_conditions.cpp.

 {
     return std::bind( &PCB_SELECTION_CONDITIONS::onlyGraphicShapeTypesFunc, _1, aTypes );
 }

References onlyGraphicShapeTypesFunc().

Referenced by CONVERT_TOOL::Init().

◆ onlyGraphicShapeTypesFunc()

bool PCB_SELECTION_CONDITIONS::onlyGraphicShapeTypesFunc	(	const SELECTION &	aSelection,
		const std::set< PCB_SHAPE_TYPE_T >	aTypes
	)

staticprivate

Definition at line 139 of file pcb_selection_conditions.cpp.

 {
     if( aSelection.Empty() )
         return false;
 
     for( const EDA_ITEM* item : aSelection )
     {
         if( item->Type() != PCB_SHAPE_T && item->Type() != PCB_FP_SHAPE_T )
             return false;
 
         PCB_SHAPE_TYPE_T shape = static_cast<const PCB_SHAPE*>( item )->GetShape();
 
         if( !aTypes.count( shape ) )
             return false;
     }
 
     return true;
 }

References SELECTION::Empty(), PCB_FP_SHAPE_T, and PCB_SHAPE_T.

Referenced by OnlyGraphicShapeTypes().

◆ OnlyType()

SELECTION_CONDITION SELECTION_CONDITIONS::OnlyType ( KICAD_T aType )

staticinherited

Create a functor that tests if the selected items are only of given type.

Parameters

aType is the type that is searched.

Returns: Functor testing if selected items are exclusively of one type.

Definition at line 64 of file selection_conditions.cpp.

 {
     return std::bind( &SELECTION_CONDITIONS::onlyTypeFunc, _1, aType );
 }

References SELECTION_CONDITIONS::onlyTypeFunc().

Referenced by SYMBOL_EDITOR_PIN_TOOL::Init(), SCH_EDIT_TOOL::Init(), EE_INSPECTION_TOOL::Init(), PAD_TOOL::Init(), CONVERT_TOOL::Init(), SCH_MOVE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EE_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ OnlyTypes()

SELECTION_CONDITION SELECTION_CONDITIONS::OnlyTypes ( const KICAD_T aTypes[] )

staticinherited

Create a functor that tests if the selected items are only of given types.

Parameters

aTypes is an array containing types that are searched. It has to be ended with #KICAD_T::EOT as end marker.

Returns: Functor testing if selected items are exclusively of the requested types.

Definition at line 70 of file selection_conditions.cpp.

 {
     return std::bind( &SELECTION_CONDITIONS::onlyTypesFunc, _1, aTypes );
 }

References SELECTION_CONDITIONS::onlyTypesFunc().

Referenced by SCH_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), EE_SELECTION_TOOL::Init(), BOARD_INSPECTION_TOOL::Init(), EDIT_TOOL::Init(), EDIT_TOOL::Properties(), PCB_EDIT_FRAME::setupUIConditions(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

◆ SameLayer()

S_C PCB_SELECTION_CONDITIONS::SameLayer ( )

static

Creates a functor that tests if selection contains items that belong exclusively to the same layer.

In case of items belonging to multiple layers, it is enough to have a single common layer with other items.

Returns: Functor testing if selected items share at least one common layer.

Definition at line 59 of file pcb_selection_conditions.cpp.

 {
     return std::bind( &PCB_SELECTION_CONDITIONS::sameLayerFunc, _1 );
 }

References sameLayerFunc().

Referenced by CONVERT_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ sameLayerFunc()

bool PCB_SELECTION_CONDITIONS::sameLayerFunc ( const SELECTION & aSelection )

staticprivate

Helper function used by OnlyGraphicShapeTypes()

Definition at line 118 of file pcb_selection_conditions.cpp.

 {
     if( aSelection.Empty() )
         return false;
 
     LSET layerSet;
     layerSet.set();
 
     for( const auto& i : aSelection )
     {
         auto item = static_cast<BOARD_ITEM*>( i );
         layerSet &= item->GetLayerSet();
 
         if( !layerSet.any() )       // there are no common layers left
             return false;
     }
 
     return true;
 }

References SELECTION::Empty().

Referenced by SameLayer().

◆ SameNet()

S_C PCB_SELECTION_CONDITIONS::SameNet ( bool aAllowUnconnected = false )

static

Create a functor that tests if selection contains items belonging to the same net or are unconnected if aAllowUnconnected == true.

Parameters

aAllowUnconnected determines if unconnected items (with no net code assigned) should be treated as connected to the same net.

Returns: Functor testing if selected items are belonging to the same net.

Definition at line 53 of file pcb_selection_conditions.cpp.

 {
     return std::bind( &PCB_SELECTION_CONDITIONS::sameNetFunc, _1, aAllowUnconnected );
 }

References sameNetFunc().

Referenced by PCB_EDIT_FRAME::setupUIConditions().

◆ sameNetFunc()

bool PCB_SELECTION_CONDITIONS::sameNetFunc	(	const SELECTION &	aSelection,
		bool	aAllowUnconnected
	)

staticprivate

< Helper function used by SameNet()

Helper function used by SameLayer()

Definition at line 72 of file pcb_selection_conditions.cpp.

 {
     if( aSelection.Empty() )
         return false;
 
     int netcode = -1;   // -1 stands for 'net code is not yet determined'
 
     for( const auto& aitem : aSelection )
     {
         int current_netcode = -1;
 
         const BOARD_CONNECTED_ITEM* item =
             dynamic_cast<const BOARD_CONNECTED_ITEM*>( aitem );
 
         if( item )
         {
             current_netcode = item->GetNetCode();
         }
         else
         {
             if( !aAllowUnconnected )
                 return false;
             else
                 // if it is not a BOARD_CONNECTED_ITEM, treat it as if there was no net assigned
                 current_netcode = 0;
         }
 
         assert( current_netcode >= 0 );
 
         if( netcode < 0 )
         {
             netcode = current_netcode;
 
             if( netcode == NETINFO_LIST::UNCONNECTED && !aAllowUnconnected )
                 return false;
         }
         else if( netcode != current_netcode )
         {
             return false;
         }
     }
 
     return true;
 }

References SELECTION::Empty(), BOARD_CONNECTED_ITEM::GetNetCode(), and NETINFO_LIST::UNCONNECTED.

Referenced by SameNet().

◆ ShowAlways()

static bool SELECTION_CONDITIONS::ShowAlways ( const SELECTION & aSelection )

inlinestaticinherited

The default condition function (always returns true).

Parameters

aSelection is the selection to be tested.

Returns: Always true.

Definition at line 77 of file selection_conditions.h.

     {
         return true;
     }

Referenced by ACTION_CONDITIONS::ACTION_CONDITIONS(), CONDITIONAL_MENU::AddSeparator(), EDA_DRAW_FRAME::AddStandardSubMenus(), ROUTER_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), PL_EDIT_TOOL::Init(), PAD_TOOL::Init(), PL_DRAWING_TOOLS::Init(), EDA_3D_CONTROLLER::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), PL_EDITOR_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), and SPECIAL_TOOLS_CONTEXT_MENU::SPECIAL_TOOLS_CONTEXT_MENU().

◆ ShowNever()

static bool SELECTION_CONDITIONS::ShowNever ( const SELECTION & aSelection )

inlinestaticinherited

Always returns false.

Parameters

aSelection is the selection to be tested.

Returns: Always false.

Definition at line 88 of file selection_conditions.h.

     {
         return false;
     }

Referenced by ACTION_CONDITIONS::ACTION_CONDITIONS(), and PL_EDITOR_FRAME::setupUIConditions().

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

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ Count()

◆ Empty()

◆ HasType()

◆ Idle()

◆ IdleSelection()

◆ LessThan()

◆ MoreThan()

◆ NotEmpty()

◆ OnlyConnectedItems()

◆ OnlyGraphicShapeTypes()

◆ onlyGraphicShapeTypesFunc()

◆ OnlyType()

◆ OnlyTypes()

◆ SameLayer()

◆ sameLayerFunc()

◆ SameNet()

◆ sameNetFunc()

◆ ShowAlways()

◆ ShowNever()