PNS::DRAG_ALGO Class Reference

DRAG_ALGO. More...

#include <pns_drag_algo.h>

Inheritance diagram for PNS::DRAG_ALGO:

Public Member Functions
	DRAG_ALGO (ROUTER *aRouter)
virtual void	SetWorld (NODE *aWorld)
	Function SetWorld().
virtual bool	Start (const VECTOR2I &aP, ITEM_SET &aPrimitives)=0
	Function Start().
virtual bool	Drag (const VECTOR2I &aP)=0
	Function Drag().
virtual bool	FixRoute ()=0
	Function FixRoute().
virtual NODE *	CurrentNode () const =0
	Function CurrentNode().
virtual const std::vector< int >	CurrentNets () const =0
	Function CurrentNets().
virtual int	CurrentLayer () const =0
	Function CurrentLayer().
virtual const ITEM_SET	Traces ()=0
	Function Traces().
virtual void	SetMode (int aDragMode)
Public Member Functions inherited from PNS::ALGO_BASE
	ALGO_BASE (ROUTER *aRouter)
virtual	~ALGO_BASE ()
	Return the instance of our router.
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
Protected Attributes inherited from PNS::ALGO_BASE
DEBUG_DECORATOR *	m_debugDecorator
ROUTER *	m_router
LOGGER *	m_logger

Detailed Description

DRAG_ALGO.

Base class for item dragging algorithms.

Member Function Documentation

CurrentLayer()

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

pure virtual

Function CurrentLayer().

Returns the layer of currently dragged item(s).

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

CurrentNets()

virtual const std::vector< int > PNS::DRAG_ALGO::CurrentNets ( ) const

pure virtual

Function CurrentNets().

Returns the net code(s) of currently dragged item(s).

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

CurrentNode()

virtual NODE * PNS::DRAG_ALGO::CurrentNode ( ) const

pure virtual

Function CurrentNode().

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

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

Drag()

virtual bool PNS::DRAG_ALGO::Drag ( const VECTOR2I & aP )

pure virtual

Function Drag().

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

Returns

true, if dragging finished with success.

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

FixRoute()

virtual bool PNS::DRAG_ALGO::FixRoute ( )

pure virtual

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.

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

SetWorld()

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

inlinevirtual

Function SetWorld().

Sets the board to work on.

Start()

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

pure virtual

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.

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

Traces()

virtual const ITEM_SET PNS::DRAG_ALGO::Traces ( )

pure virtual

Function Traces().

Returns the set of dragged items.

Implemented in PNS::COMPONENT_DRAGGER, and PNS::DRAGGER.

---

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

• 3rd_party/router/router/pns_drag_algo.h