PNS::COMPONENT_DRAGGER Class Reference

COMPONENT_DRAGGER. More...

#include <pns_component_dragger.h>

Inheritance diagram for PNS::COMPONENT_DRAGGER:

Classes
struct	DRAGGED_CONNECTION

Public Member Functions
	COMPONENT_DRAGGER (ROUTER *aRouter)
	~COMPONENT_DRAGGER ()
bool	Start (const VECTOR2I &aP, ITEM_SET &aPrimitives) override
	Function Start() More...
bool	Drag (const VECTOR2I &aP) override
	Function Drag() More...
bool	FixRoute () override
	Function FixRoute() More...
NODE *	CurrentNode () const override
	Function CurrentNode() More...
const std::vector< int >	CurrentNets () const override
	Function CurrentNets() More...
virtual int	CurrentLayer () const override
	Function CurrentLayer() More...
const ITEM_SET	Traces () override
	Function Traces() More...
virtual void	SetWorld (NODE *aWorld)
	Function SetWorld() More...
virtual void	SetMode (int aDragMode)
ROUTER *	Router () const
	Return current router settings. More...
ROUTING_SETTINGS &	Settings () const
	Return the logger object, allowing to dump geometry to a file. More...
virtual LOGGER *	Logger ()
void	SetLogger (LOGGER *aLogger)
void	SetDebugDecorator (DEBUG_DECORATOR *aDecorator)
	Assign a debug decorator allowing this algo to draw extra graphics for visual debugging. More...
DEBUG_DECORATOR *	Dbg () const
const BOX2I &	VisibleViewArea () const

Protected Attributes
NODE *	m_world
DEBUG_DECORATOR *	m_debugDecorator
ROUTER *	m_router
LOGGER *	m_logger

Private Attributes
std::set< SOLID * >	m_solids
std::vector< DRAGGED_CONNECTION >	m_conns
bool	m_dragStatus
ITEM_SET	m_draggedItems
ITEM_SET	m_initialDraggedItems
NODE *	m_currentNode
VECTOR2I	m_p0

Detailed Description

COMPONENT_DRAGGER.

Implements component dragging algorithm.

Definition at line 38 of file pns_component_dragger.h.

Constructor & Destructor Documentation

COMPONENT_DRAGGER()

PNS::COMPONENT_DRAGGER::COMPONENT_DRAGGER

(

ROUTER *

aRouter

)

Definition at line 33 of file pns_component_dragger.cpp.

                                                      : DRAG_ALGO( aRouter )
{
    // ensure all variables are initialized
    m_dragStatus = false;
    m_currentNode = nullptr;
}

References m_currentNode, and m_dragStatus.

~COMPONENT_DRAGGER()

PNS::COMPONENT_DRAGGER::~COMPONENT_DRAGGER

(

)

Definition at line 41 of file pns_component_dragger.cpp.

{
}

Member Function Documentation

CurrentLayer()

virtual int PNS::COMPONENT_DRAGGER::CurrentLayer ( ) const

inlineoverridevirtual

Function CurrentLayer()

Returns the layer of currently dragged item(s). Currently unused for component dragging.

Implements PNS::DRAG_ALGO.

Definition at line 95 of file pns_component_dragger.h.

    {
        return UNDEFINED_LAYER;
    }

References UNDEFINED_LAYER.

CurrentNets()

const std::vector<int> PNS::COMPONENT_DRAGGER::CurrentNets ( ) const

inlineoverridevirtual

Function CurrentNets()

Returns the net code(s) of currently dragged item(s). Currently unused for component dragging.

Implements PNS::DRAG_ALGO.

Definition at line 84 of file pns_component_dragger.h.

    {
        return std::vector<int>();
    }

CurrentNode()

NODE * PNS::COMPONENT_DRAGGER::CurrentNode ( ) const

overridevirtual

Function CurrentNode()

Returns the most recent world state, including all items changed due to dragging operation.

Implements PNS::DRAG_ALGO.

Definition at line 182 of file pns_component_dragger.cpp.

{
    return m_currentNode ? m_currentNode : m_world;
}

References m_currentNode, and PNS::DRAG_ALGO::m_world.

Referenced by FixRoute().

Dbg()

DEBUG_DECORATOR* PNS::ALGO_BASE::Dbg ( ) const

inlineinherited

Definition at line 78 of file pns_algo_base.h.

    {
        return m_debugDecorator;
    }

References PNS::ALGO_BASE::m_debugDecorator.

