EE_POINT_EDITOR Class Reference

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

#include <ee_point_editor.h>

Inheritance diagram for EE_POINT_EDITOR:

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

Public Member Functions
	EE_POINT_EDITOR ()
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
bool	Init () override
	Init() is called once upon a registration of the tool. More...
int	Main (const TOOL_EVENT &aEvent)
bool	HasPoint ()
	Indicate the cursor is over an edit point. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	Activate ()
	Run the tool. More...
TOOL_MENU &	GetToolMenu ()
void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated. More...
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack. More...
template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions). More...
TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives. More...
TOOL_TYPE	GetType () const
	Return the type of the tool. More...
TOOL_ID	GetId () const
	Return the unique identifier of the tool. More...
const std::string &	GetName () const
	Return the name of the tool. More...
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool. More...
bool	IsToolActive () const

Protected Member Functions
void	updateItem (EDA_ITEM *aItem, bool aUpdateRTree) const
	Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree. More...
void	saveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false)
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to. More...
KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application. More...
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application. More...
template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type. More...
template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type. More...

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

Private Member Functions
void	updateParentItem () const
	< Update item's points with edit points. More...
void	updatePoints ()
	Update which point is being edited. More...
void	updateEditedPoint (const TOOL_EVENT &aEvent)
	Clear references to the points. More...
int	clearEditedPoints (const TOOL_EVENT &aEvent)
	Set the current point being edited. NULL means none. More...
void	setEditedPoint (EDIT_POINT *aPoint)
	Return true if aPoint is the currently modified point. More...
bool	isModified (const EDIT_POINT &aPoint) const
int	getEditedPointIndex () const
bool	addCornerCondition (const SELECTION &aSelection)
bool	removeCornerCondition (const SELECTION &aSelection)
int	addCorner (const TOOL_EVENT &aEvent)
	TOOL_ACTION handlers. More...
int	removeCorner (const TOOL_EVENT &aEvent)
int	modifiedSelection (const TOOL_EVENT &aEvent)
void	saveItemsToUndo ()
void	rollbackFromUndo ()

Private Attributes
EDIT_POINT *	m_editedPoint
	< Currently edited point, NULL if there is none. More...
std::shared_ptr< EDIT_POINTS >	m_editPoints

Detailed Description

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

Definition at line 38 of file ee_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 (required full reload)
GAL_SWITCH	Rendering engine changes.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH 
 };

Constructor & Destructor Documentation

EE_POINT_EDITOR()

EE_POINT_EDITOR::EE_POINT_EDITOR

(

)

Definition at line 210 of file ee_point_editor.cpp.

 :
 EE_TOOL_BASE<SCH_BASE_FRAME>( "eeschema.PointEditor" ),
 m_editedPoint( nullptr )
{
}

Member Function Documentation

Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

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

Definition at line 51 of file tool_interactive.cpp.

{
 m_toolMgr->InvokeTool( m_toolId );
}

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

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

addCorner()

int EE_POINT_EDITOR::addCorner ( const TOOL_EVENT &  aEvent )

private

TOOL_ACTION handlers.

Definition at line 852 of file ee_point_editor.cpp.

{
 if( !m_editPoints || m_editPoints->GetParent()->Type() != LIB_SHAPE_T )
 return 0;

 LIB_SHAPE* shape = static_cast<LIB_SHAPE*>( m_editPoints->GetParent() );
 SHAPE_LINE_CHAIN& poly = shape->GetPolyShape().Outline( 0 );

 VECTOR2I cursor = getViewControls()->GetCursorPosition( !aEvent.DisableGridSnapping() );
 wxPoint pos = mapCoords( cursor );
 int currentMinDistance = INT_MAX;
 int closestLineStart = 0;

 for( unsigned i = 0; i < poly.GetPointCount() - 1; ++i )
 {
 int distance = (int) DistanceLinePoint( (wxPoint) poly.CPoint( i ),
 (wxPoint) poly.CPoint( i + 1 ), pos );

 if( distance < currentMinDistance )
 {
 currentMinDistance = distance;
 closestLineStart = i;
 }
 }

 saveItemsToUndo();
 poly.Insert( closestLineStart + 1, pos );

 updateItem( shape, true );
 updatePoints();

 m_frame->OnModify();

 return 0;
}

