pns_line_placer.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2013-2017 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @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 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_LINE_PLACER_H
#define __PNS_LINE_PLACER_H
 
#include <math/vector2d.h>
 
#include <geometry/shape.h>
#include <geometry/shape_line_chain.h>
 
#include "pns_line.h"
#include "pns_mouse_trail_tracer.h"
#include "pns_node.h"
#include "pns_placement_algo.h"
#include "pns_sizes_settings.h"
#include "pns_via.h"
#include "pns_walkaround.h"
 
namespace PNS {
 
class ROUTER;
class SHOVE;
class OPTIMIZER;
class VIA;
class SIZES_SETTINGS;
class NODE;
 
class FIXED_TAIL
{
public:
    FIXED_TAIL( int aLineCount = 1);
    ~FIXED_TAIL();
 
    struct FIX_POINT
    {
        int          layer;
        bool         placingVias;
        VECTOR2I     p;
        DIRECTION_45 direction;
    };
 
    struct STAGE
    {
        STAGE() :
            commit( nullptr )
        {}
 
        STAGE( const STAGE& aOther )
        {
            *this = aOther;
        }
 
        // Copy operator
        STAGE& operator=( const STAGE& aOther )
        {
            commit = aOther.commit;
            pts = aOther.pts;
            return *this;
        }
 
        // Move assignment operator
        STAGE& operator=( STAGE&& aOther ) noexcept
        {
            if (this != &aOther)
            {
                commit = aOther.commit;
                pts = std::move( aOther.pts );
            }
 
            return *this;
        }
 
        NODE*                  commit;
        std::vector<FIX_POINT> pts;
    };
 
    void Clear();
    void AddStage( const VECTOR2I& aStart, int aLayer, bool placingVias, DIRECTION_45 direction,
                   NODE* aNode );
    bool PopStage( STAGE& aStage );
    int StageCount() const;
 
private:
    std::vector<STAGE> m_stages;
};
 

 
class LINE_PLACER : public PLACEMENT_ALGO
{
public:
    LINE_PLACER( ROUTER* aRouter );
    ~LINE_PLACER();

    bool Start( const VECTOR2I& aP, ITEM* aStartItem ) override;

    bool Move( const VECTOR2I& aP, ITEM* aEndItem ) override;

    bool FixRoute( const VECTOR2I& aP, ITEM* aEndItem, bool aForceFinish ) override;
 
    std::optional<VECTOR2I> UnfixRoute() override;
 
    bool CommitPlacement() override;
 
    bool AbortPlacement() override;
 
    bool HasPlacedAnything() const override;

    bool ToggleVia( bool aEnabled ) override;

    bool SetLayer( int aLayer ) override;

    const LINE& Head() const { return m_head; }

    const LINE& Tail() const { return m_tail; }

    const LINE Trace() const;

    const ITEM_SET Traces() override;

    const VECTOR2I& CurrentStart() const override
    {
        return m_currentStart;
    }

    const VECTOR2I& CurrentEnd() const override
    {
        return m_currentEnd;
    }

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

    int CurrentLayer() const override
    {
        return m_currentLayer;
    }

    NODE* CurrentNode( bool aLoopsRemoved = false ) const override;

    void FlipPosture() override;

    void UpdateSizes( const SIZES_SETTINGS& aSizes ) override;
 
    void SetOrthoMode( bool aOrthoMode ) override;
 
    bool IsPlacingVia() const override { return m_placingVia; }
 
    void GetModifiedNets( std::vector<NET_HANDLE>& aNets ) const override;
 
 
private:
    bool route( const VECTOR2I& aP );

    void updateLeadingRatLine();

    void setWorld( NODE* aWorld );

    void initPlacement();

    void setInitialDirection( const DIRECTION_45& aDirection );

    bool handleSelfIntersections();

    bool handlePullback();

    bool mergeHead();

    bool reduceTail( const VECTOR2I& aEnd );

    bool optimizeTailHeadTransition();

    bool routeHead( const VECTOR2I& aP, LINE& aNewHead, LINE& aNewTail );

    void routeStep( const VECTOR2I& aP );

    bool rhWalkOnly( const VECTOR2I& aP, LINE& aNewHead, LINE& aNewTail );
    bool rhWalkBase( const VECTOR2I& aP, LINE& aWalkLine, int aCollisionMask, PNS::PNS_MODE aMode, bool& aViaOk );
    bool splitHeadTail( const LINE& aNewLine, const LINE& aOldTail, LINE& aNewHead, LINE& aNewTail );
    bool cursorDistMinimum( const SHAPE_LINE_CHAIN& aL, const VECTOR2I& aCursor,  double lengthThreshold, SHAPE_LINE_CHAIN& aOut );
    bool clipAndCheckCollisions( const VECTOR2I& aP, const SHAPE_LINE_CHAIN& aL, SHAPE_LINE_CHAIN& aOut, int &thresholdDist );
 
    void updatePStart( const LINE& tail );
 
    //bool rhPostSplitHeadTail( )

    bool rhShoveOnly( const VECTOR2I& aP, LINE& aNewHead, LINE& aNewTail );

    bool rhMarkObstacles( const VECTOR2I& aP, LINE& aNewHead, LINE& aNewTail );
 
    const VIA makeVia( const VECTOR2I& aP );
 
    bool buildInitialLine( const VECTOR2I& aP, LINE& aHead, PNS::PNS_MODE aMode, bool aForceNoVia = false );
 
 
    DIRECTION_45   m_direction;         
    DIRECTION_45   m_initial_direction; 
 
    LINE           m_head;          
 
    LINE           m_tail;          
 
    NODE*          m_world;         
    VECTOR2I       m_p_start;       
    VECTOR2I       m_fixStart;       
 
    std::optional<VECTOR2I>       m_last_p_end;
 
    std::unique_ptr<SHOVE> m_shove; 
 
    NODE*          m_currentNode;   
    NODE*          m_lastNode;      
 
    SIZES_SETTINGS m_sizes;
 
    bool           m_placingVia;
 
    NET_HANDLE     m_currentNet;
    int            m_currentLayer;
 
    VECTOR2I       m_currentEnd;
    VECTOR2I       m_currentStart;
    LINE           m_currentTrace;
 
    ITEM*          m_startItem;
    ITEM*          m_endItem;
 
    bool           m_idle;
    bool           m_chainedPlacement;
    bool           m_orthoMode;
    bool           m_placementCorrect;
 
    FIXED_TAIL     m_fixedTail;
    MOUSE_TRAIL_TRACER m_mouseTrailTracer;
};
 
}
 
#endif    // __PNS_LINE_PLACER_H