CONVERT_TOOL Class Reference

#include <convert_tool.h>

Inheritance diagram for CONVERT_TOOL:

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

Public Member Functions
	CONVERT_TOOL ()
virtual	~CONVERT_TOOL ()
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	CreatePolys (const TOOL_EVENT &aEvent)
	Convert selected lines to a polygon, if possible. More...
int	CreateLines (const TOOL_EVENT &aEvent)
	Convert selected polygon-like object to graphic lines, if possible. More...
int	SegmentToArc (const TOOL_EVENT &aEvent)
	Convert selected segment (graphic or track) to an arc of the same type. 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	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
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
SHAPE_POLY_SET	makePolysFromChainedSegs (const std::deque< EDA_ITEM * > &aItems, CONVERT_STRATEGY aStrategy)
	Try to make polygons from chained segments in the selected items. More...
SHAPE_POLY_SET	makePolysFromOpenGraphics (const std::deque< EDA_ITEM * > &aItems, int aGap)
	Make polygons from graphic shapes and zones. More...
SHAPE_POLY_SET	makePolysFromClosedGraphics (const std::deque< EDA_ITEM * > &aItems, CONVERT_STRATEGY aStrategy)
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions(). More...
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInt () const
TOOLS_HOLDER *	getToolHolderInt () const

Static Private Member Functions
static std::optional< SEG >	getStartEndPoints (EDA_ITEM *aItem)
	Retrieve the start and end points for a generic item. More...

Private Attributes
PCB_SELECTION_TOOL *	m_selectionTool
CONDITIONAL_MENU *	m_menu
PCB_BASE_FRAME *	m_frame
CONVERT_SETTINGS	m_userSettings

Detailed Description

Definition at line 37 of file convert_tool.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.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH, 
 REDRAW 
 };

Constructor & Destructor Documentation

CONVERT_TOOL()

CONVERT_TOOL::CONVERT_TOOL

(

)

Definition at line 204 of file convert_tool.cpp.

 :
 TOOL_INTERACTIVE( "pcbnew.Convert" ),
 m_selectionTool( nullptr ),
 m_menu( nullptr ),
 m_frame( nullptr )
{
 m_userSettings.m_Strategy = CENTERLINE;
 m_userSettings.m_Gap = 0;
 m_userSettings.m_LineWidth = 0;
 m_userSettings.m_DeleteOriginals = true;
}

References CENTERLINE, CONVERT_SETTINGS::m_DeleteOriginals, CONVERT_SETTINGS::m_Gap, CONVERT_SETTINGS::m_LineWidth, CONVERT_SETTINGS::m_Strategy, and m_userSettings.

~CONVERT_TOOL()

CONVERT_TOOL::~CONVERT_TOOL ( )

virtual

Definition at line 217 of file convert_tool.cpp.

{
 delete m_menu;
}