References cursor, TOOL_EVENT::DisableGridSnapping(), distance(), DistanceLinePoint(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_SHAPE::GetPolyShape(), TOOL_BASE::getViewControls(), LIB_SHAPE_T, m_editPoints, EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, KIGFX::mapCoords(), SCH_BASE_FRAME::OnModify(), SHAPE_POLY_SET::Outline(), saveItemsToUndo(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and updatePoints().

Referenced by setTransitions().

addCornerCondition()

bool EE_POINT_EDITOR::addCornerCondition ( const SELECTION &  aSelection )

private

Definition at line 835 of file ee_point_editor.cpp.

{
 if( !m_editPoints || m_editPoints->GetParent()->Type() != LIB_SHAPE_T )
 return false;

 LIB_SHAPE* shape = static_cast<LIB_SHAPE*>( m_editPoints->GetParent() );

 if( shape->GetShape() != SHAPE_T::POLY )
 return false;

 VECTOR2I cursorPos = getViewControls()->GetCursorPosition();
 double threshold = getView()->ToWorld( EDIT_POINT::POINT_SIZE );

 return shape->HitTest( (wxPoint) cursorPos, (int) threshold );
}

References KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_SHAPE::GetShape(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), LIB_SHAPE::HitTest(), LIB_SHAPE_T, 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 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

clearEditedPoints()

int EE_POINT_EDITOR::clearEditedPoints ( const TOOL_EVENT &  aEvent )

private

Set the current point being edited. NULL means none.

Definition at line 240 of file ee_point_editor.cpp.

{
 setEditedPoint( nullptr );

 return 0;
}

References setEditedPoint().

Referenced by setTransitions().

getEditedPointIndex()

int EE_POINT_EDITOR::getEditedPointIndex ( ) const

inlineprivate

Definition at line 82 of file ee_point_editor.h.

 {
 for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
 {
 if( m_editedPoint == &m_editPoints->Point( i ) )
 return i;
 }

 return wxNOT_FOUND;
 }

References m_editedPoint, and m_editPoints.

Referenced by Main(), removeCorner(), and updateParentItem().

getEditFrame()

template<typename T >

T* TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 184 of file tool_base.h.

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

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone().

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

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER* TOOL_BASE::GetManager ( ) const

inlineinherited

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

Returns

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

Definition at line 143 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), LIB_TREE::onContextMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

getModel()

template<typename T >

T* TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 196 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

GetName()

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

inlineinherited

Return the name of the tool.

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

Returns

The name of the tool.

Definition at line 133 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

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

GetToolMenu()

TOOL_MENU& TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

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

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 108 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

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

getView()

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

protectedinherited

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

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

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

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

getViewControls()

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

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

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

Returns

The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

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

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

Go()

template<class T >

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

inherited

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

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

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

 goInternal( sptr, aConditions );
}

References TOOL_INTERACTIVE::goInternal().

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

HasPoint()

bool EE_POINT_EDITOR::HasPoint ( )

inline

Indicate the cursor is over an edit point.

Used to coordinate cursor shapes with other tools.Set up handlers for various events.

Definition at line 55 of file ee_point_editor.h.

References m_editedPoint.

Referenced by EE_SELECTION_TOOL::Main().

Init()

bool EE_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 226 of file ee_point_editor.cpp.

{
 EE_TOOL_BASE::Init();

 auto& menu = m_selectionTool->GetToolMenu().GetMenu();
 menu.AddItem( EE_ACTIONS::pointEditorAddCorner,
 std::bind( &EE_POINT_EDITOR::addCornerCondition, this, _1 ) );
 menu.AddItem( EE_ACTIONS::pointEditorRemoveCorner,
 std::bind( &EE_POINT_EDITOR::removeCornerCondition, this, _1 ) );

 return true;
}

References addCornerCondition(), CONDITIONAL_MENU::AddItem(), TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::GetToolMenu(), EE_TOOL_BASE< T >::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, EE_ACTIONS::pointEditorAddCorner, EE_ACTIONS::pointEditorRemoveCorner, and removeCornerCondition().

isModified()

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

inlineprivate

Definition at line 77 of file ee_point_editor.h.

 {
 return m_editedPoint == &aPoint;
 }

References m_editedPoint.

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

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

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

Main()

int EE_POINT_EDITOR::Main

(

const TOOL_EVENT &

aEvent

)

Definition at line 274 of file ee_point_editor.cpp.

