KiCad PCB EDA Suite
EE_COLLECTOR Class Reference

Class EE_COLLECTOR. More...

#include <ee_collectors.h>

Inheritance diagram for EE_COLLECTOR:
COLLECTOR EE_TYPE_COLLECTOR

Public Types

using ITER = std::vector< EDA_ITEM * >::iterator
 
using CITER = std::vector< EDA_ITEM * >::const_iterator
 

Public Member Functions

 EE_COLLECTOR (const KICAD_T *aScanTypes=EE_COLLECTOR::AllItems)
 
SCH_ITEMoperator[] (int aIndex) const override
 Overload COLLECTOR::operator[](int) to return a SCH_ITEM instead of an EDA_ITEM. More...
 
SEARCH_RESULT Inspect (EDA_ITEM *aItem, void *aTestData) override
 
void Collect (EDA_ITEM *aItem, const KICAD_T aFilterList[], const wxPoint &aPos, int aUnit=0, int aConvert=0)
 Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection. More...
 
bool IsCorner () const
 Function IsCorner tests if the collected items forms as corner of two line segments. More...
 
bool IsDraggableJunction () const
 Function IsDraggableJunction tests to see if the collected items form a draggable junction. More...
 
ITER begin ()
 
CITER begin () const
 
ITER end ()
 
CITER end () const
 
bool IsValidIndex (int aIndex)
 Function IsValidIndex tests if aIndex is with the limits of the list of collected items. More...
 
int GetCount () const
 Function GetCount returns the number of objects in the list. More...
 
void Empty ()
 Function Empty sets the list to empty. More...
 
void Append (EDA_ITEM *item)
 Function Append adds an item to the end of the list. More...
 
void Remove (int aIndex)
 Function Remove removes the item at aIndex (first position is 0);. More...
 
void Remove (const EDA_ITEM *aItem)
 Function Remove removes the item aItem (if exists in the collector). More...
 
EDA_ITEM *const * BasePtr () const
 Function BasePtr returns the address of the first element in the array. More...
 
bool HasItem (const EDA_ITEM *aItem) const
 Function HasItem tests if aItem has already been collected. More...
 
void SetScanTypes (const KICAD_T *scanTypes)
 Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function. More...
 
void SetTimeNow ()
 
timestamp_t GetTime ()
 
void SetRefPos (const wxPoint &aRefPos)
 
const wxPoint & GetRefPos () const
 
void SetBoundingBox (const EDA_RECT &aRefBox)
 
const EDA_RECTGetBoundingBox () const
 
bool IsSimilarPointAndTime (const wxPoint &aRefPos)
 Function IsSimilarPointAndTime returns true if the given reference point is "similar" (defined here) to the internal reference point and the current time is within a few seconds of the internal m_TimeAtCollection. More...
 
int CountType (KICAD_T aType)
 Function CountType counts the number of items matching aType. More...
 

Public Attributes

int m_Unit
 
int m_Convert
 
int m_Threshold
 
wxString m_MenuTitle
 
bool m_MenuCancelled
 

Static Public Attributes

static const KICAD_T AllItems []
 
static const KICAD_T EditableItems []
 
static const KICAD_T RotatableItems []
 
static const KICAD_T ComponentsOnly []
 
static const KICAD_T SheetsOnly []
 
static const KICAD_T SheetsAndSheetLabels []
 

Protected Attributes

INSPECTOR_FUNC m_inspector
 a class common bridge into the polymorphic Inspect() More...
 
const KICAD_Tm_ScanTypes
 Which object types to scan. More...
 
std::vector< EDA_ITEM * > m_List
 A place to hold collected objects without taking ownership of their memory. More...
 
wxPoint m_RefPos
 A point to test against, and that was used to make the collection. More...
 
EDA_RECT m_RefBox
 A bounding box to test against, and that was used to make the collection. More...
 
timestamp_t m_TimeAtCollection
 The time at which the collection was made. More...
 

Detailed Description

Class EE_COLLECTOR.

Definition at line 38 of file ee_collectors.h.