Referenced by PNS::MEANDER_PLACER::doMove(), Drag(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragWalkaround(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::DP_MEANDER_PLACER::Move(), PNS::SHOVE::onCollidingArc(), PNS::SHOVE::onCollidingLine(), PNS::SHOVE::onCollidingSegment(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::onCollidingVia(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::LINE_PLACER::optimizeTailHeadTransition(), PNS::SHOVE::pushOrShoveVia(), PNS::SHOVE::replaceLine(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::LINE_PLACER::routeStep(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveIteration(), PNS::SHOVE::ShoveLines(), PNS::SHOVE::shoveLineToHullSet(), PNS::SHOVE::shoveMainLoop(), PNS::SHOVE::ShoveMultiLines(), PNS::SHOVE::ShoveObstacleLine(), PNS::WALKAROUND::singleStep(), PNS::DRAGGER::Start(), and PNS::DRAGGER::tryWalkaround().

Drag()

bool PNS::COMPONENT_DRAGGER::Drag ( const VECTOR2I &  aP )

overridevirtual

Function Drag()

Drags the current segment/corner/via to the point aP.

Returns

true, if dragging finished with success.

Implements PNS::DRAG_ALGO.

Definition at line 111 of file pns_component_dragger.cpp.

{
    m_world->KillChildren();
    m_currentNode = m_world->Branch();

    for( auto item : m_initialDraggedItems.Items() )
        m_currentNode->Remove( item );

    m_draggedItems.Clear();

    for( auto item : m_solids )
    {
        SOLID*                 s      = static_cast<SOLID*>( item );
        auto                   p_next = aP - m_p0 + s->Pos();
        std::unique_ptr<SOLID> snew( static_cast<SOLID*>( s->Clone() ) );
        snew->SetPos( p_next );

        m_draggedItems.Add( snew.get() );
        m_currentNode->Add( std::move( snew ) );

        for( auto& l : m_conns )
        {
            if( l.attachedPad == s )
            {
                l.p_orig = s->Pos() + l.offset;
                l.p_next = p_next + l.offset;
            }
        }
    }

    for( auto& cn : m_conns )
    {
        auto l_new( cn.origLine );
        l_new.Unmark();
        l_new.ClearLinks();
        l_new.DragCorner( cn.p_next, cn.origLine.CLine().Find( cn.p_orig ) );

        PNS_DBG( Dbg(), AddLine, l_new.CLine(), BLUE, 100000, "cdrag-new-fanout" );
        m_draggedItems.Add( l_new );

        auto l_orig( cn.origLine );
        m_currentNode->Remove( l_orig );
        m_currentNode->Add( l_new );
    }

    return true;
}

References PNS::ITEM_SET::Add(), PNS::NODE::Add(), BLUE, PNS::NODE::Branch(), PNS::ITEM_SET::Clear(), PNS::SOLID::Clone(), PNS::ALGO_BASE::Dbg(), PNS::ITEM_SET::Items(), PNS::NODE::KillChildren(), m_conns, m_currentNode, m_draggedItems, m_initialDraggedItems, m_p0, m_solids, PNS::DRAG_ALGO::m_world, PNS_DBG, PNS::SOLID::Pos(), and PNS::NODE::Remove().

FixRoute()

bool PNS::COMPONENT_DRAGGER::FixRoute ( )

overridevirtual

Function FixRoute()

Checks if the result of current dragging operation is correct and eventually commits it to the world.

Returns

true, if dragging finished with success.

Implements PNS::DRAG_ALGO.

Definition at line 159 of file pns_component_dragger.cpp.

{
    NODE* node = CurrentNode();

    if( node )
    {
        bool ok;

        if( Settings().AllowDRCViolations() )
            ok = true;
        else
            ok = !node->CheckColliding( m_draggedItems );

        if( !ok )
            return false;

        Router()->CommitRouting( node );
        return true;
    }

    return false;
}

References PNS::NODE::CheckColliding(), PNS::ROUTER::CommitRouting(), CurrentNode(), m_draggedItems, PNS::ALGO_BASE::Router(), and PNS::ALGO_BASE::Settings().

Logger()

LOGGER * PNS::ALGO_BASE::Logger ( )

virtualinherited

Reimplemented in PNS::SHOVE.

Definition at line 34 of file pns_algo_base.cpp.

{
    return NULL;
}

References NULL.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::DRAGGER::Start(), and PNS::DRAGGER::tryWalkaround().

Router()

ROUTER* PNS::ALGO_BASE::Router ( ) const

inlineinherited

Return current router settings.

Definition at line 54 of file pns_algo_base.h.

References PNS::ALGO_BASE::m_router.

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::MEANDER_PLACER::CommitPlacement(), PNS::DP_MEANDER_PLACER::CommitPlacement(), PNS::DIFF_PAIR_PLACER::CommitPlacement(), PNS::LINE_PLACER::CommitPlacement(), FixRoute(), PNS::DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::SHOVE::onCollidingSolid(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::MEANDER_SKEW_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::DP_MEANDER_PLACER::Start(), PNS::DRAGGER::Start(), PNS::DIFF_PAIR_PLACER::Start(), and PNS::DRAGGER::tryWalkaround().

SetDebugDecorator()

void PNS::ALGO_BASE::SetDebugDecorator ( DEBUG_DECORATOR *  aDecorator )

inlineinherited

Assign a debug decorator allowing this algo to draw extra graphics for visual debugging.

Definition at line 73 of file pns_algo_base.h.

    {
        m_debugDecorator = aDecorator;
    }

References PNS::ALGO_BASE::m_debugDecorator.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::SHOVE::SHOVE(), and PNS::DRAGGER::tryWalkaround().

SetLogger()

void PNS::ALGO_BASE::SetLogger ( LOGGER *  aLogger )

inlineinherited

Definition at line 65 of file pns_algo_base.h.

    {
        m_logger = aLogger;
    }

References PNS::ALGO_BASE::m_logger.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), and PNS::DRAGGER::tryWalkaround().

SetMode()

virtual void PNS::DRAG_ALGO::SetMode ( int  aDragMode )

inlinevirtualinherited

Reimplemented in PNS::DRAGGER.

Definition at line 118 of file pns_drag_algo.h.

{};

Settings()

ROUTING_SETTINGS & PNS::ALGO_BASE::Settings ( ) const

inherited

Return the logger object, allowing to dump geometry to a file.

Definition at line 28 of file pns_algo_base.cpp.

{
    return m_router->Settings();
}

References PNS::ALGO_BASE::m_router, and PNS::ROUTER::Settings().

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::LINE_PLACER::buildInitialLine(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragWalkaround(), FixRoute(), PNS::DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::FixRoute(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::LINE_PLACER::Move(), PNS::SHOVE::onCollidingSolid(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::LINE_PLACER::rhMarkObstacles(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::LINE_PLACER::routeStep(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveMainLoop(), PNS::DRAGGER::Start(), PNS::LINE_PLACER::Start(), and PNS::DRAGGER::tryWalkaround().

SetWorld()

virtual void PNS::DRAG_ALGO::SetWorld ( NODE *  aWorld )

inlinevirtualinherited

Function SetWorld()

Sets the board to work on.

Definition at line 60 of file pns_drag_algo.h.

    {
        m_world = aWorld;
    }

References PNS::DRAG_ALGO::m_world.

Start()

bool PNS::COMPONENT_DRAGGER::Start ( const VECTOR2I &  aP, ITEM_SET &  aPrimitives  )

overridevirtual

Function Start()

Starts routing a single track at point aP, taking item aStartItem as anchor (unless NULL). Returns true if a dragging operation has started.

Implements PNS::DRAG_ALGO.

Definition at line 46 of file pns_component_dragger.cpp.

{
    m_currentNode         = nullptr;
    m_initialDraggedItems = aPrimitives;
    m_p0                  = aP;

    std::unordered_set<LINKED_ITEM*> seenItems;

    auto addLinked =
            [&]( SOLID* aSolid, LINKED_ITEM* aItem, VECTOR2I aOffset = {} )
            {
                if( seenItems.count( aItem ) )
                    return;

                seenItems.insert( aItem );

                int segIndex;
                DRAGGED_CONNECTION cn;

                cn.origLine    = m_world->AssembleLine( aItem, &segIndex );
                cn.attachedPad = aSolid;
                cn.offset      = aOffset;

                m_conns.push_back( cn );
            };

    for( auto item : aPrimitives.Items() )
    {
        if( item.item->Kind() != ITEM::SOLID_T )
            continue;

        if( ! item.item->IsRoutable() )
            continue;

        auto solid = static_cast<SOLID*>( item.item );
        auto jt    = m_world->FindJoint( solid->Pos(), solid );

        m_solids.insert( solid );

        for( auto link : jt->LinkList() )
        {
            if( link.item->OfKind( ITEM::SEGMENT_T | ITEM::ARC_T ) )
                addLinked( solid, static_cast<LINKED_ITEM*>( link.item ) );
        }

        std::vector<JOINT*> extraJoints;

        m_world->QueryJoints( solid->Hull().BBox(), extraJoints, solid->Layers(),
                              ITEM::SEGMENT_T | ITEM::ARC_T );

        for( JOINT* extraJoint : extraJoints )
        {
            if( extraJoint->Net() == jt->Net() && extraJoint->LinkCount() == 1 )
            {
                LINKED_ITEM* li = static_cast<LINKED_ITEM*>( extraJoint->LinkList()[0].item );

                if( li->Collide( solid, nullptr, m_world ) )
                    addLinked( solid, li, extraJoint->Pos() - solid->Pos() );
            }
        }
    }

    return true;
}

References PNS::ITEM::ARC_T, PNS::NODE::AssembleLine(), PNS::COMPONENT_DRAGGER::DRAGGED_CONNECTION::attachedPad, PNS::ITEM::Collide(), PNS::NODE::FindJoint(), PNS::ITEM_SET::Items(), m_conns, m_currentNode, m_initialDraggedItems, m_p0, m_solids, PNS::DRAG_ALGO::m_world, PNS::COMPONENT_DRAGGER::DRAGGED_CONNECTION::offset, PNS::COMPONENT_DRAGGER::DRAGGED_CONNECTION::origLine, PNS::NODE::QueryJoints(), PNS::ITEM::SEGMENT_T, and PNS::ITEM::SOLID_T.

Traces()

const ITEM_SET PNS::COMPONENT_DRAGGER::Traces ( )

overridevirtual

Function Traces()

Returns the set of dragged items.

Implements PNS::DRAG_ALGO.

Definition at line 187 of file pns_component_dragger.cpp.

{
    return m_draggedItems;
}

References m_draggedItems.

VisibleViewArea()

const BOX2I & PNS::ALGO_BASE::VisibleViewArea ( ) const

inherited

Definition at line 39 of file pns_algo_base.cpp.

{
    return m_router->VisibleViewArea();
}

References PNS::ALGO_BASE::m_router, and PNS::ROUTER::VisibleViewArea().

Referenced by PNS::DRAGGER::optimizeAndUpdateDraggedLine(), and PNS::SHOVE::runOptimizer().

Member Data Documentation

m_conns

std::vector<DRAGGED_CONNECTION> PNS::COMPONENT_DRAGGER::m_conns

private

Definition at line 117 of file pns_component_dragger.h.

Referenced by Drag(), and Start().

m_currentNode

NODE* PNS::COMPONENT_DRAGGER::m_currentNode

private

Definition at line 122 of file pns_component_dragger.h.

Referenced by COMPONENT_DRAGGER(), CurrentNode(), Drag(), and Start().

m_debugDecorator

DEBUG_DECORATOR* PNS::ALGO_BASE::m_debugDecorator

protectedinherited

Definition at line 86 of file pns_algo_base.h.

Referenced by PNS::ALGO_BASE::Dbg(), and PNS::ALGO_BASE::SetDebugDecorator().

m_draggedItems

ITEM_SET PNS::COMPONENT_DRAGGER::m_draggedItems

private

Definition at line 120 of file pns_component_dragger.h.

Referenced by Drag(), FixRoute(), and Traces().

m_dragStatus

bool PNS::COMPONENT_DRAGGER::m_dragStatus

private

Definition at line 119 of file pns_component_dragger.h.

Referenced by COMPONENT_DRAGGER().

m_initialDraggedItems

ITEM_SET PNS::COMPONENT_DRAGGER::m_initialDraggedItems

private

Definition at line 121 of file pns_component_dragger.h.

Referenced by Drag(), and Start().

m_logger

LOGGER* PNS::ALGO_BASE::m_logger

protectedinherited

Definition at line 88 of file pns_algo_base.h.

Referenced by PNS::ALGO_BASE::SetLogger().

m_p0

VECTOR2I PNS::COMPONENT_DRAGGER::m_p0

private

Definition at line 123 of file pns_component_dragger.h.

Referenced by Drag(), and Start().

m_router

ROUTER* PNS::ALGO_BASE::m_router

protectedinherited

Definition at line 87 of file pns_algo_base.h.

Referenced by PNS::MEANDER_PLACER_BASE::lineLength(), PNS::ALGO_BASE::Router(), PNS::ALGO_BASE::Settings(), PNS::DIFF_PAIR_PLACER::updateLeadingRatLine(), PNS::LINE_PLACER::updateLeadingRatLine(), and PNS::ALGO_BASE::VisibleViewArea().

m_solids

std::set<SOLID*> PNS::COMPONENT_DRAGGER::m_solids

private

Definition at line 116 of file pns_component_dragger.h.

Referenced by Drag(), and Start().

m_world

NODE* PNS::DRAG_ALGO::m_world

protectedinherited

Definition at line 118 of file pns_drag_algo.h.

Referenced by PNS::DRAGGER::checkVirtualVia(), CurrentNode(), PNS::DRAGGER::CurrentNode(), Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::DRAGGER::dragWalkaround(), PNS::DRAG_ALGO::SetWorld(), Start(), PNS::DRAGGER::Start(), PNS::DRAGGER::startDragArc(), and PNS::DRAGGER::startDragSegment().

---

The documentation for this class was generated from the following files:

• pns_component_dragger.h
• pns_component_dragger.cpp