References m_menu.

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(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_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(), SCH_DRAWING_TOOLS::DrawShape(), 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(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

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

CreateLines()

int CONVERT_TOOL::CreateLines

(

const TOOL_EVENT &

aEvent

)

Convert selected polygon-like object to graphic lines, if possible.

Definition at line 808 of file convert_tool.cpp.

{
 auto& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 switch( item->Type() )
 {
 case PCB_SHAPE_T:
 case PCB_FP_SHAPE_T:
 switch( static_cast<PCB_SHAPE*>( item )->GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::ARC:
 case SHAPE_T::POLY:
 case SHAPE_T::RECT:
 break;
 
 default:
 aCollector.Remove( item );
 }
 
 break;
 
 case PCB_ZONE_T:
 case PCB_FP_ZONE_T:
 break;
 
 default:
 aCollector.Remove( item );
 }
 }
 } );
 
 if( selection.Empty() )
 return 0;
 
 auto getPolySet =
 []( EDA_ITEM* aItem )
 {
 SHAPE_POLY_SET set;
 
 switch( aItem->Type() )
 {
 case PCB_ZONE_T:
 case PCB_FP_ZONE_T:
 set = *static_cast<ZONE*>( aItem )->Outline();
 break;
 
 case PCB_SHAPE_T:
 case PCB_FP_SHAPE_T:
 {
 PCB_SHAPE* graphic = static_cast<PCB_SHAPE*>( aItem );
 
 if( graphic->GetShape() == SHAPE_T::POLY )
 {
 set = graphic->GetPolyShape();
 }
 else if( graphic->GetShape() == SHAPE_T::RECT )
 {
 SHAPE_LINE_CHAIN outline;
 VECTOR2I start( graphic->GetStart() );
 VECTOR2I end( graphic->GetEnd() );
 
 outline.Append( start );
 outline.Append( VECTOR2I( end.x, start.y ) );
 outline.Append( end );
 outline.Append( VECTOR2I( start.x, end.y ) );
 outline.SetClosed( true );
 
 set.AddOutline( outline );
 }
 else
 {
 wxFAIL_MSG( wxT( "Unhandled graphic shape type in PolyToLines - getPolySet" ) );
 }
 break;
 }
 
 default:
 wxFAIL_MSG( wxT( "Unhandled type in PolyToLines - getPolySet" ) );
 break;
 }
 
 return set;
 };
 
 auto getSegList =
 []( SHAPE_POLY_SET& aPoly )
 {
 std::vector<SEG> segs;
 
 // Our input should be valid polys, so OK to assert here
 wxASSERT( aPoly.VertexCount() >= 2 );
 
 for( int i = 1; i < aPoly.VertexCount(); i++ )
 segs.emplace_back( SEG( aPoly.CVertex( i - 1 ), aPoly.CVertex( i ) ) );
 
 segs.emplace_back( SEG( aPoly.CVertex( aPoly.VertexCount() - 1 ),
 aPoly.CVertex( 0 ) ) );
 
 return segs;
 };
 
 BOARD_COMMIT commit( m_frame );
 PCB_BASE_EDIT_FRAME* frame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 FOOTPRINT_EDIT_FRAME* fpEditor = dynamic_cast<FOOTPRINT_EDIT_FRAME*>( m_frame );
 FOOTPRINT* footprint = nullptr;
 PCB_LAYER_ID targetLayer = m_frame->GetActiveLayer();
 BOARD_ITEM_CONTAINER* parent = frame->GetModel();
 
 if( fpEditor )
 footprint = fpEditor->GetBoard()->GetFirstFootprint();
 
 auto handleGraphicSeg =
 [&]( EDA_ITEM* aItem )
 {
 if( aItem->Type() != PCB_SHAPE_T && aItem->Type() != PCB_FP_SHAPE_T )
 return false;
 
 PCB_SHAPE* graphic = static_cast<PCB_SHAPE*>( aItem );
 
 if( graphic->GetShape() == SHAPE_T::SEGMENT )
 {
 PCB_TRACK* track = new PCB_TRACK( parent );
 
 track->SetLayer( targetLayer );
 track->SetStart( graphic->GetStart() );
 track->SetEnd( graphic->GetEnd() );
 track->SetWidth( graphic->GetWidth() );
 commit.Add( track );
 
 return true;
 }
 else if( graphic->GetShape() == SHAPE_T::ARC )
 {
 PCB_ARC* arc = new PCB_ARC( parent );
 
 arc->SetLayer( targetLayer );
 arc->SetStart( graphic->GetStart() );
 arc->SetEnd( graphic->GetEnd() );
 arc->SetMid( graphic->GetArcMid() );
 arc->SetWidth( graphic->GetWidth() );
 commit.Add( arc );
 
 return true;
 }
 
 return false;
 };
 
 if( aEvent.IsAction( &PCB_ACTIONS::convertToTracks ) )
 {
 if( !IsCopperLayer( targetLayer ) )
 {
 targetLayer = frame->SelectOneLayer( F_Cu, LSET::AllNonCuMask() );
 
 if( targetLayer == UNDEFINED_LAYER ) // User canceled
 return true;
 }
 }
 
 for( EDA_ITEM* item : selection )
 {
 if( handleGraphicSeg( item ) )
 continue;
 
 SHAPE_POLY_SET polySet = getPolySet( item );
 std::vector<SEG> segs = getSegList( polySet );
 
 if( aEvent.IsAction( &PCB_ACTIONS::convertToLines ) )
 {
 for( SEG& seg : segs )
 {
 if( fpEditor )
 {
 FP_SHAPE* graphic = new FP_SHAPE( footprint, SHAPE_T::SEGMENT );
 
 graphic->SetLayer( targetLayer );
 graphic->SetStart( VECTOR2I( seg.A ) );
 graphic->SetStart0( VECTOR2I( seg.A ) );
 graphic->SetEnd( VECTOR2I( seg.B ) );
 graphic->SetEnd0( VECTOR2I( seg.B ) );
 commit.Add( graphic );
 }
 else
 {
 PCB_SHAPE* graphic = new PCB_SHAPE( nullptr, SHAPE_T::SEGMENT );
 
 graphic->SetLayer( targetLayer );
 graphic->SetStart( VECTOR2I( seg.A ) );
 graphic->SetEnd( VECTOR2I( seg.B ) );
 commit.Add( graphic );
 }
 }
 }
 else
 {
 // I am really unsure converting a polygon to "tracks" (i.e. segments on
 // copper layers) make sense for footprints, but anyway this code exists
 if( fpEditor )
 {
 // Creating segments on copper layer
 for( SEG& seg : segs )
 {
 FP_SHAPE* graphic = new FP_SHAPE( footprint, SHAPE_T::SEGMENT );
 graphic->SetLayer( targetLayer );
 graphic->SetStart( VECTOR2I( seg.A ) );
 graphic->SetStart0( VECTOR2I( seg.A ) );
 graphic->SetEnd( VECTOR2I( seg.B ) );
 graphic->SetEnd0( VECTOR2I( seg.B ) );
 commit.Add( graphic );
 }
 }
 else
 {
 // Creating tracks
 for( SEG& seg : segs )
 {
 PCB_TRACK* track = new PCB_TRACK( parent );
 
 track->SetLayer( targetLayer );
 track->SetStart( VECTOR2I( seg.A ) );
 track->SetEnd( VECTOR2I( seg.B ) );
 commit.Add( track );
 }
 }
 }
 }
 
 commit.Push( _( "Convert polygons to lines" ) );
 
 return 0;
}

References COLLECTOR::GetCount(), m_selectionTool, and PCB_SELECTION_TOOL::RequestSelection().

Referenced by setTransitions().

CreatePolys()

int CONVERT_TOOL::CreatePolys

(

const TOOL_EVENT &

aEvent

)

Convert selected lines to a polygon, if possible.

Definition at line 285 of file convert_tool.cpp.