Member Typedef Documentation

◆ CITER

using COLLECTOR::CITER = std::vector<EDA_ITEM*>::const_iterator
inherited

Definition at line 90 of file collector.h.

◆ ITER

using COLLECTOR::ITER = std::vector<EDA_ITEM*>::iterator
inherited

Definition at line 89 of file collector.h.

Constructor & Destructor Documentation

◆ EE_COLLECTOR()

EE_COLLECTOR::EE_COLLECTOR ( const KICAD_T aScanTypes = EE_COLLECTOR::AllItems)
inline

Definition at line 48 of file ee_collectors.h.

48  :
49  m_Threshold( 0 ),
50  m_MenuCancelled( false )
51  {
52  SetScanTypes( aScanTypes );
53  }
void SetScanTypes(const KICAD_T *scanTypes)
Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() f...
Definition: collector.h:215
bool m_MenuCancelled

References COLLECTOR::SetScanTypes().

Member Function Documentation

◆ Append()

void COLLECTOR::Append ( EDA_ITEM item)
inlineinherited

◆ BasePtr()

EDA_ITEM* const* COLLECTOR::BasePtr ( ) const
inlineinherited

Function BasePtr returns the address of the first element in the array.

Only call this if there is at least one element in the vector m_List, otherwise a C++ exception should get thrown.

Definition at line 185 of file collector.h.

