Tool that displays edit points allowing to modify items by dragging the points. More...

#include <pcb_point_editor.h>

Inheritance diagram for PCB_POINT_EDITOR:

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

Public Member Functions
	PCB_POINT_EDITOR ()

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	OnSelectionChange (const TOOL_EVENT &aEvent)
	Change selection event handler. More...

bool	HasPoint ()
	Indicate the cursor is over an edit point. More...

bool	HasMidpoint ()

bool	HasCorner ()

void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor() More...

bool	IsFootprintEditor () const

void	SetIsBoardEditor (bool aEnabled)

bool	IsBoardEditor () const

virtual bool	Is45Limited () const
	Should the tool use its 45° mode option? 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 Types
enum	INTERACTIVE_PLACEMENT_OPTIONS { IPO_ROTATE = 0x01 , IPO_FLIP = 0x02 , IPO_SINGLE_CLICK = 0x04 , IPO_REPEAT = 0x08 }
	Options for placing items interactively. More...

Protected Member Functions
void	doInteractiveItemPlacement (const TOOL_EVENT &aTool, INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE\|IPO_FLIP\|IPO_REPEAT)
	Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc. More...

KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

PCB_BASE_EDIT_FRAME *	frame () const

BOARD *	board () const

FOOTPRINT *	footprint () const

PCBNEW_SETTINGS::DISPLAY_OPTIONS &	displayOptions () const

PCB_DRAW_PANEL_GAL *	canvas () const

const PCB_SELECTION &	selection () const

PCB_SELECTION &	selection ()

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
bool	m_isFootprintEditor

bool	m_isBoardEditor

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
void	setTransitions () override
	< Set up handlers for various events. More...

void	buildForPolyOutline (std::shared_ptr< EDIT_POINTS > points, const SHAPE_POLY_SET *aOutline)

std::shared_ptr< EDIT_POINTS >	makePoints (EDA_ITEM *aItem)
	Update item's points with edit points. More...

void	updateItem () const

bool	validatePolygon (SHAPE_POLY_SET &aModified) const
	Validate a polygon and displays a popup warning if invalid. More...

void	updatePoints ()
	Update which point is being edited. More...

void	updateEditedPoint (const TOOL_EVENT &aEvent)
	Set the current point being edited. NULL means none. More...

void	setEditedPoint (EDIT_POINT *aPoint)

int	getEditedPointIndex () const
	Return true if aPoint is the currently modified point. More...

bool	isModified (const EDIT_POINT &aPoint) const

void	pinEditedCorner (VECTOR2I &aTopLeft, VECTOR2I &aTopRight, VECTOR2I &aBotLeft, VECTOR2I &aBotRight, const VECTOR2I &aHole={ 0, 0 }, const VECTOR2I &aHoleSize={ 0, 0 }) const
	Set up an alternative constraint (typically enabled upon a modifier key being pressed). More...

void	setAltConstraint (bool aEnabled)
	Return a point that should be used as a constrainer for 45 degrees mode. More...

EDIT_POINT	get45DegConstrainer () const
	Condition to display "Create corner" context menu entry. More...

bool	removeCornerCondition (const SELECTION &aSelection)

int	movePoint (const TOOL_EVENT &aEvent)
	TOOL_ACTION handlers. More...

int	addCorner (const TOOL_EVENT &aEvent)

int	removeCorner (const TOOL_EVENT &aEvent)

int	modifiedSelection (const TOOL_EVENT &aEvent)

