pns_diff_pair_placer.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2013-2014 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_DIFF_PLACER_H
#define __PNS_DIFF_PLACER_H
 
#include <math/vector2d.h>
 
#include "pns_sizes_settings.h"
#include "pns_node.h"
#include "pns_via.h"
#include "pns_line.h"
#include "pns_algo_base.h"
#include "pns_diff_pair.h"
 
#include "pns_placement_algo.h"
 
namespace PNS {
 
class ROUTER;
class SHOVE;
class OPTIMIZER;
class VIA;
class SIZES_SETTINGS;
 

 
class DIFF_PAIR_PLACER : public PLACEMENT_ALGO
{
public:
    DIFF_PAIR_PLACER( ROUTER* aRouter );
    ~DIFF_PAIR_PLACER();
 
    bool FindDpPrimitivePair( NODE* aWorld, const VECTOR2I& aP, ITEM* aItem,
                                     DP_PRIMITIVE_PAIR& aPair, wxString* aErrorMsg = nullptr );

    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 CommitPlacement() override;

    bool AbortPlacement() override;

    bool HasPlacedAnything() const override;

    bool ToggleVia( bool aEnabled ) override;

    bool SetLayer( int aLayer ) override;

    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;

    int CurrentLayer() const override
    {
        return m_currentLayer;
    }

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

    void FlipPosture() override;

    void UpdateSizes( const SIZES_SETTINGS& aSizes ) override;
 
    bool IsPlacingVia() const override { return m_placingVia; }
 
    void SetOrthoMode( bool aOrthoMode ) override;
 
    void GetModifiedNets( std::vector<NET_HANDLE>& aNets ) const override;
 
    const DIFF_PAIR CurrentTrace() const { return m_currentTrace; }
  
 
private:
    static constexpr int DP_DEFAULT_GAP_EPSILON = 1000;
 
 
    int viaGap() const;
    int gap() const;

    bool route( const VECTOR2I& aP );

    void updateLeadingRatLine();

    void setWorld( NODE* aWorld );

    void initPlacement( );

    void setInitialDirection( const DIRECTION_45& aDirection );
 
 
    bool routeHead( const VECTOR2I& aP );
    bool tryWalkDp( NODE* aNode, DIFF_PAIR& aPair, bool aSolidsOnly );

    bool rhWalkOnly( const VECTOR2I& aP );

    bool rhShoveOnly ( const VECTOR2I& aP );

    bool rhMarkObstacles( const VECTOR2I& aP );
 
    const VIA makeVia ( const VECTOR2I& aP, NET_HANDLE aNet );
 
    bool attemptWalk( NODE* aNode, DIFF_PAIR* aCurrent, DIFF_PAIR& aWalk, bool aPFirst,
                      bool aWindCw, bool aSolidsOnly );
    bool propagateDpHeadForces ( const VECTOR2I& aP, VECTOR2I& aNewP );
 
    bool findDpEndingPrimitives( NODE* aWorld, const VECTOR2I& aP, ITEM* aStartItem,
                                            DP_PRIMITIVE_PAIR& aPair, wxString* aErrorMsg );
 
    bool findDpMidtraceIntersection( NODE* aWorld, const VECTOR2I& aP,
                                                   ITEM* aStartItem, DP_PRIMITIVE_PAIR& aPair,
                                                   wxString* aErrorMsg );
    enum State {
        RT_START = 0,
        RT_ROUTE = 1,
        RT_FINISH = 2
    };
 
    State m_state;
 
    bool m_chainedPlacement;
    bool m_initialDiagonal;
    bool m_startDiagonal;
    bool m_fitOk;
 
    NET_HANDLE m_netP, m_netN;
 
    DP_PRIMITIVE_PAIR m_start;
    std::optional<DP_PRIMITIVE_PAIR> m_prevPair;

    int m_iteration;

    NODE* m_world;

    VECTOR2I m_p_start;

    std::unique_ptr<SHOVE> m_shove;

    NODE* m_currentNode;

    NODE* m_lastNode;
    NODE* m_lastFixNode;
 
    SIZES_SETTINGS m_sizes;

    bool m_placingVia;

    int m_viaDiameter;

    int m_viaDrill;

    int m_currentWidth;
 
    int m_currentLayer;
 
    bool m_startsOnVia;
    bool m_orthoMode;
    bool m_snapOnTarget;
 
    VECTOR2I m_currentEnd, m_currentStart;
    DIFF_PAIR m_currentTrace;
    std::optional<DP_PRIMITIVE_PAIR> m_target;
    bool m_currentTraceOk;
 
    ITEM* m_currentEndItem;
 
    bool m_idle;
    bool m_hasFixedAnything;
};
 
}
 
#endif    // __PNS_LINE_PLACER_H