186  {
187  return &m_List[0];
188  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inlineinherited

Definition at line 92 of file collector.h.

92 { return m_List.begin(); }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

Referenced by SELECTION_TOOL::RequestSelection().

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const
inlineinherited

Definition at line 94 of file collector.h.

94 { return m_List.cbegin(); }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

◆ Collect()

void EE_COLLECTOR::Collect ( EDA_ITEM aItem,
const KICAD_T  aFilterList[],
const wxPoint &  aPos,
int  aUnit = 0,
int  aConvert = 0 
)

Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection.

Parameters
aItemA EDA_ITEM to scan.
aFilterListA list of KICAD_T types with a terminating EOT, that determines what is to be collected and the priority order of the resulting collection.
aPosA wxPoint to use in hit-testing.
aUnitA symbol unit filter (for symbol editor)
aConvertA DeMorgan filter (for symbol editor)

Definition at line 118 of file ee_collectors.cpp.

120 {
121  Empty(); // empty the collection just in case
122 
123  SetScanTypes( aFilterList );
124  m_Unit = aUnit;
125  m_Convert = aConvert;
126 
127  // remember where the snapshot was taken from and pass refPos to the Inspect() function.
128  SetRefPos( aPos );
129 
130  if( aItem->Type() == LIB_PART_T )
131  static_cast<LIB_PART*>( aItem )->Visit( m_inspector, nullptr, m_ScanTypes );
132  else
134 }
void Empty()
Function Empty sets the list to empty.
Definition: collector.h:123
static SEARCH_RESULT IterateForward(EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function IterateForward walks through the object tree calling the inspector() on each object type req...
void SetScanTypes(const KICAD_T *scanTypes)
Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() f...
Definition: collector.h:215
INSPECTOR_FUNC m_inspector
a class common bridge into the polymorphic Inspect()
Definition: collector.h:59
void SetRefPos(const wxPoint &aRefPos)
Definition: collector.h:230
const KICAD_T * m_ScanTypes
Which object types to scan.
Definition: collector.h:62
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

References COLLECTOR::Empty(), EDA_ITEM::IterateForward(), LIB_PART_T, m_Convert, COLLECTOR::m_inspector, COLLECTOR::m_ScanTypes, m_Unit, COLLECTOR::SetRefPos(), COLLECTOR::SetScanTypes(), and EDA_ITEM::Type().

Referenced by EE_SELECTION_TOOL::GetNode(), and EE_SELECTION_TOOL::SelectPoint().

◆ CountType()

int COLLECTOR::CountType ( KICAD_T  aType)
inlineinherited

Function CountType counts the number of items matching aType.

Parameters
aTypetype we are interested in
Returns
number of occurences

Definition at line 265 of file collector.h.

266  {
267  int cnt = 0;
268  for( size_t i = 0; i < m_List.size(); i++ )
269  {
270  if( m_List[i]->Type() == aType )
271  cnt++;
272  }
273  return cnt;
274  }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References i, and COLLECTOR::m_List.

Referenced by SELECTION_TOOL::guessSelectionCandidates(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

void COLLECTOR::Empty ( )
inlineinherited

◆ end() [1/2]

ITER COLLECTOR::end ( )
inlineinherited

Definition at line 93 of file collector.h.

93 { return m_List.end(); }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

Referenced by SELECTION_TOOL::RequestSelection().

◆ end() [2/2]

CITER COLLECTOR::end ( ) const
inlineinherited

Definition at line 95 of file collector.h.

95 { return m_List.cend(); }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const
inlineinherited

Definition at line 234 of file collector.h.

234 { return m_RefBox; }
EDA_RECT m_RefBox
A bounding box to test against, and that was used to make the collection.
Definition: collector.h:71

References COLLECTOR::m_RefBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const
inlineinherited

Function GetCount returns the number of objects in the list.

Definition at line 114 of file collector.h.

115  {
116  return (int) m_List.size();
117  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

Referenced by AllAreModulesAndReturnSmallestIfSo(), SCH_EDIT_FRAME::AppendSchematic(), BuildBoardPolygonOutlines(), calcMaxArea(), connectedItemFilter(), connectedTrackFilter(), MODULE::CoverageRatio(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), EditToolSelectionFilter(), MODULE_EDITOR_TOOLS::EnumeratePads(), EDIT_TOOL::FootprintFilter(), DSN::SPECCTRA_DB::FromBOARD(), SCH_FIND_COLLECTOR::GetItem(), EE_SELECTION_TOOL::GetNode(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), SCH_FIND_COLLECTOR::GetText(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), EE_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::guessSelectionCandidates(), highlightNet(), SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), IsCorner(), DSN::SPECCTRA_DB::makeIMAGE(), ROUTER_TOOL::NeighboringSegmentFilter(), SCH_EDIT_FRAME::OnFindSchematicItem(), operator[](), GERBER_COLLECTOR::operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), SCH_FIND_COLLECTOR::PassedEnd(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), SELECTION_TOOL::pickSmallestComponent(), SCH_COMPONENT::ResolveAll(), PCB_EDIT_FRAME::SelectHighLight(), EE_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), SELECTION_TOOL::selectPoint(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), SCH_FIND_COLLECTOR::UpdateIndex(), and SCH_COMPONENT::UpdatePins().

◆ GetRefPos()

const wxPoint& COLLECTOR::GetRefPos ( ) const
inlineinherited

Definition at line 231 of file collector.h.

231 { return m_RefPos; }
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
Definition: collector.h:68

References COLLECTOR::m_RefPos.

Referenced by PCB_EDIT_FRAME::OnRightClick().

◆ GetTime()

timestamp_t COLLECTOR::GetTime ( )
inlineinherited

Definition at line 225 of file collector.h.

226  {
227  return m_TimeAtCollection;
228  }
timestamp_t m_TimeAtCollection
The time at which the collection was made.
Definition: collector.h:74

References COLLECTOR::m_TimeAtCollection.

◆ HasItem()

bool COLLECTOR::HasItem ( const EDA_ITEM aItem) const
inlineinherited

Function HasItem tests if aItem has already been collected.

Parameters
aItemThe EDA_ITEM* to be tested.
Returns
True if aItem is already collected.

Definition at line 197 of file collector.h.

198  {
199  for( size_t i = 0; i < m_List.size(); i++ )
200  {
201  if( m_List[i] == aItem )
202  return true;
203  }
204 
205  return false;
206  }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References i, and COLLECTOR::m_List.

Referenced by EditToolSelectionFilter().

◆ Inspect()

SEARCH_RESULT EE_COLLECTOR::Inspect ( EDA_ITEM aItem,
void *  aTestData 
)
overridevirtual

Implements COLLECTOR.

Reimplemented in EE_TYPE_COLLECTOR.

Definition at line 92 of file ee_collectors.cpp.

93 {
94  if( aItem->Type() == LIB_PIN_T )
95  {
96  // Special selection rules apply to pins of different units when edited in
97  // synchronized pins mode. Leave it to EE_SELECTION_TOOL::isSelectable() to
98  // decide what to do with them.
99  }
100  else if( m_Unit || m_Convert )
101  {
102  LIB_ITEM* lib_item = dynamic_cast<LIB_ITEM*>( aItem );
103 
104  if( m_Unit && lib_item && lib_item->GetUnit() && lib_item->GetUnit() != m_Unit )
105  return SEARCH_CONTINUE;
106 
107  if( m_Convert && lib_item && lib_item->GetConvert() && lib_item->GetConvert() != m_Convert )
108  return SEARCH_CONTINUE;
109  }
110 
111  if( aItem->HitTest( m_RefPos, m_Threshold ) )
112  Append( aItem );
113 
114  return SEARCH_CONTINUE;
115 }
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
void Append(EDA_ITEM *item)
Function Append adds an item to the end of the list.
Definition: collector.h:133
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: base_struct.h:333
int GetUnit() const
int GetConvert() const
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
Definition: collector.h:68
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

References COLLECTOR::Append(), LIB_ITEM::GetConvert(), LIB_ITEM::GetUnit(), EDA_ITEM::HitTest(), LIB_PIN_T, m_Convert, COLLECTOR::m_RefPos, m_Threshold, m_Unit, SEARCH_CONTINUE, and EDA_ITEM::Type().

◆ IsCorner()

bool EE_COLLECTOR::IsCorner ( ) const

Function IsCorner tests if the collected items forms as corner of two line segments.

Returns
True if the collected items form a corner of two line segments.

Definition at line 137 of file ee_collectors.cpp.

138 {
139  if( GetCount() != 2 )
140  return false;
141 
142  bool is_busentry0 = (dynamic_cast<SCH_BUS_ENTRY_BASE*>( m_List[0] ) != NULL);
143  bool is_busentry1 = (dynamic_cast<SCH_BUS_ENTRY_BASE*>( m_List[1] ) != NULL);
144 
145  if( (m_List[0]->Type() == SCH_LINE_T) && (m_List[1]->Type() == SCH_LINE_T) )
146  return ( ( SCH_LINE* ) m_List[0])->GetLayer() == ( ( SCH_LINE* ) m_List[1])->GetLayer();
147 
148  if( (m_List[0]->Type() == SCH_LINE_T) && is_busentry1 )
149  return true;
150 
151  if( is_busentry0 && (m_List[1]->Type() == SCH_LINE_T) )
152  return true;
153 
154  return false;
155 }
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:114
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
static bool GetLayer(MODEL_VRML &aModel, LAYER_NUM layer, VRML_LAYER **vlayer)
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::GetCount(), GetLayer(), COLLECTOR::m_List, and SCH_LINE_T.

◆ IsDraggableJunction()

bool EE_COLLECTOR::IsDraggableJunction ( ) const

Function IsDraggableJunction tests to see if the collected items form a draggable junction.

Daggable junctions are defined as:

  • The intersection of three or more wire end points.
  • The intersection of one or more wire end point and one wire mid point.
  • The crossing of two or more wire mid points and a junction.
Returns
True if the collection is a draggable junction.

Definition at line 158 of file ee_collectors.cpp.

159 {
160  for( size_t i = 0; i < m_List.size(); i++ )
161  if( ( (SCH_ITEM*) m_List[ i ] )->Type() == SCH_JUNCTION_T )
162  return true;
163 
164  return false;
165 }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

References i, COLLECTOR::m_List, and SCH_JUNCTION_T.

◆ IsSimilarPointAndTime()

bool COLLECTOR::IsSimilarPointAndTime ( const wxPoint &  aRefPos)
inlineinherited

Function IsSimilarPointAndTime returns true if the given reference point is "similar" (defined here) to the internal reference point and the current time is within a few seconds of the internal m_TimeAtCollection.

Parameters
aRefPosA wxPoint to compare to.
Returns
bool - true if the point and time are similar, else false.

Definition at line 245 of file collector.h.

246  {
247  const int distMax = 2; // adjust these here
248  const timestamp_t timeMax = 3; // seconds
249 
250  int dx = abs( aRefPos.x - m_RefPos.x );
251  int dy = abs( aRefPos.y - m_RefPos.y );
252 
253  if( dx <= distMax && dy <= distMax &&
254  GetNewTimeStamp() - m_TimeAtCollection <= timeMax )
255  return true;
256  else
257  return false;
258  }
#define abs(a)
Definition: auxiliary.h:84
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
Definition: collector.h:68
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: common.h:53
timestamp_t m_TimeAtCollection
The time at which the collection was made.
Definition: collector.h:74

References abs, GetNewTimeStamp(), COLLECTOR::m_RefPos, and COLLECTOR::m_TimeAtCollection.

◆ IsValidIndex()

bool COLLECTOR::IsValidIndex ( int  aIndex)
inlineinherited

Function IsValidIndex tests if aIndex is with the limits of the list of collected items.

Parameters
aIndexThe index to test.
Returns
True if aIndex is with the limits of the list of collected items, otherwise false.

Definition at line 105 of file collector.h.

106  {
107  return ( (unsigned) aIndex < m_List.size() );
108  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

Referenced by SCH_FIND_COLLECTOR::GetText(), and SCH_FIND_COLLECTOR::ReplaceItem().

◆ operator[]()

SCH_ITEM* EE_COLLECTOR::operator[] ( int  aIndex) const
inlineoverridevirtual

Overload COLLECTOR::operator[](int) to return a SCH_ITEM instead of an EDA_ITEM.

Parameters
aIndexThe index into the list.
Returns
SCH_ITEM* at aIndex or NULL.

Reimplemented from COLLECTOR.

Definition at line 61 of file ee_collectors.h.

62  {
63  if( (unsigned)aIndex < (unsigned)GetCount() )
64  return (SCH_ITEM*) m_List[ aIndex ];
65 
66  return NULL;
67  }
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:114
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

References COLLECTOR::GetCount(), and COLLECTOR::m_List.

◆ Remove() [1/2]

void COLLECTOR::Remove ( int  aIndex)
inlineinherited

Function Remove removes the item at aIndex (first position is 0);.

Parameters
aIndexThe index into the list.

Definition at line 143 of file collector.h.

144  {
145  m_List.erase( m_List.begin() + aIndex );
146  }
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References COLLECTOR::m_List.

Referenced by connectedItemFilter(), connectedTrackFilter(), EditToolSelectionFilter(), EDIT_TOOL::FootprintFilter(), EE_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::guessSelectionCandidates(), highlightNet(), EDIT_TOOL::PadFilter(), EE_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::selectPoint().

◆ Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM aItem)
inlineinherited

Function Remove removes the item aItem (if exists in the collector).

Parameters
aItemthe item to be removed.

Definition at line 153 of file collector.h.

154  {
155  for( size_t i = 0; i < m_List.size(); i++ )
156  {
157  if( m_List[i] == aItem )
158  {
159  m_List.erase( m_List.begin() + i);
160  return;
161  }
162  }
163  }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
A place to hold collected objects without taking ownership of their memory.
Definition: collector.h:65

References i, and COLLECTOR::m_List.

◆ SetBoundingBox()

void COLLECTOR::SetBoundingBox ( const EDA_RECT aRefBox)
inlineinherited

Definition at line 233 of file collector.h.

233 { m_RefBox = aRefBox; }
EDA_RECT m_RefBox
A bounding box to test against, and that was used to make the collection.
Definition: collector.h:71

References COLLECTOR::m_RefBox.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint &  aRefPos)
inlineinherited

