kicad/libs/kimath/include/geometry/shape_index.h

366 lines
9.4 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2013 CERN
* Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
*
2013-09-13 13:43:33 +00:00
* @author Jacobo Aragunde Pérez
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef __SHAPE_INDEX_H
#define __SHAPE_INDEX_H
2013-09-13 13:43:33 +00:00
#include <vector>
#include <geometry/rtree.h>
#include <geometry/shape.h>
#include <math/box2.h>
2013-09-13 13:43:33 +00:00
/**
* Used by #SHAPE_INDEX to get a SHAPE* from another type.
2013-09-13 13:43:33 +00:00
*
* By default relies on T::GetShape() method, should be specialized if the T object
* doesn't allow that method.
*
* @param aItem generic T object.
2013-09-13 13:43:33 +00:00
* @return a SHAPE* object equivalent to object.
*/
template <class T>
static const SHAPE* shapeFunctor( T aItem )
{
return aItem->Shape();
2013-09-13 13:43:33 +00:00
}
/**
* Used by #SHAPE_INDEX to get the bounding box of a generic T object.
2013-09-13 13:43:33 +00:00
*
* By default relies on T::BBox() method, should be specialized if the T object
* doesn't allow that method.
*
* @param aObject is a generic T object.
2013-09-13 13:43:33 +00:00
* @return a BOX2I object containing the bounding box of the T object.
*/
template <class T>
BOX2I boundingBox( T aObject )
2013-09-13 13:43:33 +00:00
{
BOX2I bbox = shapeFunctor( aObject )->BBox();
return bbox;
2013-09-13 13:43:33 +00:00
}
/**
* Used by #SHAPE_INDEX to implement Accept().
2013-09-13 13:43:33 +00:00
*
* By default relies on V::operation() redefinition, should be specialized if V class
* doesn't have its () operation defined to accept T objects.
*
* @param aObject is a generic T object.
* @param aVisitor is a visitor object.
2013-09-13 13:43:33 +00:00
*/
template <class T, class V>
void acceptVisitor( T aObject, V aVisitor )
2013-09-13 13:43:33 +00:00
{
aVisitor( aObject );
2013-09-13 13:43:33 +00:00
}
/**
* Used by #SHAPE_INDEX to implement Query().
2013-09-13 13:43:33 +00:00
*
* By default relies on T::Collide(U) method, should be specialized if the T object
* doesn't allow that method.
*
* @param aObject is a generic T object.
* @param aAnotherObject is a generic U object.
* @param aMinDistance is the minimum collision distance.
* @return true if object and anotherObject collide.
2013-09-13 13:43:33 +00:00
*/
template <class T, class U>
bool collide( T aObject, U aAnotherObject, int aMinDistance )
{
return shapeFunctor( aObject )->Collide( aAnotherObject, aMinDistance );
2013-09-13 13:43:33 +00:00
}
template <class T, class V>
bool queryCallback( T aShape, void* aContext )
{
V* visitor = (V*) aContext;
acceptVisitor<T, V>( aShape, *visitor );
2013-09-13 13:43:33 +00:00
return true;
}
template <class T = SHAPE*>
class SHAPE_INDEX
{
2013-09-13 13:43:33 +00:00
public:
class Iterator
{
private:
typedef typename RTree<T, int, 2, double>::Iterator RTreeIterator;
2013-09-13 13:43:33 +00:00
RTreeIterator iterator;
/**
* Setup the internal tree iterator.
*
* @param aTree is a #RTREE object/
2013-09-13 13:43:33 +00:00
*/
void Init( RTree<T, int, 2, double>* aTree )
{
aTree->GetFirst( iterator );
2013-09-13 13:43:33 +00:00
}
public:
/**
* Create an iterator for the index object.
2013-09-13 13:43:33 +00:00
*
* @param aIndex is a #SHAPE_INDEX object to iterate.
2013-09-13 13:43:33 +00:00
*/
Iterator( SHAPE_INDEX* aIndex )
{
Init( aIndex->m_tree );
2013-09-13 13:43:33 +00:00
}
/**
* Return the next data element.
2013-09-13 13:43:33 +00:00
*/
T operator*()
{
2013-09-13 13:43:33 +00:00
return *iterator;
}
/**
* Shift the iterator to the next element.
2013-09-13 13:43:33 +00:00
*/
bool operator++()
{
2013-09-13 13:43:33 +00:00
return ++iterator;
}
/**
* Shift the iterator to the next element.
2013-09-13 13:43:33 +00:00
*/
bool operator++( int )
{
2013-09-13 13:43:33 +00:00
return ++iterator;
}
/**
* Check if the iterator has reached the end.
2013-09-13 13:43:33 +00:00
*
* @return true if it is in an invalid position (data finished).
2013-09-13 13:43:33 +00:00
*/
2020-10-27 11:03:35 +00:00
bool IsNull() const
{
2013-09-13 13:43:33 +00:00
return iterator.IsNull();
}
/**
* Check if the iterator has not reached the end.
2013-09-13 13:43:33 +00:00
*
* @return true if it is in an valid position (data not finished).
2013-09-13 13:43:33 +00:00
*/
2020-10-27 11:03:35 +00:00
bool IsNotNull() const
{
2013-09-13 13:43:33 +00:00
return iterator.IsNotNull();
}
/**
* Return the current element of the iterator and moves to the next position.
2013-09-13 13:43:33 +00:00
*
* @return a #SHAPE object pointed by the iterator before moving to the next position.
2013-09-13 13:43:33 +00:00
*/
T Next()
{
2013-09-13 13:43:33 +00:00
T object = *iterator;
++iterator;
2013-09-13 13:43:33 +00:00
return object;
}
};
2013-09-23 15:02:25 +00:00
SHAPE_INDEX();
~SHAPE_INDEX();
/**
* Add a #SHAPE to the index.
2013-09-23 15:02:25 +00:00
*
* @param aShape is the new SHAPE.
2013-09-23 15:02:25 +00:00
*/
void Add( T aShape );
2013-09-23 15:02:25 +00:00
/**
* Add a shape with alternate BBox.
*
* @param aShape Shape (Item) to add.
* @param aBbox alternate bounding box. This should be a subset of the item's bbox
*/
void Add( T aShape, const BOX2I& aBbox );
2013-09-23 15:02:25 +00:00
/**
* Remove a #SHAPE from the index.
2013-09-23 15:02:25 +00:00
*
* @param aShape is the #SHAPE to remove.
2013-09-23 15:02:25 +00:00
*/
void Remove( T aShape );
2013-09-23 15:02:25 +00:00
/**
* Remove all the contents of the index.
2013-09-23 15:02:25 +00:00
*/
void RemoveAll();
/**
* Accept a visitor for every #SHAPE object contained in this INDEX.
2013-09-23 15:02:25 +00:00
*
* @param aVisitor is the visitor object to be run.
2013-09-23 15:02:25 +00:00
*/
template <class V>
void Accept( V aVisitor )
2013-09-23 15:02:25 +00:00
{
Iterator iter = this->Begin();
while( !iter.IsNull() )
{
2013-09-23 15:02:25 +00:00
T shape = *iter;
acceptVisitor( shape, aVisitor );
2013-09-23 15:02:25 +00:00
iter++;
}
}
/**
* Rebuild the index.
2013-09-23 15:02:25 +00:00
*
* This should be used if the geometry of the objects contained by the index has changed.
2013-09-23 15:02:25 +00:00
*/
void Reindex();
/**
* Run a callback on every #SHAPE object contained in the bounding box of (shape).
2013-09-23 15:02:25 +00:00
*
* @param aShape is the shape to search against.
* @param aMinDistance is the distance threshold.
* @param aVisitor is the object to be invoked on every object contained in the search area.
2013-09-23 15:02:25 +00:00
*/
template <class V>
2020-10-27 11:03:35 +00:00
int Query( const SHAPE *aShape, int aMinDistance, V& aVisitor) const
2013-09-23 15:02:25 +00:00
{
BOX2I box = aShape->BBox();
box.Inflate( aMinDistance );
2013-09-23 15:02:25 +00:00
int min[2] = { box.GetX(), box.GetY() };
int max[2] = { box.GetRight(), box.GetBottom() };
return this->m_tree->Search( min, max, aVisitor );
2013-09-23 15:02:25 +00:00
}
2013-09-13 13:43:33 +00:00
/**
* Create an iterator for the current index object.
2013-09-13 13:43:33 +00:00
*
* @return iterator to the first object.
2013-09-13 13:43:33 +00:00
*/
Iterator Begin();
private:
RTree<T, int, 2, double>* m_tree;
};
2013-09-13 13:43:33 +00:00
/*
* Class members implementation
*/
template <class T>
SHAPE_INDEX<T>::SHAPE_INDEX()
{
this->m_tree = new RTree<T, int, 2, double>();
2013-09-13 13:43:33 +00:00
}
template <class T>
SHAPE_INDEX<T>::~SHAPE_INDEX()
{
2013-09-13 13:43:33 +00:00
delete this->m_tree;
}
template <class T>
void SHAPE_INDEX<T>::Add( T aShape, const BOX2I& aBbox )
{
int min[2] = { aBbox.GetX(), aBbox.GetY() };
int max[2] = { aBbox.GetRight(), aBbox.GetBottom() };
this->m_tree->Insert( min, max, aShape );
}
template <class T>
void SHAPE_INDEX<T>::Add( T aShape )
{
BOX2I box = boundingBox( aShape );
int min[2] = { box.GetX(), box.GetY() };
int max[2] = { box.GetRight(), box.GetBottom() };
this->m_tree->Insert( min, max, aShape );
2013-09-13 13:43:33 +00:00
}
template <class T>
void SHAPE_INDEX<T>::Remove( T aShape )
{
BOX2I box = boundingBox( aShape );
int min[2] = { box.GetX(), box.GetY() };
int max[2] = { box.GetRight(), box.GetBottom() };
this->m_tree->Remove( min, max, aShape );
2013-09-13 13:43:33 +00:00
}
template <class T>
void SHAPE_INDEX<T>::RemoveAll()
{
2013-09-13 13:43:33 +00:00
this->m_tree->RemoveAll();
}
template <class T>
void SHAPE_INDEX<T>::Reindex()
{
RTree<T, int, 2, double>* newTree;
newTree = new RTree<T, int, 2, double>();
2013-09-13 13:43:33 +00:00
2013-09-23 15:02:25 +00:00
Iterator iter = this->Begin();
while( !iter.IsNull() )
{
2013-09-13 13:43:33 +00:00
T shape = *iter;
BOX2I box = boundingBox( shape );
int min[2] = { box.GetX(), box.GetY() };
int max[2] = { box.GetRight(), box.GetBottom() };
newTree->Insert( min, max, shape );
2013-09-13 13:43:33 +00:00
iter++;
}
2013-09-13 13:43:33 +00:00
delete this->m_tree;
this->m_tree = newTree;
}
template <class T>
typename SHAPE_INDEX<T>::Iterator SHAPE_INDEX<T>::Begin()
{
return Iterator( this );
2013-09-13 13:43:33 +00:00
}
2020-10-27 11:03:35 +00:00
#endif /* __SHAPE_INDEX_H */