kicad/include/geometry/shape_index.h

373 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
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/shape.h>
#include <geometry/rtree.h>
2013-09-13 13:43:33 +00:00
/**
* shapeFunctor template function
*
* It is used by SHAPE_INDEX to get a SHAPE* from another type.
* By default relies on T::GetShape() method, should be specialized if the T object
* doesn't allow that method.
* @param object generic T object
* @return a SHAPE* object equivalent to object.
*/
template <class T>
static const SHAPE* shapeFunctor( T aItem )
{
return aItem->GetShape();
}
2013-09-13 13:43:33 +00:00
/**
* shapeFunctor template function: specialization for T = SHAPE*
*/
template <>
2013-09-23 15:02:25 +00:00
const SHAPE* shapeFunctor( SHAPE* aItem );
2013-09-13 13:43:33 +00:00
/**
* boundingBox template method
*
* It is used by SHAPE_INDEX to get the bounding box of a generic T object.
* By default relies on T::BBox() method, should be specialized if the T object
* doesn't allow that method.
* @param object generic T object
* @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
{
return shapeFunctor( aObject )->BBox();
2013-09-13 13:43:33 +00:00
}
2013-09-13 13:43:33 +00:00
/**
* acceptVisitor template method
*
* It is used by SHAPE_INDEX to implement Accept().
* By default relies on V::operation() redefinition, should be specialized if V class
* doesn't have its () operation defined to accept T objects.
* @param object generic T object
* @param visitor V visitor object
*/
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
}
2013-09-13 13:43:33 +00:00
/**
* collide template method
*
* It is used by SHAPE_INDEX to implement Query().
* By default relies on T::Collide(U) method, should be specialized if the T object
* doesn't allow that method.
* @param object generic T object
* @param anotherObject generic U object
* @param minDistance minimum collision distance
* @return if object and anotherObject collide
*/
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, float>::Iterator RTreeIterator;
RTreeIterator iterator;
/**
* Function Init()
*
* Setup the internal tree iterator.
* @param tree pointer to a RTREE object
*/
void Init( RTree<T, int, 2, float>* aTree )
{
aTree->GetFirst( iterator );
2013-09-13 13:43:33 +00:00
}
public:
/**
* Iterator constructor
*
* Creates an iterator for the index object
* @param index SHAPE_INDEX object to iterate
*/
Iterator( SHAPE_INDEX* aIndex )
{
Init( aIndex->m_tree );
2013-09-13 13:43:33 +00:00
}
/**
* Operator * (prefix)
*
* Returns the next data element.
*/
T operator*()
{
2013-09-13 13:43:33 +00:00
return *iterator;
}
/**
* Operator ++ (prefix)
*
* Shifts the iterator to the next element.
*/
bool operator++()
{
2013-09-13 13:43:33 +00:00
return ++iterator;
}
/**
* Operator ++ (postfix)
*
* Shifts the iterator to the next element.
*/
bool operator++( int )
{
2013-09-13 13:43:33 +00:00
return ++iterator;
}
/**
* Function IsNull()
*
* Checks if the iterator has reached the end.
* @return true if it is in an invalid position (data finished)
*/
bool IsNull()
{
2013-09-13 13:43:33 +00:00
return iterator.IsNull();
}
/**
* Function IsNotNull()
*
* Checks if the iterator has not reached the end.
* @return true if it is in an valid position (data not finished)
*/
bool IsNotNull()
{
2013-09-13 13:43:33 +00:00
return iterator.IsNotNull();
}
/**
* Function Next()
*
* Returns the current element of the iterator and moves to the next
* position.
* @return 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();
/**
* Function Add()
*
* Adds a SHAPE to the index.
* @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
/**
* Function Remove()
*
* Removes a SHAPE to the index.
* @param aShape is the new SHAPE.
2013-09-23 15:02:25 +00:00
*/
void Remove( T aShape );
2013-09-23 15:02:25 +00:00
/**
* Function RemoveAll()
*
* Removes all the contents of the index.
*/
void RemoveAll();
/**
* Function Accept()
*
* Accepts a visitor for every SHAPE object contained in this INDEX.
* @param visitor Visitor object to be run
*/
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++;
}
}
/**
* Function Reindex()
*
* Rebuilds the index. This should be used if the geometry of the objects
* contained by the index has changed.
*/
void Reindex();
/**
* Function Query()
*
* Runs a callback on every SHAPE object contained in the bounding box of (shape).
* @param shape shape to search against
* @param minDistance distance threshold
* @param visitor object to be invoked on every object contained in the search area.
*/
template <class V>
int Query( const SHAPE *aShape, int aMinDistance, V& aVisitor, bool aExact )
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
/**
* Function Begin()
*
* Creates an iterator for the current index object
* @return iterator
*/
Iterator Begin();
private:
RTree<T, int, 2, float>* m_tree;
};
2013-09-13 13:43:33 +00:00
/*
* Class members implementation
*/
template <class T>
SHAPE_INDEX<T>::SHAPE_INDEX()
{
2013-09-13 13:43:33 +00:00
this->m_tree = new RTree<T, int, 2, float>();
}
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 )
{
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()
{
2013-09-13 13:43:33 +00:00
RTree<T, int, 2, float>* newTree;
newTree = new RTree<T, int, 2, float>();
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
}
#endif