ALIGN_DISTRIBUTE_TOOL Class Reference

#include <placement_tool.h>

Inheritance diagram for ALIGN_DISTRIBUTE_TOOL:

Public Types
enum	RESET_REASON { RUN , MODEL_RELOAD , GAL_SWITCH , REDRAW }
	Determine the reason of reset for a tool. More...

Public Member Functions
	ALIGN_DISTRIBUTE_TOOL ()
virtual	~ALIGN_DISTRIBUTE_TOOL ()
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
bool	Init () override
	Init() is called once upon a registration of the tool. More...
int	AlignTop (const TOOL_EVENT &aEvent)
	Set Y coordinate of the selected items to the value of the top-most selected item Y coordinate. More...
int	AlignBottom (const TOOL_EVENT &aEvent)
	Sets Y coordinate of the selected items to the value of the bottom-most selected item Y coordinate. More...
int	AlignLeft (const TOOL_EVENT &aEvent)
	Sets X coordinate of the selected items to the value of the left-most selected item X coordinate. More...
int	AlignRight (const TOOL_EVENT &aEvent)
	Sets X coordinate of the selected items to the value of the right-most selected item X coordinate. More...
int	AlignCenterX (const TOOL_EVENT &aEvent)
	Set the x coordinate of the midpoint of each of the selected items to the value of the x coordinate of the center of the middle selected item. More...
int	AlignCenterY (const TOOL_EVENT &aEvent)
	Set the y coordinate of the midpoint of each of the selected items to the value of the y coordinate of the center of the middle selected item. More...
int	DistributeHorizontally (const TOOL_EVENT &aEvent)
	Distribute the selected items along the X axis. More...
int	DistributeVertically (const TOOL_EVENT &aEvent)
	Distribute the selected items along the Y axis. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	Activate ()
	Run the tool. More...
TOOL_MENU &	GetToolMenu ()
void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated. More...
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack. More...
template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions). More...
TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives. More...
TOOL_TYPE	GetType () const
	Return the type of the tool. More...
TOOL_ID	GetId () const
	Return the unique identifier of the tool. More...
const std::string &	GetName () const
	Return the name of the tool. More...
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool. More...
bool	IsToolActive () const

Protected Member Functions
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to. More...
KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application. More...
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application. More...
template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type. More...
template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type. More...

Protected Attributes
TOOL_MENU	m_menu
	The functions below are not yet implemented - their interface may change. More...
TOOL_TYPE	m_type
	Unique identifier for the tool, assigned by a TOOL_MANAGER instance. More...
TOOL_ID	m_toolId
	Name of the tool. More...
std::string	m_toolName
TOOL_MANAGER *	m_toolMgr

Private Member Functions
template<typename T >
size_t	GetSelections (std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aItemsToAlign, std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aLockedItems, T aCompare)
	Populate two vectors with the sorted selection and sorted locked items. More...
template<typename T >
int	selectTarget (std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aItems, std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aLocked, T aGetValue)
int	doAlignLeft ()
	Sets X coordinate of the selected items to the value of the left-most selected item X coordinate. More...
int	doAlignRight ()
	Align selected items using the right edge of their bounding boxes to the right-most item. More...
void	doDistributeCentersHorizontally (std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aItems, BOARD_COMMIT &aCommit) const
	Distribute selected items using an even spacing between the centers of their bounding boxes. More...
void	doDistributeCentersVertically (std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aItems, BOARD_COMMIT &aCommit) const
	Distribute selected items using an even spacing between the centers of their bounding boxes. More...
void	doDistributeGapsHorizontally (std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aItems, BOARD_COMMIT &aCommit, const BOARD_ITEM *lastItem, int totalGap) const
	Distributes selected items using an even spacing between their bounding boxes. More...
void	doDistributeGapsVertically (std::vector< std::pair< BOARD_ITEM *, BOX2I > > &aItems, BOARD_COMMIT &aCommit, const BOARD_ITEM *lastItem, int totalGap) const
	Distributes selected items using an even spacing between their bounding boxes. More...
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions(). More...
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInt () const
TOOLS_HOLDER *	getToolHolderInt () const

Private Attributes
PCB_SELECTION_TOOL *	m_selectionTool
ACTION_MENU *	m_placementMenu
PCB_BASE_FRAME *	m_frame

Detailed Description

Definition at line 38 of file placement_tool.h.

Member Enumeration Documentation

RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

Enumerator
RUN	Tool is invoked after being inactive.
MODEL_RELOAD	Model changes (required full reload)
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH, 
 REDRAW 
 };

Constructor & Destructor Documentation

