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 191 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 193 of file sch_rtree.h.

 : type_tree( aTree )
 {
 KICAD_T type = BaseType( aType );
 
 if( type == SCH_LOCATE_ANY_T )
 m_rect = { { INT_MIN, INT_MIN, INT_MIN }, { INT_MAX, INT_MAX, INT_MAX } };
 else
 m_rect = { { type, INT_MIN, INT_MIN }, { type, INT_MAX, INT_MAX } };
 };

References BaseType(), m_rect, and SCH_LOCATE_ANY_T.

EE_TYPE() [2/2]

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

inline

Definition at line 203 of file sch_rtree.h.

 : type_tree( aTree )
 {
 KICAD_T type = BaseType( aType );
 
 if( type == SCH_LOCATE_ANY_T )
 {
 m_rect = { { INT_MIN, aRect.GetX(), aRect.GetY() },
 { INT_MAX, aRect.GetRight(), aRect.GetBottom() } };
 }
 else
 {
 m_rect = { { type, aRect.GetX(), aRect.GetY() },
 { type, aRect.GetRight(), aRect.GetBottom() } };
 }
 };

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

Member Function Documentation

begin()

iterator EE_RTREE::EE_TYPE::begin ( )

inline

Definition at line 222 of file sch_rtree.h.

 {
 return type_tree->begin( m_rect );
 }

References m_rect, and type_tree.

Referenced by SCH_SCREEN::HasItems().

empty()

bool EE_RTREE::EE_TYPE::empty ( )

inline

Definition at line 232 of file sch_rtree.h.

 {
 return type_tree->Count() == 0;
 }

References type_tree.

end()

iterator EE_RTREE::EE_TYPE::end ( )

inline

Definition at line 227 of file sch_rtree.h.

 {
 return type_tree->end( m_rect );
 }

References m_rect, and type_tree.

Referenced by SCH_SCREEN::HasItems().

Member Data Documentation

m_rect

ee_rtree::Rect EE_RTREE::EE_TYPE::m_rect

Definition at line 219 of file sch_rtree.h.

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

type_tree

ee_rtree* EE_RTREE::EE_TYPE::type_tree

Definition at line 220 of file sch_rtree.h.

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

---

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

• sch_rtree.h