#include <pns_multi_dragger.h>

Inheritance diagram for PNS::MULTI_DRAGGER:

Classes
struct	MDRAG_LINE

Public Member Functions
	MULTI_DRAGGER (ROUTER *aRouter)

	~MULTI_DRAGGER ()

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

bool	Drag (const VECTOR2I &aP) override
	Function Drag()

bool	FixRoute (bool aForceCommit) override
	Function FixRoute()

NODE *	CurrentNode () const override
	Function CurrentNode()

const std::vector< NET_HANDLE >	CurrentNets () const override
	Function CurrentNets()

int	CurrentLayer () const override
	Function CurrentLayer()

const ITEM_SET	Traces () override
	Function Traces()

void	SetMode (PNS::DRAG_MODE aDragMode) override

PNS::DRAG_MODE	Mode () const override

virtual std::vector< PNS::ITEM * >	GetLastCommittedLeaderSegments () override

virtual bool	GetForceMarkObstaclesMode (bool *aDragStatus) const override

virtual void	SetWorld (NODE *aWorld)
	Function SetWorld()

ROUTER *	Router () const
	Return current router settings.

ROUTING_SETTINGS &	Settings () const
	Return the logger object, allowing to dump geometry to a file.

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.

DEBUG_DECORATOR *	Dbg () const

const BOX2I &	VisibleViewArea () const

Protected Attributes
NODE *	m_world

DEBUG_DECORATOR *	m_debugDecorator

ROUTER *	m_router

LOGGER *	m_logger

Private Member Functions
bool	multidragMarkObstacles (std::vector< MDRAG_LINE > &aCompletedLines)

bool	multidragShove (std::vector< MDRAG_LINE > &aCompletedLines)

bool	multidragWalkaround (std::vector< MDRAG_LINE > &aCompletedLines)

void	restoreLeaderSegments (std::vector< MDRAG_LINE > &aCompletedLines)

int	findNewLeaderSegment (const MDRAG_LINE &aLine) const

bool	tryWalkaround (NODE *aNode, LINE &aOrig, LINE &aWalk)

Private Attributes
int	m_mode

bool	m_dragStatus

PNS_MODE	m_currentMode

DRAG_MODE	m_dragMode

std::vector< MDRAG_LINE >	m_mdragLines

std::vector< PNS::ITEM * >	m_leaderSegments

NODE *	m_lastNode

NODE *	m_preShoveNode

ITEM_SET	m_origDraggedItems

ITEM_SET	m_draggedItems

VECTOR2I	m_dragStartPoint

SEG	m_guide

std::unique_ptr< SHOVE >	m_shove

Detailed Description

MULTI_DRAGGER.

Dragging algorithm for multiple segments. Very trival version for demonstration purposes.

Definition at line 46 of file pns_multi_dragger.h.

Constructor & Destructor Documentation

◆ MULTI_DRAGGER()

PNS::MULTI_DRAGGER::MULTI_DRAGGER ( ROUTER * aRouter )

Definition at line 30 of file pns_multi_dragger.cpp.

References PNS::DRAG_ALGO::DRAG_ALGO(), m_lastNode, and PNS::DRAG_ALGO::m_world.

◆ ~MULTI_DRAGGER()

PNS::MULTI_DRAGGER::~MULTI_DRAGGER ( )

Definition at line 37 of file pns_multi_dragger.cpp.

Member Function Documentation

◆ CurrentLayer()

int PNS::MULTI_DRAGGER::CurrentLayer ( ) const

overridevirtual

Function CurrentLayer()

Returns the layer of currently routed track.

Implements PNS::DRAG_ALGO.

Definition at line 966 of file pns_multi_dragger.cpp.

◆ CurrentNets()

const std::vector< NET_HANDLE > PNS::MULTI_DRAGGER::CurrentNets ( ) const

overridevirtual

Function CurrentNets()

Returns the net code(s) of currently routed track(s).

Implements PNS::DRAG_ALGO.

Definition at line 345 of file pns_multi_dragger.cpp.

References m_mdragLines.

◆ CurrentNode()

NODE * PNS::MULTI_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 954 of file pns_multi_dragger.cpp.