Definition at line 230 of file collector.h.

230 { m_RefPos = aRefPos; }
wxPoint m_RefPos
A point to test against, and that was used to make the collection.
Definition: collector.h:68

References COLLECTOR::m_RefPos.

Referenced by Collect(), GERBER_COLLECTOR::Collect(), and GENERAL_COLLECTOR::Collect().

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T scanTypes)
inlineinherited

Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function.

Parameters
scanTypesAn array of KICAD_T, terminated by EOT. No copy is is made of this array (so cannot come from caller's stack).

Definition at line 215 of file collector.h.

216  {
217  m_ScanTypes = scanTypes;
218  }
const KICAD_T * m_ScanTypes
Which object types to scan.
Definition: collector.h:62

References COLLECTOR::m_ScanTypes.

Referenced by Collect(), GERBER_COLLECTOR::Collect(), EE_TYPE_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), EE_COLLECTOR(), GENERAL_COLLECTOR::GENERAL_COLLECTOR(), GERBER_COLLECTOR::GERBER_COLLECTOR(), and SCH_FIND_COLLECTOR::SCH_FIND_COLLECTOR().

◆ SetTimeNow()

void COLLECTOR::SetTimeNow ( )
inlineinherited

Definition at line 220 of file collector.h.

221  {
223  }
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
timestamp_t m_TimeAtCollection
The time at which the collection was made.
Definition: collector.h:74