{
 static KICAD_T supportedTypes[] = {
 LIB_SHAPE_T,
 SCH_SHEET_T,
 SCH_LINE_LOCATE_GRAPHIC_LINE_T,
 SCH_BITMAP_T,
 EOT
 };

 if( !m_selectionTool )
 return 0;

 if( m_isSymbolEditor )
 {
 SYMBOL_EDIT_FRAME* editor = getEditFrame<SYMBOL_EDIT_FRAME>();

 if( !editor->IsSymbolEditable() || editor->IsSymbolAlias() )
 return 0;
 }

 const EE_SELECTION& selection = m_selectionTool->GetSelection();

 if( selection.Size() != 1 || !selection.Front()->IsType( supportedTypes ) )
 return 0;

 // Wait till drawing tool is done
 if( selection.Front()->IsNew() )
 return 0;

 Activate();

 KIGFX::VIEW_CONTROLS* controls = getViewControls();
 KIGFX::VIEW* view = getView();
 EDA_ITEM* item = (EDA_ITEM*) selection.Front();

 controls->ShowCursor( true );

 m_editPoints = EDIT_POINTS_FACTORY::Make( item, m_frame );
 view->Add( m_editPoints.get() );
 setEditedPoint( nullptr );
 updateEditedPoint( aEvent );
 bool inDrag = false;
 bool modified = false;

 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 if( !m_editPoints || evt->IsSelectionEvent() )
 break;

 if ( !inDrag )
 updateEditedPoint( *evt );

 if( evt->IsDrag( BUT_LEFT ) && m_editedPoint )
 {
 if( !inDrag )
 {
 saveItemsToUndo();
 controls->ForceCursorPosition( false );
 inDrag = true;
 modified = true;
 }

 bool snap = !evt->DisableGridSnapping();
 EDA_SHAPE* shape = dynamic_cast<EDA_SHAPE*>( item );

 if( shape && shape->GetShape() == SHAPE_T::ARC && getEditedPointIndex() == ARC_CENTER )
 snap = false;

 m_editedPoint->SetPosition( controls->GetCursorPosition( snap ) );

 updateParentItem();
 updatePoints();
 }
 else if( inDrag && evt->IsMouseUp( BUT_LEFT ) )
 {
 if( modified )
 {
 m_frame->OnModify();
 modified = false;
 }

 controls->SetAutoPan( false );
 inDrag = false;
 }
 else if( evt->IsCancelInteractive() || evt->IsActivate() )
 {
 if( inDrag ) // Restore the last change
 {
 rollbackFromUndo();
 inDrag = false;
 modified = false;
 break;
 }
 else if( evt->IsCancelInteractive() )
 {
 break;
 }

 if( evt->IsActivate() )
 break;
 }
 else
 {
 evt->SetPassEvent();
 }

 controls->SetAutoPan( inDrag );
 controls->CaptureCursor( inDrag );
 }

 controls->SetAutoPan( false );
 controls->CaptureCursor( false );
 setEditedPoint( nullptr );

 if( m_editPoints )
 {
 view->Remove( m_editPoints.get() );

 if( modified )
 m_frame->OnModify();

 m_editPoints.reset();
 m_frame->GetCanvas()->Refresh();
 }

 return 0;
}