ALIGN_DISTRIBUTE_TOOL()

ALIGN_DISTRIBUTE_TOOL::ALIGN_DISTRIBUTE_TOOL

(

)

Definition at line 41 of file placement_tool.cpp.

 :
 TOOL_INTERACTIVE( "pcbnew.Placement" ),
 m_selectionTool( nullptr ),
 m_placementMenu( nullptr ),
 m_frame( nullptr )
{
}

~ALIGN_DISTRIBUTE_TOOL()

ALIGN_DISTRIBUTE_TOOL::~ALIGN_DISTRIBUTE_TOOL ( )

virtual

Definition at line 49 of file placement_tool.cpp.

{
 delete m_placementMenu;
}

References m_placementMenu.

Member Function Documentation

Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

After activation, the tool starts receiving events until it is finished.

Definition at line 51 of file tool_interactive.cpp.

{
 m_toolMgr->InvokeTool( m_toolId );
}

References TOOL_MANAGER::InvokeTool(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

AlignBottom()

int ALIGN_DISTRIBUTE_TOOL::AlignBottom

(

const TOOL_EVENT &

aEvent

)

Sets Y coordinate of the selected items to the value of the bottom-most selected item Y coordinate.

Definition at line 240 of file placement_tool.cpp.

{
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToAlign;
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> locked_items;
 
 if( !GetSelections( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetBottom() > right.second.GetBottom() );
 } ) )
 {
 return 0;
 }
 
 BOARD_COMMIT commit( m_frame );
 
 int targetBottom = selectTarget( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I>& aVal )
 {
 return aVal.second.GetBottom();
 } );
 
 // Move the selected items
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToAlign )
 {
 int difference = targetBottom - i.second.GetBottom();
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 commit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( 0, difference ) );
 }
 
 commit.Push( _( "Align to bottom" ) );
 
 return 0;
}

References _, CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), GetSelections(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Push(), right, selectTarget(), BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by setTransitions().

AlignCenterX()

int ALIGN_DISTRIBUTE_TOOL::AlignCenterX

(

const TOOL_EVENT &

aEvent

)

Set the x coordinate of the midpoint of each of the selected items to the value of the x coordinate of the center of the middle selected item.

Definition at line 405 of file placement_tool.cpp.

{
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToAlign;
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> locked_items;
 
 if( !GetSelections( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.Centre().x < right.second.Centre().x );
 } ) )
 {
 return 0;
 }
 
 BOARD_COMMIT commit( m_frame );
 
 int targetX = selectTarget( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I>& aVal )
 {
 return aVal.second.Centre().x;
 } );
 
 // Move the selected items
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToAlign )
 {
 int difference = targetX - i.second.Centre().x;
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 commit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( difference, 0 ) );
 }
 
 commit.Push( _( "Align to middle" ) );
 
 return 0;
}

References _, CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), GetSelections(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Push(), right, selectTarget(), BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by setTransitions().

AlignCenterY()

int ALIGN_DISTRIBUTE_TOOL::AlignCenterY

(

const TOOL_EVENT &

aEvent

)

Set the y coordinate of the midpoint of each of the selected items to the value of the y coordinate of the center of the middle selected item.

Definition at line 450 of file placement_tool.cpp.

{
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToAlign;
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> locked_items;
 
 if( !GetSelections( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.Centre().y < right.second.Centre().y );
 } ) )
 {
 return 0;
 }
 
 BOARD_COMMIT commit( m_frame );
 
 int targetY = selectTarget( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I>& aVal )
 {
 return aVal.second.Centre().y;
 } );
 
 // Move the selected items
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToAlign )
 {
 int difference = targetY - i.second.Centre().y;
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 commit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( 0, difference ) );
 }
 
 commit.Push( _( "Align to center" ) );
 
 return 0;
}

