SCH_POINT_EDITOR Class Reference

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

#include <sch_point_editor.h>

Inheritance diagram for SCH_POINT_EDITOR:

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

Public Member Functions
	SCH_POINT_EDITOR ()
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.
bool	Init () override
	Init() is called once upon a registration of the tool.
int	Main (const TOOL_EVENT &aEvent)
bool	HasPoint ()
	Indicate the cursor is over an edit point.
bool	IsDragging () const
	Return true while a point is actively being dragged (the model is mid-mutation between grab and release).
void	setTransitions () override
	Set up handlers for various events.
bool	IsSymbolEditor () const
	Returns true if the tool is running in the symbol editor.
int	Increment (const TOOL_EVENT &aEvent)
int	InteractiveDelete (const TOOL_EVENT &aEvent)
void	Activate ()
	Run the tool.
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.
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack.
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).
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.
TOOL_TYPE	GetType () const
	Return the type of the tool.
TOOL_ID	GetId () const
	Return the unique identifier of the tool.
const std::string &	GetName () const
	Return the name of the tool.
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool.
bool	IsToolActive () const

Protected Member Functions
F *	frame () const
EDA_ITEM *	getDrawParent () const
	Return the parent container for new draw-items in the active editor.
void	updateItem (EDA_ITEM *aItem, bool aUpdateRTree) const
	Similar to getView()->Update(), but also updates the SCH_SCREEN's RTree.
void	saveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false, bool aDirtyConnectivity=true)
	Similar to m_frame->SaveCopyInUndoList(), but also handles connectivity.
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to.
KIGFX::VIEW *	getView () const
	Return the instance of KIGFX::VIEW object used in the application.
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application.
template<typename T>
T *	getEditFrame () const
	Return the application window object, casted to requested user type.
template<typename T>
T *	getModel () const
	Return the model object if it matches the requested type.

Protected Attributes
SCH_BASE_FRAME *	m_frame
KIGFX::SCH_VIEW *	m_view
SCH_SELECTION_TOOL *	m_selectionTool
bool	m_isSymbolEditor
EDA_ITEM *	m_pickerItem
std::unique_ptr< TOOL_MENU >	m_menu
	The functions below are not yet implemented - their interface may change.
TOOL_TYPE	m_type
TOOL_ID	m_toolId
	Unique id, assigned by a TOOL_MANAGER instance.