References GetNewTimeStamp(), and COLLECTOR::m_TimeAtCollection.

Referenced by GERBER_COLLECTOR::Collect(), and GENERAL_COLLECTOR::Collect().

Member Data Documentation

◆ AllItems

const KICAD_T EE_COLLECTOR::AllItems
static

◆ ComponentsOnly

◆ EditableItems

const KICAD_T EE_COLLECTOR::EditableItems
static

◆ m_Convert

int EE_COLLECTOR::m_Convert

Definition at line 109 of file ee_collectors.h.

Referenced by Collect(), and Inspect().

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector
protectedinherited

◆ m_List

◆ m_MenuCancelled

bool EE_COLLECTOR::m_MenuCancelled

◆ m_MenuTitle

wxString EE_COLLECTOR::m_MenuTitle

◆ m_RefBox

EDA_RECT COLLECTOR::m_RefBox
protectedinherited

A bounding box to test against, and that was used to make the collection.

Definition at line 71 of file collector.h.

Referenced by COLLECTOR::GetBoundingBox(), and COLLECTOR::SetBoundingBox().

◆ m_RefPos

wxPoint COLLECTOR::m_RefPos
protectedinherited

A point to test against, and that was used to make the collection.

Definition at line 68 of file collector.h.

Referenced by COLLECTOR::GetRefPos(), Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), COLLECTOR::IsSimilarPointAndTime(), and COLLECTOR::SetRefPos().

◆ m_ScanTypes

const KICAD_T* COLLECTOR::m_ScanTypes
protectedinherited

◆ m_Threshold

int EE_COLLECTOR::m_Threshold

Definition at line 111 of file ee_collectors.h.

Referenced by Inspect(), and EE_SELECTION_TOOL::SelectPoint().

◆ m_TimeAtCollection

timestamp_t COLLECTOR::m_TimeAtCollection
protectedinherited

The time at which the collection was made.

Definition at line 74 of file collector.h.

Referenced by COLLECTOR::GetTime(), COLLECTOR::IsSimilarPointAndTime(), and COLLECTOR::SetTimeNow().

◆ m_Unit

int EE_COLLECTOR::m_Unit

Definition at line 108 of file ee_collectors.h.

Referenced by Collect(), and Inspect().

◆ RotatableItems

◆ SheetsAndSheetLabels

const KICAD_T EE_COLLECTOR::SheetsAndSheetLabels
static
Initial value:

Definition at line 46 of file ee_collectors.h.

Referenced by SCH_DRAWING_TOOLS::doTwoClickPlace().

◆ SheetsOnly

const KICAD_T EE_COLLECTOR::SheetsOnly
static

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