MICROWAVE_TOOL Class Reference

Tool responsible for adding microwave features to PCBs. More...

#include <microwave_tool.h>

Inheritance diagram for MICROWAVE_TOOL:

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

Public Member Functions
	MICROWAVE_TOOL ()
	~MICROWAVE_TOOL ()
	React to model/view changes. More...
void	Reset (RESET_REASON aReason) override
	Bind handlers to corresponding TOOL_ACTIONs. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
virtual bool	Init () override
	Init() is called once upon a registration of the tool. More...
void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor() More...
bool	IsFootprintEditor () const
void	SetIsBoardEditor (bool aEnabled)
bool	IsBoardEditor () const
virtual bool	Is45Limited () const
	Should the tool use its 45° mode option? 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 Types
enum	INTERACTIVE_PLACEMENT_OPTIONS { IPO_ROTATE = 0x01 , IPO_FLIP = 0x02 , IPO_SINGLE_CLICK = 0x04 , IPO_REPEAT = 0x08 }
	Options for placing items interactively. More...

Protected Member Functions
void	doInteractiveItemPlacement (const TOOL_EVENT &aTool, INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE|IPO_FLIP|IPO_REPEAT)
	Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc. More...
KIGFX::PCB_VIEW *	view () const
KIGFX::VIEW_CONTROLS *	controls () const
PCB_BASE_EDIT_FRAME *	frame () const
BOARD *	board () const
FOOTPRINT *	footprint () const
PCBNEW_SETTINGS::DISPLAY_OPTIONS &	displayOptions () const
PCB_DRAW_PANEL_GAL *	canvas () const
const PCB_SELECTION &	selection () const
PCB_SELECTION &	selection ()
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
bool	m_isFootprintEditor
bool	m_isBoardEditor
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
int	addMicrowaveFootprint (const TOOL_EVENT &aEvent)
	< Main interactive tool More...
void	createInductorBetween (const VECTOR2I &aStart, const VECTOR2I &aEnd)
	Draw a microwave inductor interactively. More...
int	drawMicrowaveInductor (const TOOL_EVENT &aEvent)
FOOTPRINT *	createFootprint (MICROWAVE_FOOTPRINT_SHAPE aFootprintShape)
	Create a footprint "GAP" or "STUB" used in micro wave designs. More...
FOOTPRINT *	createPolygonShape ()
FOOTPRINT *	createMicrowaveInductor (MICROWAVE_INDUCTOR_PATTERN &aPattern, wxString &aErrorMessage)
	Create an S-shaped coil footprint for microwave applications. More...
FOOTPRINT *	createBaseFootprint (const wxString &aValue, int aTextSize, int aPadCount)
	Create a basic footprint for micro wave applications. More...
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

Detailed Description

Tool responsible for adding microwave features to PCBs.

Definition at line 56 of file microwave_tool.h.

Member Enumeration Documentation

INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

Enumerator
IPO_ROTATE	Handle the rotate action in the loop by calling the item's rotate method.
IPO_FLIP	Handle flip action in the loop by calling the item's flip method.
IPO_SINGLE_CLICK	Create an item immediately on placement starting, otherwise show the pencil cursor until the item is created.
IPO_REPEAT	Allow repeat placement of the item.

Definition at line 121 of file pcb_tool_base.h.

 {
 IPO_ROTATE = 0x01,
 
 IPO_FLIP = 0x02,
 
 IPO_SINGLE_CLICK = 0x04,
 
 IPO_REPEAT = 0x08
 };

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

MICROWAVE_TOOL()

MICROWAVE_TOOL::MICROWAVE_TOOL

(

)

Definition at line 40 of file microwave_tool.cpp.

 :
 PCB_TOOL_BASE( "pcbnew.MicrowaveTool" )
{
}

~MICROWAVE_TOOL()

MICROWAVE_TOOL::~MICROWAVE_TOOL

(

)

React to model/view changes.

Definition at line 46 of file microwave_tool.cpp.

{}

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

addMicrowaveFootprint()

int MICROWAVE_TOOL::addMicrowaveFootprint ( const TOOL_EVENT &  aEvent )

private

< Main interactive tool

Create an inductor between the two points

Definition at line 55 of file microwave_tool.cpp.

{
 struct MICROWAVE_PLACER : public INTERACTIVE_PLACER_BASE
 {
 MICROWAVE_PLACER( MICROWAVE_TOOL* aTool, MICROWAVE_FOOTPRINT_SHAPE aType ) :
 m_tool( aTool ),
 m_itemType( aType )
 { };
 
 virtual ~MICROWAVE_PLACER()
 {
 }
 
 std::unique_ptr<BOARD_ITEM> CreateItem() override
 {
 switch( m_itemType )
 {
 case MICROWAVE_FOOTPRINT_SHAPE::GAP:
 case MICROWAVE_FOOTPRINT_SHAPE::STUB:
 case MICROWAVE_FOOTPRINT_SHAPE::STUB_ARC:
 return std::unique_ptr<FOOTPRINT>( m_tool->createFootprint( m_itemType ) );
 
 case MICROWAVE_FOOTPRINT_SHAPE::FUNCTION_SHAPE:
 return std::unique_ptr<FOOTPRINT>( m_tool->createPolygonShape() );
 
 default:
 return std::unique_ptr<FOOTPRINT>();
 };
 }
 
 private:
 MICROWAVE_TOOL* m_tool;
 MICROWAVE_FOOTPRINT_SHAPE m_itemType;
 };
 
 MICROWAVE_PLACER placer( this, aEvent.Parameter<MICROWAVE_FOOTPRINT_SHAPE>() );
 
 doInteractiveItemPlacement( aEvent, &placer, _( "Place microwave feature" ),
 IPO_REPEAT | IPO_ROTATE | IPO_FLIP );
 
 return 0;
}

References _, PCB_TOOL_BASE::doInteractiveItemPlacement(), FUNCTION_SHAPE, GAP, PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, TOOL_EVENT::Parameter(), STUB, and STUB_ARC.

Referenced by setTransitions().

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

board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 170 of file pcb_tool_base.h.

{ return getModel<BOARD>(); }