std::string	m_toolName
	Names are expected to obey the format application.ToolName (eg.
TOOL_MANAGER *	m_toolMgr

Private Member Functions
void	updateParentItem (bool aSnapToGrid, SCH_COMMIT &aCommit) const
	Update item's points with edit points.
void	dragPinsOnEdge (const std::vector< SEG > &aOldEdges, const std::vector< VECTOR2I > &aMoveVecs, int aUnit, SCH_COMMIT &aCommit) const
	When dragging a graphics edge, update pins too.
void	updatePoints ()
	Update edit points with item's points.
void	updateEditedPoint (const TOOL_EVENT &aEvent)
	Update which point is being edited.
int	clearEditedPoints (const TOOL_EVENT &aEvent)
	Clear references to the points.
void	setEditedPoint (EDIT_POINT *aPoint)
	Set the current point being edited. NULL means none.
bool	isModified (const EDIT_POINT &aPoint) const
	Return true if aPoint is the currently modified point.
int	getEditedPointIndex () const
void	pinEditedCorner (int minWidth, int minHeight, VECTOR2I &topLeft, VECTOR2I &topRight, VECTOR2I &botLeft, VECTOR2I &botRight, EE_GRID_HELPER *aGrid) const
bool	addCornerCondition (const SELECTION &aSelection)
bool	removeCornerCondition (const SELECTION &aSelection)
int	addCorner (const TOOL_EVENT &aEvent)
	TOOL_ACTION handlers.
int	removeCorner (const TOOL_EVENT &aEvent)
int	changeArcEditMode (const TOOL_EVENT &aEvent)
int	modifiedSelection (const TOOL_EVENT &aEvent)
void	makePointsAndBehavior (EDA_ITEM *aItem)
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions().
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInternal () const
TOOLS_HOLDER *	getToolHolderInternal () const

Private Attributes
EDIT_POINT *	m_editedPoint
	Currently edited point, NULL if there is none.
bool	m_inDrag
	True while a point drag is in progress (between grab and release).
ARC_EDIT_MODE	m_arcEditMode
bool	m_inPointEditor
	Re-entrancy guards.
std::shared_ptr< EDIT_POINTS >	m_editPoints
	Currently available edit points.
std::unique_ptr< KIGFX::PREVIEW::ANGLE_ITEM >	m_angleItem
std::unique_ptr< POINT_EDIT_BEHAVIOR >	m_editBehavior
	Current item-specific edit behavior.

Detailed Description

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

Definition at line 40 of file sch_point_editor.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 (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.
SHUTDOWN	Tool is being shut down.

Definition at line 73 of file tool_base.h.

Constructor & Destructor Documentation

SCH_POINT_EDITOR()

SCH_POINT_EDITOR::SCH_POINT_EDITOR

(

)

Definition at line 1099 of file sch_point_editor.cpp.

References KEEP_CENTER_ADJUST_ANGLE_RADIUS, m_arcEditMode, m_editedPoint, m_inDrag, m_inPointEditor, and SCH_TOOL_BASE< SCH_BASE_FRAME >::SCH_TOOL_BASE().

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 61 of file tool_interactive.cpp.

References TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by CONSTRAINT_EDIT_TOOL::AddPointConstraint(), AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawEllipseArc(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDesignRuleEditorDialog(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), DRC_TOOL::ShowDRCDialog(), and DRC_RULE_EDITOR_TOOL::ShowDRCRuleEditorDialog().

addCorner()

int SCH_POINT_EDITOR::addCorner ( const TOOL_EVENT & aEvent )

private

TOOL_ACTION handlers.

Definition at line 1671 of file sch_point_editor.cpp.

References _, cursor, TOOL_EVENT::DisableGridSnapping(), SEG::Distance(), distance(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetPolyShape(), SHAPE_LINE_CHAIN::GetSegment(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), SHAPE_LINE_CHAIN::Insert(), EDA_SHAPE::IsClosed(), SHAPE_POLY_SET::IsEmpty(), m_editPoints, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, COMMIT::Modify(), SHAPE_POLY_SET::Outline(), SCH_COMMIT::Push(), SCH_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and updatePoints().

Referenced by setTransitions().

addCornerCondition()

bool SCH_POINT_EDITOR::addCornerCondition ( const SELECTION & aSelection )

private

Definition at line 1654 of file sch_point_editor.cpp.

References KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_SHAPE::GetShape(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), SCH_SHAPE::HitTest(), m_editPoints, EDIT_POINT::POINT_SIZE, POLY, and KIGFX::VIEW::ToWorld().

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 58 of file tool_base.cpp.

References m_toolMgr, and TOOL_MANAGER.

Referenced by TOOL_MANAGER::RegisterTool().

changeArcEditMode()

int SCH_POINT_EDITOR::changeArcEditMode ( const TOOL_EVENT & aEvent )

private

Definition at line 1761 of file sch_point_editor.cpp.

References EESCHEMA_SETTINGS::DRAWING::arc_edit_mode, ACTIONS::cycleArcEditMode, IncrementArcEditMode(), SYMBOL_EDITOR_SETTINGS::m_ArcEditMode, m_arcEditMode, EESCHEMA_SETTINGS::m_Drawing, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor, TOOL_EVENT::Matches(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

clearEditedPoints()

int SCH_POINT_EDITOR::clearEditedPoints ( const TOOL_EVENT & aEvent )

private

Clear references to the points.

Definition at line 1180 of file sch_point_editor.cpp.

References setEditedPoint().

Referenced by setTransitions().

dragPinsOnEdge()

void SCH_POINT_EDITOR::dragPinsOnEdge ( const std::vector< SEG > & aOldEdges, const std::vector< VECTOR2I > & aMoveVecs, int aUnit, SCH_COMMIT & aCommit ) const

private

When dragging a graphics edge, update pins too.

frame()

F * SCH_TOOL_BASE< SCH_BASE_FRAME >::frame ( ) const

inlineprotectedinherited

Definition at line 73 of file sch_tool_base.h.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags(), EE_GRAPHIC_TOOL::commitItem(), SCH_INSPECTION_TOOL::CrossProbe(), SCH_INSPECTION_TOOL::CrossProbe(), EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), SCH_INSPECTION_TOOL::ExcludeMarker(), EE_GRAPHIC_TOOL::getDefaultTextSize(), EE_GRAPHIC_TOOL::ImportGraphics(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_INSPECTION_TOOL::NextMarker(), SCH_INSPECTION_TOOL::PrevMarker(), and SCH_INSPECTION_TOOL::ShowERCDialog().

getDrawParent()

EDA_ITEM * SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent ( ) const

protectedinherited

Return the parent container for new draw-items in the active editor.

In the schematic editor this is the SCHEMATIC, in the symbol editor it is the current LIB_SYMBOL.

Definition at line 84 of file sch_tool_base.cpp.

References getEditFrame(), m_frame, and m_isSymbolEditor.

Referenced by EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), and EE_GRAPHIC_TOOL::ImportGraphics().

getEditedPointIndex()

int SCH_POINT_EDITOR::getEditedPointIndex ( ) const

inlineprivate

Definition at line 95 of file sch_point_editor.h.

References m_editedPoint, and m_editPoints.

Referenced by Main(), and removeCorner().

getEditFrame()

template<typename T>

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 182 of file tool_base.h.

References getToolHolderInternal(), and T.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_EDITOR_CONTROL::BoardSetup(), PCB_POINT_EDITOR::chamferCorner(), PCB_POINT_EDITOR::changeArcEditMode(), ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), FOOTPRINT_EDITOR_CONTROL::DefaultPadProperties(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), MICROWAVE_TOOL::drawMicrowaveInductor(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PCB_SELECTION_TOOL::editFrame(), GLOBAL_EDIT_TOOL::EditTeardrops(), FOOTPRINT_EDITOR_CONTROL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), EDIT_TOOL::EditVertices(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), FOOTPRINT_WIZARD_TOOLS::frame(), PCB_SELECTION_TOOL::frame(), PCB_TEST_SELECTION_TOOL::frame(), PCB_TOOL_BASE::frame(), PCB_VIEWER_TOOLS::frame(), SCH_TOOL_BASE< T >::frame(), BOARD_EDITOR_CONTROL::GenerateDrillFiles(), BOARD_EDITOR_CONTROL::GeneratePosFile(), GLOBAL_EDIT_TOOL::GlobalDeletions(), PCB_CONTROL::GridPlaceOrigin(), BOARD_EDITOR_CONTROL::ImportNetlist(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), GERBVIEW_SELECTION_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_EDITOR_CONTROL::Init(), PL_POINT_EDITOR::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), ZOOM_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GLOBAL_EDIT_TOOL::Migrate3DModels(), PCB_POINT_EDITOR::movePoint(), BOARD_EDITOR_CONTROL::OnAngleSnapModeChanged(), FOOTPRINT_EDITOR_CONTROL::OnAngleSnapModeChanged(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONVERT_TOOL::OutsetItems(), ROUTER_TOOL::performRouting(), EDIT_TOOL::pickReferencePoint(), POSITION_RELATIVE_TOOL::PositionRelative(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), BITMAP2CMP_CONTROL::Reset(), BOARD_EDITOR_CONTROL::Reset(), BOARD_INSPECTION_TOOL::Reset(), BOARD_REANNOTATE_TOOL::Reset(), COMMON_CONTROL::Reset(), COMMON_TOOLS::Reset(), CVPCB_ASSOCIATION_TOOL::Reset(), CVPCB_CONTROL::Reset(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Reset(), DESIGN_BLOCK_CONTROL::Reset(), DRAWING_TOOL::Reset(), DRC_RULE_EDITOR_TOOL::Reset(), DRC_TOOL::Reset(), EDIT_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Reset(), GERBVIEW_CONTROL::Reset(), GERBVIEW_INSPECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), GROUP_TOOL::Reset(), KICAD_MANAGER_CONTROL::Reset(), LIBRARY_EDITOR_CONTROL::Reset(), PCB_CONTROL::Reset(), PCB_POINT_EDITOR::Reset(), PCB_SELECTION_TOOL::Reset(), PL_DRAWING_TOOLS::Reset(), PL_EDIT_TOOL::Reset(), PL_EDITOR_CONTROL::Reset(), PL_POINT_EDITOR::Reset(), PL_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Reset(), SIMULATOR_CONTROL::Reset(), ZOOM_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Revert(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::saveRouterDebugLog(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_SELECTION_TOOL::selectable(), SCH_SELECTION_TOOL::SelectMultiple(), BOARD_EDITOR_CONTROL::ToggleConstraintsPanel(), BOARD_EDITOR_CONTROL::ToggleLayersManager(), BOARD_EDITOR_CONTROL::ToggleLibraryTree(), BOARD_EDITOR_CONTROL::ToggleNetInspector(), BOARD_EDITOR_CONTROL::ToggleProperties(), BOARD_EDITOR_CONTROL::ToggleSearch(), PROPERTIES_TOOL::UpdateProperties(), ZONE_FILLER_TOOL::ZoneFillDirty(), and GLOBAL_EDIT_TOOL::ZonesManager().

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

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

References m_toolMgr, and TOOL_MANAGER.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_TUNING_PATTERN::EditStart(), makeShapeModificationMenu(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), SCH_COMMIT::SCH_COMMIT(), PCB_TUNING_PATTERN::Update(), and GLOBAL_EDIT_TOOL::ZonesManager().

getModel()

template<typename T>

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 195 of file tool_base.h.

References getModelInternal(), and T.

Referenced by BOARD_EDITOR_CONTROL::AutoTrackWidth(), PCB_SELECTION_TOOL::board(), PCB_TEST_SELECTION_TOOL::board(), PCB_TOOL_BASE::board(), PCB_VIEWER_TOOLS::board(), COMMON_TOOLS::doCenter(), PCB_SELECTION_TOOL::filterSelection(), PCB_GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::HideLocalRatsnest(), EMBED_TOOL::Init(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceSubGrid(), PAD_TOOL::pushPadSettings(), BOARD_EDITOR_CONTROL::Reset(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), EMBED_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::selectPoint(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), and BOARD_EDITOR_CONTROL::ZoneMerge().

getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 52 of file tool_base.cpp.

References m_toolMgr.

Referenced by 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 132 of file tool_base.h.

References m_toolName.

Referenced by PCB_CONTROL::AppendBoard(), TOOL_MANAGER::dispatchInternal(), COMMON_TOOLS::GridProperties(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), SCH_TOOL_BASE< SCH_BASE_FRAME >::SetContextMenu(), and TOOL_MANAGER::ShutdownTool().

getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 46 of file tool_base.cpp.

References m_toolMgr.

Referenced by getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 108 of file tool_interactive.cpp.

References m_menu.

Referenced by BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), SCH_EDIT_TOOL::Init(), and SYMBOL_EDITOR_EDIT_TOOL::Init().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 107 of file tool_base.h.

References m_type.

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

getView()

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

protectedinherited

Return the instance of KIGFX::VIEW object used in the application.

It allows tools to draw.

Returns

The instance of KIGFX::VIEW.

Definition at line 34 of file tool_base.cpp.

References m_toolMgr.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::CollectHits(), PCB_SELECTION_TOOL::CollectMultiple(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), COMMON_TOOLS::doCenter(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SCH_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridPlaceOrigin(), PCB_CONTROL::GridResetOrigin(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), PCB_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), CONSTRAINT_EDIT_TOOL::hitTestBadge(), PCB_SELECTION_TOOL::hitTestDistance(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_PICKER_TOOL::Main(), PL_POINT_EDITOR::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), CONSTRAINT_EDIT_TOOL::onHoverMotion(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), CONSTRAINT_EDIT_TOOL::pcbRenderSettings(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), GERBVIEW_CONTROL::ReloadAllLayers(), CONSTRAINT_EDIT_TOOL::repaintShadowItems(), BOARD_EDITOR_CONTROL::Reset(), CONSTRAINT_EDIT_TOOL::Reset(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_POINT_EDITOR::Reset(), PCB_SELECTION_TOOL::Reset(), PL_POINT_EDITOR::Reset(), PNS::TOOL_BASE::Reset(), SCH_SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectLasso(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), CONSTRAINT_EDIT_TOOL::ShowConstraints(), DRAWING_TOOL::snapEventPosition(), SCH_SELECTION_TOOL::SyncSelection(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::unselectVisually(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), SCH_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TEST_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), COMMON_TOOLS::ZoomFitBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL(), and SCH_SELECTION_TOOL::~SCH_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 40 of file tool_base.cpp.

References m_toolMgr.

Referenced by PCB_POINT_EDITOR::addCorner(), SCH_SELECTION_TOOL::autostartEvent(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TEST_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNetChain(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_TOOL_BASE< T >::Increment(), EDIT_TOOL::Init(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), CONSTRAINT_EDIT_TOOL::onHoverMotion(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Properties(), PL_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_SELECTION_TOOL::selectCursor(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::SelectNode(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PCB_PICKER_TOOL::setControls(), PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T>

void TOOL_INTERACTIVE::Go ( int(T::* aStateFunc )(const TOOL_EVENT &), 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 143 of file tool_interactive.h.

References goInternal(), and T.

Referenced by ALIGN_DISTRIBUTE_TOOL::setTransitions(), ARRAY_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), BITMAP2CMP_CONTROL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), CONSTRAINT_EDIT_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), DESIGN_BLOCK_CONTROL::setTransitions(), DIFF_PHASE_SKEW_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_RULE_EDITOR_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDA_3D_CONTROLLER::setTransitions(), EDIT_TOOL::setTransitions(), EMBED_TOOL::setTransitions(), FOOTPRINT_CHOOSER_SELECTION_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), FOOTPRINT_WIZARD_TOOLS::setTransitions(), GENERATOR_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GRAPHIC_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), LIBRARY_EDITOR_CONTROL::setTransitions(), MATCH_PROPERTIES_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), MULTICHANNEL_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_DESIGN_BLOCK_CONTROL::setTransitions(), PCB_EDIT_TABLE_TOOL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_TEST_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), SCH_DESIGN_BLOCK_CONTROL::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), VIA_STITCH_TOOL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), and ZOOM_TOOL::setTransitions().

goInternal()

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

privateinherited

Definition at line 80 of file tool_interactive.cpp.

Referenced by Go().

HasPoint()

bool SCH_POINT_EDITOR::HasPoint ( )

inline

Indicate the cursor is over an edit point.

Used to coordinate cursor shapes with other tools.

Definition at line 57 of file sch_point_editor.h.

References m_editedPoint.

Referenced by SCH_SELECTION_TOOL::autostartEvent(), and SCH_SELECTION_TOOL::Main().

Increment()

int SCH_TOOL_BASE< SCH_BASE_FRAME >::Increment ( const TOOL_EVENT & aEvent )

inherited

Definition at line 67 of file sch_tool_base.cpp.

References m_menu.

Init()

bool SCH_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 TOOL_BASE.

Definition at line 1145 of file sch_point_editor.cpp.

References addCornerCondition(), ARC, SELECTION_CONDITIONS::Count(), ACTIONS::cycleArcEditMode, SCH_TOOL_BASE< T >::Init(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_ACTIONS::pointEditorAddCorner, SCH_ACTIONS::pointEditorRemoveCorner, removeCornerCondition(), SCH_SHAPE_T, and EDA_ITEM::Type().

InteractiveDelete()

int SCH_TOOL_BASE< SCH_BASE_FRAME >::InteractiveDelete ( const TOOL_EVENT & aEvent )

inherited

Definition at line 69 of file sch_tool_base.cpp.

References ACTIONS::cancelInteractive, m_frame, m_menu, and SELECTION_CONDITIONS::ShowAlways().

IsDragging()

bool SCH_POINT_EDITOR::IsDragging ( ) const

inline

Return true while a point is actively being dragged (the model is mid-mutation between grab and release).

Lets the frame defer work, such as the autosave snapshot, that must not run over a live edit.

Definition at line 64 of file sch_point_editor.h.

References m_inDrag.

Referenced by SCH_EDIT_FRAME::interactiveOperationInProgress().

isModified()

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

inlineprivate

Return true if aPoint is the currently modified point.

Definition at line 90 of file sch_point_editor.h.

References m_editedPoint.

IsSymbolEditor()

bool SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor ( ) const

inherited

Returns true if the tool is running in the symbol editor.

Definition at line 65 of file sch_tool_base.cpp.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags(), EE_GRAPHIC_TOOL::commitItem(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::getDefaultTextSize(), EE_GRAPHIC_TOOL::getShapeLayer(), and EE_GRAPHIC_TOOL::ImportGraphics().

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 28 of file tool_base.cpp.

References m_toolId, and m_toolMgr.

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

Main()

int SCH_POINT_EDITOR::Main

(

const TOOL_EVENT &

aEvent

)

Definition at line 1214 of file sch_point_editor.cpp.

References _, SCH_TOOL_BASE< SCH_BASE_FRAME >::Activate(), KIGFX::VIEW::Add(), SNAP_RESOLVER::AddCandidate(), ANGLE_STEP_45, ANGLE_STEP_90, ARC, authoredSnapRelation(), BASE_CONFLICT, BUT_LEFT, KIGFX::VIEW_CONTROLS::CaptureCursor(), editor, COMMIT::Empty(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SELECTION::Front(), getEditedPointIndex(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getEditFrame(), EDIT_LINE::GetEnd(), KIGFX::VIEW_CONTROLS::GetMousePosition(), EDIT_LINE::GetOrigin(), EDIT_POINT::GetPosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), grid, GRID_GRAPHICS, INCOMPATIBLE, IS_MOVING, EDA_ITEM::IsNew(), EDA_ITEM::IsType(), KEEP_ENDPOINTS_OR_START_DIRECTION, EDIT_RELATION::Kind(), m_angleItem, m_arcEditMode, m_editedPoint, m_editPoints, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, m_inDrag, m_inPointEditor, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, makePointsAndBehavior(), MD_SHIFT, COMMIT::Modify(), pointEditorTypes, POLY, SCH_COMMIT::Push(), RECT_BOTRIGHT, RECT_TOPLEFT, RECTANGLE, EDIT_RELATION::Reference(), KIGFX::VIEW::Remove(), SNAP_RESOLVER::Resolve(), result, SCH_COMMIT::Revert(), KIGFX::VIEW_CONTROLS::SetAutoPan(), setEditedPoint(), KIGFX::VIEW_CONTROLS::ShowCursor(), SELECTION::Size(), updateEditedPoint(), updateParentItem(), updatePoints(), and SCH_TOOL_BASE< SCH_BASE_FRAME >::Wait().

Referenced by setTransitions().

makePointsAndBehavior()

void SCH_POINT_EDITOR::makePointsAndBehavior ( EDA_ITEM * aItem )

private

Definition at line 990 of file sch_point_editor.cpp.

References ARC, ARC_LOW_DEF_MM, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, EDA_SHAPE::GetShape(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), m_arcEditMode, m_editBehavior, m_editPoints, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor, POLY, RECTANGLE, SCH_BITMAP_T, SCH_LINE_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_TABLECELL_T, SCH_TEXTBOX_T, SCH_ITEM::Schematic(), schIUScale, EDA_SHAPE::SHAPE_T_asString(), EDA_ITEM::Type(), and UNIMPLEMENTED_FOR.

Referenced by Main().

modifiedSelection()

int SCH_POINT_EDITOR::modifiedSelection ( const TOOL_EVENT & aEvent )

private

Definition at line 1791 of file sch_point_editor.cpp.

References updatePoints().

Referenced by setTransitions().

pinEditedCorner()

void SCH_POINT_EDITOR::pinEditedCorner ( int minWidth, int minHeight, VECTOR2I & topLeft, VECTOR2I & topRight, VECTOR2I & botLeft, VECTOR2I & botRight, EE_GRID_HELPER * aGrid ) const

private

removeCorner()

int SCH_POINT_EDITOR::removeCorner ( const TOOL_EVENT & aEvent )

private

Definition at line 1716 of file sch_point_editor.cpp.

References _, getEditedPointIndex(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetPolyShape(), SHAPE_POLY_SET::IsEmpty(), m_editedPoint, m_editPoints, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, COMMIT::Modify(), SHAPE_POLY_SET::Outline(), SCH_COMMIT::Push(), SHAPE_LINE_CHAIN::Remove(), SCH_RULE_AREA_T, SCH_SHAPE_T, setEditedPoint(), EDA_SHAPE::SetHatchingDirty(), SHAPE_LINE_CHAIN::SetPoint(), SCH_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and updatePoints().

Referenced by setTransitions().

removeCornerCondition()

bool SCH_POINT_EDITOR::removeCornerCondition ( const SELECTION & aSelection )

private

Definition at line 1627 of file sch_point_editor.cpp.

References SHAPE_LINE_CHAIN::CPoints(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetPolyShape(), SHAPE_POLY_SET::IsEmpty(), m_editedPoint, m_editPoints, SHAPE_POLY_SET::Outline(), SCH_RULE_AREA_T, and SCH_SHAPE_T.

Referenced by Init().

Reset()

void SCH_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.

Implements TOOL_BASE.

Definition at line 1109 of file sch_point_editor.cpp.

References EDA_ITEM::ClearFlags(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), EDA_ITEM::HasFlag(), IS_MOVING, m_angleItem, m_editedPoint, m_editPoints, m_inDrag, SCH_TOOL_BASE< SCH_BASE_FRAME >::REDRAW, SCH_TOOL_BASE< T >::Reset(), EDA_SHAPE::SetHatchingDirty(), and SCH_SHAPE::UpdateHatching().

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 73 of file tool_interactive.cpp.

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 102 of file tool_interactive.cpp.

Referenced by DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawTable(), KICAD_MANAGER_CONTROL::NewProject(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), BOARD_EDITOR_CONTROL::ShowEeschema(), and BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic().

saveCopyInUndoList()

void SCH_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList ( EDA_ITEM * aItem, UNDO_REDO aType, bool aAppend = false, bool aDirtyConnectivity = true )

protectedinherited

Similar to m_frame->SaveCopyInUndoList(), but also handles connectivity.

Definition at line 92 of file sch_tool_base.cpp.

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 91 of file tool_interactive.cpp.

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

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), and PCB_SELECTION_TOOL::Main().

setEditedPoint()

void SCH_POINT_EDITOR::setEditedPoint ( EDIT_POINT * aPoint )

private

Set the current point being edited. NULL means none.

Definition at line 1605 of file sch_point_editor.cpp.

References ARROW, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), EDIT_POINT::GetPosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), m_editedPoint, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and KIGFX::VIEW_CONTROLS::ShowCursor().

Referenced by clearEditedPoints(), Main(), removeCorner(), and updateEditedPoint().

setTransitions()

void SCH_POINT_EDITOR::setTransitions ( )

overridevirtual

Set up handlers for various events.

Implements TOOL_INTERACTIVE.

Definition at line 1798 of file sch_point_editor.cpp.

References ACTIONS::activatePointEditor, addCorner(), changeArcEditMode(), EVENTS::ClearedEvent, clearEditedPoints(), ACTIONS::cycleArcEditMode, SCH_TOOL_BASE< SCH_BASE_FRAME >::Go(), Main(), modifiedSelection(), SCH_ACTIONS::pointEditorAddCorner, ACTIONS::pointEditorArcKeepCenter, ACTIONS::pointEditorArcKeepEndpoint, ACTIONS::pointEditorArcKeepRadius, SCH_ACTIONS::pointEditorRemoveCorner, EVENTS::PointSelectedEvent, removeCorner(), EVENTS::SelectedEvent, and EVENTS::SelectedItemsModified.

updateEditedPoint()

void SCH_POINT_EDITOR::updateEditedPoint ( const TOOL_EVENT & aEvent )

private

Update which point is being edited.

Definition at line 1188 of file sch_point_editor.cpp.

References BUT_LEFT, TOOL_EVENT::DragOrigin(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), TOOL_EVENT::IsDrag(), TOOL_EVENT::IsMotion(), m_editedPoint, m_editPoints, TOOL_EVENT::Position(), and setEditedPoint().

Referenced by Main().

updateItem()

void SCH_TOOL_BASE< SCH_BASE_FRAME >::updateItem ( EDA_ITEM * aItem, bool aUpdateRTree ) const

protectedinherited

Similar to getView()->Update(), but also updates the SCH_SCREEN's RTree.

Definition at line 89 of file sch_tool_base.cpp.

References getView(), and m_view.

Referenced by SCH_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::removeCorner(), and SCH_POINT_EDITOR::updateParentItem().

updateParentItem()

void SCH_POINT_EDITOR::updateParentItem ( bool aSnapToGrid, SCH_COMMIT & aCommit ) const

private

Update item's points with edit points.

Definition at line 1556 of file sch_point_editor.cpp.

References m_editBehavior, m_editedPoint, m_editPoints, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and SCH_TOOL_BASE< SCH_BASE_FRAME >::updateItem().

Referenced by Main().

updatePoints()

void SCH_POINT_EDITOR::updatePoints ( )

private

Update edit points with item's points.

Definition at line 1576 of file sch_point_editor.cpp.

References ALL_BODY_STYLES, ALL_UNITS, editor, SCH_ITEM::GetBodyStyle(), SCH_ITEM::GetUnit(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), m_angleItem, m_editBehavior, m_editPoints, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor, KIGFX::VIEW::Remove(), and KIGFX::VIEW::Update().

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

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 67 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr.

Referenced by CONSTRAINT_EDIT_TOOL::AddPointConstraint(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), POSITION_RELATIVE_TOOL::InteractiveOffset(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_INSPECTION_TOOL::pickItemForInspection(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), and DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew().

Member Data Documentation

m_angleItem

std::unique_ptr<KIGFX::PREVIEW::ANGLE_ITEM> SCH_POINT_EDITOR::m_angleItem

private

Definition at line 134 of file sch_point_editor.h.

Referenced by Main(), Reset(), and updatePoints().

m_arcEditMode

ARC_EDIT_MODE SCH_POINT_EDITOR::m_arcEditMode

private

Definition at line 127 of file sch_point_editor.h.

Referenced by changeArcEditMode(), Main(), makePointsAndBehavior(), and SCH_POINT_EDITOR().

m_editBehavior

std::unique_ptr<POINT_EDIT_BEHAVIOR> SCH_POINT_EDITOR::m_editBehavior

private

Current item-specific edit behavior.

Definition at line 137 of file sch_point_editor.h.

Referenced by makePointsAndBehavior(), updateParentItem(), and updatePoints().

m_editedPoint

EDIT_POINT* SCH_POINT_EDITOR::m_editedPoint

private

Currently edited point, NULL if there is none.

Definition at line 122 of file sch_point_editor.h.

Referenced by getEditedPointIndex(), HasPoint(), isModified(), Main(), removeCorner(), removeCornerCondition(), Reset(), SCH_POINT_EDITOR(), setEditedPoint(), updateEditedPoint(), and updateParentItem().

m_editPoints

std::shared_ptr<EDIT_POINTS> SCH_POINT_EDITOR::m_editPoints

private

Currently available edit points.

Definition at line 133 of file sch_point_editor.h.

Referenced by addCorner(), addCornerCondition(), getEditedPointIndex(), Main(), makePointsAndBehavior(), removeCorner(), removeCornerCondition(), Reset(), updateEditedPoint(), updateParentItem(), and updatePoints().

m_frame

SCH_BASE_FRAME* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame

protectedinherited

Definition at line 95 of file sch_tool_base.h.

Referenced by SCH_POINT_EDITOR::addCorner(), SYMBOL_EDITOR_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_POINT_EDITOR::changeArcEditMode(), SCH_INSPECTION_TOOL::CheckSymbol(), SCH_INSPECTION_TOOL::CompareSchematicWithFile(), SCH_INSPECTION_TOOL::CompareSchematicWithHistory(), SCH_INSPECTION_TOOL::constructDiffPanel(), SCH_INSPECTION_TOOL::CrossProbe(), SCH_INSPECTION_TOOL::CrossProbe(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), SCH_INSPECTION_TOOL::DiffSymbol(), SCH_INSPECTION_TOOL::DiffSymbol(), EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_INSPECTION_TOOL::ExcludeMarker(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), SCH_FIND_REPLACE_TOOL::FindAndReplace(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), getDrawParent(), SCH_FIND_REPLACE_TOOL::HasMatch(), SYMBOL_EDITOR_CONTROL::Init(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_INSPECTION_TOOL::InspectERCErrorMenuText(), InteractiveDelete(), SCH_POINT_EDITOR::Main(), SCH_POINT_EDITOR::makePointsAndBehavior(), SCH_INSPECTION_TOOL::NextMarker(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_INSPECTION_TOOL::PrevMarker(), SCH_POINT_EDITOR::removeCorner(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), SCH_INSPECTION_TOOL::Reset(), SYMBOL_EDITOR_CONTROL::Revert(), SCH_INSPECTION_TOOL::RunSimulation(), SCH_POINT_EDITOR::setEditedPoint(), SCH_INSPECTION_TOOL::ShowBusSyntaxHelp(), SCH_INSPECTION_TOOL::ShowDatasheet(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SCH_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_INSPECTION_TOOL::showSchematicComparison(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::ToggleProperties(), SCH_FIND_REPLACE_TOOL::UpdateFind(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), SCH_POINT_EDITOR::updateParentItem(), and SCH_POINT_EDITOR::updatePoints().

m_inDrag

bool SCH_POINT_EDITOR::m_inDrag

private

True while a point drag is in progress (between grab and release).

Definition at line 125 of file sch_point_editor.h.

Referenced by IsDragging(), Main(), Reset(), and SCH_POINT_EDITOR().

m_inPointEditor

bool SCH_POINT_EDITOR::m_inPointEditor

private

Re-entrancy guards.

Definition at line 130 of file sch_point_editor.h.

Referenced by Main(), and SCH_POINT_EDITOR().

m_isSymbolEditor

bool SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 98 of file sch_tool_base.h.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_POINT_EDITOR::changeArcEditMode(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), SYMBOL_EDITOR_CONTROL::FlattenSymbol(), getDrawParent(), SYMBOL_EDITOR_CONTROL::Init(), SCH_POINT_EDITOR::Main(), SCH_POINT_EDITOR::makePointsAndBehavior(), SYMBOL_EDITOR_CONTROL::OpenDirectory(), SYMBOL_EDITOR_CONTROL::OpenWithTextEditor(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_EDITOR_CONTROL::Save(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::ToggleSyncedPinsMode(), and SCH_POINT_EDITOR::updatePoints().

m_menu

std::unique_ptr<TOOL_MENU> TOOL_INTERACTIVE::m_menu

protectedinherited

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

Definition at line 121 of file tool_interactive.h.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), GetToolMenu(), BOARD_EDITOR_CONTROL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), EDA_3D_CONTROLLER::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GERBVIEW_SELECTION_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), ZOOM_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE(), and TOOL_INTERACTIVE().

m_pickerItem

EDA_ITEM* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_pickerItem

protectedinherited

Definition at line 99 of file sch_tool_base.h.

m_selectionTool

SCH_SELECTION_TOOL* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool

protectedinherited

Definition at line 97 of file sch_tool_base.h.

Referenced by SCH_INSPECTION_TOOL::DiffSymbol(), EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), EE_GRAPHIC_TOOL::ImportGraphics(), SCH_INSPECTION_TOOL::Init(), SCH_POINT_EDITOR::Init(), SYMBOL_EDITOR_CONTROL::Init(), SCH_POINT_EDITOR::Main(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_INSPECTION_TOOL::ShowDatasheet(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Unique id, assigned by a TOOL_MANAGER instance.

Definition at line 215 of file tool_base.h.

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

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), CONSTRAINT_EDIT_TOOL::AddPointConstraint(), GROUP_TOOL::AddToGroup(), PCB_CONTROL::AppendBoard(), PCB_CONTROL::ApplyDesignBlockLayout(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), attachManager(), SCH_SELECTION_TOOL::autostartEvent(), EDIT_TOOL::BooleanPolygons(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), BOARD_EDITOR_CONTROL::ChangeLineMode(), FOOTPRINT_EDITOR_CONTROL::ChangeLineMode(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), GERBVIEW_CONTROL::ClearAllLayers(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), PCB_EDIT_TABLE_TOOL::clearSelection(), VIA_STITCH_TOOL::ClearStitchViaExclusions(), ROUTER_TOOL::commitPendingViaStack(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), PCB_GROUP_TOOL::createCommit(), SCH_GROUP_TOOL::createCommit(), MICROWAVE_TOOL::createInductorBetween(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::Cursor45Crosshairs(), COMMON_TOOLS::CursorControl(), COMMON_TOOLS::CursorFullCrosshairs(), COMMON_TOOLS::CursorSmallCrosshairs(), PCB_CONTROL::CycleLayerPresets(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSyncSelection(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawEllipseArc(), DRAWING_TOOL::drawManagedShape(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), PCB_EDIT_TABLE_TOOL::EditTable(), PCB_SELECTION_TOOL::EnterGroup(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), VIA_STITCH_TOOL::ExcludeStitchVia(), KICAD_MANAGER_CONTROL::Execute(), PCB_SELECTION_TOOL::ExitGroup(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), EDA_3D_CONTROLLER::ExportImage(), PCB_EDIT_TABLE_TOOL::ExportTableToCSV(), PCB_SELECTION_TOOL::extendTableCellSelectionTo(), ZONE_FILLER_TOOL::FillAllZones(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), DRC_TOOL::FixDRCError(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), GetManager(), getModelInternal(), DRAWING_TOOL::getSourceZoneForAction(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), getToolHolderInternal(), PCB_EDIT_TABLE_TOOL::getToolMgr(), getView(), getViewControls(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridOrigin(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_GROUP_TOOL::Group(), SCH_GROUP_TOOL::Group(), EDIT_TOOL::HealShapes(), PCB_CONTROL::HighContrastModeCycle(), CONSTRAINT_EDIT_TOOL::HighlightConstraintMembers(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), BOARD_INSPECTION_TOOL::HighlightNetChain(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EDIT_TOOL::Increment(), SCH_TOOL_BASE< T >::Increment(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONSTRAINT_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GENERATOR_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GRAPHIC_EDIT_TOOL::Init(), GROUP_TOOL::Init(), MATCH_PROPERTIES_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), VIA_STITCH_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), IsToolActive(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GENERATOR_TOOL::MakeViaStackFromSelection(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), PCB_VIEWER_TOOLS::NextLineMode(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONVERT_TOOL::OutsetItems(), PCB_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_INSPECTION_TOOL::pickItemForInspection(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), PCB_CONTROL::placeBoardItems(), PCB_CONTROL::PlaceDrillMap(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_CONTROL::PlaceLinkedDesignBlock(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), SCH_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), ZONE_FILLER_TOOL::regenerateDirtyGenerators(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDA_3D_CONTROLLER::ReloadBoard(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), MULTICHANNEL_TOOL::repeatLayout(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), COMMON_TOOLS::Reset(), DIFF_PHASE_SKEW_TOOL::Reset(), EDA_3D_CONTROLLER::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PNS::TOOL_BASE::Reset(), COMMON_TOOLS::ResetLocalCoords(), EDIT_TOOL::reSolveConstraintsAfterEdit(), ROUTER_TOOL::restoreSelection(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), DRC_TOOL::RunTests(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), PL_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectChartRow(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), SCH_SELECTION_TOOL::selectLasso(), PCB_SELECTION_TOOL::SelectMultiple(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectNetChain(), SCH_SELECTION_TOOL::SelectNext(), PL_SELECTION_TOOL::SelectPoint(), SCH_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::SelectPolyArea(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::SelectRows(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PCB_SELECTION_TOOL::SelectTable(), SCH_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), PCB_SELECTION_TOOL::SetSelectPoly(), SCH_SELECTION_TOOL::SetSelectPoly(), PCB_SELECTION_TOOL::SetSelectRect(), SCH_SELECTION_TOOL::SetSelectRect(), DRC_TOOL::ShowDesignRuleEditorDialog(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), DRC_TOOL::ShowDRCDialog(), DRC_RULE_EDITOR_TOOL::ShowDRCRuleEditorDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), EDIT_TOOL::SimplifyPolygons(), DRAWING_TOOL::snapEventPosition(), PCB_CONTROL::SnapMode(), EDIT_TOOL::Swap(), EDIT_TOOL::SwapGateNets(), EDIT_TOOL::SwapPadNets(), SCH_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), EDIT_TOOL::ToggleFootprintAttribute(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), PCB_SELECTION_TOOL::toggleTableCellSelection(), EDA_3D_CONTROLLER::ToggleVisibility(), TOOL_BASE(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), PCB_POINT_EDITOR::updateItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), GERBVIEW_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), MULTICHANNEL_TOOL::UpdatePickedItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), BOARD_EDITOR_CONTROL::ZonePriorityLower(), BOARD_EDITOR_CONTROL::ZonePriorityMoveToBottom(), BOARD_EDITOR_CONTROL::ZonePriorityMoveToTop(), BOARD_EDITOR_CONTROL::ZonePriorityRaise(), and ZONE_FILLER_TOOL::ZoneUnfill().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

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

pcbnew.InteractiveSelection).

Definition at line 219 of file tool_base.h.

Referenced by GetName(), and TOOL_BASE().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by GetType(), and TOOL_BASE().

m_view

KIGFX::SCH_VIEW* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_view

protectedinherited

Definition at line 96 of file sch_tool_base.h.

Referenced by EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), EE_GRAPHIC_TOOL::ImportGraphics(), and updateItem().

---

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

• sch_point_editor.h
• sch_point_editor.cpp