ratsnest_data.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-2015 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[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 RATSNEST_DATA_H
#define RATSNEST_DATA_H
 
#include <algorithm>
#include <core/typeinfo.h>
#include <math/box2.h>
 
#include <set>
#include <vector>
 
#include <connectivity/connectivity_algo.h>
 
class BOARD_ITEM;
class BOARD_CONNECTED_ITEM;
class CN_CLUSTER;
 
struct CN_PTR_CMP
{
    bool operator()( const std::shared_ptr<CN_ANCHOR>& aItem,
                     const std::shared_ptr<CN_ANCHOR>& bItem ) const
    {
        if( aItem->Pos().x == bItem->Pos().x )
            return aItem->Pos().y < bItem->Pos().y;
        else
            return aItem->Pos().x < bItem->Pos().x;
    }
};

class RN_NET
{
public:
    RN_NET();

    bool IsDirty() const { return m_dirty; }

    void UpdateNet();
 
    void RemoveInvalidRefs();

    void OptimizeRNEdges();
 
    void Clear();
 
    void AddCluster( std::shared_ptr<CN_CLUSTER> aCluster );
 
    unsigned int GetNodeCount() const { return m_nodes.size(); }
 
    const std::vector<CN_EDGE>& GetEdges() const
    {
        // Use a const_cast to allow sorting in the const method
        // This is safe because we're not changing the logical content of the vector,
        // just the ordering of elements
        std::stable_sort( const_cast<std::vector<CN_EDGE>&>( m_rnEdges ).begin(),
                          const_cast<std::vector<CN_EDGE>&>( m_rnEdges ).end(),
                          []( const CN_EDGE& a, const CN_EDGE& b )
                          {
                              return a.StableSortCompare( b );
                          } );
        return m_rnEdges;
    }
    std::vector<CN_EDGE>& GetEdges()
    {
        std::stable_sort( m_rnEdges.begin(), m_rnEdges.end(),
                          []( const CN_EDGE& a, const CN_EDGE& b )
                          {
                              return a.StableSortCompare( b );
                          } );
        return m_rnEdges;
    }
 
    bool NearestBicoloredPair( RN_NET* aOtherNet, VECTOR2I& aPos1, VECTOR2I& aPos2 ) const;
 
protected:
    void compute();

    void kruskalMST( const std::vector<CN_EDGE> &aEdges );
 
protected:
    std::multiset<std::shared_ptr<CN_ANCHOR>, CN_PTR_CMP> m_nodes;

    std::vector<CN_EDGE> m_boardEdges;

    std::vector<CN_EDGE> m_rnEdges;

    bool m_dirty;
 
    class TRIANGULATOR_STATE;
 
    std::shared_ptr<TRIANGULATOR_STATE> m_triangulator;
};
 
#endif /* RATSNEST_DATA_H */