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 (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 *
 * 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 <http://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_sizes_settings.h"
#include "pns_node.h"
#include "pns_via.h"
#include "pns_line.h"
#include "pns_placement_algo.h"
#include "pns_mouse_trail_tracer.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
    {
        NODE*                  commit;
        std::vector<FIX_POINT> pts;
    };

    void Clear();
    void AddStage( 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;

    bool 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& CurrentEnd() const override
    {
        return m_currentEnd;
    }

    const std::vector<int> CurrentNets() const override
    {
        return std::vector<int>( 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<int>& aNets ) const override;

    bool SplitAdjacentSegments( NODE* aNode, ITEM* aSeg, const VECTOR2I& aP );


private:
    bool route( const VECTOR2I& aP );

    void updateLeadingRatLine();

    void setWorld( NODE* aWorld );

    void initPlacement();

    void setInitialDirection( const DIRECTION_45& aDirection );

    void removeLoops( NODE* aNode, LINE& aLatest );

    void simplifyNewLine( NODE* aNode, LINKED_ITEM* aLatest );

    bool handleSelfIntersections();

    bool handlePullback();

    bool mergeHead();

    bool reduceTail( const VECTOR2I& aEnd );

    bool optimizeTailHeadTransition();

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

    void routeStep( const VECTOR2I& aP );

    bool rhWalkOnly( const VECTOR2I& aP, LINE& aNewHead );

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

    bool rhMarkObstacles( const VECTOR2I& aP, LINE& aNewHead );

    const VIA makeVia( const VECTOR2I& aP );

    bool buildInitialLine( const VECTOR2I& aP, LINE& aHead );


    DIRECTION_45   m_direction;         
    DIRECTION_45   m_initial_direction; 

    LINE           m_head;          

    LINE           m_tail;          

    NODE*          m_world;         
    VECTOR2I       m_p_start;       

    std::unique_ptr<SHOVE> m_shove; 

    NODE*          m_currentNode;   
    NODE*          m_lastNode;      

    SIZES_SETTINGS m_sizes;

    bool           m_placingVia;

    int            m_currentNet;
    int            m_currentLayer;

    VECTOR2I       m_currentEnd;
    VECTOR2I       m_currentStart;
    LINE           m_currentTrace;

    PNS_MODE       m_currentMode;
    ITEM*          m_startItem;

    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