References TOOL_INTERACTIVE::Activate(), KIGFX::VIEW::Add(), ARC, ARC_CENTER, BUT_LEFT, KIGFX::VIEW_CONTROLS::CaptureCursor(), editor, EOT, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SELECTION::Front(), SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), getEditedPointIndex(), EE_SELECTION_TOOL::GetSelection(), EDA_SHAPE::GetShape(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), EDA_ITEM::IsNew(), EDA_ITEM::IsType(), LIB_SHAPE_T, m_editedPoint, m_editPoints, EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, EE_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor, EE_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, EDIT_POINTS_FACTORY::Make(), SCH_BASE_FRAME::OnModify(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::Remove(), rollbackFromUndo(), saveItemsToUndo(), SCH_BITMAP_T, SCH_LINE_LOCATE_GRAPHIC_LINE_T, SCH_SHEET_T, KIGFX::VIEW_CONTROLS::SetAutoPan(), setEditedPoint(), EDIT_POINT::SetPosition(), KIGFX::VIEW_CONTROLS::ShowCursor(), SELECTION::Size(), updateEditedPoint(), updateParentItem(), updatePoints(), and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

modifiedSelection()

int EE_POINT_EDITOR::modifiedSelection ( const TOOL_EVENT &  aEvent )

private

Definition at line 912 of file ee_point_editor.cpp.

{
 updatePoints();
 return 0;
}

References updatePoints().

Referenced by setTransitions().

removeCorner()

int EE_POINT_EDITOR::removeCorner ( const TOOL_EVENT &  aEvent )

private

Definition at line 889 of file ee_point_editor.cpp.

{
 if( !m_editPoints || !m_editedPoint || m_editPoints->GetParent()->Type() != LIB_SHAPE_T )
 return 0;

 LIB_SHAPE* shape = static_cast<LIB_SHAPE*>( m_editPoints->GetParent() );
 SHAPE_LINE_CHAIN& poly = shape->GetPolyShape().Outline( 0 );

 if( poly.GetPointCount() < 3 )
 return 0;

 saveItemsToUndo();
 poly.Remove( getEditedPointIndex() );

 updateItem( shape, true );
 updatePoints();

 m_frame->OnModify();

 return 0;
}

References getEditedPointIndex(), EDA_SHAPE::GetPolyShape(), LIB_SHAPE_T, m_editedPoint, m_editPoints, EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_BASE_FRAME::OnModify(), SHAPE_POLY_SET::Outline(), saveItemsToUndo(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and updatePoints().

Referenced by setTransitions().

removeCornerCondition()

bool EE_POINT_EDITOR::removeCornerCondition ( const SELECTION &  aSelection )

private

Definition at line 810 of file ee_point_editor.cpp.

{
 if( !m_editPoints || !m_editedPoint || m_editPoints->GetParent()->Type() != LIB_SHAPE_T )
 return false;

 LIB_SHAPE* shape = static_cast<LIB_SHAPE*>( m_editPoints->GetParent() );

 if( shape->GetPolyShape().IsEmpty() )
 return false;

 SHAPE_LINE_CHAIN& poly = shape->GetPolyShape().Outline( 0 );

 if( poly.GetPointCount() < 3 )
 return false;

 for( const VECTOR2I& pt : poly.CPoints() )
 {
 if( pt == mapCoords( m_editedPoint->GetPosition() ) )
 return true;
 }

 return false;
}

References SHAPE_LINE_CHAIN::CPoints(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetPolyShape(), EDIT_POINT::GetPosition(), SHAPE_POLY_SET::IsEmpty(), LIB_SHAPE_T, m_editedPoint, m_editPoints, KIGFX::mapCoords(), and SHAPE_POLY_SET::Outline().

Referenced by Init().

Reset()

void EE_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 217 of file ee_point_editor.cpp.

{
 EE_TOOL_BASE::Reset( aReason );

 m_editPoints.reset();
 m_editedPoint = nullptr;
}

References m_editedPoint, m_editPoints, and EE_TOOL_BASE< T >::Reset().

rollbackFromUndo()

void EE_POINT_EDITOR::rollbackFromUndo ( )

private

Definition at line 945 of file ee_point_editor.cpp.

{
 if( m_isSymbolEditor )
 static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->RollbackSymbolFromUndo();
 else
 static_cast<SCH_EDIT_FRAME*>( m_frame )->RollbackSchematicFromUndo();
}

References EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and EE_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor.

Referenced by Main().

RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

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

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

Referenced by DRAWING_TOOL::PlaceText().

saveCopyInUndoList()

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

inlineprotectedinherited

Definition at line 134 of file ee_tool_base.h.

 {
 wxASSERT( aItem );

 KICAD_T itemType = aItem->Type();
 bool selected = aItem->IsSelected();

 // IS_SELECTED flag should not be set on undo items which were added for
 // a drag operation.
 if( selected && aItem->HasFlag( TEMP_SELECTED ) )
 aItem->ClearSelected();

 if( m_isSymbolEditor )
 {
 SYMBOL_EDIT_FRAME* editFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
 wxASSERT( editFrame );

 editFrame->SaveCopyInUndoList( static_cast<LIB_ITEM*>( aItem ), aType, aAppend );
 }
 else
 {
 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
 wxASSERT( editFrame );

 if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
 {
 editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
 static_cast<SCH_ITEM*>( aItem->GetParent() ),
 UNDO_REDO::CHANGED, aAppend );
 }
 else
 {
 editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
 static_cast<SCH_ITEM*>( aItem ),
 aType, aAppend );
 }
 }

 if( selected && aItem->HasFlag( TEMP_SELECTED ) )
 aItem->SetSelected();
 }

saveItemsToUndo()

void EE_POINT_EDITOR::saveItemsToUndo ( )

private

Definition at line 919 of file ee_point_editor.cpp.

{
 if( m_isSymbolEditor )
 {
 saveCopyInUndoList( m_editPoints->GetParent()->GetParent(), UNDO_REDO::LIBEDIT );
 }
 else
 {
 saveCopyInUndoList( (SCH_ITEM*) m_editPoints->GetParent(), UNDO_REDO::CHANGED );

 if( m_editPoints->GetParent()->Type() == SCH_LINE_T )
 {
 std::pair<EDA_ITEM*, int> connected = m_editPoints->Point( LINE_START ).GetConnected();

 if( connected.first )
 saveCopyInUndoList( (SCH_ITEM*) connected.first, UNDO_REDO::CHANGED, true );

 connected = m_editPoints->Point( LINE_END ).GetConnected();

 if( connected.first )
 saveCopyInUndoList( (SCH_ITEM*) connected.first, UNDO_REDO::CHANGED, true );
 }
 }
}

References CHANGED, LIBEDIT, LINE_END, LINE_START, m_editPoints, EE_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor, EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), and SCH_LINE_T.

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

SetContextMenu()

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

inherited

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

Parameters

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

Definition at line 76 of file tool_interactive.cpp.

{
 if( aMenu )
 aMenu->SetTool( this );
 else
 aTrigger = CMENU_OFF;

 m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
}

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setEditedPoint()

void EE_POINT_EDITOR::setEditedPoint ( EDIT_POINT *  aPoint )

private

Return true if aPoint is the currently modified point.

Definition at line 788 of file ee_point_editor.cpp.

{
 KIGFX::VIEW_CONTROLS* controls = getViewControls();

 if( aPoint )
 {
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls->ForceCursorPosition( true, aPoint->GetPosition() );
 controls->ShowCursor( true );
 }
 else
 {
 if( m_frame->ToolStackIsEmpty() )
 controls->ShowCursor( false );

 controls->ForceCursorPosition( false );
 }

 m_editedPoint = aPoint;
}