{
 std::vector<SHAPE_POLY_SET> polys;
 PCB_LAYER_ID destLayer = m_frame->GetActiveLayer();
 FOOTPRINT* parentFootprint = nullptr;
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 } );
 
 if( selection.Empty() )
 return 0;
 
 auto getPolys =
 [&]( CONVERT_SETTINGS cfg )
 {
 polys.clear();
 
 for( EDA_ITEM* item : selection )
 item->ClearTempFlags();
 
 SHAPE_POLY_SET polySet;
 
 polySet.Append( makePolysFromClosedGraphics( selection.GetItems(), cfg.m_Strategy ) );
 
 polySet.Append( makePolysFromChainedSegs( selection.GetItems(), cfg.m_Strategy ) );
 
 if( cfg.m_Strategy == BOUNDING_HULL )
 polySet.Append( makePolysFromOpenGraphics( selection.GetItems(), cfg.m_Gap ) );
 
 if( polySet.IsEmpty() )
 return false;
 
 if( cfg.m_Strategy == BOUNDING_HULL )
 {
 polySet.ClearArcs();
 polySet.Simplify( SHAPE_POLY_SET::PM_FAST );
 }
 
 for( int ii = 0; ii < polySet.OutlineCount(); ++ii )
 {
 polys.emplace_back( SHAPE_POLY_SET( polySet.COutline( ii ) ) );
 
 for( int jj = 0; jj < polySet.HoleCount( ii ); ++jj )
 polys.back().AddHole( polySet.Hole( ii, jj ) );
 }
 
 return true;
 };
 
 // Pre-flight getPolys() to see if there's anything to convert.
 CONVERT_SETTINGS preflightSettings = m_userSettings;
 preflightSettings.m_Strategy = BOUNDING_HULL;
 
 if( !getPolys( preflightSettings ) )
 return 0;
 
 bool isFootprint = m_frame->IsType( FRAME_FOOTPRINT_EDITOR );
 
 if( isFootprint )
 {
 if( FP_SHAPE* graphic = dynamic_cast<FP_SHAPE*>( selection.Front() ) )
 parentFootprint = graphic->GetParentFootprint();
 else if( FP_ZONE* zone = dynamic_cast<FP_ZONE*>( selection.Front() ) )
  parentFootprint = static_cast<FOOTPRINT*>( zone->GetParent() );
 else
 wxFAIL_MSG( wxT( "Unimplemented footprint parent in CONVERT_TOOL::CreatePolys" ) );
 }
 
 BOARD_DESIGN_SETTINGS& bds = m_frame->GetBoard()->GetDesignSettings();
 PCB_LAYER_ID layer = m_frame->GetActiveLayer();
 BOARD_COMMIT commit( m_frame );
 
 if( aEvent.IsAction( &PCB_ACTIONS::convertToPoly ) )
 {
 CONVERT_SETTINGS_DIALOG dlg( m_frame, &m_userSettings );
 
 if( dlg.ShowModal() != wxID_OK )
 return 0;
 
 CONVERT_SETTINGS resolvedSettings = m_userSettings;
 
 if( resolvedSettings.m_LineWidth == 0 )
 resolvedSettings.m_LineWidth = bds.m_LineThickness[ bds.GetLayerClass( layer ) ];
 
 if( resolvedSettings.m_Strategy == BOUNDING_HULL )
 {
 if( resolvedSettings.m_Gap > 0 )
 resolvedSettings.m_Gap += KiROUND( (double) resolvedSettings.m_LineWidth / 2 );
 }
 
 if( !getPolys( resolvedSettings ) )
 return 0;
 
 for( const SHAPE_POLY_SET& poly : polys )
 {
 PCB_SHAPE* graphic = isFootprint ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 
 if( resolvedSettings.m_Strategy == COPY_LINEWIDTH )
 {
 BOARD_ITEM* topLeftItem = nullptr;
 VECTOR2I pos;
 
 for( EDA_ITEM* item : selection )
 {
 if( BOARD_ITEM* candidate = dynamic_cast<BOARD_ITEM*>( item ) )
 {
 if( candidate->HasLineStroke() )
 {
 pos = candidate->GetPosition();
 
 if( !topLeftItem
 || ( pos.x < topLeftItem->GetPosition().x )
 || ( topLeftItem->GetPosition().x == pos.x
 && pos.y < topLeftItem->GetPosition().y ) )
 {
 topLeftItem = candidate;
 resolvedSettings.m_LineWidth = topLeftItem->GetStroke().GetWidth();
 }
 }
 }
 }
 }
 
 graphic->SetShape( SHAPE_T::POLY );
 graphic->SetStroke( STROKE_PARAMS( resolvedSettings.m_LineWidth, PLOT_DASH_TYPE::SOLID,
 COLOR4D::UNSPECIFIED ) );
 graphic->SetLayer( destLayer );
 graphic->SetPolyShape( poly );
 
 commit.Add( graphic );
 }
 }
 else
 {
 // Creating zone or keepout
 PCB_BASE_EDIT_FRAME* frame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 BOARD_ITEM_CONTAINER* parent = frame->GetModel();
 ZONE_SETTINGS zoneInfo = frame->GetZoneSettings();
 
 bool nonCopper = IsNonCopperLayer( destLayer );
 zoneInfo.m_Layers.reset().set( destLayer );
 zoneInfo.m_Name.Empty();
 
 int ret;
 
 // No copy-line-width option for zones/keepouts
 if( m_userSettings.m_Strategy == COPY_LINEWIDTH )
 m_userSettings.m_Strategy = CENTERLINE;
 
 if( aEvent.IsAction( &PCB_ACTIONS::convertToKeepout ) )
 {
 zoneInfo.SetIsRuleArea( true );
 ret = InvokeRuleAreaEditor( frame, &zoneInfo, &m_userSettings );
 }
 else if( nonCopper )
 {
 zoneInfo.SetIsRuleArea( false );
 ret = InvokeNonCopperZonesEditor( frame, &zoneInfo, &m_userSettings );
 }
 else
 {
 zoneInfo.SetIsRuleArea( false );
 ret = InvokeCopperZonesEditor( frame, &zoneInfo, &m_userSettings );
 }
 
 if( ret == wxID_CANCEL )
 return 0;
 
 if( !getPolys( m_userSettings ) )
 return 0;
 
 for( const SHAPE_POLY_SET& poly : polys )
 {
 ZONE* zone = isFootprint ? new FP_ZONE( parent ) : new ZONE( parent );
 
 *zone->Outline() = poly;
 zone->HatchBorder();
 
 zoneInfo.ExportSetting( *zone );
 
 commit.Add( zone );
 }
 }
 
 if( m_userSettings.m_DeleteOriginals )
 {
 PCB_SELECTION selectionCopy = selection;
 m_selectionTool->ClearSelection();
 
 for( EDA_ITEM* item : selectionCopy )
 {
 if( item->GetFlags() & SKIP_STRUCT )
 commit.Remove( item );
 }
 }
 
 if( aEvent.IsAction( &PCB_ACTIONS::convertToPoly ) )
 commit.Push( _( "Convert shapes to polygon" ) );
 else
 commit.Push( _( "Convert shapes to zone" ) );
 
 return 0;
}

