EE_GRAPHIC_TOOL Class Reference

Tool responsible for drawing graphical shapes (rectangles, circles, arcs, beziers, text boxes, etc.) in both the schematic and symbol editors. More...

#include <ee_graphic_tool.h>

Inheritance diagram for EE_GRAPHIC_TOOL:

Public Types
enum class	MODE { NONE , ARC , BEZIER , ELLIPSE_ARC }
enum	RESET_REASON {   RUN , MODEL_RELOAD , SUPERMODEL_RELOAD , GAL_SWITCH ,   REDRAW , SHUTDOWN }
	Determine the reason of reset for a tool. More...

Public Member Functions
	EE_GRAPHIC_TOOL ()
bool	Init () override
	Init() is called once upon a registration of the tool.
int	DrawShape (const TOOL_EVENT &aEvent)
int	DrawArc (const TOOL_EVENT &aEvent)
int	DrawBezier (const TOOL_EVENT &aEvent)
int	DrawEllipseArc (const TOOL_EVENT &aEvent)
int	ImportGraphics (const TOOL_EVENT &aEvent)
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.
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)
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to.
KIGFX::VIEW *	getView () const
	Returns the instance of #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	setTransitions () override
	The layer to use for new shapes in the current editor.
SCH_LAYER_ID	getShapeLayer () const
	Commit a completed item.
void	commitItem (SCH_COMMIT &aCommit, std::unique_ptr< SCH_ITEM > aItem, const wxString &aDescription)
	Return the default text size (in IU) for the active editor.
int	getDefaultTextSize () const
void	applySymbolEditorFlags (SCH_ITEM &aItem) const
	When in the symbol editor, apply unit and body-style restrictions to aItem according to the current draw-specific flags on the frame.
bool	drawManagedShape (const TOOL_EVENT &aTool, std::unique_ptr< SCH_SHAPE > &aShape, SHAPE_DRAW_BEHAVIOR &aBehavior, const std::vector< VECTOR2D > &aInitialPts)
	Run the interactive drawing event loop for any shape driven by a SHAPE_DRAW_BEHAVIOR (arcs, ellipse arcs, etc.).
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
FILL_T	m_lastFillStyle
COLOR4D	m_lastFillColor
STROKE_PARAMS	m_lastStroke
FILL_T	m_lastTextboxFillStyle
COLOR4D	m_lastTextboxFillColor
STROKE_PARAMS	m_lastTextboxStroke
bool	m_lastTextBold
bool	m_lastTextItalic
EDA_ANGLE	m_lastTextboxAngle
GR_TEXT_H_ALIGN_T	m_lastTextboxHJustify
GR_TEXT_V_ALIGN_T	m_lastTextboxVJustify
MODE	m_mode
bool	m_inDrawingTool

Detailed Description

Tool responsible for drawing graphical shapes (rectangles, circles, arcs, beziers, text boxes, etc.) in both the schematic and symbol editors.

Definition at line 37 of file ee_graphic_tool.h.

Member Enumeration Documentation

MODE

enum class EE_GRAPHIC_TOOL::MODE

strong

Enumerator
NONE
ARC
BEZIER
ELLIPSE_ARC

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

Definition at line 73 of file tool_base.h.

Constructor & Destructor Documentation

EE_GRAPHIC_TOOL()

EE_GRAPHIC_TOOL::EE_GRAPHIC_TOOL

(

)

Definition at line 51 of file ee_graphic_tool.cpp.

References ANGLE_0, DEFAULT, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_TOP, m_inDrawingTool, m_lastFillColor, m_lastFillStyle, m_lastStroke, m_lastTextBold, m_lastTextboxAngle, m_lastTextboxFillColor, m_lastTextboxFillStyle, m_lastTextboxHJustify, m_lastTextboxStroke, m_lastTextboxVJustify, m_lastTextItalic, m_mode, NO_FILL, NONE, SCH_TOOL_BASE< SCH_BASE_FRAME >::SCH_TOOL_BASE(), and UNSPECIFIED.

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(), 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::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), 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().

applySymbolEditorFlags()

void EE_GRAPHIC_TOOL::applySymbolEditorFlags ( SCH_ITEM & aItem ) const