References _, CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), GetSelections(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Push(), right, selectTarget(), BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by setTransitions().

AlignLeft()

int ALIGN_DISTRIBUTE_TOOL::AlignLeft

(

const TOOL_EVENT &

aEvent

)

Sets X coordinate of the selected items to the value of the left-most selected item X coordinate.

Definition at line 285 of file placement_tool.cpp.

{
 // Because this tool uses bounding boxes and they aren't mirrored even when
 // the view is mirrored, we need to call the other one if mirrored.
 if( getView()->IsMirroredX() )
 {
 return doAlignRight();
 }
 else
 {
 return doAlignLeft();
 }
}

References doAlignLeft(), doAlignRight(), and TOOL_BASE::getView().

Referenced by setTransitions().

AlignRight()

int ALIGN_DISTRIBUTE_TOOL::AlignRight

(

const TOOL_EVENT &

aEvent

)

Sets X coordinate of the selected items to the value of the right-most selected item X coordinate.

Definition at line 345 of file placement_tool.cpp.

{
 // Because this tool uses bounding boxes and they aren't mirrored even when
 // the view is mirrored, we need to call the other one if mirrored.
 if( getView()->IsMirroredX() )
 {
 return doAlignLeft();
 }
 else
 {
 return doAlignRight();
 }
}

References doAlignLeft(), doAlignRight(), and TOOL_BASE::getView().

Referenced by setTransitions().

AlignTop()

int ALIGN_DISTRIBUTE_TOOL::AlignTop

(

const TOOL_EVENT &

aEvent

)

Set Y coordinate of the selected items to the value of the top-most selected item Y coordinate.

Definition at line 195 of file placement_tool.cpp.

{
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToAlign;
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> locked_items;
 
 if( !GetSelections( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetTop() < right.second.GetTop() );
 } ) )
 {
 return 0;
 }
 
 BOARD_COMMIT commit( m_frame );
 
 int targetTop = selectTarget( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I>& aVal )
 {
 return aVal.second.GetTop();
 } );
 
 // Move the selected items
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToAlign )
 {
 BOARD_ITEM* item = i.first;
 int difference = targetTop - i.second.GetTop();
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 commit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( 0, difference ) );
 }
 
 commit.Push( _( "Align to top" ) );
 
 return 0;
}

References _, CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), GetSelections(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Push(), right, selectTarget(), BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by setTransitions().

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

DistributeHorizontally()

int ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally

(

const TOOL_EVENT &

aEvent

)

Distribute the selected items along the X axis.

Definition at line 495 of file placement_tool.cpp.

{
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( item->Type() == PCB_MARKER_T )
 aCollector.Remove( item );
 }
 },
 m_frame->IsType( FRAME_PCB_EDITOR ) /* prompt user regarding locked items */ );
 
 if( selection.Size() <= 1 )
 return 0;
 
 BOARD_COMMIT commit( m_frame );
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToDistribute = GetBoundingBoxes( selection );
 
 // find the last item by reverse sorting
 std::sort( itemsToDistribute.begin(), itemsToDistribute.end(),
 [] ( const std::pair<BOARD_ITEM*, BOX2I> left,
 const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetRight() > right.second.GetRight() );
 } );
 
 BOARD_ITEM* lastItem = itemsToDistribute.begin()->first;
 const int maxRight = itemsToDistribute.begin()->second.GetRight();
 
 // sort to get starting order
 std::sort( itemsToDistribute.begin(), itemsToDistribute.end(),
 [] ( const std::pair<BOARD_ITEM*, BOX2I> left,
 const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetX() < right.second.GetX() );
 } );
 
 const int minX = itemsToDistribute.begin()->second.GetX();
 int totalGap = maxRight - minX;
 int totalWidth = 0;
 
 for( const auto& [ item, rect ] : itemsToDistribute )
 totalWidth += rect.GetWidth();
 
 if( totalGap < totalWidth )
 {
 // the width of the items exceeds the gap (overlapping items) -> use center point spacing
 doDistributeCentersHorizontally( itemsToDistribute, commit );
 }
 else
 {
 totalGap -= totalWidth;
 doDistributeGapsHorizontally( itemsToDistribute, commit, lastItem, totalGap );
 }
 
 commit.Push( _( "Distribute horizontally" ) );
 
 return 0;
}

References _, doDistributeCentersHorizontally(), doDistributeGapsHorizontally(), FRAME_PCB_EDITOR, GetBoundingBoxes(), COLLECTOR::GetCount(), EDA_BASE_FRAME::IsType(), left, m_frame, m_selectionTool, BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RequestSelection(), right, and SELECTION::Size().

Referenced by setTransitions().

DistributeVertically()

int ALIGN_DISTRIBUTE_TOOL::DistributeVertically

(

const TOOL_EVENT &

aEvent

)

Distribute the selected items along the Y axis.

Set up handlers for various events.

Definition at line 624 of file placement_tool.cpp.