References _, COMMIT::Add(), SHAPE_POLY_SET::Append(), BOUNDING_HULL, CENTERLINE, SHAPE_POLY_SET::ClearArcs(), PCB_SELECTION_TOOL::ClearSelection(), PCB_ACTIONS::convertToKeepout, PCB_ACTIONS::convertToPoly, COPY_LINEWIDTH, SHAPE_POLY_SET::COutline(), SELECTION::Empty(), ZONE_SETTINGS::ExportSetting(), FRAME_FOOTPRINT_EDITOR, SELECTION::Front(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetLayerClass(), PCB_BASE_FRAME::GetModel(), BOARD_ITEM::GetParentFootprint(), EDA_ITEM::GetPosition(), BOARD_ITEM::GetStroke(), STROKE_PARAMS::GetWidth(), PCB_BASE_FRAME::GetZoneSettings(), ZONE::HatchBorder(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), TOOL_EVENT::IsAction(), SHAPE_POLY_SET::IsEmpty(), IsNonCopperLayer(), EDA_BASE_FRAME::IsType(), KiROUND(), CONVERT_SETTINGS::m_DeleteOriginals, m_frame, CONVERT_SETTINGS::m_Gap, ZONE_SETTINGS::m_Layers, BOARD_DESIGN_SETTINGS::m_LineThickness, CONVERT_SETTINGS::m_LineWidth, ZONE_SETTINGS::m_Name, m_selectionTool, CONVERT_SETTINGS::m_Strategy, m_userSettings, makePolysFromChainedSegs(), makePolysFromClosedGraphics(), makePolysFromOpenGraphics(), ZONE::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, POLY, BOARD_COMMIT::Push(), COMMIT::Remove(), PCB_SELECTION_TOOL::RequestSelection(), ZONE_SETTINGS::SetIsRuleArea(), BOARD_ITEM::SetLayer(), EDA_SHAPE::SetPolyShape(), EDA_SHAPE::SetShape(), PCB_SHAPE::SetStroke(), SHAPE_POLY_SET::Simplify(), SKIP_STRUCT, SOLID, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 185 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(), and ZONE_CREATE_HELPER::setUniquePriority().

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 121 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 144 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(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), 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 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

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

Referenced by TOOL_BASE::getModel().

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 134 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(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getStartEndPoints()

std::optional< SEG > CONVERT_TOOL::getStartEndPoints ( EDA_ITEM *  aItem )

staticprivate

Retrieve the start and end points for a generic item.

Parameters

aItem

is an item that has a start and end point.

Returns

a segment from start to end, or std::nullopt if invalid.

Definition at line 1135 of file convert_tool.cpp.

{
 switch( aItem->Type() )
 {
 case PCB_SHAPE_T:
 case PCB_FP_SHAPE_T:
 {
 PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( aItem );
 
 switch( shape->GetShape() )
 {
  case SHAPE_T::SEGMENT:
 case SHAPE_T::ARC:
 case SHAPE_T::POLY:
 case SHAPE_T::BEZIER:
 if( shape->GetStart() == shape->GetEnd() )
 return std::nullopt;
 
 return std::make_optional<SEG>( VECTOR2I( shape->GetStart() ),
 VECTOR2I( shape->GetEnd() ) );
 
 default:
 return std::nullopt;
 }
 }
 
 case PCB_TRACE_T:
 {
 PCB_TRACK* line = static_cast<PCB_TRACK*>( aItem );
 return std::make_optional<SEG>( VECTOR2I( line->GetStart() ), VECTOR2I( line->GetEnd() ) );
 }
 
 case PCB_ARC_T:
 {
 PCB_ARC* arc = static_cast<PCB_ARC*>( aItem );
 return std::make_optional<SEG>( VECTOR2I( arc->GetStart() ), VECTOR2I( arc->GetEnd() ) );
 }
 
 default:
 return std::nullopt;
 }
}

References ARC, BEZIER, EDA_SHAPE::GetEnd(), PCB_TRACK::GetEnd(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), PCB_TRACK::GetStart(), PCB_ARC_T, PCB_FP_SHAPE_T, PCB_SHAPE_T, PCB_TRACE_T, POLY, SEGMENT, and EDA_ITEM::Type().

Referenced by makePolysFromChainedSegs().

getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

{
 return m_toolMgr->GetToolHolder();
}

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

Referenced by TOOL_BASE::getEditFrame().

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 EE_INSPECTION_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), Init(), EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), and ALIGN_DISTRIBUTE_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 109 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 EE_POINT_EDITOR::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(), SCH_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EE_SELECTION_TOOL::Reset(), EE_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), EE_SELECTION_TOOL::selectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), EE_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), 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 EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), 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(), SCH_DRAWING_TOOLS::DrawShape(), 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_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), 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(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::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 EDA_3D_CONTROLLER::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), EE_POINT_EDITOR::setTransitions(), EE_SELECTION_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), and ZONE_FILLER_TOOL::setTransitions().

goInternal()

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

privateinherited

Definition at line 70 of file tool_interactive.cpp.

{
 m_toolMgr->ScheduleNextState( this, aState, aConditions );
}

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

Referenced by TOOL_INTERACTIVE::Go().

Init()

bool CONVERT_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 227 of file convert_tool.cpp.