private

When in the symbol editor, apply unit and body-style restrictions to aItem according to the current draw-specific flags on the frame.

Definition at line 115 of file ee_graphic_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SYMBOL_EDIT_FRAME::GetBodyStyle(), SYMBOL_EDIT_FRAME::GetDrawSpecificBodyStyle(), SYMBOL_EDIT_FRAME::GetDrawSpecificUnit(), SYMBOL_EDIT_FRAME::GetUnit(), SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor(), SCH_ITEM::SetBodyStyle(), and SCH_ITEM::SetUnit().

Referenced by DrawArc(), DrawBezier(), DrawEllipseArc(), and DrawShape().

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().

commitItem()

void EE_GRAPHIC_TOOL::commitItem ( SCH_COMMIT & aCommit, std::unique_ptr< SCH_ITEM > aItem, const wxString & aDescription )

private

Return the default text size (in IU) for the active editor.

Definition at line 130 of file ee_graphic_tool.cpp.

References COMMIT::Add(), LIB_SYMBOL::AddDrawItem(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SYMBOL_EDIT_FRAME::GetCurSymbol(), SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor(), COMMIT::Modify(), SCH_COMMIT::Push(), and SYMBOL_EDIT_FRAME::RebuildView().

Referenced by DrawArc(), DrawBezier(), DrawEllipseArc(), and DrawShape().

DrawArc()

int EE_GRAPHIC_TOOL::DrawArc

(

const TOOL_EVENT &

aEvent

)

Definition at line 425 of file ee_graphic_tool.cpp.

References _, SCH_TOOL_BASE< SCH_BASE_FRAME >::Activate(), ACTIONS::activatePointEditor, applySymbolEditorFlags(), ARC, ARC, commitItem(), drawManagedShape(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent(), getShapeLayer(), TOOL_EVENT::HasPosition(), IS_NEW, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, m_inDrawingTool, m_lastFillColor, m_lastFillStyle, m_lastStroke, m_mode, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, TOOL_EVENT::Position(), and schIUScale.

Referenced by setTransitions().

DrawBezier()

int EE_GRAPHIC_TOOL::DrawBezier

(

const TOOL_EVENT &

aEvent

)

Definition at line 556 of file ee_graphic_tool.cpp.

References _, SCH_TOOL_BASE< SCH_BASE_FRAME >::Activate(), ACTIONS::activatePointEditor, applySymbolEditorFlags(), BEZIER, BEZIER, commitItem(), drawManagedShape(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent(), getShapeLayer(), TOOL_EVENT::HasPosition(), IS_NEW, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, m_inDrawingTool, m_lastFillColor, m_lastFillStyle, m_lastStroke, m_mode, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, TOOL_EVENT::Position(), and schIUScale.

Referenced by setTransitions().

DrawEllipseArc()

int EE_GRAPHIC_TOOL::DrawEllipseArc

(

const TOOL_EVENT &

aEvent

)

Definition at line 491 of file ee_graphic_tool.cpp.

References _, SCH_TOOL_BASE< SCH_BASE_FRAME >::Activate(), ACTIONS::activatePointEditor, applySymbolEditorFlags(), commitItem(), drawManagedShape(), ELLIPSE_ARC, ELLIPSE_ARC, SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent(), getShapeLayer(), TOOL_EVENT::HasPosition(), IS_NEW, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, m_inDrawingTool, m_lastFillColor, m_lastFillStyle, m_lastStroke, m_mode, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, TOOL_EVENT::Position(), and schIUScale.

Referenced by setTransitions().

drawManagedShape()

bool EE_GRAPHIC_TOOL::drawManagedShape ( const TOOL_EVENT & aTool, std::unique_ptr< SCH_SHAPE > & aShape, SHAPE_DRAW_BEHAVIOR & aBehavior, const std::vector< VECTOR2D > & aInitialPts )

private

Run the interactive drawing event loop for any shape driven by a SHAPE_DRAW_BEHAVIOR (arcs, ellipse arcs, etc.).

Returns

true if the shape was completed, false if cancelled.

Definition at line 635 of file ee_graphic_tool.cpp.

References SELECTION::Add(), SHAPE_DRAW_BEHAVIOR::AddPoint(), SHAPE_DRAW_BEHAVIOR::ApplyToShape(), ACTIONS::arcPosture, ARROW, BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), SHAPE_DRAW_BEHAVIOR::ClearGeometryChanged(), ACTIONS::deleteLastPoint, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SHAPE_DRAW_BEHAVIOR::GetAssistant(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent(), KIGFX::VIEW_CONTROLS::GetMousePosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), grid, GRID_GRAPHICS, SHAPE_DRAW_BEHAVIOR::HasGeometryChanged(), SHAPE_DRAW_BEHAVIOR::IsComplete(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_menu, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_view, MD_SHIFT, PENCIL, ACTIONS::redo, ACTIONS::refreshPreview, SELECTION::Remove(), SHAPE_DRAW_BEHAVIOR::RemoveLastPoint(), SHAPE_DRAW_BEHAVIOR::Reset(), ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), SHAPE_DRAW_BEHAVIOR::SetCursorPosition(), SHAPE_DRAW_BEHAVIOR::SetUnits(), KIGFX::VIEW_CONTROLS::ShowCursor(), SHAPE_DRAW_BEHAVIOR::ToggleClockwise(), ACTIONS::undo, ACTIONS::updateUnits, and SCH_TOOL_BASE< SCH_BASE_FRAME >::Wait().

Referenced by DrawArc(), DrawBezier(), and DrawEllipseArc().

DrawShape()

int EE_GRAPHIC_TOOL::DrawShape

(

const TOOL_EVENT &

aEvent

)

Definition at line 152 of file ee_graphic_tool.cpp.

References _, SCH_TOOL_BASE< SCH_BASE_FRAME >::Activate(), ACTIONS::activatePointEditor, applySymbolEditorFlags(), ARROW, BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), commitItem(), ACTIONS::cursorClick, ACTIONS::cursorDblClick, SCH_ACTIONS::drawSymbolTextBox, SCH_ACTIONS::drawTextBox, ACTIONS::duplicate, ACTIONS::finishInteractive, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), getDefaultTextSize(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), EDA_TEXT::GetHorizJustify(), KIGFX::VIEW_CONTROLS::GetMousePosition(), getShapeLayer(), SCH_SHAPE::GetStroke(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetVertJustify(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), grid, GRID_GRAPHICS, TOOL_EVENT::HasPosition(), IS_NEW, TOOL_EVENT::IsAction(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), m_inDrawingTool, m_lastFillColor, m_lastFillStyle, m_lastStroke, m_lastTextBold, m_lastTextboxAngle, m_lastTextboxFillColor, m_lastTextboxFillStyle, m_lastTextboxHJustify, m_lastTextboxStroke, m_lastTextboxVJustify, m_lastTextItalic, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_menu, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_view, MD_SHIFT, TOOL_EVENT::Parameter(), ACTIONS::paste, PENCIL, TOOL_EVENT::Position(), SCH_ACTIONS::properties, RECTANGLE, ACTIONS::redo, ACTIONS::refreshPreview, SCH_ACTIONS::repeatDrawItem, ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), KIGFX::VIEW_CONTROLS::ShowCursor(), DIALOG_SHIM::ShowQuasiModal(), ACTIONS::undo, and SCH_TOOL_BASE< SCH_BASE_FRAME >::Wait().