{
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( item->Type() == PCB_MARKER_T )
 aCollector.Remove( item );
 }
 },
 m_frame->IsType( FRAME_PCB_EDITOR ) /* prompt user regarding locked items */ );
 
 if( selection.Size() <= 1 )
 return 0;
 
 BOARD_COMMIT commit( m_frame );
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToDistribute = GetBoundingBoxes( selection );
 
 // find the last item by reverse sorting
 std::sort( itemsToDistribute.begin(), itemsToDistribute.end(),
 [] ( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetBottom() > right.second.GetBottom() );
 } );
 
 BOARD_ITEM* lastItem = itemsToDistribute.begin()->first;
 const int maxBottom = itemsToDistribute.begin()->second.GetBottom();
 
 // sort to get starting order
 std::sort( itemsToDistribute.begin(), itemsToDistribute.end(),
 [] ( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.Centre().y < right.second.Centre().y );
 } );
 
 int minY = itemsToDistribute.begin()->second.GetY();
 int totalGap = maxBottom - minY;
 int totalHeight = 0;
 
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToDistribute )
 totalHeight += i.second.GetHeight();
 
 if( totalGap < totalHeight )
 {
 // the width of the items exceeds the gap (overlapping items) -> use center point spacing
 doDistributeCentersVertically( itemsToDistribute, commit );
 }
 else
 {
 totalGap -= totalHeight;
 doDistributeGapsVertically( itemsToDistribute, commit, lastItem, totalGap );
 }
 
 commit.Push( _( "Distribute vertically" ) );
 
 return 0;
}

References _, doDistributeCentersVertically(), doDistributeGapsVertically(), FRAME_PCB_EDITOR, GetBoundingBoxes(), COLLECTOR::GetCount(), EDA_BASE_FRAME::IsType(), left, m_frame, m_selectionTool, BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RequestSelection(), right, and SELECTION::Size().

Referenced by setTransitions().

doAlignLeft()

int ALIGN_DISTRIBUTE_TOOL::doAlignLeft ( )

private

Sets X coordinate of the selected items to the value of the left-most selected item X coordinate.

Note

Uses the bounding box of items, which do not get mirrored even when the view is mirrored!

Definition at line 300 of file placement_tool.cpp.

{
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToAlign;
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> locked_items;
 
 if( !GetSelections( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetLeft() < right.second.GetLeft() );
 } ) )
 {
 return 0;
 }
 
 BOARD_COMMIT commit( m_frame );
 
 int targetLeft = selectTarget( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I>& aVal )
 {
 return aVal.second.GetLeft();
 } );
 
 // Move the selected items
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToAlign )
 {
 int difference = targetLeft - i.second.GetLeft();
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 commit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( difference, 0 ) );
 }
 
 commit.Push( _( "Align to left" ) );
 
 return 0;
}

References _, CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), GetSelections(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Push(), right, selectTarget(), BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by AlignLeft(), and AlignRight().

doAlignRight()

int ALIGN_DISTRIBUTE_TOOL::doAlignRight ( )

private

Align selected items using the right edge of their bounding boxes to the right-most item.

Note

Uses the bounding box of items, which do not get mirrored even when the view is mirrored!

Definition at line 360 of file placement_tool.cpp.

{
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> itemsToAlign;
 std::vector<std::pair<BOARD_ITEM*, BOX2I>> locked_items;
 
 if( !GetSelections( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.GetRight() > right.second.GetRight() );
 } ) )
 {
 return 0;
 }
 
 BOARD_COMMIT commit( m_frame );
 
 int targetRight = selectTarget( itemsToAlign, locked_items,
 []( const std::pair<BOARD_ITEM*, BOX2I>& aVal )
 {
 return aVal.second.GetRight();
 } );
 
 // Move the selected items
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : itemsToAlign )
 {
 int difference = targetRight - i.second.GetRight();
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
  // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 commit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( difference, 0 ) );
 }
 
 commit.Push( _( "Align to right" ) );
 
 return 0;
}

References _, CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), GetSelections(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Push(), right, selectTarget(), BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by AlignLeft(), and AlignRight().

doDistributeCentersHorizontally()

void ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally ( std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aItems, BOARD_COMMIT &  aCommit  ) const

private

Distribute selected items using an even spacing between the centers of their bounding boxes.

Note

Using the centers of bounding box of items can give unsatisfactory visual results since items of differing widths will be placed with different gaps. Is only used if items overlap.

Definition at line 591 of file placement_tool.cpp.

{
 std::sort( aItems.begin(), aItems.end(),
 [] ( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.Centre().x < right.second.Centre().x );
 } );
 
 const int totalGap = ( aItems.end() - 1 )->second.Centre().x
 - aItems.begin()->second.Centre().x;
 const int itemGap = totalGap / ( aItems.size() - 1 );
 int targetX = aItems.begin()->second.Centre().x;
 
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : aItems )
 {
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 int difference = targetX - i.second.Centre().x;
 aCommit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( difference, 0 ) );
 targetX += ( itemGap );
 }
}

References CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, right, BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by DistributeHorizontally().

doDistributeCentersVertically()

void ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically ( std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aItems, BOARD_COMMIT &  aCommit  ) const

private

Distribute selected items using an even spacing between the centers of their bounding boxes.

Note

Using the centers of bounding box of items can give unsatisfactory visual results since items of differing widths will be placed with different gaps. Is only used if items overlap

Definition at line 718 of file placement_tool.cpp.

{
 std::sort( aItems.begin(), aItems.end(),
 [] ( const std::pair<BOARD_ITEM*, BOX2I> left, const std::pair<BOARD_ITEM*, BOX2I> right)
 {
 return ( left.second.Centre().y < right.second.Centre().y );
 } );
 
 const int totalGap = ( aItems.end() - 1 )->second.Centre().y
 - aItems.begin()->second.Centre().y;
 const int itemGap = totalGap / ( aItems.size() - 1 );
 int targetY = aItems.begin()->second.Centre().y;
 
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : aItems )
 {
 BOARD_ITEM* item = i.first;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 int difference = targetY - i.second.Centre().y;
 aCommit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( 0, difference ) );
 targetY += ( itemGap );
 }
}

References CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), left, m_frame, BOARD_ITEM::Move(), PCB_PAD_T, right, BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by DistributeVertically().

doDistributeGapsHorizontally()

void ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally ( std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aItems, BOARD_COMMIT &  aCommit, const BOARD_ITEM *  lastItem, int  totalGap  ) const

private

Distributes selected items using an even spacing between their bounding boxes.

Note

Using the edges of bounding box of items is only possible if there is enough space between them. If this is not the case, use the center spacing method

Definition at line 560 of file placement_tool.cpp.

{
 const int itemGap = totalGap / ( aItems.size() - 1 );
 int targetX = aItems.begin()->second.GetX();
 
 for( const std::pair<BOARD_ITEM*, BOX2I>& i : aItems )
 {
 BOARD_ITEM* item = i.first;
 
 // cover the corner case where the last item is wider than the previous item and gap
 if( lastItem == item )
 continue;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 int difference = targetX - i.second.GetX();
 aCommit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( difference, 0 ) );
 targetX += ( i.second.GetWidth() + itemGap );
 }
}

References CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), BOARD_ITEM::GetX(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by DistributeHorizontally().

doDistributeGapsVertically()

void ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically ( std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aItems, BOARD_COMMIT &  aCommit, const BOARD_ITEM *  lastItem, int  totalGap  ) const

private

Distributes selected items using an even spacing between their bounding boxes.

Note

Using the edges of bounding box of items is only possible if there is enough space between them. If this is not the case, use the center spacing method

Definition at line 687 of file placement_tool.cpp.

{
 const int itemGap = totalGap / ( aItems.size() - 1 );
 int targetY = aItems.begin()->second.GetY();
 
 for( std::pair<BOARD_ITEM*, BOX2I>& i : aItems )
 {
 BOARD_ITEM* item = i.first;
 
 // cover the corner case where the last item is wider than the previous item and gap
 if( lastItem == item )
 continue;
 
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 // Don't move a pad by itself unless editing the footprint
 if( item->Type() == PCB_PAD_T && m_frame->IsType( FRAME_PCB_EDITOR ) )
 item = item->GetParent();
 
 int difference = targetY - i.second.GetY();
 aCommit.Stage( item, CHT_MODIFY );
 item->Move( VECTOR2I( 0, difference ) );
 targetY += ( i.second.GetHeight() + itemGap );
 }
}

References CHT_MODIFY, FRAME_PCB_EDITOR, BOARD_ITEM::GetParent(), BOARD_ITEM::GetY(), EDA_ITEM::IsSelected(), EDA_BASE_FRAME::IsType(), m_frame, BOARD_ITEM::Move(), PCB_PAD_T, BOARD_COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by DistributeVertically().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Return the application window object, casted to requested user type.

Definition at line 185 of file tool_base.h.

 {
#if !defined( QA_TEST ) // Dynamic casts give the linker a seizure in the test framework
 wxASSERT( dynamic_cast<T*>( getToolHolderInt() ) );
#endif
 return static_cast<T*>( getToolHolderInt() );
 }

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone(), and ZONE_CREATE_HELPER::setUniquePriority().

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 121 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::isActive(), TOOL_MANAGER::RegisterTool(), ACTION_MANAGER::RunHotKey(), TOOL_MANAGER::runTool(), TOOL_MANAGER::saveViewControls(), and TOOL_MANAGER::ShutdownTool().

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

Return the instance of TOOL_MANAGER that takes care of the tool.

Returns

Instance of the TOOL_MANAGER or NULL if there is no associated tool manager.

Definition at line 144 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

Referenced by ZONE_CREATE_HELPER::commitZone(), and ZONE_CREATE_HELPER::createZoneFromExisting().

getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

References TOOL_MANAGER::GetModel(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getModel().

GetName()

const std::string & TOOL_BASE::GetName ( void  ) const

inlineinherited

Return the name of the tool.

Tool names are expected to obey the format: application.ToolName (eg. pcbnew.InteractiveSelection).

Returns

The name of the tool.

Definition at line 134 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

Referenced by TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

GetSelections()

template<typename T >

size_t ALIGN_DISTRIBUTE_TOOL::GetSelections ( std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aItemsToAlign, std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aLockedItems, T  aCompare  )

private

Populate two vectors with the sorted selection and sorted locked items.

Returns the size of aItemsToAlign()

Definition at line 144 of file placement_tool.cpp.

{
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( item->Type() == PCB_MARKER_T )
 aCollector.Remove( item );
 }
 } );
 
 std::vector<BOARD_ITEM*> lockedItems;
 std::vector<BOARD_ITEM*> itemsToAlign;
 
 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( item );
 
 // We do not lock items in the footprint editor
 if( boardItem->IsLocked() && m_frame->IsType( FRAME_PCB_EDITOR ) )
 {
 // Locking a pad but not the footprint means that we align the footprint using
 // the pad position. So we test for footprint locking here
 if( boardItem->Type() == PCB_PAD_T && !boardItem->GetParent()->IsLocked() )
 {
 itemsToAlign.push_back( boardItem );
 }
 else
 {
 lockedItems.push_back( boardItem );
 }
 }
 else
 itemsToAlign.push_back( boardItem );
 }
 
 aItemsToAlign = GetBoundingBoxes( itemsToAlign );
 aLockedItems = GetBoundingBoxes( lockedItems );
 std::sort( aItemsToAlign.begin(), aItemsToAlign.end(), aCompare );
 std::sort( aLockedItems.begin(), aLockedItems.end(), aCompare );
 
 return aItemsToAlign.size();
}