{
 m_selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 m_frame = getEditFrame<PCB_BASE_FRAME>();
 
 // Create a context menu and make it available through selection tool
 m_menu = new CONDITIONAL_MENU( this );
 m_menu->SetIcon( BITMAPS::convert );
 m_menu->SetTitle( _( "Create from Selection" ) );
 
 auto graphicLines = S_C::OnlyTypes( { PCB_SHAPE_LOCATE_SEGMENT_T, PCB_SHAPE_LOCATE_RECT_T,
 PCB_SHAPE_LOCATE_CIRCLE_T, PCB_SHAPE_LOCATE_ARC_T,
 PCB_SHAPE_LOCATE_BEZIER_T } )
 && P_S_C::SameLayer();
 
 auto graphicToTrack = S_C::OnlyTypes( { PCB_SHAPE_LOCATE_SEGMENT_T, PCB_SHAPE_LOCATE_ARC_T } );
 
 auto anyTracks = S_C::MoreThan( 0 ) && S_C::OnlyTypes( { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T } )
 && P_S_C::SameLayer();
 
 auto anyPolys = S_C::OnlyTypes( { PCB_ZONE_T, PCB_FP_ZONE_T,
 PCB_SHAPE_LOCATE_POLY_T, PCB_SHAPE_LOCATE_RECT_T } );
 
 auto canCreateArcs = S_C::Count( 1 )
 && S_C::OnlyTypes( { PCB_TRACE_T, PCB_SHAPE_LOCATE_SEGMENT_T } );
 auto canCreateArray = S_C::MoreThan( 0 );
 auto canCreatePolyType = graphicLines || anyPolys || anyTracks;
 auto canCreateLines = anyPolys;
 auto canCreateTracks = anyPolys || graphicToTrack;
 auto canCreate = canCreatePolyType
 || canCreateLines
 || canCreateTracks
 || canCreateArcs
 || canCreateArray;
 
 m_menu->AddItem( PCB_ACTIONS::convertToPoly, canCreatePolyType );
 m_menu->AddItem( PCB_ACTIONS::convertToZone, canCreatePolyType );
 m_menu->AddItem( PCB_ACTIONS::convertToKeepout, canCreatePolyType );
 m_menu->AddItem( PCB_ACTIONS::convertToLines, canCreateLines );
 m_menu->AppendSeparator();
 
 // Currently the code exists, but tracks are not really existing in footprints
 // only segments on copper layers
 if( m_frame->IsType( FRAME_PCB_EDITOR ) )
 m_menu->AddItem( PCB_ACTIONS::convertToTracks, canCreateTracks );
 
 m_menu->AddItem( PCB_ACTIONS::convertToArc, canCreateArcs );
 
 m_menu->AppendSeparator();
 m_menu->AddItem( PCB_ACTIONS::createArray, canCreateArray );
 
 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
 selToolMenu.AddMenu( m_menu, canCreate, 100 );
 
 return true;
}