Referenced by setTransitions().

frame()

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

inlineprotectedinherited

Definition at line 322 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().

getDefaultTextSize()

int EE_GRAPHIC_TOOL::getDefaultTextSize ( ) const

private

Definition at line 102 of file ee_graphic_tool.cpp.

References DEFAULT_TEXT_SIZE, SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getModel(), SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor(), SYMBOL_EDITOR_SETTINGS::m_Defaults, schIUScale, and SYMBOL_EDITOR_SETTINGS::DEFAULTS::text_size.

Referenced by DrawShape().

getDrawParent()

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

inlineprotectedinherited

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 333 of file sch_tool_base.h.

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().

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(), 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(), SCH_TOOL_BASE< T >::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(), 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(), 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().

getShapeLayer()

SCH_LAYER_ID EE_GRAPHIC_TOOL::getShapeLayer ( ) const

private

Commit a completed item.

Definition at line 96 of file ee_graphic_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor(), LAYER_DEVICE, and LAYER_NOTES.

Referenced by DrawArc(), DrawBezier(), DrawEllipseArc(), and DrawShape().

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

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

It allows tools to draw.

Returns

The instance of 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(), 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::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), 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(), PL_EDIT_TOOL::Paste(), CONSTRAINT_EDIT_TOOL::pcbRenderSettings(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), 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(), SCH_TOOL_BASE< T >::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(), PCB_SELECTION_TOOL::SelectMultiple(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), CONSTRAINT_EDIT_TOOL::ShowConstraints(), 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(), 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(), 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(), 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(), PCB_SELECTION_TOOL::SelectRectArea(), 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(), GROUP_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), LIBRARY_EDITOR_CONTROL::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(), 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().

