#include <symbol_editor_drawing_tools.h>

Inheritance diagram for SYMBOL_EDITOR_DRAWING_TOOLS:

Public Types
enum	RESET_REASON
	Determine the reason of reset for a tool. More...

Public Member Functions
	SYMBOL_EDITOR_DRAWING_TOOLS ()

	~SYMBOL_EDITOR_DRAWING_TOOLS () override

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

int	TwoClickPlace (const TOOL_EVENT &aEvent)

int	DrawShape (const TOOL_EVENT &aEvent)

int	DrawSymbolTextBox (const TOOL_EVENT &aEvent)

int	PlaceAnchor (const TOOL_EVENT &aEvent)

int	ImportGraphics (const TOOL_EVENT &aEvent)

int	RepeatDrawItem (const TOOL_EVENT &aEvent)

void	SetLastTextAngle (const EDA_ANGLE &aAngle)

EDA_ANGLE	GetLastTextAngle () const

void	SetDrawSpecificBodyStyle (bool aSpecific)

bool	GetDrawSpecificBodyStyle () const

void	SetDrawSpecificUnit (bool aSpecific)

bool	GetDrawSpecificUnit () const

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.

void	Go (int(SYMBOL_EDIT_FRAME::*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
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.

SYMBOL_EDIT_FRAME *	getEditFrame () const
	Return the application window object, casted to requested user type.

SYMBOL_EDIT_FRAME *	getModel () const
	Return the model object if it matches the requested type.

Protected Attributes
SYMBOL_EDIT_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
int	doDrawShape (const TOOL_EVENT &aEvent, std::optional< SHAPE_T > aDrawingShape)

void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events.

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

bool	m_lastTextItalic

EDA_ANGLE	m_lastTextAngle

GR_TEXT_H_ALIGN_T	m_lastTextJust

FILL_T	m_lastFillStyle

COLOR4D	m_lastFillColor

STROKE_PARAMS	m_lastStroke

bool	m_drawSpecificBodyStyle

bool	m_drawSpecificUnit
	Re-entrancy guards.

bool	m_inDrawShape

bool	m_inPlaceAnchor

bool	m_inTwoClickPlace

Static Private Attributes
static KIID	g_lastPin

Detailed Description

SYMBOL_EDITOR_DRAWING_TOOLS.

Tool responsible for drawing/placing items (body outlines, pins, etc.)

Definition at line 42 of file symbol_editor_drawing_tools.h.

Member Enumeration Documentation

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

Definition at line 77 of file tool_base.h.

Constructor & Destructor Documentation

◆ SYMBOL_EDITOR_DRAWING_TOOLS()

SYMBOL_EDITOR_DRAWING_TOOLS::SYMBOL_EDITOR_DRAWING_TOOLS ( )

◆ ~SYMBOL_EDITOR_DRAWING_TOOLS()

SYMBOL_EDITOR_DRAWING_TOOLS::~SYMBOL_EDITOR_DRAWING_TOOLS ( )

inlineoverride

Definition at line 46 of file symbol_editor_drawing_tools.h.

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

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

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

◆ doDrawShape()

int SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape	(	const TOOL_EVENT &	aEvent,
		std::optional< SHAPE_T >	aDrawingShape )

private

Definition at line 372 of file symbol_editor_drawing_tools.cpp.

Referenced by DrawShape(), and DrawSymbolTextBox().

◆ DrawShape()

int SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape ( const TOOL_EVENT & aEvent )

Definition at line 358 of file symbol_editor_drawing_tools.cpp.

References doDrawShape(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

◆ DrawSymbolTextBox()

int SYMBOL_EDITOR_DRAWING_TOOLS::DrawSymbolTextBox ( const TOOL_EVENT & aEvent )

Definition at line 366 of file symbol_editor_drawing_tools.cpp.

References doDrawShape().

Referenced by setTransitions().

◆ GetDrawSpecificBodyStyle()

bool SYMBOL_EDITOR_DRAWING_TOOLS::GetDrawSpecificBodyStyle ( ) const

inline

Definition at line 63 of file symbol_editor_drawing_tools.h.

References m_drawSpecificBodyStyle.

◆ GetDrawSpecificUnit()

bool SYMBOL_EDITOR_DRAWING_TOOLS::GetDrawSpecificUnit ( ) const

inline

Definition at line 66 of file symbol_editor_drawing_tools.h.

References m_drawSpecificUnit.

◆ getEditFrame()

SYMBOL_EDIT_FRAME * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 186 of file tool_base.h.

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

◆ GetLastTextAngle()

EDA_ANGLE SYMBOL_EDITOR_DRAWING_TOOLS::GetLastTextAngle ( ) const

inline

Definition at line 60 of file symbol_editor_drawing_tools.h.

References m_lastTextAngle.

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

◆ getModel()

SYMBOL_EDIT_FRAME * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 198 of file tool_base.h.

◆ getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 210 of file tool_base.cpp.

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

◆ getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 211 of file tool_base.cpp.

◆ GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 77 of file tool_interactive.cpp.

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns: The type of the tool.

Definition at line 111 of file tool_base.h.

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

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

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

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ Go()

void TOOL_INTERACTIVE::Go	(	int(SYMBOL_EDIT_FRAME::*	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 100 of file tool_interactive.h.

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), and SYMBOL_EDITOR_PIN_TOOL::setTransitions().

◆ goInternal()

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

privateinherited

Definition at line 140 of file tool_interactive.cpp.

◆ ImportGraphics()

int SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics ( const TOOL_EVENT & aEvent )

Definition at line 687 of file symbol_editor_drawing_tools.cpp.

Referenced by setTransitions().

◆ Increment()

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

inlineinherited

Definition at line 110 of file sch_tool_base.h.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::setTransitions().

◆ Init()

bool SYMBOL_EDITOR_DRAWING_TOOLS::Init ( )

overridevirtual

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

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

Reimplemented from SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >.

Definition at line 66 of file symbol_editor_drawing_tools.cpp.

References ACTIONS::finishInteractive, SCH_TOOL_BASE< T >::Init(), EDA_ITEM::IsNew(), and SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_menu.

◆ InteractiveDelete()

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

inlineinherited

Definition at line 247 of file sch_tool_base.h.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::setTransitions().

◆ IsSymbolEditor()

bool SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::IsSymbolEditor ( ) const

inlineinherited

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

Definition at line 105 of file sch_tool_base.h.

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 153 of file tool_base.cpp.

◆ PlaceAnchor()

int SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor ( const TOOL_EVENT & aEvent )

Definition at line 620 of file symbol_editor_drawing_tools.cpp.

References SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::Activate(), ARROW, BULLSEYE, BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::GetCursorPosition(), SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::getViewControls(), SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_frame, m_inPlaceAnchor, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_menu, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_selectionTool, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_view, LIB_SYMBOL::Move(), KIGFX::VIEW_CONTROLS::ShowCursor(), and SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::Wait().

Referenced by setTransitions().

◆ RepeatDrawItem()

int SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem ( const TOOL_EVENT & aEvent )

Definition at line 854 of file symbol_editor_drawing_tools.cpp.

References g_lastPin, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::m_toolMgr, pin, SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), ACTIONS::selectionClear, and ACTIONS::selectItem.

Referenced by setTransitions().

◆ Reset()

void SCH_TOOL_BASE< SYMBOL_EDIT_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.

Reimplemented in SYMBOL_EDITOR_MOVE_TOOL.

Definition at line 90 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 138 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 92 of file tool_interactive.cpp.

◆ saveCopyInUndoList()

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