References ARROW, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SCH_BASE_FRAME::GetCanvas(), EDIT_POINT::GetPosition(), TOOL_BASE::getViewControls(), m_editedPoint, EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::VIEW_CONTROLS::ShowCursor(), and TOOLS_HOLDER::ToolStackIsEmpty().

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

setTransitions()

void EE_POINT_EDITOR::setTransitions ( )

overridevirtual

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

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Definition at line 954 of file ee_point_editor.cpp.

{
 Go( &EE_POINT_EDITOR::Main, EVENTS::SelectedEvent );
 Go( &EE_POINT_EDITOR::Main, ACTIONS::activatePointEditor.MakeEvent() );
 Go( &EE_POINT_EDITOR::addCorner, EE_ACTIONS::pointEditorAddCorner.MakeEvent() );
 Go( &EE_POINT_EDITOR::removeCorner, EE_ACTIONS::pointEditorRemoveCorner.MakeEvent() );
 Go( &EE_POINT_EDITOR::modifiedSelection, EVENTS::SelectedItemsModified );
 Go( &EE_POINT_EDITOR::clearEditedPoints, EVENTS::ClearedEvent );
}

References ACTIONS::activatePointEditor, addCorner(), EVENTS::ClearedEvent, clearEditedPoints(), TOOL_INTERACTIVE::Go(), Main(), modifiedSelection(), EE_ACTIONS::pointEditorAddCorner, EE_ACTIONS::pointEditorRemoveCorner, removeCorner(), EVENTS::SelectedEvent, and EVENTS::SelectedItemsModified.

updateEditedPoint()

void EE_POINT_EDITOR::updateEditedPoint ( const TOOL_EVENT &  aEvent )

private

Clear references to the points.

Definition at line 248 of file ee_point_editor.cpp.

{
 EDIT_POINT* point = m_editedPoint;

 if( !m_editPoints )
 {
 point = nullptr;
 }
 else if( aEvent.IsMotion() )
 {
 point = m_editPoints->FindPoint( aEvent.Position(), getView() );
 }
 else if( aEvent.IsDrag( BUT_LEFT ) )
 {
 point = m_editPoints->FindPoint( aEvent.DragOrigin(), getView() );
 }
 else
 {
 point = m_editPoints->FindPoint( getViewControls()->GetCursorPosition(), getView() );
 }

 if( m_editedPoint != point )
 setEditedPoint( point );
}

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

Referenced by Main().

updateItem()

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

inlineprotectedinherited

Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree.

Similar to m_frame->SaveCopyInUndoList(), but handles items that are owned by their parents.

Definition at line 103 of file ee_tool_base.h.

updateParentItem()

void EE_POINT_EDITOR::updateParentItem ( ) const

private

< Update item's points with edit points.

Update edit points with item's points.

Definition at line 476 of file ee_point_editor.cpp.