References m_lastNode, 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.

References m_debugDecorator.

◆ Drag()

bool PNS::MULTI_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 670 of file pns_multi_dragger.cpp.

References SEG::A, DIRECTION_45::ANG_HALF_FULL, DIRECTION_45::ANG_OBTUSE, DIRECTION_45::ANG_STRAIGHT, DIRECTION_45::Angle(), SEG::B, PNS::LINE::CLastPoint(), PNS::LINK_HOLDER::ClearLinks(), PNS::ALGO_BASE::Dbg(), PNS::DM_CORNER, PNS::DM_SEGMENT, VECTOR2< T >::Dot(), PNS::LINE::DragCorner(), VECTOR2< T >::EuclideanNorm(), PNS::MULTI_DRAGGER::MDRAG_LINE::leaderSegIndex, LIGHTBLUE, LIGHTGRAY, LIGHTRED, LIGHTYELLOW, SEG::LineDistance(), SEG::LineProject(), m_draggedItems, m_dragMode, m_dragStartPoint, m_dragStatus, m_guide, m_leaderSegments, m_mdragLines, m_origDraggedItems, PNS::MULTI_DRAGGER::MDRAG_LINE::midSeg, Mode(), multidragMarkObstacles(), multidragShove(), multidragWalkaround(), PNS_DBG, PNS::LINE::PointCount(), res, VECTOR2< T >::Resize(), PNS::RM_MarkObstacles, PNS::RM_Shove, PNS::RM_Walkaround, PNS::ALGO_BASE::Settings(), sign(), PNS::ROUTING_SETTINGS::SmoothDraggedSegments(), and YELLOW.

◆ findNewLeaderSegment()

int PNS::MULTI_DRAGGER::findNewLeaderSegment ( const MDRAG_LINE & aLine ) const

private

Definition at line 402 of file pns_multi_dragger.cpp.

References SEG::Contains(), PNS::LINE::CSegment(), PNS::ALGO_BASE::Dbg(), PNS::MULTI_DRAGGER::MDRAG_LINE::draggedLine, DIRECTION_45::Format(), SEG::IntersectLines(), PNS::MULTI_DRAGGER::MDRAG_LINE::leaderSegIndex, m_guide, DIRECTION_45::Opposite(), PNS_DBG, PNS::MULTI_DRAGGER::MDRAG_LINE::preDragLine, and PNS::LINE::SegmentCount().

Referenced by restoreLeaderSegments().

◆ FixRoute()

bool PNS::MULTI_DRAGGER::FixRoute ( bool aForceCommit )

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 360 of file pns_multi_dragger.cpp.

References PNS::ROUTER::CommitRouting(), CurrentNode(), m_dragStatus, PNS::ALGO_BASE::Router(), and PNS::ALGO_BASE::Settings().

◆ GetForceMarkObstaclesMode()

virtual bool PNS::MULTI_DRAGGER::GetForceMarkObstaclesMode ( bool * aDragStatus ) const

inlineoverridevirtual

Implements PNS::DRAG_ALGO.

Definition at line 114 of file pns_multi_dragger.h.

References m_dragStatus.

◆ GetLastCommittedLeaderSegments()

virtual std::vector< PNS::ITEM * > PNS::MULTI_DRAGGER::GetLastCommittedLeaderSegments ( )

inlineoverridevirtual

Reimplemented from PNS::DRAG_ALGO.

Definition at line 112 of file pns_multi_dragger.h.

References m_leaderSegments.

◆ Logger()

LOGGER * PNS::ALGO_BASE::Logger ( )

virtualinherited

Definition at line 34 of file pns_algo_base.cpp.

References m_logger.

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

◆ Mode()

PNS::DRAG_MODE PNS::MULTI_DRAGGER::Mode ( ) const

overridevirtual

Implements PNS::DRAG_ALGO.

Definition at line 283 of file pns_multi_dragger.cpp.

References PNS::DM_CORNER.

Referenced by Drag(), and Start().

◆ multidragMarkObstacles()

bool PNS::MULTI_DRAGGER::multidragMarkObstacles ( std::vector< MDRAG_LINE > & aCompletedLines )

