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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef __SHAPE_INDEX_H
#define __SHAPE_INDEX_H
 
#include <vector>
 
#include <geometry/rtree/dynamic_rtree_cow.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:
        using TREE_TYPE = KIRTREE::COW_RTREE<T, int, 2>;
 
        class Iterator
        {
        private:
            using TreeIterator = typename TREE_TYPE::Iterator;
            TreeIterator m_current;
            TreeIterator m_end;
 
        public:
            Iterator( const TREE_TYPE& aTree ) :
                    m_current( aTree.begin() ),
                    m_end( aTree.end() )
            {
            }
 
            T operator*()
            {
                return *m_current;
            }

            bool operator++()
            {
                ++m_current;
                return m_current != m_end;
            }

            bool operator++( int )
            {
                ++m_current;
                return m_current != m_end;
            }

            bool IsNull() const
            {
                return m_current == m_end;
            }

            bool IsNotNull() const
            {
                return m_current != m_end;
            }

            T Next()
            {
                T object = *m_current;
                ++m_current;
 
                return object;
            }
        };
 
        explicit SHAPE_INDEX( int aLayer ) : m_shapeLayer( aLayer ) {}
 
        ~SHAPE_INDEX() = default;
 
        // Move semantics
        SHAPE_INDEX( SHAPE_INDEX&& aOther ) noexcept = default;
        SHAPE_INDEX& operator=( SHAPE_INDEX&& aOther ) noexcept = default;
 
        // Non-copyable (use Clone() for intentional sharing)
        SHAPE_INDEX( const SHAPE_INDEX& ) = delete;
        SHAPE_INDEX& operator=( const SHAPE_INDEX& ) = delete;

        SHAPE_INDEX Clone() const
        {
            SHAPE_INDEX clone( m_shapeLayer );
            clone.m_tree = m_tree.Clone();
            return clone;
        }

        void Add( T aShape )
        {
            BOX2I box = boundingBox( aShape, m_shapeLayer );
            int min[2] = { box.GetX(), box.GetY() };
            int max[2] = { box.GetRight(), box.GetBottom() };
 
            m_tree.Insert( min, max, aShape );
        }

        void Add( T aShape, const BOX2I& aBbox )
        {
            int min[2] = { aBbox.GetX(), aBbox.GetY() };
            int max[2] = { aBbox.GetRight(), aBbox.GetBottom() };
 
            m_tree.Insert( min, max, aShape );
        }

        void Remove( T aShape )
        {
            BOX2I box = boundingBox( aShape, m_shapeLayer );
            int min[2] = { box.GetX(), box.GetY() };
            int max[2] = { box.GetRight(), box.GetBottom() };
 
            m_tree.Remove( min, max, aShape );
        }

        void RemoveAll()
        {
            m_tree.RemoveAll();
        }

        template <class V>
        void Accept( V aVisitor )
        {
            for( const T& item : m_tree )
                acceptVisitor( item, aVisitor );
        }

        void BulkLoad( std::vector<std::pair<T, BOX2I>>& aItems )
        {
            using BULK_ENTRY = typename TREE_TYPE::BULK_ENTRY;
            std::vector<BULK_ENTRY> entries;
            entries.reserve( aItems.size() );
 
            for( const auto& [item, box] : aItems )
            {
                BULK_ENTRY e;
                e.min[0] = box.GetX();
                e.min[1] = box.GetY();
                e.max[0] = box.GetRight();
                e.max[1] = box.GetBottom();
                e.data = item;
                entries.push_back( e );
            }
 
            m_tree.BulkLoad( entries );
        }

        void Reindex()
        {
            std::vector<T> items;
            items.reserve( m_tree.size() );
 
            for( const T& item : m_tree )
                items.push_back( item );
 
            m_tree.RemoveAll();
 
            for( T& item : items )
                Add( item );
        }

        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 m_tree.Search( min, max, aVisitor );
        }

        Iterator Begin() const
        {
            return Iterator( m_tree );
        }
 
        // Range-for support
        typename TREE_TYPE::Iterator begin() const { return m_tree.begin(); }
        typename TREE_TYPE::Iterator end() const { return m_tree.end(); }
 
        size_t Size() const { return m_tree.size(); }
 
    private:
        TREE_TYPE m_tree;
        int m_shapeLayer;
};
 
#endif /* __SHAPE_INDEX_H */