SHAPE_INDEX< T > Class Template Reference

Classes
class	Iterator

Public Member Functions
void	Add (T aShape)
	Add a SHAPE to the index. More...
void	Add (T aShape, const BOX2I &aBbox)
	Add a shape with alternate BBox. More...
void	Remove (T aShape)
	Remove a SHAPE from the index. More...
void	RemoveAll ()
	Remove all the contents of the index.
template<class V >
void	Accept (V aVisitor)
	Accept a visitor for every SHAPE object contained in this INDEX. More...
void	Reindex ()
	Rebuild the index. More...
template<class V >
int	Query (const SHAPE *aShape, int aMinDistance, V &aVisitor) const
	Run a callback on every SHAPE object contained in the bounding box of (shape). More...
Iterator	Begin ()
	Create an iterator for the current index object. More...

Member Function Documentation

Accept()

template<class T = SHAPE*>

template<class V >

void SHAPE_INDEX< T >::Accept ( V  aVisitor )

inline

Accept a visitor for every SHAPE object contained in this INDEX.

Parameters

aVisitor

is the visitor object to be run.

Add() [1/2]

template<class T >

void SHAPE_INDEX< T >::Add

(

T

aShape

)

Add a SHAPE to the index.

Parameters

aShape

is the new SHAPE.

Add() [2/2]

template<class T >

void SHAPE_INDEX< T >::Add	(	T	aShape,
		const BOX2I &	aBbox
	)

Add a shape with alternate BBox.

Parameters

aShape	Shape (Item) to add.
aBbox	alternate bounding box. This should be a subset of the item's bbox

Begin()

template<class T >

SHAPE_INDEX< T >::Iterator SHAPE_INDEX< T >::Begin

Create an iterator for the current index object.

Returns

iterator to the first object.

Query()

template<class T = SHAPE*>

template<class V >

int SHAPE_INDEX< T >::Query ( const SHAPE *  aShape, int  aMinDistance, V &  aVisitor  ) const

inline

Run a callback on every SHAPE object contained in the bounding box of (shape).

Parameters

aShape	is the shape to search against.
aMinDistance	is the distance threshold.
aVisitor	is the object to be invoked on every object contained in the search area.

Reindex()

template<class T >

void SHAPE_INDEX< T >::Reindex

Rebuild the index.

This should be used if the geometry of the objects contained by the index has changed.

Remove()

template<class T >

void SHAPE_INDEX< T >::Remove

(

T

aShape

)

Remove a SHAPE from the index.

Parameters

aShape

is the SHAPE to remove.

---

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

• 3rd_party/router/kimath/include/geometry/shape_index.h