shape_index.h

Go to the documentation of this file.

/*
 * 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.
 *
 * @author Jacobo Aragunde Pérez
 * @author Tomasz Wlostowski <[email protected]>
 *
 * 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
 
#include <vector>
 
#include <geometry/rtree.h>
#include <geometry/shape.h>
#include <math/box2.h>
 
template <class T>
static const SHAPE* shapeFunctor( T aItem, int aLayer )
{
    return aItem->Shape( aLayer );
}
 
template <class T>
BOX2I boundingBox( T aObject, int aLayer )
{
    BOX2I bbox = shapeFunctor( aObject, aLayer )->BBox();
 
    return bbox;
}
 
template <class T, class V>
void acceptVisitor( T aObject, V aVisitor )
{
    aVisitor( aObject );
}
 
template <class T, class U>
bool collide( T aObject, U aAnotherObject, int aLayer, int aMinDistance )
{
    return shapeFunctor( aObject, aLayer )->Collide( aAnotherObject, aMinDistance );
}
 
template <class T, class V>
bool queryCallback( T aShape, void* aContext )
{
    V* visitor = (V*) aContext;
 
    acceptVisitor<T, V>( aShape, *visitor );
 
    return true;
}
 
template <class T = SHAPE*>
class SHAPE_INDEX
{
    public:
        class Iterator
        {
        private:
            typedef typename RTree<T, int, 2, double>::Iterator RTreeIterator;
            RTreeIterator iterator;
 
            void Init( RTree<T, int, 2, double>* aTree )
            {
                aTree->GetFirst( iterator );
            }
 
        public:
            Iterator( SHAPE_INDEX* aIndex )
            {
                Init( aIndex->m_tree );
            }
 
            T operator*()
            {
                return *iterator;
            }
 
            bool operator++()
            {
                return ++iterator;
            }
 
            bool operator++( int )
            {
                return ++iterator;
            }
 
            bool IsNull() const
            {
                return iterator.IsNull();
            }
 
            bool IsNotNull() const
            {
                return iterator.IsNotNull();
            }
 
            T Next()
            {
                T object = *iterator;
                ++iterator;
 
                return object;
            }
        };
 
        explicit SHAPE_INDEX( int aLayer );
 
        ~SHAPE_INDEX();
 
        void Add( T aShape );
 
        void Add( T aShape, const BOX2I& aBbox );
 
        void Remove( T aShape );
 
        void RemoveAll();
 
        template <class V>
        void Accept( V aVisitor )
        {
            Iterator iter = this->Begin();
 
            while( !iter.IsNull() )
            {
                T shape = *iter;
                acceptVisitor( shape, aVisitor );
                iter++;
            }
        }
 
        void Reindex();
 
        template <class V>
        int Query( const SHAPE *aShape, int aMinDistance, V& aVisitor) const
        {
            BOX2I box = aShape->BBox();
            box.Inflate( aMinDistance );
 
            int min[2] = { box.GetX(),         box.GetY() };
            int max[2] = { box.GetRight(),     box.GetBottom() };
 
            return this->m_tree->Search( min, max, aVisitor );
        }
 
        Iterator Begin();
 
    private:
        RTree<T, int, 2, double>* m_tree;
        int m_shapeLayer;
};
 
/*
 * Class members implementation
 */
 
template <class T>
SHAPE_INDEX<T>::SHAPE_INDEX( int aLayer )
{
    this->m_tree = new RTree<T, int, 2, double>();
    this->m_shapeLayer = aLayer;
}
 
template <class T>
SHAPE_INDEX<T>::~SHAPE_INDEX()
{
    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, this->m_shapeLayer );
    int min[2] = { box.GetX(), box.GetY() };
    int max[2] = { box.GetRight(), box.GetBottom() };
 
    this->m_tree->Insert( min, max, aShape );
}
 
template <class T>
void SHAPE_INDEX<T>::Remove( T aShape )
{
    BOX2I box = boundingBox( aShape, this->m_shapeLayer );
    int min[2] = { box.GetX(), box.GetY() };
    int max[2] = { box.GetRight(), box.GetBottom() };
 
    this->m_tree->Remove( min, max, aShape );
}
 
template <class T>
void SHAPE_INDEX<T>::RemoveAll()
{
    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>();
 
    Iterator iter = this->Begin();
 
    while( !iter.IsNull() )
    {
        T shape = *iter;
        BOX2I box = boundingBox( shape, this->m_shapeLayer );
        int min[2] = { box.GetX(), box.GetY() };
        int max[2] = { box.GetRight(), box.GetBottom() };
        newTree->Insert( min, max, shape );
        iter++;
    }
 
    delete this->m_tree;
    this->m_tree = newTree;
}
 
template <class T>
typename SHAPE_INDEX<T>::Iterator SHAPE_INDEX<T>::Begin()
{
    return Iterator( this );
}
 
#endif /* __SHAPE_INDEX_H */