EE_RTREE::EE_TYPE Struct Reference

The EE_TYPE struct provides a type-specific auto-range iterator to the RTree. More...

#include <sch_rtree.h>

Public Member Functions
	EE_TYPE (ee_rtree *aTree, KICAD_T aType)
	EE_TYPE (ee_rtree *aTree, KICAD_T aType, const BOX2I &aRect)
iterator	begin ()
iterator	end ()
bool	empty ()

Public Attributes
ee_rtree::Rect	m_rect
ee_rtree *	type_tree

Detailed Description

The EE_TYPE struct provides a type-specific auto-range iterator to the RTree.

Using this struct, one can write lines like:

for( auto item : rtree.OfType( SCH_SYMBOL_T ) )

and iterate over the RTree items that are symbols only

Definition at line 194 of file sch_rtree.h.

Constructor & Destructor Documentation

EE_TYPE() [1/2]

EE_RTREE::EE_TYPE::EE_TYPE ( ee_rtree * aTree, KICAD_T aType )

inline

Definition at line 196 of file sch_rtree.h.

References BaseType(), m_rect, SCH_LOCATE_ANY_T, and type_tree.

EE_TYPE() [2/2]

EE_RTREE::EE_TYPE::EE_TYPE ( ee_rtree * aTree, KICAD_T aType, const BOX2I & aRect )

inline

Definition at line 206 of file sch_rtree.h.

References BaseType(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), m_rect, SCH_LOCATE_ANY_T, and type_tree.

Member Function Documentation

begin()

iterator EE_RTREE::EE_TYPE::begin ( )

inline

Definition at line 225 of file sch_rtree.h.

References m_rect, and type_tree.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_SCREEN::HasItems().

empty()

bool EE_RTREE::EE_TYPE::empty ( )

inline

Definition at line 235 of file sch_rtree.h.

References type_tree.

end()

iterator EE_RTREE::EE_TYPE::end ( )

inline

Definition at line 230 of file sch_rtree.h.

References m_rect, and type_tree.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_SCREEN::HasItems().

Member Data Documentation

m_rect

ee_rtree::Rect EE_RTREE::EE_TYPE::m_rect

Definition at line 222 of file sch_rtree.h.

Referenced by begin(), EE_TYPE(), EE_TYPE(), and end().

type_tree

ee_rtree* EE_RTREE::EE_TYPE::type_tree

Definition at line 223 of file sch_rtree.h.

Referenced by begin(), EE_TYPE(), EE_TYPE(), empty(), and end().

---

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

• sch_rtree.h