References _, CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), convert, PCB_ACTIONS::convertToArc, PCB_ACTIONS::convertToKeepout, PCB_ACTIONS::convertToLines, PCB_ACTIONS::convertToPoly, PCB_ACTIONS::convertToTracks, PCB_ACTIONS::convertToZone, SELECTION_CONDITIONS::Count(), PCB_ACTIONS::createArray, FRAME_PCB_EDITOR, TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), EDA_BASE_FRAME::IsType(), m_frame, m_menu, m_selectionTool, TOOL_BASE::m_toolMgr, SELECTION_CONDITIONS::MoreThan(), SELECTION_CONDITIONS::OnlyTypes(), PCB_ARC_T, PCB_FP_ZONE_T, PCB_SHAPE_LOCATE_ARC_T, PCB_SHAPE_LOCATE_BEZIER_T, PCB_SHAPE_LOCATE_CIRCLE_T, PCB_SHAPE_LOCATE_POLY_T, PCB_SHAPE_LOCATE_RECT_T, PCB_SHAPE_LOCATE_SEGMENT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PCB_SELECTION_CONDITIONS::SameLayer(), ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

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(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

makePolysFromChainedSegs()

SHAPE_POLY_SET CONVERT_TOOL::makePolysFromChainedSegs ( const std::deque< EDA_ITEM * > &  aItems, CONVERT_STRATEGY  aStrategy  )

private

Try to make polygons from chained segments in the selected items.

Polygons are formed from chains of lines/arcs. Each set containing two or more lines/arcs that are connected will be added to the return SHAPE_POLY_SET as an outline. No attempt is made to guess at holes.

Parameters

aItems

is a list of items to process.

Returns

a SHAPE_POLY_SET containing any polygons that were created.

Definition at line 492 of file convert_tool.cpp.

{
 // TODO: This code has a somewhat-similar purpose to ConvertOutlineToPolygon but is slightly
 // different, so this remains a separate algorithm. It might be nice to analyze the dfiferences
 // in requirements and refactor this.
 
 // Using a large epsilon here to allow for sloppy drawing can cause the algorithm to miss very
 // short segments in a converted bezier. So use an epsilon only large enough to cover for
 // rouding errors in the conversion.
 int chainingEpsilon = 100; // max dist from one endPt to next startPt in IU
 
 BOARD_DESIGN_SETTINGS& bds = m_frame->GetBoard()->GetDesignSettings();
 SHAPE_POLY_SET poly;
 
 // Stores pairs of (anchor, item) where anchor == 0 -> SEG.A, anchor == 1 -> SEG.B
 std::map<VECTOR2I, std::vector<std::pair<int, EDA_ITEM*>>> connections;
 std::deque<EDA_ITEM*> toCheck;
 
 auto closeEnough =
 []( VECTOR2I aLeft, VECTOR2I aRight, int aLimit )
 {
 return ( aLeft - aRight ).SquaredEuclideanNorm() <= SEG::Square( aLimit );
 };
 
 auto findInsertionPoint =
 [&]( VECTOR2I aPoint ) -> VECTOR2I
 {
 if( connections.count( aPoint ) )
 return aPoint;
 
 for( const auto& candidatePair : connections )
 {
 if( closeEnough( aPoint, candidatePair.first, chainingEpsilon ) )
 return candidatePair.first;
 }
 
 return aPoint;
 };
 
 for( EDA_ITEM* item : aItems )
 {
 if( std::optional<SEG> seg = getStartEndPoints( item ) )
 {
 toCheck.push_back( item );
 connections[findInsertionPoint( seg->A )].emplace_back( std::make_pair( 0, item ) );
 connections[findInsertionPoint( seg->B )].emplace_back( std::make_pair( 1, item ) );
 }
 }
 
 while( !toCheck.empty() )
 {
 std::vector<BOARD_ITEM*> insertedItems;
 
 EDA_ITEM* candidate = toCheck.front();
 toCheck.pop_front();
 
 if( candidate->GetFlags() & SKIP_STRUCT )
 continue;
 
 SHAPE_LINE_CHAIN outline;
 
 auto insert =
 [&]( EDA_ITEM* aItem, VECTOR2I aAnchor, bool aDirection )
 {
 if( aItem->Type() == PCB_ARC_T
 || ( ( aItem->Type() == PCB_SHAPE_T || aItem->Type() == PCB_FP_SHAPE_T )
 && static_cast<PCB_SHAPE*>( aItem )->GetShape() == SHAPE_T::ARC ) )
 {
 SHAPE_ARC arc;
 
 if( aItem->Type() == PCB_ARC_T )
 {
 PCB_ARC* pcb_arc = static_cast<PCB_ARC*>( aItem );
 arc = *static_cast<SHAPE_ARC*>( pcb_arc->GetEffectiveShape().get() );
 }
 else
 {
 PCB_SHAPE* pcb_shape = static_cast<PCB_SHAPE*>( aItem );
  arc = SHAPE_ARC( pcb_shape->GetStart(), pcb_shape->GetArcMid(),
 pcb_shape->GetEnd(), pcb_shape->GetWidth() );
 }
 
 if( aDirection )
 outline.Append( aAnchor == arc.GetP0() ? arc : arc.Reversed() );
 else
 outline.Insert( 0, aAnchor == arc.GetP0() ? arc : arc.Reversed() );
 
 insertedItems.push_back( static_cast<BOARD_ITEM*>( aItem ) );
 }
 else if( aItem->IsType( { PCB_SHAPE_LOCATE_BEZIER_T } ) )
 {
 PCB_SHAPE* graphic = static_cast<PCB_SHAPE*>( aItem );
 
 if( aAnchor == graphic->GetStart() )
 {
 for( auto it = graphic->GetBezierPoints().begin();
 it != graphic->GetBezierPoints().end();
 ++it )
 {
 if( aDirection )
 outline.Append( *it );
 else
 outline.Insert( 0, *it );
 }
 
 }
 else
 {
 for( auto it = graphic->GetBezierPoints().rbegin();
 it != graphic->GetBezierPoints().rend();
 ++it )
 {
 if( aDirection )
 outline.Append( *it );
 else
 outline.Insert( 0, *it );
 }
 }
 
 insertedItems.push_back( static_cast<BOARD_ITEM*>( aItem ) );
 }
 else if( std::optional<SEG> nextSeg = getStartEndPoints( aItem ) )
 {
 VECTOR2I& point = ( aAnchor == nextSeg->A ) ? nextSeg->B : nextSeg->A;
 
 if( aDirection )
 outline.Append( point );
 else
 outline.Insert( 0, point );
 
 insertedItems.push_back( static_cast<BOARD_ITEM*>( aItem ) );
 }
 };
 
 // aDirection == true for walking "right" and appending to the end of points
 // false for walking "left" and prepending to the beginning
 std::function<void( EDA_ITEM*, VECTOR2I, bool )> process =
 [&]( EDA_ITEM* aItem, VECTOR2I aAnchor, bool aDirection )
 {
 if( aItem->GetFlags() & SKIP_STRUCT )
 return;
 
 aItem->SetFlags( SKIP_STRUCT );
 
 insert( aItem, aAnchor, aDirection );
 
 std::optional<SEG> anchors = getStartEndPoints( aItem );
 wxASSERT( anchors );
 
 VECTOR2I nextAnchor = ( aAnchor == anchors->A ) ? anchors->B : anchors->A;
 
 for( std::pair<int, EDA_ITEM*> pair : connections[nextAnchor] )
 {
 if( pair.second == aItem )
 continue;
 
 process( pair.second, nextAnchor, aDirection );
 }
 };
 
 std::optional<SEG> anchors = getStartEndPoints( candidate );
 wxASSERT( anchors );
 
 // Start with the first object and walk "right"
 // Note if the first object is an arc, we don't need to insert its first point here, the
 // whole arc will be inserted at anchor B inside process()
 if( !( candidate->Type() == PCB_ARC_T
 || ( ( candidate->Type() == PCB_SHAPE_T || candidate->Type() == PCB_FP_SHAPE_T )
 && static_cast<PCB_SHAPE*>( candidate )->GetShape() == SHAPE_T::ARC ) ) )
 {
 insert( candidate, anchors->A, true );
 }
 
 process( candidate, anchors->B, true );
 
 // check for any candidates on the "left"
 EDA_ITEM* left = nullptr;
 
 for( std::pair<int, EDA_ITEM*> possibleLeft : connections[anchors->A] )
 {
 if( possibleLeft.second != candidate )
 {
 left = possibleLeft.second;
 break;
 }
 }
 
 if( left )
 process( left, anchors->A, false );
 
 if( outline.PointCount() < 3
 || !closeEnough( outline.GetPoint( 0 ), outline.GetPoint( -1 ), chainingEpsilon ) )
 {
 for( EDA_ITEM* item : insertedItems )
 item->ClearFlags( SKIP_STRUCT );
 
 continue;
 }
 
 outline.SetClosed( true );
 
 poly.AddOutline( outline );
 
 if( aStrategy == BOUNDING_HULL )
 {
 for( BOARD_ITEM* item : insertedItems )
 {
 item->TransformShapeToPolygon( poly, UNDEFINED_LAYER, 0, bds.m_MaxError,
 ERROR_INSIDE, false );
 }
 }
 
 insertedItems.clear();
 }
 
 return poly;
}

References SHAPE_POLY_SET::AddOutline(), SHAPE_LINE_CHAIN::Append(), ARC, BOUNDING_HULL, ERROR_INSIDE, EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierPoints(), PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), PCB_ARC::GetEffectiveShape(), EDA_SHAPE::GetEnd(), EDA_ITEM::GetFlags(), SHAPE_ARC::GetP0(), SHAPE_LINE_CHAIN::GetPoint(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), getStartEndPoints(), EDA_SHAPE::GetWidth(), SHAPE_LINE_CHAIN::Insert(), EDA_ITEM::IsType(), left, m_frame, BOARD_DESIGN_SETTINGS::m_MaxError, PCB_ARC_T, PCB_FP_SHAPE_T, PCB_SHAPE_T, SHAPE_LINE_CHAIN::PointCount(), process(), SHAPE_ARC::Reversed(), SHAPE_LINE_CHAIN::SetClosed(), EDA_ITEM::SetFlags(), SKIP_STRUCT, SEG::Square(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

Referenced by CreatePolys().

makePolysFromClosedGraphics()

SHAPE_POLY_SET CONVERT_TOOL::makePolysFromClosedGraphics ( const std::deque< EDA_ITEM * > &  aItems, CONVERT_STRATEGY  aStrategy  )

private

Definition at line 762 of file convert_tool.cpp.

{
 BOARD_DESIGN_SETTINGS& bds = m_frame->GetBoard()->GetDesignSettings();
 SHAPE_POLY_SET poly;
 
 for( EDA_ITEM* item : aItems )
 {
 if( item->GetFlags() & SKIP_STRUCT )
 continue;
 
 switch( item->Type() )
 {
 case PCB_SHAPE_T:
 case PCB_FP_SHAPE_T:
 {
 PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( item );
 FILL_T wasFilled = shape->GetFillMode();
 
 if( !shape->IsClosed() )
 continue;
 
 shape->SetFilled( true );
 shape->TransformShapeToPolygon( poly, UNDEFINED_LAYER, 0, bds.m_MaxError, ERROR_INSIDE,
 aStrategy == COPY_LINEWIDTH || aStrategy == CENTERLINE );
 shape->SetFillMode( wasFilled );
 shape->SetFlags( SKIP_STRUCT );
 
 break;
 }
 
 case PCB_ZONE_T:
 case PCB_FP_ZONE_T:
 poly.Append( *static_cast<ZONE*>( item )->Outline() );
 item->SetFlags( SKIP_STRUCT );
 break;
 
 default:
 continue;
 }
 }
 
 return poly;
}

References SHAPE_POLY_SET::Append(), CENTERLINE, COPY_LINEWIDTH, ERROR_INSIDE, PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::IsClosed(), m_frame, BOARD_DESIGN_SETTINGS::m_MaxError, ZONE::Outline(), PCB_FP_SHAPE_T, PCB_FP_ZONE_T, PCB_SHAPE_T, PCB_ZONE_T, EDA_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), SKIP_STRUCT, PCB_SHAPE::TransformShapeToPolygon(), and UNDEFINED_LAYER.