{
 EDA_ITEM* item = m_editPoints->GetParent();

 if( !item )
 return;

 switch( item->Type() )
 {
 case LIB_SHAPE_T:
 {
 LIB_SHAPE* shape = static_cast<LIB_SHAPE*>( item );

 switch( shape->GetShape() )
 {
 case SHAPE_T::ARC:
 if( getEditedPointIndex() == ARC_CENTER )
 {
 shape->SetEditState( 4 );
 shape->CalcEdit( mapCoords( m_editPoints->Point( ARC_CENTER ).GetPosition() ) );
 }
 else if( getEditedPointIndex() == ARC_START )
 {
 shape->SetEditState( 2 );
 shape->CalcEdit( mapCoords( m_editPoints->Point( ARC_START ).GetPosition() ) );
 }
 else if( getEditedPointIndex() == ARC_END )
 {
 shape->SetEditState( 3 );
 shape->CalcEdit( mapCoords( m_editPoints->Point( ARC_END ).GetPosition() ) );
 }
 break;

 case SHAPE_T::CIRCLE:
 shape->SetPosition( mapCoords( m_editPoints->Point( CIRC_CENTER ).GetPosition() ) );
 shape->SetEnd( mapCoords( m_editPoints->Point( CIRC_END ).GetPosition() ) );
 break;

 case SHAPE_T::POLY:
 shape->GetPolyShape().RemoveAllContours();
 shape->GetPolyShape().NewOutline();

 for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
 {
 wxPoint pt = mapCoords( m_editPoints->Point( i ).GetPosition() );
 shape->GetPolyShape().Append( pt.x, pt.y, -1, -1, true );
 }

 break;

 case SHAPE_T::RECT:
 {
 EE_GRID_HELPER gridHelper( m_toolMgr );
 VECTOR2I topLeft = m_editPoints->Point( RECT_TOPLEFT ).GetPosition();
 VECTOR2I topRight = m_editPoints->Point( RECT_TOPRIGHT ).GetPosition();
 VECTOR2I botLeft = m_editPoints->Point( RECT_BOTLEFT ).GetPosition();
 VECTOR2I botRight = m_editPoints->Point( RECT_BOTRIGHT ).GetPosition();

 pinEditedCorner( getEditedPointIndex(), Mils2iu( 1 ), Mils2iu( 1 ),
 topLeft, topRight, botLeft, botRight, &gridHelper );

 shape->SetPosition( mapCoords( topLeft ) );
 shape->SetEnd( mapCoords( botRight ) );
 }
 break;

 case SHAPE_T::BEZIER:
 // TODO
 break;

 default:
 wxFAIL_MSG( wxT( "EE_POINT_EDITOR::updateParentItem not implemented for " )
 + shape->SHAPE_T_asString() );
 }
 }
 break;

 case SCH_BITMAP_T:
 {
 EE_GRID_HELPER gridHelper( m_toolMgr );
 SCH_BITMAP* bitmap = (SCH_BITMAP*) item;
 VECTOR2I topLeft = m_editPoints->Point( RECT_TOPLEFT ).GetPosition();
 VECTOR2I topRight = m_editPoints->Point( RECT_TOPRIGHT ).GetPosition();
 VECTOR2I botLeft = m_editPoints->Point( RECT_BOTLEFT ).GetPosition();
 VECTOR2I botRight = m_editPoints->Point( RECT_BOTRIGHT ).GetPosition();

 pinEditedCorner( getEditedPointIndex(), Mils2iu( 50 ), Mils2iu( 50 ),
 topLeft, topRight, botLeft, botRight, &gridHelper );

 double oldWidth = bitmap->GetSize().x;
 double newWidth = topRight.x - topLeft.x;
 double widthRatio = newWidth / oldWidth;

 double oldHeight = bitmap->GetSize().y;
 double newHeight = botLeft.y - topLeft.y;
 double heightRatio = newHeight / oldHeight;

 bitmap->SetImageScale( bitmap->GetImageScale() * std::min( widthRatio, heightRatio ) );
 }
 break;

 case SCH_SHEET_T:
 {
 SCH_SHEET* sheet = (SCH_SHEET*) item;
 EE_GRID_HELPER gridHelper( m_toolMgr );
 VECTOR2I topLeft = m_editPoints->Point( RECT_TOPLEFT ).GetPosition();
 VECTOR2I topRight = m_editPoints->Point( RECT_TOPRIGHT ).GetPosition();
 VECTOR2I botLeft = m_editPoints->Point( RECT_BOTLEFT ).GetPosition();
 VECTOR2I botRight = m_editPoints->Point( RECT_BOTRIGHT ).GetPosition();
 int edited = getEditedPointIndex();

 pinEditedCorner( getEditedPointIndex(),
 sheet->GetMinWidth( edited == RECT_TOPRIGHT || edited == RECT_BOTRIGHT ),
 sheet->GetMinHeight( edited == RECT_BOTLEFT || edited == RECT_BOTRIGHT ),
 topLeft, topRight, botLeft, botRight, &gridHelper );

 // Pin positions are relative to origin. Attempt to leave them where they
 // are if the origin moves.
 wxPoint originDelta = sheet->GetPosition() - (wxPoint) topLeft;

 sheet->SetPosition( (wxPoint) topLeft );
 sheet->SetSize( wxSize( botRight.x - topLeft.x, botRight.y - topLeft.y ) );

 // Update the fields if we're in autoplace mode
 if( sheet->GetFieldsAutoplaced() == FIELDS_AUTOPLACED_AUTO )
 sheet->AutoplaceFields( /* aScreen */ nullptr, /* aManual */ false );

 // Keep sheet pins attached to edges:
 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
 {
 wxPoint pos = pin->GetPosition();

 pos += originDelta;

 switch( pin->GetSide() )
 {
 case SHEET_SIDE::LEFT: pos.x = topLeft.x; break;
 case SHEET_SIDE::RIGHT: pos.x = topRight.x; break;
 case SHEET_SIDE::TOP: pos.y = topLeft.y; break;
 case SHEET_SIDE::BOTTOM: pos.y = botLeft.y; break;
 case SHEET_SIDE::UNDEFINED: break;
 }

 pin->SetPosition( pos );
 }
 }
 break;

 case SCH_LINE_T:
 {
 SCH_LINE* line = (SCH_LINE*) item;

 line->SetStartPoint( (wxPoint) m_editPoints->Point( LINE_START ).GetPosition() );
 line->SetEndPoint( (wxPoint) m_editPoints->Point( LINE_END ).GetPosition() );

 std::pair<EDA_ITEM*, int> connected = m_editPoints->Point( LINE_START ).GetConnected();

 if( connected.first )
 {
 if( connected.second == STARTPOINT )
 static_cast<SCH_LINE*>( connected.first )->SetStartPoint( line->GetPosition() );
 else if( connected.second == ENDPOINT )
 static_cast<SCH_LINE*>( connected.first )->SetEndPoint( line->GetPosition() );

 updateItem( connected.first, true );
 }

 connected = m_editPoints->Point( LINE_END ).GetConnected();

 if( connected.first )
 {
 if( connected.second == STARTPOINT )
 static_cast<SCH_LINE*>( connected.first )->SetStartPoint( line->GetEndPoint() );
 else if( connected.second == ENDPOINT )
  static_cast<SCH_LINE*>( connected.first )->SetEndPoint( line->GetEndPoint() );

 updateItem( connected.first, true );
 }
 }
 break;

 default:
 break;
 }

 updateItem( item, true );
 m_frame->SetMsgPanel( item );
}

