pns_block_dragger.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 3 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 __PNS_BLOCK_DRAGGER_H
#define __PNS_BLOCK_DRAGGER_H
 
#include <set>
#include <unordered_set>
#include <vector>
 
#include <math/vector2d.h>
 
#include "pns_drag_algo.h"
 
namespace PNS
{
class ROUTER;

class BLOCK_DRAGGER : public DRAG_ALGO
{
public:
    BLOCK_DRAGGER( ROUTER* aRouter );
    ~BLOCK_DRAGGER();

    bool Start( const VECTOR2I& aP, ITEM_SET& aPrimitives ) override;

    bool Drag( const VECTOR2I& aP ) override;

    bool FixRoute( bool aForceCommit ) override;

    NODE* CurrentNode() const override;

    const std::vector<NET_HANDLE> CurrentNets() const override { return std::vector<NET_HANDLE>(); }

    virtual int CurrentLayer() const override { return UNDEFINED_LAYER; }

    const ITEM_SET Traces() override;

    const std::vector<LINE>& AnchoredLines() const { return m_anchoredLines; }
 
    void SetMode( PNS::DRAG_MODE aDragMode ) override { m_mode = aDragMode; }
 
    virtual PNS::DRAG_MODE Mode() const override { return m_mode; }
 
    bool GetForceMarkObstaclesMode( bool* aDragStatus ) const override
    {
        *aDragStatus = m_dragStatus;
        return true;
    }
 
private:
    struct DRAGGED_CONNECTION
    {
        LINE     origLine;
        VECTOR2I p_orig;           
        bool     dragBody = false; 
    };

    bool isFixedByLock( ITEM* aItem ) const;

    bool isPinned( const JOINT* aJoint, const LINE& aOwnLine ) const;

    bool isHeldByBlock( const JOINT* aJoint ) const;

    bool coveredBySolid( const JOINT* aJoint, bool aSelected ) const;

    bool isBlockBoundary( const JOINT* aJoint ) const;

    static LINE wrapLink( LINKED_ITEM* aLink );

    void classifySelectedLink( LINKED_ITEM* aLink );

    void clipToBlock( LINE& aLine, const VECTOR2I& aEntry, LINKED_ITEM* aLink ) const;

    void classifyNeighbour( const JOINT* aJoint, LINKED_ITEM* aLink );

    void scanJoint( const JOINT* aJoint );

    void scanRigidItem( ITEM* aItem );

    void displaceItem( ITEM* aItem, const VECTOR2I& aDelta );
 
    std::set<ITEM*>                 m_rigidItems;    
    std::set<ITEM*>                 m_bridgeItems;   
    std::vector<DRAGGED_CONNECTION> m_conns;         
    std::vector<LINE>               m_anchoredLines; 
 
    // Working state of Start()
    std::unordered_set<ITEM*>        m_selectedLinks; 
    std::unordered_set<LINKED_ITEM*> m_seenLinks;     
    std::set<const JOINT*>           m_carriedJoints; 
 
    bool           m_dragStatus;
    ITEM_SET       m_draggedItems;
    NODE*          m_currentNode;
    VECTOR2I       m_p0;
    PNS::DRAG_MODE m_mode;
};
 
}; // namespace PNS
 
#endif