Referenced by CreatePolys().

makePolysFromOpenGraphics()

SHAPE_POLY_SET CONVERT_TOOL::makePolysFromOpenGraphics ( const std::deque< EDA_ITEM * > &  aItems, int  aGap  )

private

Make polygons from graphic shapes and zones.

Parameters

aItems

is a list of items to process.

Returns

a SHAPE_POLY_SET containing any polygons that were created.

Definition at line 712 of file convert_tool.cpp.

{
 BOARD_DESIGN_SETTINGS& bds = m_frame->GetBoard()->GetDesignSettings();
 SHAPE_POLY_SET poly;
 
 for( EDA_ITEM* item : aItems )
 {
 if( item->GetFlags() & SKIP_STRUCT )
 continue;
 
 switch( item->Type() )
 {
 case PCB_SHAPE_T:
 case PCB_FP_SHAPE_T:
 {
 PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( item );
 
 if( shape->IsClosed() )
 continue;
 
 shape->TransformShapeToPolygon( poly, UNDEFINED_LAYER, aGap, bds.m_MaxError,
 ERROR_INSIDE, false );
 shape->SetFlags( SKIP_STRUCT );
 
 break;
 }
 
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 {
 PCB_TRACK* track = static_cast<PCB_TRACK*>( item );
 
 track->TransformShapeToPolygon( poly, UNDEFINED_LAYER, aGap, bds.m_MaxError,
 ERROR_INSIDE, false );
 track->SetFlags( SKIP_STRUCT );
 
 break;
 }
 
 default:
 continue;
 }
 }
 
 return poly;
}

References ERROR_INSIDE, PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), EDA_SHAPE::IsClosed(), m_frame, BOARD_DESIGN_SETTINGS::m_MaxError, PCB_ARC_T, PCB_FP_SHAPE_T, PCB_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, EDA_ITEM::SetFlags(), SKIP_STRUCT, PCB_SHAPE::TransformShapeToPolygon(), PCB_TRACK::TransformShapeToPolygon(), and UNDEFINED_LAYER.

Referenced by CreatePolys().

Reset()

void CONVERT_TOOL::Reset ( RESET_REASON  aReason )

inlineoverridevirtual

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 44 of file convert_tool.h.

{}

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 63 of file tool_interactive.cpp.