References FRAME_PCB_EDITOR, GetBoundingBoxes(), COLLECTOR::GetCount(), BOARD_ITEM::GetParent(), BOARD_ITEM::IsLocked(), EDA_BASE_FRAME::IsType(), m_frame, m_selectionTool, PCB_PAD_T, PCB_SELECTION_TOOL::RequestSelection(), and EDA_ITEM::Type().

Referenced by AlignBottom(), AlignCenterX(), AlignCenterY(), AlignTop(), doAlignLeft(), and doAlignRight().

getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

{
 return m_toolMgr->GetToolHolder();
}

References TOOL_MANAGER::GetToolHolder(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

Referenced by EE_INSPECTION_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), and Init().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 109 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getView()

KIGFX::VIEW * TOOL_BASE::getView ( ) const

protectedinherited

Returns the instance of #VIEW object used in the application.

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

References TOOL_MANAGER::GetView(), and TOOL_BASE::m_toolMgr.

Referenced by EE_POINT_EDITOR::addCornerCondition(), AlignLeft(), AlignRight(), COMMON_TOOLS::CenterContents(), SCH_EDIT_TOOL::ChangeTextType(), EE_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), SCH_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EE_SELECTION_TOOL::Reset(), EE_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), EE_SELECTION_TOOL::selectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), EE_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), EE_SELECTION_TOOL::~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL().

getViewControls()

KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.).

Returns

The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

References TOOL_MANAGER::GetViewControls(), and TOOL_BASE::m_toolMgr.

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T >

void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc, const TOOL_EVENT_LIST &  aConditions = TOOL_EVENT( TC_ANY, TA_ANY )  )

inherited

Define which state (aStateFunc) to go when a certain event arrives (aConditions).

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

{
 TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );
 
 goInternal( sptr, aConditions );
}

References TOOL_INTERACTIVE::goInternal().

Referenced by EDA_3D_CONTROLLER::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), EE_POINT_EDITOR::setTransitions(), EE_SELECTION_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), and ZONE_FILLER_TOOL::setTransitions().

goInternal()

void TOOL_INTERACTIVE::goInternal ( TOOL_STATE_FUNC &  aState, const TOOL_EVENT_LIST &  aConditions  )

privateinherited

Definition at line 70 of file tool_interactive.cpp.

{
 m_toolMgr->ScheduleNextState( this, aState, aConditions );
}

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::ScheduleNextState().

Referenced by TOOL_INTERACTIVE::Go().

Init()

bool ALIGN_DISTRIBUTE_TOOL::Init ( )

overridevirtual