private

Definition at line 554 of file pns_multi_dragger.cpp.

References PNS::clipToOtherLine(), m_lastNode, PNS::DRAG_ALGO::m_world, and restoreLeaderSegments().

Referenced by Drag().

◆ multidragShove()

bool PNS::MULTI_DRAGGER::multidragShove ( std::vector< MDRAG_LINE > & aCompletedLines )

private

Definition at line 598 of file pns_multi_dragger.cpp.

References PNS::LINK_HOLDER::ClearLinks(), PNS::ALGO_BASE::Dbg(), PNS::MULTI_DRAGGER::MDRAG_LINE::dragDist, PNS::MULTI_DRAGGER::MDRAG_LINE::draggedLine, PNS::ROUTER::GetInterface(), GREEN, m_lastNode, m_mdragLines, m_shove, PNS_DBG, restoreLeaderSegments(), PNS::ALGO_BASE::Router(), PNS::SHOVE::SH_OK, PNS::SHOVE::SHP_DONT_OPTIMIZE, and PNS::SHOVE::SHP_SHOVE.

Referenced by Drag().

◆ multidragWalkaround()

bool PNS::MULTI_DRAGGER::multidragWalkaround ( std::vector< MDRAG_LINE > & aCompletedLines )

private

Definition at line 453 of file pns_multi_dragger.cpp.

References PNS::NODE::Add(), BLUE, PNS::NODE::Branch(), PNS::LINE::CLine(), PNS::ALGO_BASE::Dbg(), PNS::MULTI_DRAGGER::MDRAG_LINE::dragDist, PNS::MULTI_DRAGGER::MDRAG_LINE::draggedLine, PNS::MULTI_DRAGGER::MDRAG_LINE::isPrimaryLine, SHAPE_LINE_CHAIN::Length(), m_lastNode, PNS::DRAG_ALGO::m_world, PNS_DBG, PNS::NODE::Remove(), restoreLeaderSegments(), result, tryWalkaround(), and YELLOW.

Referenced by Drag().

◆ restoreLeaderSegments()

void PNS::MULTI_DRAGGER::restoreLeaderSegments ( std::vector< MDRAG_LINE > & aCompletedLines )

private

Definition at line 424 of file pns_multi_dragger.cpp.

References PNS::DM_CORNER, findNewLeaderSegment(), m_dragMode, and m_leaderSegments.

Referenced by multidragMarkObstacles(), multidragShove(), and multidragWalkaround().

◆ Router()

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

inlineinherited

Return current router settings.

Definition at line 54 of file pns_algo_base.h.