{
 m_toolMgr->ClearTransitions( this );
 setTransitions();
}

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

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

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

Referenced by DRAWING_TOOL::PlaceText().

SegmentToArc()

int CONVERT_TOOL::SegmentToArc

(

const TOOL_EVENT &

aEvent

)

Convert selected segment (graphic or track) to an arc of the same type.

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

It is called every time tool is reset or finished.

Definition at line 1047 of file convert_tool.cpp.

{
 auto& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( !( item->Type() == PCB_SHAPE_T ||
 item->Type() == PCB_TRACE_T ||
 item->Type() == PCB_FP_SHAPE_T ) )
 {
 aCollector.Remove( item );
 }
 }
 } );
 
 EDA_ITEM* source = selection.Front();
 VECTOR2I start, end, mid;
 
 // Offset the midpoint along the normal a little bit so that it's more obviously an arc
 const double offsetRatio = 0.1;
 
 if( std::optional<SEG> seg = getStartEndPoints( source ) )
 {
 start = seg->A;
 end = seg->B;
 
 VECTOR2I normal = ( seg->B - seg->A ).Perpendicular().Resize( offsetRatio * seg->Length() );
 mid = seg->Center() + normal;
 }
 else
 {
 return -1;
 }
 
 PCB_BASE_EDIT_FRAME* frame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 BOARD_ITEM_CONTAINER* parent = frame->GetModel();
 
 BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( source );
 
 // Don't continue processing if we don't actually have a board item
 if( !boardItem )
 return 0;
 
 PCB_LAYER_ID layer = boardItem->GetLayer();
 
 BOARD_COMMIT commit( m_frame );
 
 if( source->Type() == PCB_SHAPE_T || source->Type() == PCB_FP_SHAPE_T )
 {
 PCB_SHAPE* line = static_cast<PCB_SHAPE*>( source );
 PCB_SHAPE* arc = new PCB_SHAPE( parent, SHAPE_T::ARC );
 
 VECTOR2I center = CalcArcCenter( start, mid, end );
 
 arc->SetFilled( false );
 arc->SetLayer( layer );
 arc->SetStroke( line->GetStroke() );
 
 arc->SetCenter( VECTOR2I( center ) );
 arc->SetStart( VECTOR2I( start ) );
 arc->SetEnd( VECTOR2I( end ) );
 
 commit.Add( arc );
 }
 else
 {
 wxASSERT( source->Type() == PCB_TRACE_T );
 PCB_TRACK* line = static_cast<PCB_TRACK*>( source );
 PCB_ARC* arc = new PCB_ARC( parent );
 
 arc->SetLayer( layer );
 arc->SetWidth( line->GetWidth() );
 arc->SetStart( VECTOR2I( start ) );
 arc->SetMid( VECTOR2I( mid ) );
 arc->SetEnd( VECTOR2I( end ) );
 
 commit.Add( arc );
 }
 
 commit.Push( _( "Create arc from line segment" ) );
 
 return 0;
}

References COLLECTOR::GetCount(), m_selectionTool, and PCB_SELECTION_TOOL::RequestSelection().

Referenced by setTransitions().

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 SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setTransitions()

void CONVERT_TOOL::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 1179 of file convert_tool.cpp.

{
 Go( &CONVERT_TOOL::CreatePolys, PCB_ACTIONS::convertToPoly.MakeEvent() );
 Go( &CONVERT_TOOL::CreatePolys, PCB_ACTIONS::convertToZone.MakeEvent() );
 Go( &CONVERT_TOOL::CreatePolys, PCB_ACTIONS::convertToKeepout.MakeEvent() );
 Go( &CONVERT_TOOL::CreateLines, PCB_ACTIONS::convertToLines.MakeEvent() );
 Go( &CONVERT_TOOL::CreateLines, PCB_ACTIONS::convertToTracks.MakeEvent() );
 Go( &CONVERT_TOOL::SegmentToArc, PCB_ACTIONS::convertToArc.MakeEvent() );
}

References PCB_ACTIONS::convertToArc, PCB_ACTIONS::convertToKeepout, PCB_ACTIONS::convertToLines, PCB_ACTIONS::convertToPoly, PCB_ACTIONS::convertToTracks, PCB_ACTIONS::convertToZone, CreateLines(), CreatePolys(), TOOL_INTERACTIVE::Go(), and SegmentToArc().

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

Member Data Documentation

m_frame

PCB_BASE_FRAME* CONVERT_TOOL::m_frame

private

Definition at line 102 of file convert_tool.h.

Referenced by CreatePolys(), Init(), makePolysFromChainedSegs(), makePolysFromClosedGraphics(), and makePolysFromOpenGraphics().

m_menu

CONDITIONAL_MENU* CONVERT_TOOL::m_menu

private

Definition at line 101 of file convert_tool.h.

Referenced by Init(), and ~CONVERT_TOOL().

m_selectionTool

PCB_SELECTION_TOOL* CONVERT_TOOL::m_selectionTool

private

Definition at line 100 of file convert_tool.h.

Referenced by CreateLines(), CreatePolys(), Init(), and SegmentToArc().

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

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_EDIT_TOOL::AutoplaceFields(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), MICROWAVE_TOOL::createInductorBetween(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), 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(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::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(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_SELECTION_TOOL::ExitGroup(), 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(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EE_TOOL_BASE< T >::Init(), SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), POSITION_RELATIVE_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(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::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::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), EE_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), EE_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), EE_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(), SCH_EDIT_TOOL::Swap(), EE_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSelected(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), EE_POINT_EDITOR::updateParentItem(), 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 214 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 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

m_userSettings

CONVERT_SETTINGS CONVERT_TOOL::m_userSettings

private

Definition at line 103 of file convert_tool.h.

Referenced by CONVERT_TOOL(), and CreatePolys().

---

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

• convert_tool.h
• convert_tool.cpp