Init() is called once upon a registration of the tool.

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Definition at line 55 of file placement_tool.cpp.

{
 // Find the selection tool, so they can cooperate
 m_selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 m_frame = getEditFrame<PCB_BASE_FRAME>();
 
 // Create a context menu and make it available through selection tool
 m_placementMenu = new ACTION_MENU( true, this );
 m_placementMenu->SetIcon( BITMAPS::align_items );
 m_placementMenu->SetTitle( _( "Align/Distribute" ) );
 
 // Add all align/distribute commands
 m_placementMenu->Add( PCB_ACTIONS::alignLeft );
 m_placementMenu->Add( PCB_ACTIONS::alignCenterX );
 m_placementMenu->Add( PCB_ACTIONS::alignRight );
 
 m_placementMenu->AppendSeparator();
 m_placementMenu->Add( PCB_ACTIONS::alignTop );
 m_placementMenu->Add( PCB_ACTIONS::alignCenterY );
 m_placementMenu->Add( PCB_ACTIONS::alignBottom );
 
 m_placementMenu->AppendSeparator();
 m_placementMenu->Add( PCB_ACTIONS::distributeHorizontally );
 m_placementMenu->Add( PCB_ACTIONS::distributeVertically );
 
 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
 selToolMenu.AddMenu( m_placementMenu, SELECTION_CONDITIONS::MoreThan( 1 ), 100 );
 
 return true;
}

References _, ACTION_MENU::Add(), CONDITIONAL_MENU::AddMenu(), align_items, PCB_ACTIONS::alignBottom, PCB_ACTIONS::alignCenterX, PCB_ACTIONS::alignCenterY, PCB_ACTIONS::alignLeft, PCB_ACTIONS::alignRight, PCB_ACTIONS::alignTop, PCB_ACTIONS::distributeHorizontally, PCB_ACTIONS::distributeVertically, TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), m_frame, m_placementMenu, m_selectionTool, TOOL_BASE::m_toolMgr, SELECTION_CONDITIONS::MoreThan(), ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