void	editArcEndpointKeepTangent (PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
	Move an end point of the arc, while keeping the tangent at the other endpoint. More...

void	editArcEndpointKeepCenter (PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
	Move an end point of the arc around the circumference. More...

void	editArcCenterKeepEndpoints (PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd) const
	Move the arc center but keep endpoint locations. More...

void	editArcMidKeepEndpoints (PCB_SHAPE *aArc, const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
	Move the mid point of the arc, while keeping the two endpoints. More...

void	editArcMidKeepCenter (PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
	Move the mid point of the arc, while keeping the angle. More...

int	changeArcEditMode (const TOOL_EVENT &aEvent)

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

Static Private Member Functions
static bool	addCornerCondition (const SELECTION &aSelection)
	Determine if the tool can currently add a corner to the given item. More...

static bool	canAddCorner (const EDA_ITEM &aItem)
	Condition to display "Remove corner" context menu entry. More...

Private Attributes
PCB_SELECTION_TOOL *	m_selectionTool

std::unique_ptr< STATUS_TEXT_POPUP >	m_statusPopup

std::shared_ptr< EDIT_POINTS >	m_editPoints

EDIT_POINT *	m_editedPoint

EDIT_POINT *	m_hoveredPoint

EDIT_POINT	m_original
	Original position for the current drag point. More...

bool	m_refill

ARC_EDIT_MODE	m_arcEditMode

std::shared_ptr< EDIT_CONSTRAINT< EDIT_POINT > >	m_altConstraint

EDIT_POINT	m_altConstrainer

Static Private Attributes
static const unsigned int	COORDS_PADDING = pcbIUScale.mmToIU( 20 )

Detailed Description

Tool that displays edit points allowing to modify items by dragging the points.

Definition at line 44 of file pcb_point_editor.h.

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

Enumerator
IPO_ROTATE	Handle the rotate action in the loop by calling the item's rotate method.
IPO_FLIP	Handle flip action in the loop by calling the item's flip method.
IPO_SINGLE_CLICK	Create an item immediately on placement starting, otherwise show the pencil cursor until the item is created.
IPO_REPEAT	Allow repeat placement of the item.

Definition at line 121 of file pcb_tool_base.h.

◆ 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 (the sheet for a schematic)
SUPERMODEL_RELOAD	For schematics, the entire schematic changed, not just the sheet.
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

Constructor & Destructor Documentation

◆ PCB_POINT_EDITOR()

PCB_POINT_EDITOR::PCB_POINT_EDITOR ( )

Definition at line 106 of file pcb_point_editor.cpp.

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.

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(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_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(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_POINT_EDITOR::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(), 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_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ addCorner()

int PCB_POINT_EDITOR::addCorner ( const TOOL_EVENT & aEvent )

private

◆ addCornerCondition()

bool PCB_POINT_EDITOR::addCornerCondition ( const SELECTION & aSelection )

staticprivate

Determine if the tool can currently add a corner to the given item.

Definition at line 2114 of file pcb_point_editor.cpp.

References canAddCorner(), SELECTION::Front(), and SELECTION::Size().

Referenced by Init().

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

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 170 of file pcb_tool_base.h.

Referenced by PCB_CONTROL::AppendBoard(), BOARD_EDITOR_CONTROL::AssignNetclass(), AUTOPLACE_TOOL::autoplace(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), BOARD_INSPECTION_TOOL::ClearHighlight(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createInductorBetween(), ROUTER_TOOL::CustomTrackWidthDialog(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), PCB_TOOL_BASE::footprint(), GROUP_TOOL::Group(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::Init(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PAD_TOOL::OnUndoRedo(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), PCB_CONTROL::pruneItemLayers(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), PAD_TOOL::RecombinePad(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::unfilledZoneCheck(), GROUP_TOOL::Ungroup(), ROUTER_TOOL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterLayerSwitch(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ buildForPolyOutline()

void PCB_POINT_EDITOR::buildForPolyOutline	(	std::shared_ptr< EDIT_POINTS >	points,
		const SHAPE_POLY_SET *	aOutline
	)

private

Definition at line 144 of file pcb_point_editor.cpp.

References SHAPE_POLY_SET::CIterateWithHoles(), and SHAPE_POLY_SET::TotalVertices().

Referenced by makePoints().

◆ canAddCorner()

bool PCB_POINT_EDITOR::canAddCorner ( const EDA_ITEM & aItem )

staticprivate

Condition to display "Remove corner" context menu entry.

Definition at line 2096 of file pcb_point_editor.cpp.

References EDA_SHAPE::GetShape(), PCB_SHAPE_T, PCB_ZONE_T, and EDA_ITEM::Type().

Referenced by addCorner(), and addCornerCondition().

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 311 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame(), and PCB_BASE_FRAME::GetCanvas().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::exitPadEditMode(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickReferencePoint(), PCB_CONTROL::RatsnestModeCycle(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ changeArcEditMode()

int PCB_POINT_EDITOR::changeArcEditMode ( const TOOL_EVENT & aEvent )

private

Definition at line 2395 of file pcb_point_editor.cpp.

References ACTIONS::cycleArcEditMode, FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetFootprintEditorSettings(), PCB_BASE_FRAME::GetPcbNewSettings(), EDA_BASE_FRAME::IsType(), FOOTPRINT_EDITOR_SETTINGS::m_ArcEditMode, PCBNEW_SETTINGS::m_ArcEditMode, m_arcEditMode, TOOL_ACTION::MakeEvent(), TOOL_EVENT::Matches(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

◆ controls()

KIGFX::VIEW_CONTROLS * PCB_TOOL_BASE::controls ( ) const

inlineprotectedinherited

◆ displayOptions()

PCBNEW_SETTINGS::DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 306 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetPcbNewSettings(), and PCBNEW_SETTINGS::m_Display.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_CONTROL::RatsnestModeCycle(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), and PCB_CONTROL::ViaDisplayMode().

◆ doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement	(	const TOOL_EVENT &	aTool,
		INTERACTIVE_PLACER_BASE *	aPlacer,
		const wxString &	aCommitMessage,
		int	aOptions = `IPO_ROTATE \| IPO_FLIP \| IPO_REPEAT`
	)

protectedinherited

Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

More complex interactive processes are not supported here, you should implement a customised event loop for those.

Parameters

aItemCreator	the callable that will attempt to create the item
aCommitMessage	the message used on a successful commit

Definition at line 42 of file pcb_tool_base.cpp.

References TOOL_INTERACTIVE::Activate(), SELECTION::Add(), KIGFX::VIEW_GROUP::Add(), KIGFX::PCB_VIEW::Add(), PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getView(), grid, PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, PCB_TOOL_BASE::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), PCB_FOOTPRINT_T, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::PostAction(), TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), EDA_ITEM::SetFlags(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

Referenced by MICROWAVE_TOOL::addMicrowaveFootprint(), DRAWING_TOOL::DrawVia(), and PAD_TOOL::PlacePad().

◆ editArcCenterKeepEndpoints()

void PCB_POINT_EDITOR::editArcCenterKeepEndpoints	(	PCB_SHAPE *	aArc,
		const VECTOR2I &	aCenter,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aMid,
		const VECTOR2I &	aEnd
	)		const

private

Move the arc center but keep endpoint locations.

Definition at line 854 of file pcb_point_editor.cpp.

References SEG::A, SEG::B, VECTOR2< int >::ECOORD_MAX, SEG::IntersectLines(), VECTOR2< T >::Resize(), EDA_SHAPE::SetCenter(), and SEG::SquaredDistance().

Referenced by updateItem().

◆ editArcEndpointKeepCenter()

void PCB_POINT_EDITOR::editArcEndpointKeepCenter	(	PCB_SHAPE *	aArc,
		const VECTOR2I &	aCenter,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aMid,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aCursor
	)		const

private

Move an end point of the arc around the circumference.

Definition at line 1010 of file pcb_point_editor.cpp.

References VECTOR2< T >::EuclideanNorm(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), EDA_UNIT_UTILS::Mils2IU(), pcbIUScale, VECTOR2< T >::Resize(), EDA_SHAPE::SetCenter(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by updateItem().

◆ editArcEndpointKeepTangent()

void PCB_POINT_EDITOR::editArcEndpointKeepTangent	(	PCB_SHAPE *	aArc,
		const VECTOR2I &	aCenter,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aMid,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aCursor
	)		const

private

Move an end point of the arc, while keeping the tangent at the other endpoint.

Definition at line 705 of file pcb_point_editor.cpp.

References delta, VECTOR2< T >::EuclideanNorm(), VECTOR3< T >::EuclideanNorm(), ADVANCED_CFG::GetCfg(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), ADVANCED_CFG::m_DrawArcCenterMaxAngle, EDA_SHAPE::SetCenter(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), v1, v2, v3, v4, VECTOR2< T >::x, VECTOR3< T >::x, VECTOR2< T >::y, and VECTOR3< T >::y.

Referenced by updateItem().

◆ editArcMidKeepCenter()

void PCB_POINT_EDITOR::editArcMidKeepCenter	(	PCB_SHAPE *	aArc,
		const VECTOR2I &	aCenter,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aMid,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aCursor
	)		const

private

Move the mid point of the arc, while keeping the angle.

Change the edit method for arcs.

Definition at line 1069 of file pcb_point_editor.cpp.

References EuclideanNorm(), EDA_UNIT_UTILS::Mils2IU(), pcbIUScale, VECTOR2< T >::Resize(), EDA_SHAPE::SetEnd(), and EDA_SHAPE::SetStart().

Referenced by updateItem().

◆ editArcMidKeepEndpoints()

void PCB_POINT_EDITOR::editArcMidKeepEndpoints	(	PCB_SHAPE *	aArc,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aCursor
	)		const

private

Move the mid point of the arc, while keeping the two endpoints.

Definition at line 1098 of file pcb_point_editor.cpp.

References EuclideanNorm(), EDA_SHAPE::GetArcMid(), SEG::NearestPoint(), VECTOR2< T >::Resize(), and EDA_SHAPE::SetArcGeometry().

Referenced by updateItem().

◆ footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 172 of file pcb_tool_base.h.

References PCB_TOOL_BASE::board(), and BOARD::GetFirstFootprint().

Referenced by PCB_CONTROL::AppendBoard(), MICROWAVE_TOOL::createBaseFootprint(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawSpecificationStackup(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_INSPECTION_TOOL::makeDRCEngine(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), FOOTPRINT_EDITOR_CONTROL::Properties(), PAD_TOOL::pushPadSettings(), PAD_TOOL::RecombinePad(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), and DRAWING_TOOL::SetAnchor().

◆ frame()

PCB_BASE_EDIT_FRAME * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 165 of file pcb_tool_base.h.

Referenced by addCorner(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PCB_CONTROL::ContrastModeFeedback(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), PCB_TOOL_BASE::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EditPad(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::exitPadEditMode(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), PCB_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MoveExact(), movePoint(), PCB_CONTROL::NetColorModeCycle(), OnSelectionChange(), ROUTER_TOOL::onViaCommand(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::pushPadSettings(), PCB_CONTROL::RatsnestModeCycle(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SCRIPTING_TOOL::reloadPlugins(), removeCorner(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), setEditedPoint(), ROUTER_TOOL::SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), DRAWING_TOOL::ToggleHV45Mode(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::unfilledZoneCheck(), updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ get45DegConstrainer()

EDIT_POINT PCB_POINT_EDITOR::get45DegConstrainer ( ) const

private

Condition to display "Create corner" context menu entry.

Definition at line 2034 of file pcb_point_editor.cpp.

References CIRC_CENTER, DIM_END, DIM_KNEE, DIM_START, DIM_TEXT, EDIT_POINT::GetPosition(), isModified(), m_editedPoint, m_editPoints, m_original, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_RADIAL_T, PCB_SHAPE_T, and EDA_ITEM::Type().

Referenced by setAltConstraint().

◆ getEditedPointIndex()

int PCB_POINT_EDITOR::getEditedPointIndex ( ) const

inlineprivate

Return true if aPoint is the currently modified point.

Definition at line 97 of file pcb_point_editor.h.

References m_editedPoint, and m_editPoints.

◆ getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 186 of file tool_base.h.

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 122 of file tool_base.h.

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 145 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

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

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

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

Referenced by TOOL_BASE::getModel().

◆ GetName()

const std::string & TOOL_BASE::GetName ( ) 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 135 of file tool_base.h.

References TOOL_BASE::m_toolName.

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

◆ getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getEditFrame().

◆ GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns: The type of the tool.

Definition at line 110 of file tool_base.h.

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.

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

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

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

Referenced by EE_POINT_EDITOR::addCorner(), addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_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(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), 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(), 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(), OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), 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(), 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(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), updateEditedPoint(), 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.

References TOOL_INTERACTIVE::goInternal().

◆ goInternal()

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

privateinherited

Definition at line 70 of file tool_interactive.cpp.

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

Referenced by TOOL_INTERACTIVE::Go().

◆ HasCorner()

bool PCB_POINT_EDITOR::HasCorner ( )

inline

Definition at line 67 of file pcb_point_editor.h.

References HasMidpoint(), and HasPoint().

Referenced by makeShapeModificationMenu().

◆ HasMidpoint()

bool PCB_POINT_EDITOR::HasMidpoint ( )

inline

Definition at line 66 of file pcb_point_editor.h.

References HasPoint(), and m_editedPoint.

Referenced by HasCorner(), and makeShapeModificationMenu().

◆ HasPoint()

bool PCB_POINT_EDITOR::HasPoint ( )

inline

Indicate the cursor is over an edit point.

Used to coordinate cursor shapes with other tools.

Definition at line 65 of file pcb_point_editor.h.

References m_editedPoint.

Referenced by HasCorner(), HasMidpoint(), PCB_SELECTION_TOOL::Main(), and movePoint().

◆ Init()

bool PCB_POINT_EDITOR::Init ( )

overridevirtual

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

Returns: True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 128 of file pcb_point_editor.cpp.

References addCornerCondition(), CONDITIONAL_MENU::AddItem(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), m_selectionTool, TOOL_BASE::m_toolMgr, PCB_ACTIONS::pointEditorAddCorner, PCB_ACTIONS::pointEditorRemoveCorner, and removeCornerCondition().

◆ Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns: True if set to use 45°

Definition at line 333 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), and Pgm().

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), and ZONE_CREATE_HELPER::OnFirstPoint().

◆ IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 109 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isBoardEditor.

◆ IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 106 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by EDIT_TOOL::DeleteItems(), EDIT_TOOL::Flip(), and PCB_GRID_HELPER::queryVisible().

◆ isModified()

bool PCB_POINT_EDITOR::isModified ( const EDIT_POINT & aPoint ) const

inlineprivate

Definition at line 109 of file pcb_point_editor.h.

References m_editedPoint.

Referenced by get45DegConstrainer(), pinEditedCorner(), and updateItem().

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

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

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

◆ makePoints()

std::shared_ptr< EDIT_POINTS > PCB_POINT_EDITOR::makePoints ( EDA_ITEM * aItem )

private

Update item's points with edit points.

Definition at line 177 of file pcb_point_editor.cpp.

References ALL_LAYERS, ANGLE_270, ANGLE_90, buildForPolyOutline(), DIM_CROSSBAREND, DIM_CROSSBARSTART, DIM_END, DIM_KNEE, DIM_START, DIM_TEXT, EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetBotRight(), PCB_SHAPE::GetCenter(), PCB_DIM_ALIGNED::GetCrossbarEnd(), PCB_DIM_ALIGNED::GetCrossbarStart(), EDA_SHAPE::GetEnd(), PCB_DIMENSION_BASE::GetEnd(), PCB_DIM_RADIAL::GetKnee(), EDA_SHAPE::GetPolyShape(), PCB_BITMAP::GetPosition(), EDA_SHAPE::GetShape(), PCB_BITMAP::GetSize(), EDA_SHAPE::GetStart(), PCB_DIMENSION_BASE::GetStart(), EDA_TEXT::GetTextPos(), EDA_SHAPE::GetTopLeft(), IGNORE_SNAPS, PCB_TOOL_BASE::m_isFootprintEditor, ZONE::Outline(), pad, PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXTBOX_T, PCB_ZONE_T, RECT_BOT, RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_LEFT, RECT_RIGHT, RECT_TOP, RECT_TOP_LEFT, RECT_TOP_RIGHT, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by OnSelectionChange(), and updatePoints().

◆ modifiedSelection()

int PCB_POINT_EDITOR::modifiedSelection ( const TOOL_EVENT & aEvent )

private

Definition at line 2388 of file pcb_point_editor.cpp.

References updatePoints().

Referenced by setTransitions().

◆ movePoint()

int PCB_POINT_EDITOR::movePoint ( const TOOL_EVENT & aEvent )

private

TOOL_ACTION handlers.

Definition at line 670 of file pcb_point_editor.cpp.

References _, CHT_MODIFY, PCB_TOOL_BASE::frame(), EDIT_POINT::GetPosition(), WX_PT_ENTRY_DIALOG::GetValue(), HasPoint(), m_editedPoint, m_editPoints, BOARD_COMMIT::Push(), EDIT_POINT::SetPosition(), BOARD_COMMIT::Stage(), and updateItem().

Referenced by setTransitions().

◆ OnSelectionChange()

int PCB_POINT_EDITOR::OnSelectionChange ( const TOOL_EVENT & aEvent )

Change selection event handler.

Definition at line 453 of file pcb_point_editor.cpp.

References _, TOOL_INTERACTIVE::Activate(), KIGFX::VIEW::Add(), ALL_LAYERS, LSET::AllLayersMask(), EDIT_POINT::ApplyConstraint(), BUT_LEFT, CHT_MODIFY, COORDS_PADDING, delta, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, SELECTION::Front(), EDA_ITEM::GetEditFlags(), PCB_BASE_FRAME::GetFootprintEditorSettings(), EDIT_POINT::GetGridConstraint(), BOARD_ITEM::GetLayerSet(), PCB_BASE_FRAME::GetMagneticItemsSettings(), PCB_BASE_FRAME::GetPcbNewSettings(), EDIT_POINT::GetPosition(), PCB_SELECTION_TOOL::GetSelection(), EDIT_POINT::GetSnapConstraint(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), grid, IGNORE_SNAPS, EVENTS::InhibitSelectionEditing, EDIT_POINT::IsConstrained(), BOARD_ITEM::IsLocked(), EDA_BASE_FRAME::IsType(), m_altConstraint, FOOTPRINT_EDITOR_SETTINGS::m_ArcEditMode, PCBNEW_SETTINGS::m_ArcEditMode, m_arcEditMode, m_editedPoint, m_editPoints, m_hoveredPoint, m_original, m_refill, m_selectionTool, TOOL_BASE::m_toolMgr, PCBNEW_SETTINGS::m_Use45DegreeLimit, FOOTPRINT_EDITOR_SETTINGS::m_Use45Limit, makePoints(), TOOL_EVENT::Matches(), MD_SHIFT, OBJECT_LAYERS, BOARD_COMMIT::Push(), KIGFX::VIEW::Remove(), BOARD_COMMIT::Revert(), PCB_TOOL_BASE::selection(), EDIT_POINT::SetActive(), setAltConstraint(), KIGFX::VIEW_CONTROLS::SetAutoPan(), setEditedPoint(), EDIT_POINT::SetPosition(), KIGFX::VIEW_CONTROLS::ShowCursor(), SELECTION::Size(), SNAP_BY_GRID, SNAP_TO_GRID, COMMIT::StageItems(), TA_MOUSE_DOWN, TA_UNDO_REDO_POST, PCB_BASE_EDIT_FRAME::UndoRedoBlock(), KIGFX::VIEW::Update(), updateEditedPoint(), updateItem(), updatePoints(), TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

◆ pinEditedCorner()

void PCB_POINT_EDITOR::pinEditedCorner	(	VECTOR2I &	aTopLeft,
		VECTOR2I &	aTopRight,
		VECTOR2I &	aBotLeft,
		VECTOR2I &	aBotRight,
		const VECTOR2I &	aHole = `{ 0, 0 }`,
		const VECTOR2I &	aHoleSize = `{ 0, 0 }`
	)		const

private

Set up an alternative constraint (typically enabled upon a modifier key being pressed).

Update the coordinates of 4 corners of a rectangle, according to pad constraints and the moved corner.

Parameters

aTopLeft	[in/out] is the RECT_TOPLEFT to constraint
aTopRight	[in/out] is the RECT_TOPRIGHT to constraint
aBotLeft	[in/out] is the RECT_BOTLEFT to constraint
aBotRight	[in/out] is the RECT_BOTRIGHT to constraint
aHole	the location of the pad's hole
aHoleSize	the pad's hole size (or {0,0} if it has no hole)

Definition at line 908 of file pcb_point_editor.cpp.

References isModified(), m_editPoints, EDA_UNIT_UTILS::Mils2IU(), pcbIUScale, RECT_BOT, RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_LEFT, RECT_RIGHT, RECT_TOP, RECT_TOP_LEFT, RECT_TOP_RIGHT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by updateItem().

◆ removeCorner()

int PCB_POINT_EDITOR::removeCorner ( const TOOL_EVENT & aEvent )

private

◆ removeCornerCondition()

bool PCB_POINT_EDITOR::removeCornerCondition ( const SELECTION & aSelection )

private

Definition at line 2141 of file pcb_point_editor.cpp.

References findVertex(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), SHAPE_POLY_SET::VERTEX_INDEX::m_contour, m_editedPoint, m_editPoints, SHAPE_POLY_SET::VERTEX_INDEX::m_polygon, PCB_SHAPE_T, PCB_ZONE_T, SHAPE_POLY_SET::Polygon(), and EDA_ITEM::Type().

Referenced by Init().

◆ Reset()

void PCB_POINT_EDITOR::Reset ( RESET_REASON aReason )

overridevirtual

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.

Reimplemented from PCB_TOOL_BASE.

Definition at line 119 of file pcb_point_editor.cpp.

References TOOL_BASE::getViewControls(), m_altConstraint, m_editPoints, m_refill, and KIGFX::VIEW_CONTROLS::SetAutoPan().

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

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.

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

Referenced by DRAWING_TOOL::PlaceText().

◆ selection() [1/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 325 of file pcb_tool_base.cpp.

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

◆ selection() [2/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 317 of file pcb_tool_base.cpp.

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

◆ setAltConstraint()

void PCB_POINT_EDITOR::setAltConstraint ( bool aEnabled )

private

Return a point that should be used as a constrainer for 45 degrees mode.

Definition at line 1992 of file pcb_point_editor.cpp.

References get45DegConstrainer(), m_altConstrainer, m_altConstraint, m_editedPoint, m_editPoints, PCB_SHAPE_T, PCB_ZONE_T, and EDA_ITEM::Type().

Referenced by OnSelectionChange().

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

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

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

◆ setEditedPoint()

void PCB_POINT_EDITOR::setEditedPoint ( EDIT_POINT * aPoint )

private

Definition at line 1970 of file pcb_point_editor.cpp.

References PCB_TOOL_BASE::controls(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), EDIT_POINT::GetPosition(), TOOL_BASE::getViewControls(), m_editedPoint, EDA_DRAW_PANEL_GAL::SetCurrentCursor(), and KIGFX::VIEW_CONTROLS::ShowCursor().

Referenced by OnSelectionChange(), removeCorner(), and updateEditedPoint().

◆ SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool aEnabled )

inlineinherited

Definition at line 108 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isBoardEditor.

◆ SetIsFootprintEditor()

void PCB_TOOL_BASE::SetIsFootprintEditor ( bool aEnabled )

inlineinherited

Function SetIsFootprintEditor()

Toggles edit footprint mode. When enabled, one may select parts of footprints individually (graphics, pads, etc.), so they can be modified.

Parameters

aEnabled decides if the mode should be enabled.

Definition at line 105 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isFootprintEditor.

◆ setTransitions()

void PCB_POINT_EDITOR::setTransitions ( )

overrideprivatevirtual

◆ updateEditedPoint()

void PCB_POINT_EDITOR::updateEditedPoint ( const TOOL_EVENT & aEvent )

private

Set the current point being edited. NULL means none.

Definition at line 412 of file pcb_point_editor.cpp.

References BUT_LEFT, TOOL_EVENT::DragOrigin(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_EVENT::IsDrag(), TOOL_EVENT::IsMotion(), m_editedPoint, m_editPoints, m_hoveredPoint, TOOL_EVENT::Position(), setEditedPoint(), and EDIT_POINT::SetHover().

Referenced by OnSelectionChange().

◆ updateItem()

void PCB_POINT_EDITOR::updateItem ( ) const

private

Definition at line 1116 of file pcb_point_editor.cpp.

References std::abs(), ANGLE_270, ANGLE_90, ARC_CENTER, ARC_END, ARC_START, BEZIER_CURVE_CONTROL_POINT1, BEZIER_CURVE_CONTROL_POINT2, BEZIER_CURVE_END, BEZIER_CURVE_START, CIRC_CENTER, CIRC_END, BOX2< Vec >::Contains(), VECTOR2< T >::Cross(), SHAPE_POLY_SET::CVertex(), delta, DIM_CROSSBAREND, DIM_CROSSBARSTART, DIM_END, DIM_KNEE, DIM_START, DIM_TEXT, editArcCenterKeepEndpoints(), editArcEndpointKeepCenter(), editArcEndpointKeepTangent(), editArcMidKeepCenter(), editArcMidKeepEndpoints(), VECTOR2< T >::EuclideanNorm(), EuclideanNorm(), PCB_TOOL_BASE::frame(), BOX2< Vec >::GetBottom(), PCB_SHAPE::GetCenter(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_DIMENSION_BASE::GetEnd(), BOX2< Vec >::GetHeight(), PCB_BITMAP::GetImageScale(), PCB_DIM_RADIAL::GetKnee(), BOX2< Vec >::GetLeft(), PCB_DIM_ORTHOGONAL::GetOrientation(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetPolyShape(), EDIT_POINT::GetPosition(), BOX2< Vec >::GetRight(), EDA_SHAPE::GetShape(), PCB_BITMAP::GetSize(), PCB_DIMENSION_BASE::GetStart(), EDA_TEXT::GetTextPos(), BOX2< Vec >::GetTop(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), BOX2< Vec >::GetWidth(), PCB_SHAPE::GetWidth(), ZONE::HatchBorder(), PCB_DIM_ORTHOGONAL::HORIZONTAL, isModified(), PCB_SHAPE::IsProxyItem(), left, m_arcEditMode, m_editedPoint, m_editPoints, EDA_UNIT_UTILS::Mils2IU(), PCB_SHAPE::Move(), ZONE::Outline(), pad, FOOTPRINT::Pads(), PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXTBOX_T, PCB_ZONE_T, pcbIUScale, pinEditedCorner(), EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECT_BOT, RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_LEFT, RECT_RIGHT, RECT_TOP, RECT_TOP_LEFT, RECT_TOP_RIGHT, right, RotatePoint(), SEG_END, SEG_START, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), EDA_SHAPE::SetBottom(), EDA_SHAPE::SetEnd(), PCB_DIMENSION_BASE::SetEnd(), PCB_DIM_ALIGNED::SetHeight(), PCB_BITMAP::SetImageScale(), PCB_DIM_RADIAL::SetLeaderLength(), EDA_SHAPE::SetLeft(), EDA_DRAW_FRAME::SetMsgPanel(), ZONE::SetNeedRefill(), PCB_DIM_ORTHOGONAL::SetOrientation(), EDA_SHAPE::SetRight(), PCB_DIMENSION_BASE::SetStart(), EDA_SHAPE::SetStart(), EDA_TEXT::SetTextPos(), PCB_DIMENSION_BASE::SetTextPositionMode(), EDA_SHAPE::SetTop(), SHAPE_POLY_SET::SetVertex(), SHAPE_POLY_SET::TotalVertices(), EDA_ITEM::Type(), ZONE::UnFill(), PCB_DIMENSION_BASE::Update(), KIGFX::VIEW::Update(), KIGFX::PCB_VIEW::Update(), validatePolygon(), PCB_DIM_ORTHOGONAL::VERTICAL, PCB_TOOL_BASE::view(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by movePoint(), and OnSelectionChange().

◆ updatePoints()

void PCB_POINT_EDITOR::updatePoints ( )

private

Update which point is being edited.

Definition at line 1688 of file pcb_point_editor.cpp.

References KIGFX::VIEW::Add(), ANGLE_270, ANGLE_90, ARC_CENTER, ARC_END, ARC_START, BEZIER_CURVE_CONTROL_POINT1, BEZIER_CURVE_CONTROL_POINT2, BEZIER_CURVE_END, BEZIER_CURVE_START, CIRC_CENTER, CIRC_END, SHAPE_POLY_SET::CVertex(), DIM_CROSSBAREND, DIM_CROSSBARSTART, DIM_END, DIM_KNEE, DIM_START, DIM_TEXT, EDA_SHAPE::DupPolyPointsList(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetBotRight(), PCB_SHAPE::GetCenter(), PCB_DIM_ALIGNED::GetCrossbarEnd(), PCB_DIM_ALIGNED::GetCrossbarStart(), EDA_SHAPE::GetEnd(), PCB_DIMENSION_BASE::GetEnd(), PCB_DIM_RADIAL::GetKnee(), PCB_BITMAP::GetPosition(), EDA_SHAPE::GetShape(), PCB_BITMAP::GetSize(), EDA_SHAPE::GetStart(), PCB_DIMENSION_BASE::GetStart(), EDA_TEXT::GetTextPos(), EDA_SHAPE::GetTopLeft(), TOOL_BASE::getView(), locked, m_editedPoint, m_editPoints, makePoints(), ZONE::Outline(), pad, PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXTBOX_T, PCB_ZONE_T, RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_TOP_LEFT, RECT_TOP_RIGHT, KIGFX::VIEW::Remove(), SEG_END, SEG_START, SHAPE_POLY_SET::TotalVertices(), EDA_ITEM::Type(), KIGFX::VIEW::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by addCorner(), modifiedSelection(), OnSelectionChange(), and removeCorner().

◆ validatePolygon()

bool PCB_POINT_EDITOR::validatePolygon ( SHAPE_POLY_SET & aModified ) const

private

Validate a polygon and displays a popup warning if invalid.

Parameters

aModified is the polygon to be checked.

Returns: True if polygon is valid. Update edit points with item's points.

Definition at line 1682 of file pcb_point_editor.cpp.

Referenced by removeCorner(), and updateItem().

◆ view()

KIGFX::PCB_VIEW * PCB_TOOL_BASE::view ( ) const

inlineprotectedinherited

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

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), 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(), 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(), 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

◆ COORDS_PADDING

const unsigned int PCB_POINT_EDITOR::COORDS_PADDING = pcbIUScale.mmToIU( 20 )

staticprivate

Definition at line 193 of file pcb_point_editor.h.

Referenced by OnSelectionChange().

◆ m_altConstrainer

EDIT_POINT PCB_POINT_EDITOR::m_altConstrainer

private

Definition at line 191 of file pcb_point_editor.h.

Referenced by setAltConstraint().

◆ m_altConstraint

std::shared_ptr<EDIT_CONSTRAINT<EDIT_POINT> > PCB_POINT_EDITOR::m_altConstraint

private

Definition at line 190 of file pcb_point_editor.h.

Referenced by OnSelectionChange(), Reset(), and setAltConstraint().

◆ m_arcEditMode

ARC_EDIT_MODE PCB_POINT_EDITOR::m_arcEditMode

private

Definition at line 187 of file pcb_point_editor.h.

Referenced by changeArcEditMode(), OnSelectionChange(), and updateItem().

◆ m_editedPoint

EDIT_POINT* PCB_POINT_EDITOR::m_editedPoint

private

Definition at line 180 of file pcb_point_editor.h.

Referenced by get45DegConstrainer(), getEditedPointIndex(), HasMidpoint(), HasPoint(), isModified(), movePoint(), OnSelectionChange(), removeCorner(), removeCornerCondition(), setAltConstraint(), setEditedPoint(), updateEditedPoint(), updateItem(), and updatePoints().

◆ m_editPoints

std::shared_ptr<EDIT_POINTS> PCB_POINT_EDITOR::m_editPoints

private

Definition at line 178 of file pcb_point_editor.h.

Referenced by addCorner(), get45DegConstrainer(), getEditedPointIndex(), movePoint(), OnSelectionChange(), pinEditedCorner(), removeCorner(), removeCornerCondition(), Reset(), setAltConstraint(), updateEditedPoint(), updateItem(), and updatePoints().

◆ m_hoveredPoint

EDIT_POINT* PCB_POINT_EDITOR::m_hoveredPoint

private

Definition at line 181 of file pcb_point_editor.h.

Referenced by OnSelectionChange(), and updateEditedPoint().

◆ m_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 187 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::IsBoardEditor(), PCB_CONTROL::placeBoardItems(), and PCB_TOOL_BASE::SetIsBoardEditor().

◆ m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 186 of file pcb_tool_base.h.

Referenced by EDIT_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), GROUP_TOOL::Group(), EDIT_TOOL::Init(), PAD_TOOL::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::IsFootprintEditor(), makePoints(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_CONTROL::Print(), PCB_CONTROL::pruneItemLayers(), SCRIPTING_TOOL::reloadPlugins(), EDIT_TOOL::Rotate(), DRAWING_TOOL::SetAnchor(), PCB_TOOL_BASE::SetIsFootprintEditor(), PCB_CONTROL::SnapMode(), PCB_CONTROL::SnapModeFeedback(), and GROUP_TOOL::Ungroup().

◆ 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(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_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(), 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_original

EDIT_POINT PCB_POINT_EDITOR::m_original

private

Original position for the current drag point.

Definition at line 183 of file pcb_point_editor.h.

Referenced by get45DegConstrainer(), and OnSelectionChange().

◆ m_refill

bool PCB_POINT_EDITOR::m_refill

private

Definition at line 185 of file pcb_point_editor.h.

Referenced by OnSelectionChange(), and Reset().

◆ m_selectionTool

PCB_SELECTION_TOOL* PCB_POINT_EDITOR::m_selectionTool

private

Definition at line 176 of file pcb_point_editor.h.

Referenced by Init(), and OnSelectionChange().

◆ m_statusPopup

std::unique_ptr<STATUS_TEXT_POPUP> PCB_POINT_EDITOR::m_statusPopup

mutableprivate

Definition at line 177 of file pcb_point_editor.h.

◆ 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 211 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 216 of file tool_base.h.

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 215 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 208 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

◆ RESET_REASON

Constructor & Destructor Documentation

◆ PCB_POINT_EDITOR()

Member Function Documentation

◆ Activate()

◆ addCorner()

◆ addCornerCondition()

◆ attachManager()

◆ board()

◆ buildForPolyOutline()

◆ canAddCorner()

◆ canvas()

◆ changeArcEditMode()

◆ controls()

◆ displayOptions()

◆ doInteractiveItemPlacement()

◆ editArcCenterKeepEndpoints()

◆ editArcEndpointKeepCenter()

◆ editArcEndpointKeepTangent()

◆ editArcMidKeepCenter()

◆ editArcMidKeepEndpoints()

◆ footprint()

◆ frame()

◆ get45DegConstrainer()

◆ getEditedPointIndex()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ getModelInt()

◆ GetName()

◆ getToolHolderInt()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ goInternal()

◆ HasCorner()

◆ HasMidpoint()

◆ HasPoint()

◆ Init()

◆ Is45Limited()

◆ IsBoardEditor()

◆ IsFootprintEditor()

◆ isModified()

◆ IsToolActive()

◆ makePoints()

◆ modifiedSelection()

◆ movePoint()

◆ OnSelectionChange()

◆ pinEditedCorner()

◆ removeCorner()

◆ removeCornerCondition()

◆ Reset()

◆ resetTransitions()

◆ RunMainStack()

◆ selection() [1/2]

◆ selection() [2/2]

◆ setAltConstraint()

◆ SetContextMenu()

◆ setEditedPoint()

◆ SetIsBoardEditor()

◆ SetIsFootprintEditor()

◆ setTransitions()

◆ updateEditedPoint()

◆ updateItem()

◆ updatePoints()