References SHAPE_POLY_SET::Append(), ARC, ARC_CENTER, ARC_END, ARC_START, SCH_SHEET::AutoplaceFields(), BEZIER, BOTTOM, LIB_SHAPE::CalcEdit(), CIRC_CENTER, CIRC_END, CIRCLE, ENDPOINT, FIELDS_AUTOPLACED_AUTO, getEditedPointIndex(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetFieldsAutoplaced(), SCH_BITMAP::GetImageScale(), SCH_SHEET::GetMinHeight(), SCH_SHEET::GetMinWidth(), SCH_SHEET::GetPins(), EDA_SHAPE::GetPolyShape(), SCH_LINE::GetPosition(), SCH_SHEET::GetPosition(), EDA_SHAPE::GetShape(), SCH_BITMAP::GetSize(), LEFT, LIB_SHAPE_T, LINE_END, LINE_START, m_editPoints, EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, TOOL_BASE::m_toolMgr, KIGFX::mapCoords(), SHAPE_POLY_SET::NewOutline(), pin, pinEditedCorner(), POLY, RECT, RECT_BOTLEFT, RECT_BOTRIGHT, RECT_TOPLEFT, RECT_TOPRIGHT, SHAPE_POLY_SET::RemoveAllContours(), RIGHT, SCH_BITMAP_T, SCH_LINE_T, SCH_SHEET_T, LIB_SHAPE::SetEditState(), EDA_SHAPE::SetEnd(), SCH_LINE::SetEndPoint(), SCH_BITMAP::SetImageScale(), EDA_DRAW_FRAME::SetMsgPanel(), LIB_SHAPE::SetPosition(), SCH_SHEET::SetPosition(), SCH_SHEET::SetSize(), SCH_LINE::SetStartPoint(), EDA_SHAPE::SHAPE_T_asString(), STARTPOINT, TOP, EDA_ITEM::Type(), UNDEFINED, EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Main().

updatePoints()

void EE_POINT_EDITOR::updatePoints ( )

private

Update which point is being edited.

Definition at line 666 of file ee_point_editor.cpp.

{
 if( !m_editPoints )
 return;

 EDA_ITEM* item = m_editPoints->GetParent();

 if( !item )
 return;

 switch( item->Type() )
 {
 case LIB_SHAPE_T:
 {
 LIB_SHAPE* shape = static_cast<LIB_SHAPE*>( item );

 switch( shape->GetShape() )
 {
 case SHAPE_T::ARC:
 m_editPoints->Point( ARC_CENTER ).SetPosition( mapCoords( shape->GetPosition() ) );
 m_editPoints->Point( ARC_START ).SetPosition( mapCoords( shape->GetStart() ) );
 m_editPoints->Point( ARC_END ).SetPosition( mapCoords( shape->GetEnd() ) );
 break;

 case SHAPE_T::CIRCLE:
 m_editPoints->Point( CIRC_CENTER ).SetPosition( mapCoords( shape->GetPosition() ) );
 m_editPoints->Point( CIRC_END ).SetPosition( mapCoords( shape->GetEnd() ) );
 break;

 case SHAPE_T::POLY:
 {
 if( (int) m_editPoints->PointsSize() != shape->GetPointCount() )
 {
 getView()->Remove( m_editPoints.get() );
 m_editedPoint = nullptr;
 m_editPoints = EDIT_POINTS_FACTORY::Make( item, m_frame );
 getView()->Add( m_editPoints.get() );
 }
 else
 {
 int ii = 0;

 for( const VECTOR2I& pt : shape->GetPolyShape().Outline( 0 ).CPoints() )
 m_editPoints->Point( ii++ ).SetPosition( mapCoords( pt ) );
 }

 break;
 }

 case SHAPE_T::RECT:
 {
 // point editor works only with rectangles having width and height > 0
 // Some symbols can have rectangles with width or height < 0
 // So normalize the size:
 BOX2I dummy;
 dummy.SetOrigin( mapCoords( shape->GetPosition() ) );
 dummy.SetEnd( mapCoords( shape->GetEnd() ) );
 dummy.Normalize();
 VECTOR2I topLeft = dummy.GetPosition();
 VECTOR2I botRight = dummy.GetEnd();

 m_editPoints->Point( RECT_TOPLEFT ).SetPosition( topLeft );
 m_editPoints->Point( RECT_TOPRIGHT ).SetPosition( VECTOR2I( botRight.x, topLeft.y ) );
 m_editPoints->Point( RECT_BOTLEFT ).SetPosition( VECTOR2I( topLeft.x, botRight.y ) );
 m_editPoints->Point( RECT_BOTRIGHT ).SetPosition( botRight );
 }
 break;

 case SHAPE_T::BEZIER:
 // TODO
 break;

 default:
 wxFAIL_MSG( wxT( "EE_POINT_EDITOR::updatePoints not implemented for " )
 + shape->SHAPE_T_asString() );
 }
 }
 break;

 case SCH_BITMAP_T:
 {
 SCH_BITMAP* bitmap = (SCH_BITMAP*) item;
 wxPoint topLeft = bitmap->GetPosition() - bitmap->GetSize() / 2;
 wxPoint botRight = bitmap->GetPosition() + bitmap->GetSize() / 2;

 m_editPoints->Point( RECT_TOPLEFT ).SetPosition( topLeft );
 m_editPoints->Point( RECT_TOPRIGHT ).SetPosition( botRight.x, topLeft.y );
 m_editPoints->Point( RECT_BOTLEFT ).SetPosition( topLeft.x, botRight.y );
 m_editPoints->Point( RECT_BOTRIGHT ).SetPosition( botRight );
 }
 break;

 case SCH_SHEET_T:
 {
 SCH_SHEET* sheet = (SCH_SHEET*) item;
 wxPoint topLeft = sheet->GetPosition();
 wxPoint botRight = sheet->GetPosition() + sheet->GetSize();

 m_editPoints->Point( RECT_TOPLEFT ).SetPosition( topLeft );
 m_editPoints->Point( RECT_TOPRIGHT ).SetPosition( botRight.x, topLeft.y );
 m_editPoints->Point( RECT_BOTLEFT ).SetPosition( topLeft.x, botRight.y );
 m_editPoints->Point( RECT_BOTRIGHT ).SetPosition( botRight );
 }
 break;

 case SCH_LINE_T:
 {
 SCH_LINE* line = (SCH_LINE*) item;

 m_editPoints->Point( LINE_START ).SetPosition( line->GetStartPoint() );
 m_editPoints->Point( LINE_END ).SetPosition( line->GetEndPoint() );
 }
 break;

 default:
 break;
 }

 getView()->Update( m_editPoints.get() );
}

References KIGFX::VIEW::Add(), ARC, ARC_CENTER, ARC_END, ARC_START, BEZIER, CIRC_CENTER, CIRC_END, CIRCLE, SHAPE_LINE_CHAIN::CPoints(), dummy(), EDA_SHAPE::GetEnd(), SCH_LINE::GetEndPoint(), EDA_SHAPE::GetPointCount(), EDA_SHAPE::GetPolyShape(), LIB_SHAPE::GetPosition(), SCH_BITMAP::GetPosition(), EDA_ITEM::GetPosition(), SCH_SHEET::GetPosition(), EDA_SHAPE::GetShape(), SCH_BITMAP::GetSize(), SCH_SHEET::GetSize(), EDA_SHAPE::GetStart(), SCH_LINE::GetStartPoint(), TOOL_BASE::getView(), LIB_SHAPE_T, LINE_END, LINE_START, m_editedPoint, m_editPoints, EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame, EDIT_POINTS_FACTORY::Make(), KIGFX::mapCoords(), SHAPE_POLY_SET::Outline(), POLY, RECT, RECT_BOTLEFT, RECT_BOTRIGHT, RECT_TOPLEFT, RECT_TOPRIGHT, KIGFX::VIEW::Remove(), SCH_BITMAP_T, SCH_LINE_T, SCH_SHEET_T, EDA_SHAPE::SHAPE_T_asString(), EDA_ITEM::Type(), KIGFX::VIEW::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

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

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

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

Member Data Documentation

m_editedPoint

EDIT_POINT* EE_POINT_EDITOR::m_editedPoint

private

< Currently edited point, NULL if there is none.

Currently available edit points.

Definition at line 106 of file ee_point_editor.h.

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

m_editPoints

std::shared_ptr<EDIT_POINTS> EE_POINT_EDITOR::m_editPoints

private

Definition at line 109 of file ee_point_editor.h.

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

m_frame

SCH_BASE_FRAME * EE_TOOL_BASE< SCH_BASE_FRAME >::m_frame

protectedinherited

Definition at line 177 of file ee_tool_base.h.

m_isSymbolEditor

bool EE_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 180 of file ee_tool_base.h.

m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu

protectedinherited

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

Definition at line 125 of file tool_interactive.h.

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

m_selectionTool

EE_SELECTION_TOOL* EE_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool

protectedinherited

Definition at line 179 of file ee_tool_base.h.

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

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

Definition at line 209 of file tool_base.h.

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

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 214 of file tool_base.h.

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

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 213 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

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

Definition at line 206 of file tool_base.h.

Referenced by TOOL_BASE::GetType(), and BOARD_COMMIT::Push().

m_view

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

protectedinherited

Definition at line 178 of file ee_tool_base.h.

---

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

• ee_point_editor.h
• ee_point_editor.cpp