Referenced by PCB_CONTROL::AppendBoard(), BOARD_EDITOR_CONTROL::AssignNetclass(), AUTOPLACE_TOOL::autoplace(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), BOARD_INSPECTION_TOOL::ClearHighlight(), EDIT_TOOL::copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), createInductorBetween(), ROUTER_TOOL::CustomTrackWidthDialog(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), PCB_TOOL_BASE::footprint(), GROUP_TOOL::Group(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::Init(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), PCB_CONTROL::pruneItemLayers(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), PAD_TOOL::RecombinePad(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::unfilledZoneCheck(), GROUP_TOOL::Ungroup(), ROUTER_TOOL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterLayerSwitch(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 310 of file pcb_tool_base.cpp.

{
 return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
}

References PCB_TOOL_BASE::frame(), and PCB_BASE_FRAME::GetCanvas().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickReferencePoint(), PCB_CONTROL::RatsnestModeCycle(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

controls()

KIGFX::VIEW_CONTROLS * PCB_TOOL_BASE::controls ( ) const

inlineprotectedinherited

Definition at line 160 of file pcb_tool_base.h.

 {
 return getViewControls();
 }

References TOOL_BASE::getViewControls().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), drawMicrowaveInductor(), DRAWING_TOOL::DrawZone(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::handleLayerSwitch(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), BOARD_EDITOR_CONTROL::PlaceFootprint(), ROUTER_TOOL::prepareInteractive(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

createBaseFootprint()

FOOTPRINT * MICROWAVE_TOOL::createBaseFootprint ( const wxString &  aValue, int  aTextSize, int  aPadCount  )

private

Create a basic footprint for micro wave applications.

The default pad settings are: PAD_ATTRIB::SMD, rectangular, H size = V size = current track width.

Parameters

aValue	is the text value.
aTextSize	is the size of ref and value texts ( <= 0 to use board default values ).
aPadCount	is number of pads.

Returns

the new footprint.

Definition at line 190 of file microwave_footprint.cpp.

{
 PCB_EDIT_FRAME& editFrame = *getEditFrame<PCB_EDIT_FRAME>();
 
 FOOTPRINT* footprint = editFrame.CreateNewFootprint( aValue, true );
 
 footprint->SetAttributes( FP_EXCLUDE_FROM_POS_FILES | FP_EXCLUDE_FROM_BOM );
 
 if( aTextSize > 0 )
 {
 footprint->Reference().SetTextSize( VECTOR2I( aTextSize, aTextSize ) );
 footprint->Reference().SetTextThickness( aTextSize / 5 );
 footprint->Value().SetTextSize( VECTOR2I( aTextSize, aTextSize ) );
 footprint->Value().SetTextThickness( aTextSize / 5 );
 }
 
 // Create 2 pads used in gaps and stubs. The gap is between these 2 pads
 // the stub is the pad 2
 int pad_num = 1;
 
 while( aPadCount-- )
 {
 PAD* pad = new PAD( footprint );
 
 footprint->Add( pad, ADD_MODE::INSERT );
 
 int tw = editFrame.GetDesignSettings().GetCurrentTrackWidth();
 pad->SetSize( VECTOR2I( tw, tw ) );
 
 pad->SetPosition( footprint->GetPosition() );
 pad->SetShape( PAD_SHAPE::RECT );
 pad->SetAttribute( PAD_ATTRIB::SMD );
 pad->SetLayerSet( F_Cu );
 
 pad->SetNumber( wxString::Format( wxT( "%d" ), pad_num ) );
 pad_num++;
 }
 
 return footprint;
}

References FOOTPRINT::Add(), PCB_BASE_FRAME::CreateNewFootprint(), F_Cu, PCB_TOOL_BASE::footprint(), Format(), FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), PCB_BASE_FRAME::GetDesignSettings(), FOOTPRINT::GetPosition(), INSERT, pad, PAD, RECT, FOOTPRINT::Reference(), FOOTPRINT::SetAttributes(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), SMD, and FOOTPRINT::Value().

Referenced by createFootprint().

createFootprint()

FOOTPRINT * MICROWAVE_TOOL::createFootprint ( MICROWAVE_FOOTPRINT_SHAPE  aFootprintShape )

private

Create a footprint "GAP" or "STUB" used in micro wave designs.

This footprint has 2 pads: PAD_ATTRIB::SMD, rectangular, H size = V size = current track width. the "gap" is isolation created between this 2 pads

Parameters

aComponentShape

is the component to create.

Returns

the new footprint.

Definition at line 34 of file microwave_footprint.cpp.

{
 int oX;
 PAD* pad;
 FOOTPRINT* footprint;
 wxString msg;
 wxString cmp_name;
 int pad_count = 2;
 EDA_ANGLE angle = ANGLE_0;
 
 PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();
 
 // Ref and value text size (O = use board default value.
 // will be set to a value depending on the footprint size, if possible
 int text_size = 0;
 
 // Enter the size of the gap or stub
 int gap_size = editFrame->GetDesignSettings().GetCurrentTrackWidth();
 
 switch( aFootprintShape )
 {
 case MICROWAVE_FOOTPRINT_SHAPE::GAP:
 msg = _( "Gap Size:" );
 cmp_name = wxT( "muwave_gap" );
 text_size = gap_size;
 break;
 
 case MICROWAVE_FOOTPRINT_SHAPE::STUB:
 msg = _( "Stub Size:" );
 cmp_name = wxT( "muwave_stub" );
 text_size = gap_size;
 pad_count = 2;
 break;
 
 case MICROWAVE_FOOTPRINT_SHAPE::STUB_ARC:
 msg = _( "Arc Stub Radius Value:" );
 cmp_name = wxT( "muwave_arcstub" );
 pad_count = 1;
 break;
 
 default:
 msg = wxT( "???" );
 break;
 }
 
 wxString value = editFrame->StringFromValue( gap_size );
 WX_TEXT_ENTRY_DIALOG dlg( editFrame, msg, _( "Create Microwave Footprint" ), value );
 
 if( dlg.ShowQuasiModal() != wxID_OK )
 return nullptr; // cancelled by user
 
 value = dlg.GetValue();
 gap_size = editFrame->ValueFromString( value );
 
 bool abort = false;
 
 if( aFootprintShape == MICROWAVE_FOOTPRINT_SHAPE::STUB_ARC )
 {
 msg = wxT( "0.0" );
 WX_TEXT_ENTRY_DIALOG angledlg( editFrame, _( "Angle in degrees:" ),
 _( "Create Microwave Footprint" ), msg );
 
 if( angledlg.ShowQuasiModal() != wxID_OK )
 return nullptr; // cancelled by user
 
 msg = angledlg.GetValue();
 
 double fval;
 
 if( !msg.ToDouble( &fval ) )
 {
 DisplayError( editFrame, _( "Incorrect number, abort" ) );
 abort = true;
 }
 
 angle = EDA_ANGLE( fval, DEGREES_T );
 
 if( angle < ANGLE_0 )
 angle = -angle;
 
 if( angle > ANGLE_180 )
 angle = ANGLE_180;
 }
 
 if( abort )
 return nullptr;
 
 footprint = createBaseFootprint( cmp_name, text_size, pad_count );
 auto it = footprint->Pads().begin();
 pad = *it;
 
 switch( aFootprintShape )
 {
 case MICROWAVE_FOOTPRINT_SHAPE::GAP: //Gap :
 oX = -( gap_size + pad->GetSize().x ) / 2;
 pad->SetX0( oX );
 
 pad->SetX( pad->GetPos0().x + pad->GetPosition().x );
 
 pad = *( it + 1 );
 
 pad->SetX0( oX + gap_size + pad->GetSize().x );
 pad->SetX( pad->GetPos0().x + pad->GetPosition().x );
 break;
 
 case MICROWAVE_FOOTPRINT_SHAPE::STUB: //Stub :
 pad->SetNumber( wxT( "1" ) );
 pad = *( it + 1 );
 pad->SetY0( -( gap_size + pad->GetSize().y ) / 2 );
 pad->SetSize( VECTOR2I( pad->GetSize().x, gap_size ) );
 pad->SetY( pad->GetPos0().y + pad->GetPosition().y );
 break;
 
 case MICROWAVE_FOOTPRINT_SHAPE::STUB_ARC: // Arc Stub created by a polygonal approach:
 {
 pad->SetShape( PAD_SHAPE::CUSTOM );
 pad->SetAnchorPadShape( PAD_SHAPE::RECT );
 
 int numPoints = ( angle.AsDegrees() / 5.0 ) + 3;
 std::vector<VECTOR2I> polyPoints;
 polyPoints.reserve( numPoints );
 
 polyPoints.emplace_back( VECTOR2I( 0, 0 ) );
 
 EDA_ANGLE theta = -angle / 2;
 
 for( int ii = 1; ii < numPoints - 1; ii++ )
 {
 VECTOR2I pt( 0, -gap_size );
 RotatePoint( &pt.x, &pt.y, theta );
 polyPoints.push_back( pt );
 
 theta += EDA_ANGLE( 5.0, DEGREES_T );
 
 if( theta > angle / 2 )
 theta = angle / 2;
 }
 
 // Close the polygon:
 polyPoints.push_back( polyPoints[0] );
 
 pad->AddPrimitivePoly( polyPoints, 0, true ); // add a polygonal basic shape
 break;
 }
 
 default:
 break;
 }
 
 // Update the footprint and board
 editFrame->OnModify();
 
 return footprint;
}

References _, PNS::angle(), ANGLE_0, ANGLE_180, createBaseFootprint(), CUSTOM, DEGREES_T, DisplayError(), PCB_TOOL_BASE::footprint(), GAP, BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), PCB_BASE_FRAME::GetDesignSettings(), WX_TEXT_ENTRY_DIALOG::GetValue(), PCB_EDIT_FRAME::OnModify(), pad, FOOTPRINT::Pads(), RECT, RotatePoint(), DIALOG_SHIM::ShowQuasiModal(), UNITS_PROVIDER::StringFromValue(), STUB, STUB_ARC, UNITS_PROVIDER::ValueFromString(), VECTOR2< T >::x, and VECTOR2< T >::y.

createInductorBetween()

void MICROWAVE_TOOL::createInductorBetween ( const VECTOR2I &  aStart, const VECTOR2I &  aEnd  )

private

Draw a microwave inductor interactively.

Definition at line 288 of file microwave_inductor.cpp.

{
 PCB_EDIT_FRAME& editFrame = *getEditFrame<PCB_EDIT_FRAME>();
 
 MICROWAVE_INDUCTOR_PATTERN pattern;
 
 pattern.m_Width = board()->GetDesignSettings().GetCurrentTrackWidth();
 
 pattern.m_Start = { aStart.x, aStart.y };
 pattern.m_End = { aEnd.x, aEnd.y };
 
 wxString errorMessage;
 
 auto inductorFP = std::unique_ptr<FOOTPRINT>( createMicrowaveInductor( pattern, errorMessage ) );
 
 // on any error, report if we can
 if ( !inductorFP || !errorMessage.IsEmpty() )
 {
 if ( !errorMessage.IsEmpty() )
 editFrame.ShowInfoBarError( errorMessage );
 }
 else
 {
 // at this point, we can save the footprint
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, inductorFP.get() );
 
 BOARD_COMMIT commit( this );
 commit.Add( inductorFP.release() );
 commit.Push( _("Add microwave inductor" ) );
 }
}

References _, COMMIT::Add(), PCB_TOOL_BASE::board(), createMicrowaveInductor(), SIM_MODEL_SERIALIZER_GRAMMAR::errorMessage, BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD::GetDesignSettings(), MICROWAVE_INDUCTOR_PATTERN::m_End, MICROWAVE_INDUCTOR_PATTERN::m_Start, TOOL_BASE::m_toolMgr, MICROWAVE_INDUCTOR_PATTERN::m_Width, BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectItem, EDA_BASE_FRAME::ShowInfoBarError(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawMicrowaveInductor().

createMicrowaveInductor()

FOOTPRINT * MICROWAVE_TOOL::createMicrowaveInductor ( MICROWAVE_INDUCTOR_PATTERN &  aPattern, wxString &  aErrorMessage  )

private

Create an S-shaped coil footprint for microwave applications.

Definition at line 321 of file microwave_inductor.cpp.

{
 /* Build a microwave inductor footprint.
 * - Length Mself.lng
 * - Extremities Mself.m_Start and Mself.m_End
 * We must determine:
 * Mself.nbrin = number of segments perpendicular to the direction
 * (The coil nbrin will demicercles + 1 + 2 1 / 4 circle)
 * Mself.lbrin = length of a strand
 * Mself.radius = radius of rounded parts of the coil
 * Mself.delta = segments extremities connection between him and the coil even
 *
 * The equations are
 * Mself.m_Size.x = 2 * Mself.radius + Mself.lbrin
 * Mself.m_Size.y * Mself.delta = 2 + 2 * Mself.nbrin * Mself.radius
 * Mself.lng = 2 * Mself.delta / / connections to the coil
 + (Mself.nbrin-2) * Mself.lbrin / / length of the strands except 1st and last
 + (Mself.nbrin 1) * (PI * Mself.radius) / / length of rounded
 * Mself.lbrin + / 2 - Melf.radius * 2) / / length of 1st and last bit
 *
 * The constraints are:
 * Nbrin >= 2
 * Mself.radius < Mself.m_Size.x
 * Mself.m_Size.y = Mself.radius * 4 + 2 * Mself.raccord
 * Mself.lbrin> Mself.radius * 2
 *
 * The calculation is conducted in the following way:
 * Initially:
 * Nbrin = 2
 * Radius = 4 * m_Size.x (arbitrarily fixed value)
 * Then:
 * Increasing the number of segments to the desired length
 * (Radius decreases if necessary)
 */
 
 PAD* pad;
 PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();
 
 VECTOR2I pt = aInductorPattern.m_End - aInductorPattern.m_Start;
 int min_len = KiROUND( EuclideanNorm( pt ) );
 aInductorPattern.m_Length = min_len;
 
 // Enter the desired length.
 wxString  msg = editFrame->StringFromValue( aInductorPattern.m_Length );
 WX_TEXT_ENTRY_DIALOG dlg( editFrame, _( "Length of Trace:" ), wxEmptyString, msg );
 
 if( dlg.ShowQuasiModal() != wxID_OK )
 return nullptr; // canceled by user
 
 aInductorPattern.m_Length = editFrame->ValueFromString( dlg.GetValue() );
 
 // Control values (ii = minimum length)
 if( aInductorPattern.m_Length < min_len )
 {
 aErrorMessage = _( "Requested length < minimum length" );
 return nullptr;
 }
 
 // Calculate the elements.
 std::vector<VECTOR2I> buffer;
 const INDUCTOR_S_SHAPE_RESULT res = BuildCornersList_S_Shape( buffer, aInductorPattern.m_Start,
 aInductorPattern.m_End,
 aInductorPattern.m_Length,
 aInductorPattern.m_Width );
 
 switch( res )
 {
 case INDUCTOR_S_SHAPE_RESULT::TOO_LONG:
 aErrorMessage = _( "Requested length too large" );
 return nullptr;
 case INDUCTOR_S_SHAPE_RESULT::TOO_SHORT:
 aErrorMessage = _( "Requested length too small" );
 return nullptr;
 case INDUCTOR_S_SHAPE_RESULT::NO_REPR:
 aErrorMessage = _( "Requested length can't be represented" );
 return nullptr;
 case INDUCTOR_S_SHAPE_RESULT::OK:
 break;
 }
 
 // Generate footprint. the value is also used as footprint name.
 msg = wxT( "L" );
 WX_TEXT_ENTRY_DIALOG cmpdlg( editFrame, _( "Component Value:" ), wxEmptyString, msg );
 cmpdlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &msg ) );
 
 if( ( cmpdlg.ShowQuasiModal() != wxID_OK ) || msg.IsEmpty() )
 return nullptr; // Aborted by user
 
 FOOTPRINT* footprint = editFrame->CreateNewFootprint( msg, true );
 
 footprint->SetFPID( LIB_ID( wxEmptyString, wxT( "mw_inductor" ) ) );
 footprint->SetAttributes( FP_EXCLUDE_FROM_POS_FILES | FP_EXCLUDE_FROM_BOM );
 footprint->ClearFlags();
 footprint->SetPosition( aInductorPattern.m_End );
 
 // Generate segments
 for( unsigned jj = 1; jj < buffer.size(); jj++ )
 {
 FP_SHAPE* seg = new FP_SHAPE( footprint, SHAPE_T::SEGMENT );
 seg->SetStart( buffer[jj - 1] );
 seg->SetEnd( buffer[jj] );
 seg->SetStroke( STROKE_PARAMS( aInductorPattern.m_Width, PLOT_DASH_TYPE::SOLID ) );
 seg->SetLayer( footprint->GetLayer() );
 seg->SetStart0( seg->GetStart() - footprint->GetPosition() );
 seg->SetEnd0( seg->GetEnd() - footprint->GetPosition() );
 footprint->Add( seg );
 }
 
 // Place a pad on each end of coil.
 pad = new PAD( footprint );
 
 footprint->Add( pad );
 
 pad->SetNumber( wxT( "1" ) );
 pad->SetPosition( aInductorPattern.m_End );
 pad->SetPos0( pad->GetPosition() - footprint->GetPosition() );
 
 pad->SetSize( VECTOR2I( aInductorPattern.m_Width, aInductorPattern.m_Width ) );
 
 pad->SetLayerSet( LSET( footprint->GetLayer() ) );
 pad->SetAttribute( PAD_ATTRIB::SMD );
 pad->SetShape( PAD_SHAPE::CIRCLE );
 
 PAD* newpad = new PAD( *pad );
 const_cast<KIID&>( newpad->m_Uuid ) = KIID();
 
 footprint->Add( newpad );
 
 pad = newpad;
 pad->SetNumber( wxT( "2" ) );
 pad->SetPosition( aInductorPattern.m_Start );
 pad->SetPos0( pad->GetPosition() - footprint->GetPosition() );
 
 // Modify text positions.
 VECTOR2I refPos( ( aInductorPattern.m_Start.x + aInductorPattern.m_End.x ) / 2,
 ( aInductorPattern.m_Start.y + aInductorPattern.m_End.y ) / 2 );
 
 VECTOR2I valPos = refPos;
 
 refPos.y -= footprint->Reference().GetTextSize().y;
 footprint->Reference().SetPosition( refPos );
 valPos.y += footprint->Value().GetTextSize().y;
 footprint->Value().SetPosition( valPos );
 
 return footprint;
}

References _, FOOTPRINT::Add(), BuildCornersList_S_Shape(), CIRCLE, EDA_ITEM::ClearFlags(), PCB_BASE_FRAME::CreateNewFootprint(), EuclideanNorm(), PCB_TOOL_BASE::footprint(), FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, EDA_SHAPE::GetEnd(), FOOTPRINT::GetLayer(), FOOTPRINT::GetPosition(), EDA_SHAPE::GetStart(), EDA_TEXT::GetTextSize(), WX_TEXT_ENTRY_DIALOG::GetValue(), KiROUND(), MICROWAVE_INDUCTOR_PATTERN::m_End, MICROWAVE_INDUCTOR_PATTERN::m_Length, MICROWAVE_INDUCTOR_PATTERN::m_Start, EDA_ITEM::m_Uuid, MICROWAVE_INDUCTOR_PATTERN::m_Width, NO_REPR, OK, pad, PAD, FOOTPRINT::Reference(), res, SEGMENT, FOOTPRINT::SetAttributes(), EDA_SHAPE::SetEnd(), FP_SHAPE::SetEnd0(), FOOTPRINT::SetFPID(), BOARD_ITEM::SetLayer(), FOOTPRINT::SetPosition(), FP_TEXT::SetPosition(), EDA_SHAPE::SetStart(), FP_SHAPE::SetStart0(), PCB_SHAPE::SetStroke(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), DIALOG_SHIM::ShowQuasiModal(), SMD, SOLID, UNITS_PROVIDER::StringFromValue(), TOO_LONG, TOO_SHORT, FOOTPRINT::Value(), UNITS_PROVIDER::ValueFromString(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by createInductorBetween().

createPolygonShape()

FOOTPRINT * MICROWAVE_TOOL::createPolygonShape ( )

private

Definition at line 285 of file microwave_polygon.cpp.

{
 PAD* pad1;
 PAD* pad2;
 FOOTPRINT* footprint;
 wxString cmp_name;
 int pad_count = 2;
 FP_SHAPE* shape;
 
 PCB_EDIT_FRAME& editFrame = *getEditFrame<PCB_EDIT_FRAME>();
 
 MWAVE_POLYGONAL_SHAPE_DLG dlg( &editFrame, wxDefaultPosition );
 
 int ret = dlg.ShowModal();
 
 if( ret != wxID_OK )
 {
 g_PolyEdges.clear();
 return nullptr;
 }
 
 if( g_PolyShapeType == 2 ) // mirrored
 g_ShapeScaleY = -g_ShapeScaleY;
 
 g_ShapeSize.x = KiROUND( g_ShapeScaleX );
 g_ShapeSize.y = KiROUND( g_ShapeScaleY );
 
 if(( g_ShapeSize.x ) == 0 || ( g_ShapeSize.y == 0 ) )
 {
 editFrame.ShowInfoBarError( _( "Shape has a null size." ) );
 return nullptr;
 }
 
 if( g_PolyEdges.size() == 0 )
 {
 editFrame.ShowInfoBarError( _( "Shape has no points." ) );
 return nullptr;
 }
 
 cmp_name = wxT( "muwave_polygon" );
 
 // Create a footprint with 2 pads, orientation = 0, pos 0
 footprint = createBaseFootprint( cmp_name, 0, pad_count );
 
 // We try to place the footprint anchor to the middle of the shape len
 VECTOR2I offset;
 offset.x = -g_ShapeSize.x / 2;
 
 auto it = footprint->Pads().begin();
 
 pad1 = *it;
 pad1->SetX0( offset.x );
 pad1->SetX( pad1->GetPos0().x );
 
 pad2 = *( ++it );
 pad2->SetX0( offset.x + g_ShapeSize.x );
 pad2->SetX( pad2->GetPos0().x );
 
 // Add a polygonal edge (corners will be added later) on copper layer
 shape = new FP_SHAPE( footprint, SHAPE_T::POLY );
 shape->SetFilled( true );
 shape->SetLayer( F_Cu );
 
 footprint->Add( shape, ADD_MODE::INSERT );
 
 // Get the corner buffer of the polygonal edge
 std::vector<VECTOR2I> polyPoints;
 polyPoints.reserve( g_PolyEdges.size() + 2 );
 
 // Init start point coord:
 polyPoints.emplace_back( VECTOR2I( offset.x, 0 ) );
 
 VECTOR2I last_coordinate;
 
 for( wxRealPoint& pt: g_PolyEdges ) // Copy points
 {
 last_coordinate.x = KiROUND( pt.x * g_ShapeScaleX );
 last_coordinate.y = -KiROUND( pt.y * g_ShapeScaleY );
 last_coordinate += offset;
 polyPoints.push_back( last_coordinate );
 }
 
 // finish the polygonal shape
 if( last_coordinate.y != 0 )
 polyPoints.emplace_back( VECTOR2I( last_coordinate.x, 0 ) );
 
 switch( g_PolyShapeType )
 {
 case 0: // shape from file
 case 2: // shape from file, mirrored (the mirror is already done)
 break;
 
 case 1: // Symmetric shape: add the symmetric (mirrored) shape
 for( int ndx = (int) polyPoints.size() - 1; ndx >= 0; --ndx )
 {
 VECTOR2I pt = polyPoints[ndx];
 pt.y = -pt.y; // mirror about X axis
 polyPoints.push_back( pt );
 }
 
 break;
 }
 
 shape->SetPolyPoints( polyPoints );
 
 // Set the polygon outline thickness to 0, only the polygonal shape is filled
 // without extra thickness.
 shape->SetStroke( STROKE_PARAMS( 0, PLOT_DASH_TYPE::SOLID ) );
 g_PolyEdges.clear();
 
 editFrame.OnModify();
 return footprint;
}

References _, FOOTPRINT::Add(), F_Cu, g_PolyEdges, g_PolyShapeType, g_ShapeScaleX, g_ShapeScaleY, g_ShapeSize, PAD::GetPos0(), INSERT, KiROUND(), PCB_EDIT_FRAME::OnModify(), FOOTPRINT::Pads(), POLY, EDA_SHAPE::SetFilled(), BOARD_ITEM::SetLayer(), EDA_SHAPE::SetPolyPoints(), PCB_SHAPE::SetStroke(), PAD::SetX(), PAD::SetX0(), EDA_BASE_FRAME::ShowInfoBarError(), SOLID, VECTOR2< T >::x, and VECTOR2< T >::y.

displayOptions()

PCBNEW_SETTINGS::DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 305 of file pcb_tool_base.cpp.

{
 return frame()->GetPcbNewSettings()->m_Display;
}

References PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetPcbNewSettings(), and PCBNEW_SETTINGS::m_Display.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_CONTROL::RatsnestModeCycle(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), and PCB_CONTROL::ViaDisplayMode().

doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement ( const TOOL_EVENT &  aTool, INTERACTIVE_PLACER_BASE *  aPlacer, const wxString &  aCommitMessage, int  aOptions = IPO_ROTATE | IPO_FLIP | IPO_REPEAT  )

protectedinherited

Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

More complex interactive processes are not supported here, you should implement a customised event loop for those.

Parameters

aItemCreator	the callable that will attempt to create the item
aCommitMessage	the message used on a successful commit

Definition at line 41 of file pcb_tool_base.cpp.

{
 using namespace std::placeholders;
 std::unique_ptr<BOARD_ITEM> newItem;
 
 frame()->PushTool( aTool );
 
 BOARD_COMMIT commit( frame() );
 
 GetManager()->RunAction( PCB_ACTIONS::selectionClear, true );
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls()->ShowCursor( true );
 controls()->ForceCursorPosition( false );
 // do not capture or auto-pan until we start placing an item
 
 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );
 
 // Add a VIEW_GROUP that serves as a preview for the new item
 PCB_SELECTION preview;
 view()->Add( &preview );
 
 aPlacer->m_board = board();
 aPlacer->m_frame = frame();
 aPlacer->m_modifiers = 0;
 
 auto makeNewItem =
 [&]( VECTOR2I aPosition )
 {
 if( frame()->GetModel() )
 newItem = aPlacer->CreateItem();
 
 if( newItem )
 {
 newItem->SetPosition( aPosition );
 preview.Add( newItem.get() );
 
 if( newItem->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* fp = dyn_cast<FOOTPRINT*>( newItem.get() );
 
 // footprints have more drawable parts
 fp->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
 }
 }
 };
 
 if( aOptions & IPO_SINGLE_CLICK )
 makeNewItem( controls()->GetCursorPosition() );
 
 auto setCursor =
 [&]()
 {
 if( !newItem )
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 else
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PLACE );
 };
 
 // Set initial cursor
 setCursor();
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 
 grid.SetSnap( false ); // Interactive placement tools need to set their own item snaps
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 VECTOR2I cursorPos = grid.BestSnapAnchor( controls()->GetMousePosition(), nullptr );
 
 aPlacer->m_modifiers = evt->Modifier();
 
 auto cleanup =
 [&] ()
 {
 newItem = nullptr;
 preview.Clear();
 view()->Update( &preview );
 controls()->SetAutoPan( false );
 controls()->CaptureCursor( false );
 controls()->ShowCursor( true );
 controls()->ForceCursorPosition( false );
 };
 
 if( evt->IsCancelInteractive() )
 {
 if( aOptions & IPO_SINGLE_CLICK )
 {
 cleanup();
 frame()->PopTool( aTool );
 break;
 }
  else if( newItem )
 {
 cleanup();
 }
 else
 {
 frame()->PopTool( aTool );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( newItem )
 cleanup();
 
 if( evt->IsPointEditor() )
 {
 // don't exit (the point editor runs in the background)
 }
 else if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 break;
 }
 else
 {
 frame()->PopTool( aTool );
 break;
 }
 }
 else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
 {
 if( !newItem )
 {
 // create the item if possible
 makeNewItem( cursorPos );
 
 // no item created, so wait for another click
 if( !newItem )
 continue;
 
 controls()->CaptureCursor( true );
 controls()->SetAutoPan( true );
 }
 else
 {
 BOARD_ITEM* newBoardItem = newItem.release();
 EDA_ITEM_FLAGS oldFlags = newBoardItem->GetFlags();
 
 newBoardItem->ClearFlags();
 
 if( !aPlacer->PlaceItem( newBoardItem, commit ) )
 {
 newBoardItem->SetFlags( oldFlags );
 newItem.reset( newBoardItem );
 continue;
 }
 
 preview.Clear();
 commit.Push( aCommitMessage );
 
 controls()->CaptureCursor( false );
 controls()->SetAutoPan( false );
 controls()->ShowCursor( true );
 
 if( !( aOptions & IPO_REPEAT ) )
 break;
 
 if( aOptions & IPO_SINGLE_CLICK )
 makeNewItem( controls()->GetCursorPosition() );
 
 setCursor();
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsAction( &PCB_ACTIONS::trackViaSizeChanged ) )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else if( newItem && evt->Category() == TC_COMMAND )
 {
 /*
 * Handle any events that can affect the item as we move it around
 */
 if( TOOL_EVT_UTILS::IsRotateToolEvt( *evt ) && ( aOptions & IPO_ROTATE ) )
 {
 EDA_ANGLE rotationAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *frame(), *evt );
 newItem->Rotate( newItem->GetPosition(), rotationAngle );
 view()->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::flip ) && ( aOptions & IPO_FLIP ) )
 {
 newItem->Flip( newItem->GetPosition(), frame()->GetPcbNewSettings()->m_FlipLeftRight );
 view()->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 frame()->OnEditItemRequest( newItem.get() );
 
 // Notify other tools of the changes
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 }
 else if( evt->IsAction( &ACTIONS::refreshPreview ) )
 {
 preview.Clear();
 newItem.reset();
 
 makeNewItem( cursorPos );
 aPlacer->SnapItem( newItem.get() );
 view()->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else if( newItem && evt->IsMotion() )
 {
 // track the cursor
 newItem->SetPosition( cursorPos );
 aPlacer->SnapItem( newItem.get() );
 
 // Show a preview of the item
 view()->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 view()->Remove( &preview );
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls()->SetAutoPan( false );
 controls()->CaptureCursor( false );
 controls()->ForceCursorPosition( false );
}

References TOOL_INTERACTIVE::Activate(), SELECTION::Add(), KIGFX::VIEW_GROUP::Add(), KIGFX::PCB_VIEW::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getView(), grid, PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, PCB_TOOL_BASE::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), PCB_FOOTPRINT_T, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), EDA_ITEM::SetFlags(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

Referenced by addMicrowaveFootprint(), DRAWING_TOOL::DrawVia(), and PAD_TOOL::PlacePad().

drawMicrowaveInductor()

int MICROWAVE_TOOL::drawMicrowaveInductor ( const TOOL_EVENT &  aEvent )

private

Definition at line 108 of file microwave_tool.cpp.

{
 using namespace KIGFX::PREVIEW;
 
 KIGFX::VIEW& view = *getView();
 KIGFX::VIEW_CONTROLS& controls = *getViewControls();
 PCB_EDIT_FRAME& frame = *getEditFrame<PCB_EDIT_FRAME>();
 
 frame.PushTool( aEvent );
 
 auto setCursor =
 [&]()
 {
 frame.GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls.ShowCursor( true );
 controls.CaptureCursor( false );
 controls.SetAutoPan( false );
 // Set initial cursor
 setCursor();
 
 bool originSet = false;
 TWO_POINT_GEOMETRY_MANAGER tpGeomMgr;
 CENTRELINE_RECT_ITEM previewRect( tpGeomMgr, inductorAreaAspect );
 
 previewRect.SetFillColor( inductorAreaFill );
 previewRect.SetStrokeColor( inductorAreaStroke );
 previewRect.SetLineWidth( inductorAreaStrokeWidth );
 view.Add( &previewRect );
 
 while( auto evt = Wait() )
 {
 setCursor();
 VECTOR2I cursorPos = controls.GetCursorPosition();
 
 auto cleanup =
 [&] ()
 {
 originSet = false;
 controls.CaptureCursor( false );
 controls.SetAutoPan( false );
 view.SetVisible( &previewRect, false );
 view.Update( &previewRect, KIGFX::GEOMETRY );
 };
 
 if( evt->IsCancelInteractive() )
 {
 if( originSet )
 cleanup();
 else
 {
 frame.PopTool( aEvent );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( originSet )
 cleanup();
 
 if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 break;
 }
 else
 {
 frame.PopTool( aEvent );
 break;
 }
 }
 // A click or drag starts
 else if( !originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsDrag( BUT_LEFT ) ) )
 {
 tpGeomMgr.SetOrigin( cursorPos );
 tpGeomMgr.SetEnd( cursorPos );
 
 originSet = true;
 controls.CaptureCursor( true );
 controls.SetAutoPan( true );
 }
 // another click after origin set is the end
 // left up is also the end, as you'll only get that after a drag
 else if( originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsMouseUp( BUT_LEFT ) ) )
 {
 // second click, we're done:
 // delegate to the point-to-point inductor creator function
 createInductorBetween( tpGeomMgr.GetOrigin(), tpGeomMgr.GetEnd() );
 
 // start again if needed
 originSet = false;
 controls.CaptureCursor( false );
 controls.SetAutoPan( false );
 
 view.SetVisible( &previewRect, false );
 view.Update( &previewRect, KIGFX::GEOMETRY );
 }
 // any move or drag once the origin was set updates
 // the end point
 else if( originSet && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
 {
 tpGeomMgr.SetAngleSnap( Is45Limited() );
 tpGeomMgr.SetEnd( cursorPos );
 
 view.SetVisible( &previewRect, true );
 view.Update( &previewRect, KIGFX::GEOMETRY );
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 view.Remove( &previewRect );
 
 frame.GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls.CaptureCursor( false );
 controls.SetAutoPan( false );
 return 0;
}

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), ARROW, BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), PCB_TOOL_BASE::controls(), createInductorBetween(), PCB_TOOL_BASE::frame(), KIGFX::GEOMETRY, PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::GetEnd(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::GetOrigin(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), inductorAreaAspect, inductorAreaFill, inductorAreaStroke, inductorAreaStrokeWidth, PCB_TOOL_BASE::Is45Limited(), TOOL_INTERACTIVE::m_menu, PENCIL, TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), KIGFX::PCB_VIEW::Remove(), PCB_TOOL_BASE::selection(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetAngleSnap(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetEnd(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::SetFillColor(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::SetLineWidth(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetOrigin(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::SetStrokeColor(), KIGFX::VIEW::SetVisible(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 172 of file pcb_tool_base.h.

 {
 return board()->GetFirstFootprint();
 }

References PCB_TOOL_BASE::board(), and BOARD::GetFirstFootprint().

Referenced by PCB_CONTROL::AppendBoard(), createBaseFootprint(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), createFootprint(), createMicrowaveInductor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::makeDRCEngine(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), FOOTPRINT_EDITOR_CONTROL::Properties(), PAD_TOOL::pushPadSettings(), PAD_TOOL::RecombinePad(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), and DRAWING_TOOL::SetAnchor().

frame()

PCB_BASE_EDIT_FRAME * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 165 of file pcb_tool_base.h.

 {
 return getEditFrame<PCB_BASE_EDIT_FRAME>();
 }

Referenced by PCB_POINT_EDITOR::addCorner(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), PCB_TOOL_BASE::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), PCB_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MoveExact(), PCB_CONTROL::NetColorModeCycle(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::pushPadSettings(), PCB_CONTROL::RatsnestModeCycle(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SCRIPTING_TOOL::reloadPlugins(), PCB_POINT_EDITOR::removeCorner(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), DRAWING_TOOL::ToggleHV45Mode(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::unfilledZoneCheck(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

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

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(), CONVERT_TOOL::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(), 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(), 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(), setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::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 PCB_TOOL_BASE::Init ( )

overridevirtualinherited

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Reimplemented in SCRIPTING_TOOL, LENGTH_TUNER_TOOL, ROUTER_TOOL, BOARD_EDITOR_CONTROL, BOARD_INSPECTION_TOOL, BOARD_REANNOTATE_TOOL, DRAWING_TOOL, EDIT_TOOL, FOOTPRINT_EDITOR_CONTROL, GLOBAL_EDIT_TOOL, GROUP_TOOL, PAD_TOOL, PCB_POINT_EDITOR, and POSITION_RELATIVE_TOOL.

Definition at line 279 of file pcb_tool_base.cpp.

{
 // A basic context manu. Many (but not all) tools will choose to override this.
 CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
 
 // cancel current tool goes in main context menu at the top if present
 ctxMenu.AddItem( ACTIONS::cancelInteractive, SELECTION_CONDITIONS::ShowAlways, 1 );
 ctxMenu.AddSeparator( 1 );
 
 // Finally, add the standard zoom/grid items
 getEditFrame<PCB_BASE_FRAME>()->AddStandardSubMenus( m_menu );
 
 return true;
}

References CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddSeparator(), ACTIONS::cancelInteractive, TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::m_menu, and SELECTION_CONDITIONS::ShowAlways().

Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns

True if set to use 45°

Definition at line 332 of file pcb_tool_base.cpp.

{
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 
 if( frame()->IsType( FRAME_PCB_EDITOR ) )
 return mgr.GetAppSettings<PCBNEW_SETTINGS>()->m_Use45DegreeLimit;
 else
 return mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>()->m_Use45Limit;
}

References PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), and Pgm().

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), and ZONE_CREATE_HELPER::OnFirstPoint().

IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 109 of file pcb_tool_base.h.

{ return m_isBoardEditor; }

References PCB_TOOL_BASE::m_isBoardEditor.

Referenced by BOARD_COMMIT::BOARD_COMMIT().

IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 106 of file pcb_tool_base.h.

{ return m_isFootprintEditor; }

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PCB_GRID_HELPER::queryVisible(), and EDIT_TOOL::Rotate().

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

Reset()

void MICROWAVE_TOOL::Reset ( RESET_REASON  aReason )

overridevirtual

Bind handlers to corresponding TOOL_ACTIONs.

Reimplemented from PCB_TOOL_BASE.

Definition at line 50 of file microwave_tool.cpp.

{
}

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

selection() [1/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 324 of file pcb_tool_base.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 return selTool->GetSelection();
}

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

selection() [2/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 316 of file pcb_tool_base.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 return selTool->GetSelection();
}

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), AUTOPLACE_TOOL::autoplaceSelected(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::ChangeTrackWidth(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), DRC_TOOL::CrossProbe(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), GROUP_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::FilletLines(), EDIT_TOOL::FilletTracks(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::PackAndMoveFootprints(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), GROUP_TOOL::RemoveFromGroup(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), EDIT_TOOL::Swap(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), PCB_CONTROL::UpdateMessagePanel(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

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

SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool  aEnabled )

inlineinherited

Definition at line 108 of file pcb_tool_base.h.

{ m_isBoardEditor = aEnabled; }

References PCB_TOOL_BASE::m_isBoardEditor.

SetIsFootprintEditor()

void PCB_TOOL_BASE::SetIsFootprintEditor ( bool  aEnabled )

inlineinherited

Function SetIsFootprintEditor()

Toggles edit footprint mode. When enabled, one may select parts of footprints individually (graphics, pads, etc.), so they can be modified.

Parameters

aEnabled

decides if the mode should be enabled.

Definition at line 105 of file pcb_tool_base.h.

{ m_isFootprintEditor = aEnabled; }

References PCB_TOOL_BASE::m_isFootprintEditor.

setTransitions()

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

Reimplemented from PCB_TOOL_BASE.

Definition at line 238 of file microwave_tool.cpp.

{
 Go( &MICROWAVE_TOOL::addMicrowaveFootprint, PCB_ACTIONS::microwaveCreateGap.MakeEvent() );
 Go( &MICROWAVE_TOOL::addMicrowaveFootprint, PCB_ACTIONS::microwaveCreateStub.MakeEvent() );
 Go( &MICROWAVE_TOOL::addMicrowaveFootprint, PCB_ACTIONS::microwaveCreateStubArc.MakeEvent() );
 Go( &MICROWAVE_TOOL::addMicrowaveFootprint,
 PCB_ACTIONS::microwaveCreateFunctionShape.MakeEvent() );
 
 Go( &MICROWAVE_TOOL::drawMicrowaveInductor, PCB_ACTIONS::microwaveCreateLine.MakeEvent() );
}

References addMicrowaveFootprint(), drawMicrowaveInductor(), TOOL_INTERACTIVE::Go(), PCB_ACTIONS::microwaveCreateFunctionShape, PCB_ACTIONS::microwaveCreateGap, PCB_ACTIONS::microwaveCreateLine, PCB_ACTIONS::microwaveCreateStub, and PCB_ACTIONS::microwaveCreateStubArc.

view()

KIGFX::PCB_VIEW * PCB_TOOL_BASE::view ( ) const

inlineprotectedinherited

Definition at line 155 of file pcb_tool_base.h.

 {
 return static_cast<KIGFX::PCB_VIEW*>( getView() );
 }

References TOOL_BASE::getView().

Referenced by AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::doInteractiveItemPlacement(), drawMicrowaveInductor(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), PCB_CONTROL::FlipPcbView(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_CONTROL::TrackDisplayMode(), PCB_POINT_EDITOR::updateItem(), PCB_CONTROL::ViaDisplayMode(), and PCB_CONTROL::ZoneDisplayMode().

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(), 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_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 187 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::IsBoardEditor(), PCB_CONTROL::placeBoardItems(), and PCB_TOOL_BASE::SetIsBoardEditor().

m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 186 of file pcb_tool_base.h.

Referenced by ZONE_CREATE_HELPER::commitZone(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), EDIT_TOOL::Init(), PAD_TOOL::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::IsFootprintEditor(), PCB_POINT_EDITOR::makePoints(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_CONTROL::Print(), PCB_CONTROL::pruneItemLayers(), SCRIPTING_TOOL::reloadPlugins(), EDIT_TOOL::Rotate(), DRAWING_TOOL::SetAnchor(), PCB_TOOL_BASE::SetIsFootprintEditor(), and GROUP_TOOL::Ungroup().

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(), 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(), TOOL_INTERACTIVE::GetToolMenu(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), EE_TOOL_BASE< T >::Init(), SCH_DRAWING_TOOLS::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PAD_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::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_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(), 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::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

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

---

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

• microwave_tool.h
• microwave_footprint.cpp
• microwave_inductor.cpp
• microwave_polygon.cpp
• microwave_tool.cpp