References m_router.

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::MEANDER_PLACER_BASE::Clearance(), PNS::DIFF_PAIR_PLACER::CommitPlacement(), PNS::DP_MEANDER_PLACER::CommitPlacement(), PNS::LINE_PLACER::CommitPlacement(), PNS::MEANDER_PLACER::CommitPlacement(), PNS::COMPONENT_DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::DRAGGER::FixRoute(), PNS::MULTI_DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::MEANDER_PLACER_BASE::lineDelay(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::LINE_PLACER::makeVia(), PNS::MULTI_DRAGGER::multidragShove(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::reconstructHeads(), PNS::SHOVE::removeHeads(), PNS::LINE_PLACER::rhWalkBase(), PNS::SHOVE::Run(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveIteration(), PNS::DIFF_PAIR_PLACER::Start(), PNS::DP_MEANDER_PLACER::Start(), PNS::DRAGGER::Start(), PNS::LINE_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), PNS::MULTI_DRAGGER::Start(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_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.

References m_debugDecorator.

Referenced by PNS::SHOVE::onCollidingSolid(), PNS::LINE_PLACER::rhWalkBase(), PNS::SHOVE::SHOVE(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ SetLogger()

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

inlineinherited

Definition at line 65 of file pns_algo_base.h.

References m_logger.

Referenced by PNS::LINE_PLACER::rhWalkBase(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ SetMode()

void PNS::MULTI_DRAGGER::SetMode ( PNS::DRAG_MODE aDragMode )

overridevirtual

Reimplemented from PNS::DRAG_ALGO.

Definition at line 278 of file pns_multi_dragger.cpp.

◆ 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.

References m_router.

◆ SetWorld()

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

inlinevirtualinherited

Function SetWorld()

Sets the board to work on.

Definition at line 61 of file pns_drag_algo.h.

References m_world.

◆ Start()

bool PNS::MULTI_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 42 of file pns_multi_dragger.cpp.

References PNS::ITEM_SET::Contains(), PNS::ALGO_BASE::Dbg(), PNS::DM_CORNER, PNS::DM_SEGMENT, dyn_cast(), PNS::ITEM_SET::Empty(), PNS::ITEM_SET::FindVertex(), PNS::MULTI_DRAGGER::MDRAG_LINE::isDraggable, PNS::MULTI_DRAGGER::MDRAG_LINE::isPrimaryLine, PNS::JOINT::IsTrivialEndpoint(), PNS::ITEM_SET::Items(), PNS::ALGO_BASE::Logger(), m_dragMode, m_dragStartPoint, m_dragStatus, m_lastNode, m_mdragLines, m_origDraggedItems, m_preShoveNode, m_shove, PNS::DRAG_ALGO::m_world, Mode(), PNS::MULTI_DRAGGER::MDRAG_LINE::originalLeaders, PNS::MULTI_DRAGGER::MDRAG_LINE::originalLine, PNS::RM_Shove, PNS::ALGO_BASE::Router(), PNS::ALGO_BASE::Settings(), PNS::SHOVE::SHP_DONT_LOCK_ENDPOINTS, and PNS::SHOVE::SHP_SHOVE.

◆ Traces()

const ITEM_SET PNS::MULTI_DRAGGER::Traces ( )

overridevirtual

Function Traces()

Returns the set of dragged items.

Implements PNS::DRAG_ALGO.

Definition at line 960 of file pns_multi_dragger.cpp.

References m_draggedItems.

◆ tryWalkaround()

bool PNS::MULTI_DRAGGER::tryWalkaround	(	NODE *	aNode,
		LINE &	aOrig,
		LINE &	aWalk )

private

Definition at line 378 of file pns_multi_dragger.cpp.

References PNS::ALGO_BASE::Dbg(), PNS::WALKAROUND::RESULT::lines, PNS::ALGO_BASE::Logger(), PNS::WALKAROUND::Route(), PNS::ALGO_BASE::Router(), PNS::WALKAROUND::SetAllowedPolicies(), PNS::ALGO_BASE::SetDebugDecorator(), PNS::WALKAROUND::SetIterationLimit(), PNS::WALKAROUND::SetLengthLimit(), PNS::ALGO_BASE::SetLogger(), PNS::WALKAROUND::SetSolidsOnly(), PNS::ALGO_BASE::Settings(), PNS::WALKAROUND::ST_DONE, PNS::WALKAROUND::RESULT::status, and PNS::WALKAROUND::WP_SHORTEST.

Referenced by multidragWalkaround().

◆ VisibleViewArea()

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

inherited

Definition at line 40 of file pns_algo_base.cpp.

References m_router.

Referenced by PNS::SHOVE::runOptimizer().

Member Data Documentation

◆ m_currentMode

PNS_MODE PNS::MULTI_DRAGGER::m_currentMode

private

Definition at line 167 of file pns_multi_dragger.h.

◆ m_debugDecorator

DEBUG_DECORATOR* PNS::ALGO_BASE::m_debugDecorator

protectedinherited

Definition at line 86 of file pns_algo_base.h.

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

◆ m_draggedItems

ITEM_SET PNS::MULTI_DRAGGER::m_draggedItems

private

Definition at line 174 of file pns_multi_dragger.h.

Referenced by Drag(), and Traces().

◆ m_dragMode

DRAG_MODE PNS::MULTI_DRAGGER::m_dragMode

private

Definition at line 168 of file pns_multi_dragger.h.

Referenced by Drag(), restoreLeaderSegments(), and Start().

◆ m_dragStartPoint

VECTOR2I PNS::MULTI_DRAGGER::m_dragStartPoint

private

Definition at line 175 of file pns_multi_dragger.h.

Referenced by Drag(), and Start().

◆ m_dragStatus

bool PNS::MULTI_DRAGGER::m_dragStatus

private

Definition at line 166 of file pns_multi_dragger.h.

Referenced by Drag(), FixRoute(), GetForceMarkObstaclesMode(), and Start().

◆ m_guide

SEG PNS::MULTI_DRAGGER::m_guide

private

Definition at line 176 of file pns_multi_dragger.h.

Referenced by Drag(), and findNewLeaderSegment().

◆ m_lastNode

NODE* PNS::MULTI_DRAGGER::m_lastNode

private

Definition at line 171 of file pns_multi_dragger.h.

Referenced by CurrentNode(), MULTI_DRAGGER(), multidragMarkObstacles(), multidragShove(), multidragWalkaround(), and Start().

◆ m_leaderSegments

std::vector<PNS::ITEM*> PNS::MULTI_DRAGGER::m_leaderSegments

private

Definition at line 170 of file pns_multi_dragger.h.

Referenced by Drag(), GetLastCommittedLeaderSegments(), and restoreLeaderSegments().

◆ m_logger

LOGGER* PNS::ALGO_BASE::m_logger

protectedinherited

Definition at line 88 of file pns_algo_base.h.

Referenced by ALGO_BASE(), Logger(), and SetLogger().

◆ m_mdragLines

std::vector<MDRAG_LINE> PNS::MULTI_DRAGGER::m_mdragLines

private

Definition at line 169 of file pns_multi_dragger.h.

Referenced by CurrentNets(), Drag(), multidragShove(), and Start().

◆ m_mode

int PNS::MULTI_DRAGGER::m_mode

private

Definition at line 165 of file pns_multi_dragger.h.

◆ m_origDraggedItems

ITEM_SET PNS::MULTI_DRAGGER::m_origDraggedItems

private

Definition at line 173 of file pns_multi_dragger.h.

Referenced by Drag(), and Start().

◆ m_preShoveNode

NODE* PNS::MULTI_DRAGGER::m_preShoveNode

private

Definition at line 172 of file pns_multi_dragger.h.

Referenced by Start().

◆ m_router

ROUTER* PNS::ALGO_BASE::m_router

protectedinherited

Definition at line 87 of file pns_algo_base.h.

Referenced by ALGO_BASE(), PNS::DP_MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_SKEW_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::doMove(), PNS::LINE_PLACER::FixRoute(), PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), Router(), Settings(), PNS::DIFF_PAIR_PLACER::updateLeadingRatLine(), PNS::LINE_PLACER::updateLeadingRatLine(), and VisibleViewArea().

◆ m_shove

std::unique_ptr<SHOVE> PNS::MULTI_DRAGGER::m_shove

private

Definition at line 177 of file pns_multi_dragger.h.

Referenced by multidragShove(), and Start().

◆ m_world

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

Classes

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MULTI_DRAGGER()

◆ ~MULTI_DRAGGER()

Member Function Documentation

◆ CurrentLayer()

◆ CurrentNets()

◆ CurrentNode()

◆ Dbg()

◆ Drag()

◆ findNewLeaderSegment()

◆ FixRoute()

◆ GetForceMarkObstaclesMode()

◆ GetLastCommittedLeaderSegments()

◆ Logger()

◆ Mode()

◆ multidragMarkObstacles()

◆ multidragShove()

◆ multidragWalkaround()

◆ restoreLeaderSegments()

◆ Router()

◆ SetDebugDecorator()

◆ SetLogger()

◆ SetMode()

◆ Settings()

◆ SetWorld()

◆ Start()

◆ Traces()

◆ tryWalkaround()

◆ VisibleViewArea()

Member Data Documentation

◆ m_currentMode

◆ m_debugDecorator

◆ m_draggedItems

◆ m_dragMode

◆ m_dragStartPoint

◆ m_dragStatus

◆ m_guide

◆ m_lastNode

◆ m_leaderSegments

◆ m_logger

◆ m_mdragLines

◆ m_mode

◆ m_origDraggedItems

◆ m_preShoveNode

◆ m_router

◆ m_shove

◆ m_world