References TOOL_MANAGER::IsToolActive(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by EDIT_TOOL::Drag(), ROUTER_TOOL::handleLayerSwitch(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

Reset()

void ALIGN_DISTRIBUTE_TOOL::Reset ( RESET_REASON  aReason )

inlineoverridevirtual

Bring the tool to a known, initial state.

If the tool claimed anything from the model or the view, it must release it when its reset.

Parameters

aReason

contains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 45 of file placement_tool.h.

{}

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

Clear the current transition map and restores the default one created by setTransitions().

Definition at line 63 of file tool_interactive.cpp.

{
 m_toolMgr->ClearTransitions( this );
 setTransitions();
}

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

RunMainStack()

void TOOL_INTERACTIVE::RunMainStack ( std::function< void()>  aFunc )

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

{
 m_toolMgr->RunMainStack( this, std::move( aFunc ) );
}

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::RunMainStack().

Referenced by DRAWING_TOOL::PlaceText().

selectTarget()

template<typename T >

int ALIGN_DISTRIBUTE_TOOL::selectTarget ( std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aItems, std::vector< std::pair< BOARD_ITEM *, BOX2I > > &  aLocked, T  aGetValue  )

private

Definition at line 113 of file placement_tool.cpp.

{
 VECTOR2I curPos = getViewControls()->GetCursorPosition();
 
 // Prefer locked items to unlocked items.
 // Secondly, prefer items under the cursor to other items.
 
 if( aLocked.size() >= 1 )
 {
 for( const std::pair<BOARD_ITEM*, BOX2I>& item : aLocked )
 {
 if( item.second.Contains( curPos ) )
 return aGetValue( item );
 }
 
 return aGetValue( aLocked.front() );
 }
 
 for( const std::pair<BOARD_ITEM*, BOX2I>& item : aItems )
 {
 if( item.second.Contains( curPos ) )
 return aGetValue( item );
 }
 
 return aGetValue( aItems.front() );
}

References KIGFX::VIEW_CONTROLS::GetCursorPosition(), and TOOL_BASE::getViewControls().

Referenced by AlignBottom(), AlignCenterX(), AlignCenterY(), AlignTop(), doAlignLeft(), and doAlignRight().

SetContextMenu()

void TOOL_INTERACTIVE::SetContextMenu ( ACTION_MENU *  aMenu, CONTEXT_MENU_TRIGGER  aTrigger = CMENU_BUTTON  )

inherited

Assign a context menu and tells when it should be activated.

Parameters

aMenu	is the menu to be assigned.
aTrigger	determines conditions upon which the context menu is activated.

Definition at line 76 of file tool_interactive.cpp.

{
 if( aMenu )
 aMenu->SetTool( this );
 else
 aTrigger = CMENU_OFF;
 
 m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
}

References CMENU_OFF, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ScheduleContextMenu(), and ACTION_MENU::SetTool().

Referenced by SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setTransitions()

void ALIGN_DISTRIBUTE_TOOL::setTransitions ( )

overridevirtual

This method is meant to be overridden in order to specify handlers for events.

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Definition at line 751 of file placement_tool.cpp.

{
 Go( &ALIGN_DISTRIBUTE_TOOL::AlignTop, PCB_ACTIONS::alignTop.MakeEvent() );
 Go( &ALIGN_DISTRIBUTE_TOOL::AlignBottom, PCB_ACTIONS::alignBottom.MakeEvent() );
 Go( &ALIGN_DISTRIBUTE_TOOL::AlignLeft, PCB_ACTIONS::alignLeft.MakeEvent() );
 Go( &ALIGN_DISTRIBUTE_TOOL::AlignRight, PCB_ACTIONS::alignRight.MakeEvent() );
 Go( &ALIGN_DISTRIBUTE_TOOL::AlignCenterX, PCB_ACTIONS::alignCenterX.MakeEvent() );
 Go( &ALIGN_DISTRIBUTE_TOOL::AlignCenterY, PCB_ACTIONS::alignCenterY.MakeEvent() );
 
 Go( &ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally,
 PCB_ACTIONS::distributeHorizontally.MakeEvent() );
 Go( &ALIGN_DISTRIBUTE_TOOL::DistributeVertically,
 PCB_ACTIONS::distributeVertically.MakeEvent() );
}

References PCB_ACTIONS::alignBottom, AlignBottom(), PCB_ACTIONS::alignCenterX, AlignCenterX(), PCB_ACTIONS::alignCenterY, AlignCenterY(), PCB_ACTIONS::alignLeft, AlignLeft(), PCB_ACTIONS::alignRight, AlignRight(), PCB_ACTIONS::alignTop, AlignTop(), PCB_ACTIONS::distributeHorizontally, DistributeHorizontally(), PCB_ACTIONS::distributeVertically, DistributeVertically(), and TOOL_INTERACTIVE::Go().

Wait()

TOOL_EVENT * TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST &  aEventList = TOOL_EVENT( TC_ANY, TA_ANY ) )

inherited

Suspend execution of the tool until an event specified in aEventList arrives.

No parameters means waiting for any event.

Definition at line 57 of file tool_interactive.cpp.

{
 return m_toolMgr->ScheduleWait( this, aEventList );
}

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::ScheduleWait().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

m_frame

PCB_BASE_FRAME* ALIGN_DISTRIBUTE_TOOL::m_frame

private

Definition at line 176 of file placement_tool.h.

Referenced by AlignBottom(), AlignCenterX(), AlignCenterY(), AlignTop(), DistributeHorizontally(), DistributeVertically(), doAlignLeft(), doAlignRight(), doDistributeCentersHorizontally(), doDistributeCentersVertically(), doDistributeGapsHorizontally(), doDistributeGapsVertically(), GetSelections(), and Init().

m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu

protectedinherited

The functions below are not yet implemented - their interface may change.

Definition at line 125 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), EE_TOOL_BASE< T >::Init(), SCH_DRAWING_TOOLS::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PAD_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

m_placementMenu

ACTION_MENU* ALIGN_DISTRIBUTE_TOOL::m_placementMenu

private

Definition at line 175 of file placement_tool.h.

Referenced by Init(), and ~ALIGN_DISTRIBUTE_TOOL().

m_selectionTool

PCB_SELECTION_TOOL* ALIGN_DISTRIBUTE_TOOL::m_selectionTool

private

Definition at line 174 of file placement_tool.h.

Referenced by DistributeHorizontally(), DistributeVertically(), GetSelections(), and Init().

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

Names are expected to obey the format application.ToolName (eg. pcbnew.InteractiveSelection).

Definition at line 210 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), TOOL_BASE::GetId(), and TOOL_BASE::IsToolActive().

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_EDIT_TOOL::AutoplaceFields(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), MICROWAVE_TOOL::createInductorBetween(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), PAD_TOOL::explodePad(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getToolHolderInt(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EE_TOOL_BASE< T >::Init(), SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), EE_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), EE_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), EE_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSelected(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), EE_POINT_EDITOR::updateParentItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Unique identifier for the tool, assigned by a TOOL_MANAGER instance.

Definition at line 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

---

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

• placement_tool.h
• placement_tool.cpp