ImportGraphics()

int EE_GRAPHIC_TOOL::ImportGraphics

(

const TOOL_EVENT &

aEvent

)

Definition at line 833 of file ee_graphic_tool.cpp.

References _, SCH_TOOL_BASE< SCH_BASE_FRAME >::Activate(), COMMIT::Add(), SELECTION::Add(), LIB_SYMBOL::AddDrawItem(), ARROW, BUT_LEFT, BUT_RIGHT, ACTIONS::cancelInteractive, SELECTION::Clear(), ACTIONS::cursorClick, ACTIONS::cursorDblClick, delta, TOOL_EVENT::DisableGridSnapping(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent(), DIALOG_IMPORT_GFX_SCH::GetImportedItems(), KIGFX::VIEW_CONTROLS::GetMousePosition(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getViewControls(), grid, GRID_GRAPHICS, TOOL_EVENT::HasParameter(), DIALOG_IMPORT_GFX_SCH::IsPlacementInteractive(), SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor(), m_inDrawingTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_menu, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_view, MD_SHIFT, COMMIT::Modify(), MOVING, TOOL_EVENT::Parameter(), SCH_COMMIT::Push(), ACTIONS::selectionClear, ACTIONS::selectItems, DIALOG_IMPORT_GFX_SCH::SetFilenameOverride(), KIGFX::VIEW_CONTROLS::ShowCursor(), DIALOG_SHIM::ShowModal(), and SCH_TOOL_BASE< SCH_BASE_FRAME >::Wait().

Referenced by setTransitions().

Increment()

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

inlineinherited

Definition at line 107 of file sch_tool_base.h.

Init()

bool EE_GRAPHIC_TOOL::Init ( )

overridevirtual

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Definition at line 70 of file ee_graphic_tool.cpp.

References CONDITIONAL_MENU::AddItem(), ARC, ACTIONS::arcPosture, BEZIER, ACTIONS::deleteLastPoint, ELLIPSE_ARC, SCH_TOOL_BASE< T >::Init(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_menu, and m_mode.

InteractiveDelete()

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

inlineinherited

Definition at line 244 of file sch_tool_base.h.

IsSymbolEditor()

bool SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor ( ) const

inlineinherited

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

Definition at line 102 of file sch_tool_base.h.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags(), EE_GRAPHIC_TOOL::commitItem(), 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(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

Reset()

void SCH_TOOL_BASE< SCH_BASE_FRAME >::Reset ( RESET_REASON aReason )

inlineoverridevirtualinherited

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 87 of file sch_tool_base.h.

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 )

inlineprotectedinherited

Definition at line 350 of file sch_tool_base.h.

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(), and DRAWING_TOOL::DrawVia().

setTransitions()

void EE_GRAPHIC_TOOL::setTransitions ( )

overrideprivatevirtual

The layer to use for new shapes in the current editor.

Implements TOOL_INTERACTIVE.

Definition at line 1006 of file ee_graphic_tool.cpp.

References SCH_ACTIONS::ddImportGraphics, DrawArc(), SCH_ACTIONS::drawArc, DrawBezier(), SCH_ACTIONS::drawBezier, SCH_ACTIONS::drawCircle, SCH_ACTIONS::drawEllipse, DrawEllipseArc(), SCH_ACTIONS::drawEllipseArc, SCH_ACTIONS::drawRectangle, DrawShape(), SCH_ACTIONS::drawSymbolLines, SCH_ACTIONS::drawSymbolPolygon, SCH_ACTIONS::drawSymbolTextBox, SCH_ACTIONS::drawTextBox, SCH_TOOL_BASE< SCH_BASE_FRAME >::Go(), ImportGraphics(), and SCH_ACTIONS::importGraphics.

updateItem()

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

inlineprotectedinherited

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

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

Definition at line 344 of file sch_tool_base.h.

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

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(), 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::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), and DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew().

Member Data Documentation

m_frame

SCH_BASE_FRAME* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame

protectedinherited

Definition at line 390 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(), SCH_FIND_REPLACE_TOOL::HasMatch(), SYMBOL_EDITOR_CONTROL::Init(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_INSPECTION_TOOL::InspectERCErrorMenuText(), 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_inDrawingTool

bool EE_GRAPHIC_TOOL::m_inDrawingTool

private

Definition at line 102 of file ee_graphic_tool.h.

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

m_isSymbolEditor

bool SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 393 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(), 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_lastFillColor

COLOR4D EE_GRAPHIC_TOOL::m_lastFillColor

private

Definition at line 86 of file ee_graphic_tool.h.

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

m_lastFillStyle

FILL_T EE_GRAPHIC_TOOL::m_lastFillStyle

private

Definition at line 85 of file ee_graphic_tool.h.

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

m_lastStroke

STROKE_PARAMS EE_GRAPHIC_TOOL::m_lastStroke

private

Definition at line 87 of file ee_graphic_tool.h.

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

m_lastTextBold

bool EE_GRAPHIC_TOOL::m_lastTextBold

private

Definition at line 93 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextboxAngle

EDA_ANGLE EE_GRAPHIC_TOOL::m_lastTextboxAngle

private

Definition at line 95 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextboxFillColor

COLOR4D EE_GRAPHIC_TOOL::m_lastTextboxFillColor

private

Definition at line 90 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextboxFillStyle

FILL_T EE_GRAPHIC_TOOL::m_lastTextboxFillStyle

private

Definition at line 89 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextboxHJustify

GR_TEXT_H_ALIGN_T EE_GRAPHIC_TOOL::m_lastTextboxHJustify

private

Definition at line 96 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextboxStroke

STROKE_PARAMS EE_GRAPHIC_TOOL::m_lastTextboxStroke

private

Definition at line 91 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextboxVJustify

GR_TEXT_V_ALIGN_T EE_GRAPHIC_TOOL::m_lastTextboxVJustify

private

Definition at line 97 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

m_lastTextItalic

bool EE_GRAPHIC_TOOL::m_lastTextItalic

private

Definition at line 94 of file ee_graphic_tool.h.

Referenced by DrawShape(), and EE_GRAPHIC_TOOL().

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(), SCH_TOOL_BASE< T >::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::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE(), and TOOL_INTERACTIVE().

m_mode

MODE EE_GRAPHIC_TOOL::m_mode

private

Definition at line 99 of file ee_graphic_tool.h.

Referenced by DrawArc(), DrawBezier(), DrawEllipseArc(), EE_GRAPHIC_TOOL(), and Init().

m_pickerItem

EDA_ITEM* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_pickerItem

protectedinherited

Definition at line 394 of file sch_tool_base.h.

m_selectionTool

SCH_SELECTION_TOOL* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool

protectedinherited

Definition at line 392 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(), 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(), 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(), 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(), BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), 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(), GROUP_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(), 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(), 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(), CONVERT_TOOL::OutsetItems(), PCB_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), 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(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_CONTROL::PlaceLinkedDesignBlock(), DRAWING_TOOL::PlaceReferenceImage(), 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(), 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(), DRAWING_TOOL::runSimpleShapeDraw(), DRC_TOOL::RunTests(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), 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::SelectRectArea(), 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(), 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 391 of file sch_tool_base.h.

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

---

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

• ee_graphic_tool.h
• ee_graphic_tool.cpp