DRAWING_TOOL Class Reference

Tool responsible for drawing graphical elements like lines, arcs, circles, etc. More...

#include <drawing_tool.h>

Inheritance diagram for DRAWING_TOOL:

Public Types
enum class	MODE {   NONE , LINE , RECTANGLE , CIRCLE ,   ARC , IMAGE , TEXT , ANCHOR ,   DXF , DIMENSION , KEEPOUT , ZONE ,   GRAPHIC_POLYGON , VIA }
enum	RESET_REASON { RUN , MODEL_RELOAD , GAL_SWITCH , REDRAW }
	Determine the reason of reset for a tool. More...

Public Member Functions
	DRAWING_TOOL ()
	~DRAWING_TOOL ()
bool	Init () override
	Init() is called once upon a registration of the tool. More...
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
MODE	GetDrawingMode () const
	Return the current drawing mode of the DRAWING_TOOL or #MODE::NONE if not currently in any drawing mode. More...
std::vector< BOARD_ITEM * >	DrawBoardCharacteristics (const VECTOR2I &origin, PCB_LAYER_ID aLayer, bool aDrawNow, VECTOR2I *tablesize)
std::vector< BOARD_ITEM * >	DrawSpecificationStackup (const VECTOR2I &origin, PCB_LAYER_ID aLayer, bool aDrawNow, VECTOR2I *tablesize)
int	PlaceCharacteristics (const TOOL_EVENT &aEvent)
int	PlaceStackup (const TOOL_EVENT &aEvent)
int	DrawLine (const TOOL_EVENT &aEvent)
	Start interactively drawing a line. More...
int	DrawRectangle (const TOOL_EVENT &aEvent)
	Start interactively drawing a rectangle. More...
int	DrawCircle (const TOOL_EVENT &aEvent)
	Start interactively drawing a circle. More...
int	DrawArc (const TOOL_EVENT &aEvent)
	Start interactively drawing an arc. More...
int	PlaceImage (const TOOL_EVENT &aEvent)
	Display a dialog that allows one to select and image then decide where to place the image in the editor. More...
int	PlaceText (const TOOL_EVENT &aEvent)
	Display a dialog that allows one to input text and its settings and then lets the user decide where to place the text in editor. More...
int	DrawDimension (const TOOL_EVENT &aEvent)
	Start interactively drawing a dimension. More...
int	DrawZone (const TOOL_EVENT &aEvent)
	Start interactively drawing a zone. More...
int	DrawVia (const TOOL_EVENT &aEvent)
int	PlaceImportedGraphics (const TOOL_EVENT &aEvent)
	Place a drawing imported from a DXF or SVG file in footprint editor. More...
int	InteractivePlaceWithPreview (const TOOL_EVENT &aEvent, std::vector< BOARD_ITEM * > &aItems, std::vector< BOARD_ITEM * > &aPreview, LSET *aLayers)
	Interactively place a set of BOARD_ITEM. More...
int	SetAnchor (const TOOL_EVENT &aEvent)
	Place the footprint anchor (only in footprint editor). More...
int	ToggleHV45Mode (const TOOL_EVENT &toolEvent)
	Toggle the horizontal/vertical/45-degree constraint for drawing tools. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	SetStroke (const STROKE_PARAMS &aStroke, PCB_LAYER_ID aLayer)
void	UpdateStatusBar () const
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
bool	drawShape (const TOOL_EVENT &aTool, PCB_SHAPE **aGraphic, std::optional< VECTOR2D > aStartingPoint)
	Start drawing a selected shape (i.e. More...
bool	drawArc (const TOOL_EVENT &aTool, PCB_SHAPE **aGraphic, std::optional< VECTOR2D > aStartingPoint)
	Start drawing an arc. More...
bool	getSourceZoneForAction (ZONE_MODE aMode, ZONE **aZone)
	Draw a polygon, that is added as a zone or a keepout area. More...
void	constrainDimension (PCB_DIMENSION_BASE *aDim)
	Force the dimension lime to be drawn on multiple of 45 degrees. More...
VECTOR2I	getClampedDifferenceEnd (const VECTOR2I &aOrigin, const VECTOR2I &aEnd)
	Clamps the end vector to respect numeric limits of difference representation. More...
VECTOR2I	getClampedRadiusEnd (const VECTOR2I &aOrigin, const VECTOR2I &aEnd)
	Clamps the end vector to respect numeric limits of radius representation. More...
int	getSegmentWidth (PCB_LAYER_ID aLayer) const
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

Private Attributes
KIGFX::VIEW *	m_view
KIGFX::VIEW_CONTROLS *	m_controls
BOARD *	m_board
PCB_BASE_EDIT_FRAME *	m_frame
MODE	m_mode
bool	m_inDrawingTool
PCB_LAYER_ID	m_layer
STROKE_PARAMS	m_stroke
TEXT_ATTRIBUTES	m_textAttrs

Static Private Attributes
static const unsigned int	WIDTH_STEP = pcbIUScale.mmToIU( 0.1 )
static const unsigned int	COORDS_PADDING = pcbIUScale.mmToIU( 20 )

Friends
class	ZONE_CREATE_HELPER

Detailed Description

Tool responsible for drawing graphical elements like lines, arcs, circles, etc.

Definition at line 50 of file drawing_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
 };

MODE

enum class DRAWING_TOOL::MODE

strong

Enumerator
NONE
LINE
RECTANGLE
CIRCLE
ARC
IMAGE
TEXT
ANCHOR
DXF
DIMENSION
KEEPOUT
ZONE
GRAPHIC_POLYGON
VIA

Definition at line 63 of file drawing_tool.h.

 {
 NONE,
 LINE,
 RECTANGLE,
 CIRCLE,
 ARC,
 IMAGE,
 TEXT,
 ANCHOR,
 DXF,
 DIMENSION,
 KEEPOUT,
 ZONE,
 GRAPHIC_POLYGON,
 VIA
 };

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

DRAWING_TOOL()

DRAWING_TOOL::DRAWING_TOOL

(

)

Definition at line 167 of file drawing_tool.cpp.

 :
 PCB_TOOL_BASE( "pcbnew.InteractiveDrawing" ),
 m_view( nullptr ),
 m_controls( nullptr ),
 m_board( nullptr ),
 m_frame( nullptr ),
 m_mode( MODE::NONE ),
 m_inDrawingTool( false ),
 m_layer( UNDEFINED_LAYER ),
 m_stroke( 1, PLOT_DASH_TYPE::DEFAULT, COLOR4D::UNSPECIFIED )
{
}

References DEFAULT, and UNSPECIFIED.

~DRAWING_TOOL()

DRAWING_TOOL::~DRAWING_TOOL

(

)

Definition at line 181 of file drawing_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(), DrawArc(), DrawCircle(), DrawDimension(), DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), 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(), PlaceImage(), PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), 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().

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(), MICROWAVE_TOOL::createInductorBetween(), ROUTER_TOOL::CustomTrackWidthDialog(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), drawArc(), DrawDimension(), 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(), 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(), 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().

constrainDimension()

void DRAWING_TOOL::constrainDimension ( PCB_DIMENSION_BASE *  aDim )

private

Force the dimension lime to be drawn on multiple of 45 degrees.

Parameters

aDimension

is the dimension element currently being drawn.

Definition at line 1044 of file drawing_tool.cpp.

{
 const VECTOR2I lineVector{ aDim->GetEnd() - aDim->GetStart() };
 
 aDim->SetEnd( aDim->GetStart() + GetVectorSnapped45( lineVector ) );
 aDim->Update();
}

References PCB_DIMENSION_BASE::GetEnd(), PCB_DIMENSION_BASE::GetStart(), GetVectorSnapped45(), PCB_DIMENSION_BASE::SetEnd(), and PCB_DIMENSION_BASE::Update().

Referenced by DrawDimension().

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

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 MICROWAVE_TOOL::addMicrowaveFootprint(), DrawVia(), and PAD_TOOL::PlacePad().

DrawArc()

int DRAWING_TOOL::DrawArc

(

const TOOL_EVENT &

aEvent

)

Start interactively drawing an arc.

After invoking the function it expects the user to first click on a point that is going to be used as the center of the arc. The second click determines the origin and radius, the third one - the angle.

Definition at line 484 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return 0;
 
 if( m_inDrawingTool )
 return 0;
 
 REENTRANCY_GUARD guard( &m_inDrawingTool );
 
 FOOTPRINT* parentFootprint = dynamic_cast<FOOTPRINT*>( m_frame->GetModel() );
 PCB_SHAPE* arc = m_isFootprintEditor ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 BOARD_COMMIT commit( m_frame );
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::ARC );
 std::optional<VECTOR2D> startingPoint;
 
 arc->SetShape( SHAPE_T::ARC );
 arc->SetFlags( IS_NEW );
 
 m_frame->PushTool( aEvent );
 Activate();
 
 if( aEvent.HasPosition() )
 startingPoint = aEvent.Position();
 
 while( drawArc( aEvent, &arc, startingPoint ) )
 {
 if( arc )
 {
 if( m_isFootprintEditor )
 static_cast<FP_SHAPE*>( arc )->SetLocalCoord();
 
 commit.Add( arc );
 commit.Push( _( "Draw an arc" ) );
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, arc );
 }
 
 arc = m_isFootprintEditor ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 arc->SetShape( SHAPE_T::ARC );
 arc->SetFlags( IS_NEW );
 
 startingPoint = std::nullopt;
 }
 
 return 0;
}

References _, TOOL_INTERACTIVE::Activate(), COMMIT::Add(), ARC, ARC, drawArc(), PCB_BASE_FRAME::GetModel(), TOOL_EVENT::HasPosition(), IS_NEW, m_frame, m_inDrawingTool, PCB_TOOL_BASE::m_isFootprintEditor, m_mode, TOOL_BASE::m_toolMgr, TOOL_EVENT::Position(), BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectItem, EDA_ITEM::SetFlags(), and EDA_SHAPE::SetShape().

Referenced by setTransitions().

drawArc()

bool DRAWING_TOOL::drawArc ( const TOOL_EVENT &  aTool, PCB_SHAPE **  aGraphic, std::optional< VECTOR2D >  aStartingPoint  )

private

Start drawing an arc.

Parameters

aGraphic

is an object that is going to be used by the tool for drawing. Must be already created. The tool deletes the object if it is not added to a BOARD.

Returns

False if the tool was canceled before the origin was set or origin and end are the same point.

Definition at line 2196 of file drawing_tool.cpp.

{
 wxCHECK( aGraphic, false );
 
 PCB_SHAPE*& graphic = *aGraphic;
 
 wxCHECK( graphic, false );
 
 if( m_layer != m_frame->GetActiveLayer() )
 {
 m_layer = m_frame->GetActiveLayer();
 m_stroke.SetWidth( getSegmentWidth( m_layer ) );
 m_stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT );
 m_stroke.SetColor( COLOR4D::UNSPECIFIED );
 }
 
 // Arc geometric construction manager
 KIGFX::PREVIEW::ARC_GEOM_MANAGER arcManager;
 
 // Arc drawing assistant overlay
 KIGFX::PREVIEW::ARC_ASSISTANT arcAsst( arcManager, pcbIUScale, m_frame->GetUserUnits() );
 
 // Add a VIEW_GROUP that serves as a preview for the new item
 PCB_SELECTION preview;
 m_view->Add( &preview );
 m_view->Add( &arcAsst );
 PCB_GRID_HELPER grid( m_toolMgr, m_frame->GetMagneticItemsSettings() );
 
 auto setCursor =
 [&]()
 {
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };
 
 auto cleanup =
 [&] ()
 {
 preview.Clear();
 delete *aGraphic;
 *aGraphic = nullptr;
 };
 
 m_controls->ShowCursor( true );
 m_controls->ForceCursorPosition( false );
 // Set initial cursor
 setCursor();
 
 bool started = false;
 bool cancelled = false;
 
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 
 if( aStartingPoint )
 m_toolMgr->PrimeTool( *aStartingPoint );
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 if( started )
 m_frame->SetMsgPanel( graphic );
 
 setCursor();
 
 graphic->SetLayer( m_layer );
 
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 VECTOR2I cursorPos = GetClampedCoords(
 grid.BestSnapAnchor( m_controls->GetMousePosition(), graphic ), COORDS_PADDING );
 m_controls->ForceCursorPosition( true, cursorPos );
 
 if( evt->IsCancelInteractive() )
 {
 cleanup();
 
 if( !started )
 {
 // We've handled the cancel event. Don't cancel other tools
 evt->SetPassEvent( false );
 m_frame->PopTool( aTool );
 cancelled = true;
 }
 
 break;
 }
 else if( evt->IsActivate() )
 {
 if( evt->IsPointEditor() )
 {
 // don't exit (the point editor runs in the background)
 }
 else if( evt->IsMoveTool() )
 {
 cleanup();
 // leave ourselves on the stack so we come back after the move
 cancelled = true;
 break;
 }
 else
 {
 cleanup();
 m_frame->PopTool( aTool );
 cancelled = true;
  break;
 }
 }
 else if( evt->IsClick( BUT_LEFT ) )
 {
 if( !started )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 m_controls->SetAutoPan( true );
 m_controls->CaptureCursor( true );
 
 // Init the new item attributes
 // (non-geometric, those are handled by the manager)
 graphic->SetShape( SHAPE_T::ARC );
 graphic->SetStroke( m_stroke );
 
 if( !m_view->IsLayerVisible( m_layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( m_layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 
 preview.Add( graphic );
 frame()->SetMsgPanel( graphic );
 started = true;
 }
 
 arcManager.AddPoint( cursorPos, true );
 }
 else if( evt->IsAction( &PCB_ACTIONS::deleteLastPoint ) )
 {
 arcManager.RemoveLastPoint();
 }
 else if( evt->IsMotion() )
 {
 // set angle snap
 arcManager.SetAngleSnap( Is45Limited() );
 
 // update, but don't step the manager state
 arcManager.AddPoint( cursorPos, false );
 }
 else if( evt->IsAction( &PCB_ACTIONS::layerChanged ) )
 {
 if( m_layer != m_frame->GetActiveLayer() )
 {
 m_layer = m_frame->GetActiveLayer();
 m_stroke.SetWidth( getSegmentWidth( m_layer ) );
 m_stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT );
 m_stroke.SetColor( COLOR4D::UNSPECIFIED );
 }
 
 if( graphic )
 {
 if( !m_view->IsLayerVisible( m_layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( m_layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 
 graphic->SetLayer( m_layer );
 graphic->SetStroke( m_stroke );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else if( evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 if( arcManager.GetStep() == KIGFX::PREVIEW::ARC_GEOM_MANAGER::SET_START )
 {
 graphic->SetArcAngleAndEnd( ANGLE_90 );
 frame()->OnEditItemRequest( graphic );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 break;
 }
 // Don't show the edit panel if we can't represent the arc with it
 else if( ( arcManager.GetStep() == KIGFX::PREVIEW::ARC_GEOM_MANAGER::SET_ANGLE )
 && ( arcManager.GetStartRadiusEnd() != arcManager.GetEndRadiusEnd() ) )
 {
 frame()->OnEditItemRequest( graphic );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 break;
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsAction( &PCB_ACTIONS::incWidth ) )
 {
 m_stroke.SetWidth( m_stroke.GetWidth() + WIDTH_STEP );
 graphic->SetStroke( m_stroke );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 }
 else if( evt->IsAction( &PCB_ACTIONS::decWidth ) )
 {
 if( (unsigned) m_stroke.GetWidth() > WIDTH_STEP )
 {
 m_stroke.SetWidth( m_stroke.GetWidth() - WIDTH_STEP );
 graphic->SetStroke( m_stroke );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 }
 }
 else if( evt->IsAction( &PCB_ACTIONS::arcPosture ) )
 {
 arcManager.ToggleClockwise();
 }
 else if( evt->IsAction( &ACTIONS::updateUnits ) )
 {
 arcAsst.SetUnits( frame()->GetUserUnits() );
 m_view->Update( &arcAsst );
 evt->SetPassEvent();
 }
 else if( started && ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else
 {
 evt->SetPassEvent();
 }
 
 if( arcManager.IsComplete() )
 {
 break;
 }
 else if( arcManager.HasGeometryChanged() )
 {
 updateArcFromConstructionMgr( arcManager, *graphic );
 m_view->Update( &preview );
 m_view->Update( &arcAsst );
 
 if( started )
 frame()->SetMsgPanel( graphic );
 else
 frame()->SetMsgPanel( board() );
 }
 }
 
 preview.Remove( graphic );
 m_view->Remove( &arcAsst );
 m_view->Remove( &preview );
 
 if( selection().Empty() )
 m_frame->SetMsgPanel( board() );
 
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 m_controls->ForceCursorPosition( false );
 
 return !cancelled;
}

References SELECTION::Add(), KIGFX::VIEW::Add(), KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::AddPoint(), ANGLE_90, ARC, PCB_ACTIONS::arcPosture, ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), COORDS_PADDING, PCB_ACTIONS::decWidth, DEFAULT, PCB_ACTIONS::deleteLastPoint, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), GetClampedCoords(), KIGFX::PREVIEW::ARC_GEOM_MANAGER::GetEndRadiusEnd(), PCB_BASE_FRAME::GetMagneticItemsSettings(), KIGFX::VIEW_CONTROLS::GetMousePosition(), getSegmentWidth(), KIGFX::PREVIEW::ARC_GEOM_MANAGER::GetStartRadiusEnd(), KIGFX::PREVIEW::ARC_GEOM_MANAGER::GetStep(), GetUserUnits(), UNITS_PROVIDER::GetUserUnits(), TOOL_BASE::getView(), STROKE_PARAMS::GetWidth(), grid, KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::HasGeometryChanged(), PCB_ACTIONS::incWidth, PCB_TOOL_BASE::Is45Limited(), KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::IsComplete(), KIGFX::VIEW::IsLayerVisible(), ZONE_FILLER_TOOL::IsZoneFillAction(), PCB_ACTIONS::layerChanged, m_controls, m_frame, m_layer, TOOL_INTERACTIVE::m_menu, m_stroke, TOOL_BASE::m_toolMgr, m_view, MD_SHIFT, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), pcbIUScale, PENCIL, TOOLS_HOLDER::PopTool(), TOOL_MANAGER::PrimeTool(), PCB_ACTIONS::properties, EDA_DRAW_PANEL_GAL::Refresh(), ACTIONS::refreshPreview, SELECTION::Remove(), KIGFX::VIEW::Remove(), KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::RemoveLastPoint(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::PREVIEW::ARC_GEOM_MANAGER::SET_ANGLE, KIGFX::PREVIEW::ARC_GEOM_MANAGER::SET_START, KIGFX::PREVIEW::ARC_GEOM_MANAGER::SetAngleSnap(), EDA_SHAPE::SetArcAngleAndEnd(), KIGFX::VIEW_CONTROLS::SetAutoPan(), STROKE_PARAMS::SetColor(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), BOARD_ITEM::SetLayer(), APPEARANCE_CONTROLS::SetLayerVisible(), EDA_DRAW_FRAME::SetMsgPanel(), STROKE_PARAMS::SetPlotStyle(), EDA_SHAPE::SetShape(), PCB_SHAPE::SetStroke(), KIGFX::PREVIEW::ARC_ASSISTANT::SetUnits(), STROKE_PARAMS::SetWidth(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), KIGFX::PREVIEW::ARC_GEOM_MANAGER::ToggleClockwise(), KIGFX::VIEW::Update(), updateArcFromConstructionMgr(), ACTIONS::updateUnits, TOOL_INTERACTIVE::Wait(), and WIDTH_STEP.

Referenced by DrawArc().

DrawBoardCharacteristics()

std::vector< BOARD_ITEM * > DRAWING_TOOL::DrawBoardCharacteristics	(	const VECTOR2I &	origin,
		PCB_LAYER_ID	aLayer,
		bool	aDrawNow,
		VECTOR2I *	tablesize
	)

Definition at line 360 of file drawing_stackup_table_tool.cpp.

{
 BOARD_COMMIT commit( m_frame );
 std::vector<BOARD_ITEM*> objects;
 BOARD_DESIGN_SETTINGS& settings = m_frame->GetBoard()->GetDesignSettings();
 BOARD_STACKUP& stackup = settings.GetStackupDescriptor();
 
 VECTOR2I cursorPos = aOrigin;
 
 // Style : Section header
 std::unique_ptr<PCB_TEXT> headStyle =
 std::make_unique<PCB_TEXT>( static_cast<FOOTPRINT*>( m_frame->GetModel() ) );
 headStyle->SetLayer( Eco1_User );
 headStyle->SetTextSize( VECTOR2I( pcbIUScale.mmToIU( 2.0 ), pcbIUScale.mmToIU( 2.0 ) ) );
 headStyle->SetTextThickness( pcbIUScale.mmToIU( 0.4 ) );
 headStyle->SetItalic( false );
 headStyle->SetTextPos( VECTOR2I( 0, 0 ) );
 headStyle->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 headStyle->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 
 // Style : Data
 std::unique_ptr<PCB_TEXT> dataStyle =
 std::make_unique<PCB_TEXT>( static_cast<FOOTPRINT*>( m_frame->GetModel() ) );
 dataStyle->SetLayer( Eco1_User );
 dataStyle->SetTextSize( VECTOR2I( pcbIUScale.mmToIU( 1.5 ), pcbIUScale.mmToIU( 1.5 ) ) );
 dataStyle->SetTextThickness( pcbIUScale.mmToIU( 0.2 ) );
 dataStyle->SetItalic( false );
 dataStyle->SetTextPos( VECTOR2I( 0, 0 ) );
 dataStyle->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 dataStyle->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 
 PCB_TEXT* t;
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "BOARD CHARACTERISTICS" ) );
 t->SetPosition( cursorPos );
 objects.push_back( t );
 
 cursorPos.y = cursorPos.y + t->GetBoundingBox().GetHeight()
 + EDA_UNIT_UTILS::UI::FromUserUnit( pcbIUScale, EDA_UNITS::MILLIMETRES, 1.0 );
 
 std::vector<std::vector<PCB_TEXT*>> texts;
 std::vector<PCB_TEXT*> colLabel1;
 std::vector<PCB_TEXT*> colData1;
 std::vector<PCB_TEXT*> colbreak;
 std::vector<PCB_TEXT*> colLabel2;
 std::vector<PCB_TEXT*> colData2;
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Copper Layer Count: " ) );
 colLabel1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::UNSCALED,
 settings.GetCopperLayerCount(), false ) );
 colData1.push_back( t );
 
 SHAPE_POLY_SET outline;
 m_frame->GetBoard()->GetBoardPolygonOutlines( outline );
 BOX2I size = outline.BBox();
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Board overall dimensions: " ) );
 colLabel1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( wxString::Format( wxT( "%s x %s" ),
 m_frame->MessageTextFromValue( size.GetWidth(), true ),
 m_frame->MessageTextFromValue( size.GetHeight(), true ) ) );
 colData1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Min track/spacing: " ) );
 colLabel1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( wxString::Format( wxT( "%s / %s" ),
 m_frame->MessageTextFromValue( settings.m_TrackMinWidth, true ),
 m_frame->MessageTextFromValue( settings.m_MinClearance, true ) ) );
 colData1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Copper Finish: " ) );
 colLabel1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup.m_FinishType );
 colData1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Castellated pads: " ) );
 colLabel1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup.m_CastellatedPads ? _( "Yes" ) : _( "No" ) );
 colData1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Board Thickness: " ) );
 colLabel2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( m_frame->MessageTextFromValue( settings.GetBoardThickness(), true ) );
 colData2.push_back( t );
 
 // some empty cells
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 colLabel2.push_back( t );
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 colData2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Min hole diameter: " ) );
 colLabel2.push_back( t );
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 
 double holeSize = std::min( settings.m_MinThroughDrill, settings.m_ViasMinSize );
 t->SetText( m_frame->MessageTextFromValue( holeSize, true ) );
 colData2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Impedance Control: " ) );
 colLabel2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup.m_HasDielectricConstrains ? _( "Yes" ) : _( "No" ) );
 colData2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Plated Board Edge: " ) );
 colLabel2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup.m_EdgePlating ? _( "Yes" ) : _( "No" ) );
 colData2.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( _( "Edge card connectors: " ) );
 colLabel1.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 switch( stackup.m_EdgeConnectorConstraints )
 {
 case BS_EDGE_CONNECTOR_NONE: t->SetText( _( "No" ) ); break;
 case BS_EDGE_CONNECTOR_IN_USE: t->SetText( _( "Yes" ) ); break;
 case BS_EDGE_CONNECTOR_BEVELLED: t->SetText( _( "Yes, Bevelled" ) ); break;
 }
 colData1.push_back( t );
 
 texts.push_back( colLabel1 );
 texts.push_back( colData1 );
 texts.push_back( colbreak );
 texts.push_back( colLabel2 );
 texts.push_back( colData2 );
 VECTOR2I tableSize2;
 
 std::vector<BOARD_ITEM*> table = initTextTable( texts, cursorPos, Eco1_User, &tableSize2,
 false );
 
 for( BOARD_ITEM* item : table )
 objects.push_back( item );
 
 if( aDrawNow )
 {
 for( BOARD_ITEM* item : objects )
 commit.Add( item );
 
 commit.Push( wxT( "Board Characteristics" ) );
 }
 
 tableSize->x = tableSize2.x;
 tableSize->y = cursorPos.y + tableSize2.y
 + EDA_UNIT_UTILS::UI::FromUserUnit( pcbIUScale, EDA_UNITS::MILLIMETRES, 2.0 );
 
 return objects;
}

References _, COMMIT::Add(), SHAPE_POLY_SET::BBox(), BS_EDGE_CONNECTOR_BEVELLED, BS_EDGE_CONNECTOR_IN_USE, BS_EDGE_CONNECTOR_NONE, Eco1_User, Format(), EDA_UNIT_UTILS::UI::FromUserUnit(), PCB_BASE_FRAME::GetBoard(), BOARD::GetBoardPolygonOutlines(), BOARD_DESIGN_SETTINGS::GetBoardThickness(), PCB_TEXT::GetBoundingBox(), BOARD_DESIGN_SETTINGS::GetCopperLayerCount(), BOARD::GetDesignSettings(), BOX2< Vec >::GetHeight(), PCB_BASE_FRAME::GetModel(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), BOX2< Vec >::GetWidth(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_TOP, initTextTable(), BOARD_STACKUP::m_CastellatedPads, BOARD_STACKUP::m_EdgeConnectorConstraints, BOARD_STACKUP::m_EdgePlating, BOARD_STACKUP::m_FinishType, m_frame, BOARD_STACKUP::m_HasDielectricConstrains, BOARD_DESIGN_SETTINGS::m_MinClearance, BOARD_DESIGN_SETTINGS::m_MinThroughDrill, BOARD_DESIGN_SETTINGS::m_TrackMinWidth, BOARD_DESIGN_SETTINGS::m_ViasMinSize, UNITS_PROVIDER::MessageTextFromValue(), MILLIMETRES, EDA_IU_SCALE::mmToIU(), pcbIUScale, BOARD_COMMIT::Push(), PCB_TEXT::SetPosition(), EDA_TEXT::SetText(), EDA_UNIT_UTILS::UI::StringFromValue(), unityScale, UNSCALED, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PlaceCharacteristics().

DrawCircle()

int DRAWING_TOOL::DrawCircle

(

const TOOL_EVENT &

aEvent

)

Start interactively drawing a circle.

After invoking the function it expects the user to first click on a point that is going to be used as the center of the circle. The second click determines the circle radius.

Definition at line 433 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return 0;
 
 if( m_inDrawingTool )
 return 0;
 
  REENTRANCY_GUARD guard( &m_inDrawingTool );
 
 FOOTPRINT* parentFootprint = dynamic_cast<FOOTPRINT*>( m_frame->GetModel() );
 PCB_SHAPE* circle = m_isFootprintEditor ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 BOARD_COMMIT commit( m_frame );
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::CIRCLE );
 std::optional<VECTOR2D> startingPoint;
 
 circle->SetShape( SHAPE_T::CIRCLE );
 circle->SetFilled( false );
 circle->SetFlags( IS_NEW );
 
 if( aEvent.HasPosition() )
 startingPoint = getViewControls()->GetCursorPosition( !aEvent.DisableGridSnapping() );
 
 m_frame->PushTool( aEvent );
 Activate();
 
 while( drawShape( aEvent, &circle, startingPoint ) )
 {
 if( circle )
 {
 if( m_isFootprintEditor )
 static_cast<FP_SHAPE*>( circle )->SetLocalCoord();
 
 commit.Add( circle );
 commit.Push( _( "Draw a circle" ) );
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, circle );
 }
 
 circle = m_isFootprintEditor ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 circle->SetShape( SHAPE_T::CIRCLE );
 circle->SetFilled( false );
 circle->SetFlags( IS_NEW );
 
 startingPoint = std::nullopt;
 }
 
 return 0;
}

References _, TOOL_INTERACTIVE::Activate(), COMMIT::Add(), CIRCLE, CIRCLE, TOOL_EVENT::DisableGridSnapping(), drawShape(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getViewControls(), TOOL_EVENT::HasPosition(), IS_NEW, m_frame, m_inDrawingTool, PCB_TOOL_BASE::m_isFootprintEditor, m_mode, TOOL_BASE::m_toolMgr, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectItem, EDA_SHAPE::SetFilled(), EDA_ITEM::SetFlags(), and EDA_SHAPE::SetShape().

Referenced by setTransitions().

DrawDimension()

int DRAWING_TOOL::DrawDimension

(

const TOOL_EVENT &

aEvent

)

Start interactively drawing a dimension.

After invoking the function it expects the user to first click on a point that is going to be used as the origin of the dimension. The second click determines the end and the third click modifies its height.

Definition at line 1053 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return 0;
 
 if( m_inDrawingTool )
 return 0;
 
 REENTRANCY_GUARD guard( &m_inDrawingTool );
 
 enum DIMENSION_STEPS
 {
 SET_ORIGIN = 0,
 SET_END,
 SET_HEIGHT,
 FINISHED
 };
 
 TOOL_EVENT originalEvent = aEvent;
 PCB_DIMENSION_BASE* dimension = nullptr;
 BOARD_COMMIT commit( m_frame );
 PCB_GRID_HELPER grid( m_toolMgr, m_frame->GetMagneticItemsSettings() );
 BOARD_DESIGN_SETTINGS& boardSettings = m_board->GetDesignSettings();
 PCB_SELECTION preview; // A VIEW_GROUP that serves as a preview for the new item(s)
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::DIMENSION );
 int step = SET_ORIGIN;
 KICAD_T t = PCB_DIMENSION_T;
 
 m_view->Add( &preview );
 
 auto cleanup =
 [&]()
 {
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 m_controls->ForceCursorPosition( false );
 
 preview.Clear();
 m_view->Update( &preview );
 
 delete dimension;
 dimension = nullptr;
 step = SET_ORIGIN;
 };
 
 auto setCursor =
 [&]()
 {
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::MEASURE );
 };
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 m_frame->PushTool( aEvent );
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 m_controls->ShowCursor( true );
 m_controls->ForceCursorPosition( false );
 // Set initial cursor
 setCursor();
 
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 
 if( aEvent.HasPosition() )
 m_toolMgr->PrimeTool( aEvent.Position() );
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 if( step > SET_ORIGIN )
 frame()->SetMsgPanel( dimension );
 
 setCursor();
 
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 
 if( step == SET_HEIGHT )
 {
 if( dimension->GetStart().x != dimension->GetEnd().x
 && dimension->GetStart().y != dimension->GetEnd().y )
 {
 // Not cardinal. Grid snapping doesn't make sense for height.
 grid.SetUseGrid( false );
 }
 }
 
 VECTOR2I cursorPos = evt->HasPosition() ? evt->Position() : m_controls->GetMousePosition();
 cursorPos = GetClampedCoords( grid.BestSnapAnchor( cursorPos, nullptr ), COORDS_PADDING );
 
 m_controls->ForceCursorPosition( true, cursorPos );
 
 if( evt->IsCancelInteractive() )
 {
 m_controls->SetAutoPan( false );
 
 if( step != SET_ORIGIN ) // start from the beginning
 {
 cleanup();
 }
 else
 {
 m_frame->PopTool( aEvent );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( step != SET_ORIGIN )
 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
 {
 m_frame->PopTool( aEvent );
 break;
 }
 }
 else if( evt->IsAction( &PCB_ACTIONS::incWidth ) && step != SET_ORIGIN )
 {
 m_stroke.SetWidth( m_stroke.GetWidth() + WIDTH_STEP );
 dimension->SetLineThickness( m_stroke.GetWidth() );
 m_view->Update( &preview );
 frame()->SetMsgPanel( dimension );
 }
 else if( evt->IsAction( &PCB_ACTIONS::decWidth ) && step != SET_ORIGIN )
 {
 if( (unsigned) m_stroke.GetWidth() > WIDTH_STEP )
 {
 m_stroke.SetWidth( m_stroke.GetWidth() - WIDTH_STEP );
 dimension->SetLineThickness( m_stroke.GetWidth() );
 m_view->Update( &preview );
 frame()->SetMsgPanel( dimension );
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
 {
 switch( step )
 {
 case SET_ORIGIN:
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 PCB_LAYER_ID layer = m_frame->GetActiveLayer();
 
 // Init the new item attributes
 auto setMeasurementAttributes =
 [&]( PCB_DIMENSION_BASE* aDim )
 {
 aDim->SetUnitsMode( boardSettings.m_DimensionUnitsMode );
 aDim->SetUnitsFormat( boardSettings.m_DimensionUnitsFormat );
 aDim->SetPrecision( boardSettings.m_DimensionPrecision );
 aDim->SetSuppressZeroes( boardSettings.m_DimensionSuppressZeroes );
 aDim->SetTextPositionMode( boardSettings.m_DimensionTextPosition );
 aDim->SetKeepTextAligned( boardSettings.m_DimensionKeepTextAligned );
 };
 
 if( originalEvent.IsAction( &PCB_ACTIONS::drawAlignedDimension ) )
 {
 dimension = new PCB_DIM_ALIGNED( m_frame->GetModel(),
 m_isFootprintEditor ? PCB_FP_DIM_ALIGNED_T
 : PCB_DIM_ALIGNED_T );
 setMeasurementAttributes( dimension );
 }
 else if( originalEvent.IsAction( &PCB_ACTIONS::drawOrthogonalDimension ) )
 {
 dimension = new PCB_DIM_ORTHOGONAL( m_frame->GetModel(), m_isFootprintEditor );
 setMeasurementAttributes( dimension );
 }
 else if( originalEvent.IsAction( &PCB_ACTIONS::drawCenterDimension ) )
 {
 dimension = new PCB_DIM_CENTER( m_frame->GetModel(), m_isFootprintEditor );
 }
 else if( originalEvent.IsAction( &PCB_ACTIONS::drawRadialDimension ) )
 {
 dimension = new PCB_DIM_RADIAL( m_frame->GetModel(), m_isFootprintEditor );
 setMeasurementAttributes( dimension );
 }
 else if( originalEvent.IsAction( &PCB_ACTIONS::drawLeader ) )
 {
 dimension = new PCB_DIM_LEADER( m_frame->GetModel(), m_isFootprintEditor );
 dimension->SetTextPos( cursorPos );
 }
 else
 {
 wxFAIL_MSG( wxT( "Unhandled action in DRAWING_TOOL::DrawDimension" ) );
 }
 
 t = dimension->Type();
 
 dimension->SetLayer( layer );
 dimension->SetTextSize( boardSettings.GetTextSize( layer ) );
 dimension->SetTextThickness( boardSettings.GetTextThickness( layer ) );
 dimension->SetItalic( boardSettings.GetTextItalic( layer ) );
 dimension->SetLineThickness( boardSettings.GetLineThickness( layer ) );
 dimension->SetArrowLength( boardSettings.m_DimensionArrowLength );
 dimension->SetExtensionOffset( boardSettings.m_DimensionExtensionOffset );
 dimension->SetStart( cursorPos );
 dimension->SetEnd( cursorPos );
 dimension->Update();
 
 if( !m_view->IsLayerVisible( layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 
 preview.Add( dimension );
 frame()->SetMsgPanel( dimension );
 
 m_controls->SetAutoPan( true );
 m_controls->CaptureCursor( true );
 break;
 }
 
 case SET_END:
 // Dimensions that have origin and end in the same spot are not valid
 if( dimension->GetStart() == dimension->GetEnd() )
 {
 --step;
 break;
 }
 
 if( t == PCB_DIM_CENTER_T || t == PCB_DIM_RADIAL_T || t == PCB_DIM_LEADER_T
 || t == PCB_FP_DIM_CENTER_T || t == PCB_FP_DIM_RADIAL_T || t == PCB_FP_DIM_LEADER_T )
 {
 // No separate height step
 ++step;
 KI_FALLTHROUGH;
 }
 else
 {
 break;
 }
 
 case SET_HEIGHT:
 assert( dimension->GetStart() != dimension->GetEnd() );
 assert( dimension->GetLineThickness() > 0 );
 
 preview.Remove( dimension );
 
 commit.Add( dimension );
 commit.Push( _( "Draw a dimension" ) );
 
 if( t == PCB_DIM_LEADER_T || t == PCB_FP_DIM_LEADER_T )
 {
 // Run the edit immediately to set the leader text
 m_toolMgr->RunAction( PCB_ACTIONS::properties, true, dimension );
 }
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, dimension );
 
 break;
 }
 
 if( ++step >= FINISHED )
 {
 dimension = nullptr;
 step = SET_ORIGIN;
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 }
 else if( evt->IsDblClick( BUT_LEFT ) )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::cursorClick, false );
 }
 }
 else if( evt->IsMotion() )
 {
 switch( step )
 {
 case SET_END:
 dimension->SetEnd( cursorPos );
 
 if( Is45Limited() || t == PCB_DIM_CENTER_T || t == PCB_FP_DIM_CENTER_T )
 constrainDimension( dimension );
 
 if( t == PCB_DIM_ORTHOGONAL_T || t == PCB_FP_DIM_ORTHOGONAL_T )
 {
 PCB_DIM_ORTHOGONAL* ortho = static_cast<PCB_DIM_ORTHOGONAL*>( dimension );
 
 BOX2I bounds( dimension->GetStart(),
 dimension->GetEnd() - dimension->GetStart() );
 
 // Create a nice preview by measuring the longer dimension
 bool vert = bounds.GetWidth() < bounds.GetHeight();
 
 ortho->SetOrientation( vert ? PCB_DIM_ORTHOGONAL::DIR::VERTICAL
 : PCB_DIM_ORTHOGONAL::DIR::HORIZONTAL );
 }
 else if( t == PCB_DIM_RADIAL_T || t == PCB_FP_DIM_RADIAL_T )
 {
 PCB_DIM_RADIAL* radialDim = static_cast<PCB_DIM_RADIAL*>( dimension );
 VECTOR2I textOffset( radialDim->GetArrowLength() * 10, 0 );
 
 if( radialDim->GetEnd().x < radialDim->GetStart().x )
 textOffset = -textOffset;
 
 radialDim->SetTextPos( radialDim->GetKnee() + textOffset );
 }
 else if( t == PCB_DIM_LEADER_T || t == PCB_FP_DIM_LEADER_T )
 {
 VECTOR2I textOffset( dimension->GetArrowLength() * 10, 0 );
 
 if( dimension->GetEnd().x < dimension->GetStart().x )
 textOffset = -textOffset;
 
 dimension->SetTextPos( dimension->GetEnd() + textOffset );
 }
 
 dimension->Update();
 break;
 
 case SET_HEIGHT:
 if( t == PCB_DIM_ALIGNED_T || t == PCB_FP_DIM_ALIGNED_T )
 {
 PCB_DIM_ALIGNED* aligned = static_cast<PCB_DIM_ALIGNED*>( dimension );
 
 // Calculating the direction of travel perpendicular to the selected axis
 double angle = aligned->GetAngle() + ( M_PI / 2 );
 
 VECTOR2I delta( (VECTOR2I) cursorPos - dimension->GetEnd() );
 double height = ( delta.x * cos( angle ) ) + ( delta.y * sin( angle ) );
 aligned->SetHeight( height );
 aligned->Update();
 }
 else if( t == PCB_DIM_ORTHOGONAL_T || t == PCB_FP_DIM_ORTHOGONAL_T )
 {
 PCB_DIM_ORTHOGONAL* ortho = static_cast<PCB_DIM_ORTHOGONAL*>( dimension );
 
 BOX2I bbox( dimension->GetStart(),
 dimension->GetEnd() - dimension->GetStart() );
 VECTOR2I direction( cursorPos - bbox.Centre() );
 bool vert;
 
 // Only change the orientation when we move outside the bbox
 if( !bbox.Contains( cursorPos ) )
 {
 // If the dimension is horizontal or vertical, set correct orientation
 // otherwise, test if we're left/right of the bounding box or above/below it
 if( bbox.GetWidth() == 0 )
 vert = true;
  else if( bbox.GetHeight() == 0 )
 vert = false;
 else if( cursorPos.x > bbox.GetLeft() && cursorPos.x < bbox.GetRight() )
 vert = false;
 else if( cursorPos.y > bbox.GetTop() && cursorPos.y < bbox.GetBottom() )
 vert = true;
 else
 vert = std::abs( direction.y ) < std::abs( direction.x );
 
 ortho->SetOrientation( vert ? PCB_DIM_ORTHOGONAL::DIR::VERTICAL
 : PCB_DIM_ORTHOGONAL::DIR::HORIZONTAL );
 }
 else
 {
 vert = ortho->GetOrientation() == PCB_DIM_ORTHOGONAL::DIR::VERTICAL;
 }
 
 VECTOR2I heightVector( cursorPos - dimension->GetStart() );
 ortho->SetHeight( vert ? heightVector.x : heightVector.y );
 ortho->Update();
 }
 
 break;
 }
 
 // Show a preview of the item
 m_view->Update( &preview );
 }
 else if( dimension && evt->IsAction( &PCB_ACTIONS::layerChanged ) )
 {
 PCB_LAYER_ID layer = m_frame->GetActiveLayer();
 
 if( !m_view->IsLayerVisible( layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 
 dimension->SetLayer( layer );
 dimension->SetTextSize( boardSettings.GetTextSize( layer ) );
 dimension->SetTextThickness( boardSettings.GetTextThickness( layer ) );
 dimension->SetItalic( boardSettings.GetTextItalic( layer ) );
 dimension->SetLineThickness( boardSettings.GetLineThickness( layer ) );
 dimension->Update();
 
 m_view->Update( &preview );
 frame()->SetMsgPanel( dimension );
 }
 else if( dimension && evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 if( step == SET_END || step == SET_HEIGHT )
 {
 frame()->OnEditItemRequest( dimension );
 dimension->Update();
 frame()->SetMsgPanel( dimension );
 break;
 }
 else
 {
 wxBell();
 }
 }
 else if( dimension && ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 if( step != SET_ORIGIN )
 delete dimension;
 
 m_controls->SetAutoPan( false );
 m_controls->ForceCursorPosition( false );
 m_controls->CaptureCursor( false );
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 
 m_view->Remove( &preview );
 
 if( selection().Empty() )
 m_frame->SetMsgPanel( board() );
 
 return 0;
}

References _, std::abs(), TOOL_INTERACTIVE::Activate(), COMMIT::Add(), SELECTION::Add(), KIGFX::VIEW::Add(), PNS::angle(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), BOX2< Vec >::Centre(), SELECTION::Clear(), constrainDimension(), BOX2< Vec >::Contains(), COORDS_PADDING, ACTIONS::cursorClick, PCB_ACTIONS::decWidth, delta, DIMENSION, PCB_ACTIONS::drawAlignedDimension, PCB_ACTIONS::drawCenterDimension, PCB_ACTIONS::drawLeader, PCB_ACTIONS::drawOrthogonalDimension, PCB_ACTIONS::drawRadialDimension, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PCB_DIM_ALIGNED::GetAngle(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_DIMENSION_BASE::GetArrowLength(), BOX2< Vec >::GetBottom(), PCB_BASE_FRAME::GetCanvas(), GetClampedCoords(), BOARD::GetDesignSettings(), PCB_DIMENSION_BASE::GetEnd(), BOX2< Vec >::GetHeight(), PCB_DIM_RADIAL::GetKnee(), BOX2< Vec >::GetLeft(), PCB_DIMENSION_BASE::GetLineThickness(), BOARD_DESIGN_SETTINGS::GetLineThickness(), PCB_BASE_FRAME::GetMagneticItemsSettings(), PCB_BASE_FRAME::GetModel(), KIGFX::VIEW_CONTROLS::GetMousePosition(), BOX2< Vec >::GetRight(), PCB_DIMENSION_BASE::GetStart(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOX2< Vec >::GetTop(), TOOL_BASE::getView(), STROKE_PARAMS::GetWidth(), BOX2< Vec >::GetWidth(), grid, TOOL_EVENT::HasPosition(), PCB_DIM_ORTHOGONAL::HORIZONTAL, PCB_ACTIONS::incWidth, PCB_TOOL_BASE::Is45Limited(), TOOL_EVENT::IsAction(), KIGFX::VIEW::IsLayerVisible(), ZONE_FILLER_TOOL::IsZoneFillAction(), KI_FALLTHROUGH, PCB_ACTIONS::layerChanged, m_board, m_controls, BOARD_DESIGN_SETTINGS::m_DimensionArrowLength, BOARD_DESIGN_SETTINGS::m_DimensionExtensionOffset, BOARD_DESIGN_SETTINGS::m_DimensionKeepTextAligned, BOARD_DESIGN_SETTINGS::m_DimensionPrecision, BOARD_DESIGN_SETTINGS::m_DimensionSuppressZeroes, BOARD_DESIGN_SETTINGS::m_DimensionTextPosition, BOARD_DESIGN_SETTINGS::m_DimensionUnitsFormat, BOARD_DESIGN_SETTINGS::m_DimensionUnitsMode, m_frame, m_inDrawingTool, PCB_TOOL_BASE::m_isFootprintEditor, TOOL_INTERACTIVE::m_menu, m_mode, m_stroke, TOOL_BASE::m_toolMgr, m_view, MD_SHIFT, MEASURE, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), ortho, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DIMENSION_T, PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, TOOLS_HOLDER::PopTool(), TOOL_EVENT::Position(), TOOL_MANAGER::PrimeTool(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), EDA_DRAW_PANEL_GAL::Refresh(), ACTIONS::refreshPreview, SELECTION::Remove(), KIGFX::VIEW::Remove(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, PCB_DIMENSION_BASE::SetArrowLength(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PCB_DIMENSION_BASE::SetEnd(), PCB_DIMENSION_BASE::SetExtensionOffset(), PCB_DIM_ALIGNED::SetHeight(), EDA_TEXT::SetItalic(), BOARD_ITEM::SetLayer(), APPEARANCE_CONTROLS::SetLayerVisible(), PCB_DIMENSION_BASE::SetLineThickness(), EDA_DRAW_FRAME::SetMsgPanel(), PCB_DIMENSION_BASE::SetStart(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), STROKE_PARAMS::SetWidth(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), EDA_ITEM::Type(), PCB_DIMENSION_BASE::Update(), KIGFX::VIEW::Update(), PCB_DIM_ORTHOGONAL::VERTICAL, TOOL_INTERACTIVE::Wait(), WIDTH_STEP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

DrawLine()

int DRAWING_TOOL::DrawLine

(

const TOOL_EVENT &

aEvent

)

Start interactively drawing a line.

After invoking the function it expects the user to click at least two times to determine the origin and the end for a line. If there are more clicks, the line is drawn as a continuous polyline.

Definition at line 302 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return 0;
 
 if( m_inDrawingTool )
 return 0;
 
 REENTRANCY_GUARD guard( &m_inDrawingTool );
 
 FOOTPRINT* parentFootprint = dynamic_cast<FOOTPRINT*>( m_frame->GetModel() );
 PCB_SHAPE* line = m_isFootprintEditor ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 BOARD_COMMIT commit( m_frame );
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::LINE );
 std::optional<VECTOR2D> startingPoint;
 
 line->SetShape( SHAPE_T::SEGMENT );
 line->SetFlags( IS_NEW );
 
 if( aEvent.HasPosition() )
 startingPoint = getViewControls()->GetCursorPosition( !aEvent.DisableGridSnapping() );
 
 m_frame->PushTool( aEvent );
 Activate();
 
 while( drawShape( aEvent, &line, startingPoint ) )
 {
 if( line )
 {
 if( m_isFootprintEditor )
 static_cast<FP_SHAPE*>( line )->SetLocalCoord();
 
 commit.Add( line );
 commit.Push( _( "Draw a line segment" ) );
 startingPoint = VECTOR2D( line->GetEnd() );
 }
 else
 {
 startingPoint = std::nullopt;
 }
 
 line = m_isFootprintEditor ? new FP_SHAPE( parentFootprint ) : new PCB_SHAPE;
 line->SetShape( SHAPE_T::SEGMENT );
 line->SetFlags( IS_NEW );
 }
 
 return 0;
}

References _, TOOL_INTERACTIVE::Activate(), COMMIT::Add(), TOOL_EVENT::DisableGridSnapping(), drawShape(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_SHAPE::GetEnd(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getViewControls(), TOOL_EVENT::HasPosition(), IS_NEW, LINE, m_frame, m_inDrawingTool, PCB_TOOL_BASE::m_isFootprintEditor, m_mode, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), SEGMENT, EDA_ITEM::SetFlags(), and EDA_SHAPE::SetShape().

Referenced by setTransitions().

DrawRectangle()

int DRAWING_TOOL::DrawRectangle

(

const TOOL_EVENT &

aEvent

)

Start interactively drawing a rectangle.

After invoking the function it expects the user to first click on a point that is going to be used as the top-left of the rectangle. The second click determines the bottom-right.

Definition at line 352 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return 0;
 
 if( m_inDrawingTool )
 return 0;
 
 REENTRANCY_GUARD guard( &m_inDrawingTool );
 
 bool isTextBox = aEvent.IsAction( &PCB_ACTIONS::drawTextBox );
 PCB_SHAPE* rect = nullptr;
 BOARD_COMMIT commit( m_frame );
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::RECTANGLE );
 std::optional<VECTOR2D> startingPoint;
 
 auto makeNew =
 [&]() -> PCB_SHAPE*
 {
 if( m_isFootprintEditor )
 {
 FOOTPRINT* parentFootprint = dynamic_cast<FOOTPRINT*>( m_frame->GetModel() );
 
 if( isTextBox )
 return new FP_TEXTBOX( parentFootprint );
 else
 return new FP_SHAPE( parentFootprint );
 }
 else
 {
 if( isTextBox )
 return new PCB_TEXTBOX( m_frame->GetModel() );
 else
 return new PCB_SHAPE();
 }
 };
 
 rect = makeNew();
 rect->SetShape( SHAPE_T::RECT );
 rect->SetFilled( false );
 rect->SetFlags( IS_NEW );
 
 if( aEvent.HasPosition() )
 startingPoint = getViewControls()->GetCursorPosition( !aEvent.DisableGridSnapping() );
 
 m_frame->PushTool( aEvent );
 Activate();
 
 while( drawShape( aEvent, &rect, startingPoint ) )
 {
 if( rect )
 {
 if( m_isFootprintEditor )
 static_cast<FP_SHAPE*>( rect )->SetLocalCoord();
 
 if( isTextBox && m_frame->ShowTextBoxPropertiesDialog( rect ) != wxID_OK )
 {
 delete rect;
 rect = nullptr;
 }
 else
 {
 rect->NormalizeRect();
 commit.Add( rect );
 commit.Push( isTextBox ? _( "Draw a text box" ) : _( "Draw a rectangle" ) );
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, rect );
 }
 }
 
 rect = makeNew();
 rect->SetShape( SHAPE_T::RECT );
 rect->SetFilled( false );
 rect->SetFlags( IS_NEW );
 startingPoint = std::nullopt;
 }
 
 return 0;
}

References _, TOOL_INTERACTIVE::Activate(), COMMIT::Add(), TOOL_EVENT::DisableGridSnapping(), drawShape(), PCB_ACTIONS::drawTextBox, KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getViewControls(), TOOL_EVENT::HasPosition(), IS_NEW, TOOL_EVENT::IsAction(), m_frame, m_inDrawingTool, PCB_TOOL_BASE::m_isFootprintEditor, m_mode, TOOL_BASE::m_toolMgr, PCB_SHAPE::NormalizeRect(), BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), RECT, RECTANGLE, TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectItem, EDA_SHAPE::SetFilled(), EDA_ITEM::SetFlags(), EDA_SHAPE::SetShape(), and PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog().

Referenced by setTransitions().

drawShape()

bool DRAWING_TOOL::drawShape ( const TOOL_EVENT &  aTool, PCB_SHAPE **  aGraphic, std::optional< VECTOR2D >  aStartingPoint  )

private

Start drawing a selected shape (i.e.

PCB_SHAPE).

Parameters

aGraphic	is an object that is going to be used by the tool for drawing. Must be already created. The tool deletes the object if it is not added to a BOARD.
aStartingPoint	is a starting point for this new PCB_SHAPE. If it exists the new item has its start point set to aStartingPoint, and its settings (width, layer) set to the current default values.

Returns

False if the tool was canceled before the origin was set or origin and end are the same point.

Definition at line 1799 of file drawing_tool.cpp.

{
 SHAPE_T shape = ( *aGraphic )->GetShape();
 
 // Only three shapes are currently supported
 wxASSERT( shape == SHAPE_T::SEGMENT || shape == SHAPE_T::CIRCLE || shape == SHAPE_T::RECT );
 
 const BOARD_DESIGN_SETTINGS& bds = m_frame->GetDesignSettings();
 EDA_UNITS userUnits = m_frame->GetUserUnits();
 PCB_GRID_HELPER grid( m_toolMgr, m_frame->GetMagneticItemsSettings() );
 PCB_SHAPE*& graphic = *aGraphic;
 
 if( m_layer != m_frame->GetActiveLayer() )
 {
 m_layer = m_frame->GetActiveLayer();
 m_stroke.SetWidth( getSegmentWidth( m_layer ) );
 m_stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT );
 m_stroke.SetColor( COLOR4D::UNSPECIFIED );
 
 m_textAttrs.m_Size = bds.GetTextSize( m_layer );
 m_textAttrs.m_StrokeWidth = bds.GetTextThickness( m_layer );
 InferBold( &m_textAttrs );
 m_textAttrs.m_Italic = bds.GetTextItalic( m_layer );
 m_textAttrs.m_KeepUpright = bds.GetTextUpright( m_layer );
 m_textAttrs.m_Mirrored = IsBackLayer( m_layer );
 m_textAttrs.m_Halign = GR_TEXT_H_ALIGN_LEFT;
 m_textAttrs.m_Valign = GR_TEXT_V_ALIGN_TOP;
 }
 
 // geometric construction manager
 KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER twoPointManager;
 
 // drawing assistant overlay
 // TODO: workaround because EDA_SHAPE_TYPE_T is not visible from commons.
 KIGFX::PREVIEW::GEOM_SHAPE geomShape( static_cast<KIGFX::PREVIEW::GEOM_SHAPE>( shape ) );
 KIGFX::PREVIEW::TWO_POINT_ASSISTANT twoPointAsst( twoPointManager, pcbIUScale, userUnits, geomShape );
 
 // Add a VIEW_GROUP that serves as a preview for the new item
 PCB_SELECTION preview;
 m_view->Add( &preview );
 m_view->Add( &twoPointAsst );
 
 bool started = false;
 bool cancelled = false;
 bool isLocalOriginSet = ( m_frame->GetScreen()->m_LocalOrigin != VECTOR2D( 0, 0 ) );
 VECTOR2I cursorPos = m_controls->GetMousePosition();
 
 auto setCursor =
 [&]()
 {
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };
 
 auto cleanup =
 [&]()
 {
 preview.Clear();
 m_view->Update( &preview );
 delete graphic;
 graphic = nullptr;
 
 if( !isLocalOriginSet )
 m_frame->GetScreen()->m_LocalOrigin = VECTOR2D( 0, 0 );
 };
 
 m_controls->ShowCursor( true );
 m_controls->ForceCursorPosition( false );
 // Set initial cursor
 setCursor();
 
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 
 if( aStartingPoint )
 m_toolMgr->PrimeTool( *aStartingPoint );
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 
 if( started )
 m_frame->SetMsgPanel( graphic );
 
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 cursorPos = GetClampedCoords(
 grid.BestSnapAnchor( m_controls->GetMousePosition(), m_layer ),
 COORDS_PADDING );
 m_controls->ForceCursorPosition( true, cursorPos );
 
 if( evt->IsCancelInteractive() )
 {
 cleanup();
 
 if( !started )
 {
 // We've handled the cancel event. Don't cancel other tools
 evt->SetPassEvent( false );
 m_frame->PopTool( aTool );
 cancelled = true;
 }
 
 break;
 }
 else if( evt->IsActivate() )
 {
 if( evt->IsPointEditor() )
 {
 // don't exit (the point editor runs in the background)
 }
 else if( evt->IsMoveTool() )
 {
 cleanup();
 // leave ourselves on the stack so we come back after the move
 cancelled = true;
 break;
 }
 else
 {
 cleanup();
 m_frame->PopTool( aTool );
 cancelled = true;
 break;
 }
 }
 else if( evt->IsAction( &PCB_ACTIONS::layerChanged ) )
 {
 if( m_layer != m_frame->GetActiveLayer() )
 {
 m_layer = m_frame->GetActiveLayer();
 m_stroke.SetWidth( getSegmentWidth( m_layer ) );
 m_stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT );
 m_stroke.SetColor( COLOR4D::UNSPECIFIED );
 
 m_textAttrs.m_Size = bds.GetTextSize( m_layer );
 m_textAttrs.m_StrokeWidth = bds.GetTextThickness( m_layer );
 InferBold( &m_textAttrs );
 m_textAttrs.m_Italic = bds.GetTextItalic( m_layer );
 m_textAttrs.m_KeepUpright = bds.GetTextUpright( m_layer );
 m_textAttrs.m_Mirrored = IsBackLayer( m_layer );
 m_textAttrs.m_Halign = GR_TEXT_H_ALIGN_LEFT;
 m_textAttrs.m_Valign = GR_TEXT_V_ALIGN_TOP;
 }
 
 if( graphic )
 {
 if( !m_view->IsLayerVisible( m_layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( m_layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 
 graphic->SetLayer( m_layer );
 graphic->SetStroke( m_stroke );
 
 if( FP_TEXTBOX* fp_textbox = dynamic_cast<FP_TEXTBOX*>( graphic ) )
 fp_textbox->SetAttributes( m_textAttrs );
 else if( PCB_TEXTBOX* pcb_textbox = dynamic_cast<PCB_TEXTBOX*>( graphic ) )
 pcb_textbox->SetAttributes( m_textAttrs );
 
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
 {
 if( !graphic )
 break;
 
 if( !started )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 if( aStartingPoint )
 {
 cursorPos = *aStartingPoint;
 aStartingPoint = std::nullopt;
 }
 
 // Init the new item attributes
 if( graphic ) // always true, but Coverity can't seem to figure that out
 {
 graphic->SetShape( static_cast<SHAPE_T>( shape ) );
 graphic->SetFilled( false );
 graphic->SetStroke( m_stroke );
 graphic->SetLayer( m_layer );
 }
 
 if( FP_TEXTBOX* fp_textbox = dynamic_cast<FP_TEXTBOX*>( graphic ) )
 fp_textbox->SetAttributes( m_textAttrs );
 else if( PCB_TEXTBOX* pcb_textbox = dynamic_cast<PCB_TEXTBOX*>( graphic ) )
 pcb_textbox->SetAttributes( m_textAttrs );
 
 grid.SetSkipPoint( cursorPos );
 
 twoPointManager.SetOrigin( cursorPos );
 twoPointManager.SetEnd( cursorPos );
 
 if( !isLocalOriginSet )
 m_frame->GetScreen()->m_LocalOrigin = cursorPos;
 
 preview.Add( graphic );
 frame()->SetMsgPanel( graphic );
 m_controls->SetAutoPan( true );
 m_controls->CaptureCursor( true );
 
 if( !m_view->IsLayerVisible( m_layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( m_layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 
 updateSegmentFromGeometryMgr( twoPointManager, graphic );
 
 started = true;
 }
 else if( shape == SHAPE_T::CIRCLE )
 {
 // No clever logic if drawing a circle
 preview.Clear();
 twoPointManager.Reset();
 break;
 }
 else
 {
 PCB_SHAPE* snapItem = dyn_cast<PCB_SHAPE*>( grid.GetSnapped() );
 
 if( twoPointManager.GetOrigin() == twoPointManager.GetEnd()
 || ( evt->IsDblClick( BUT_LEFT ) && shape == SHAPE_T::SEGMENT )
 || snapItem )
 // User has clicked twice in the same spot
 // or clicked on the end of an existing segment (closing a path)
 {
 BOARD_COMMIT commit( m_frame );
 
 // If the user clicks on an existing snap point from a drawsegment
 // we finish the segment as they are likely closing a path
 if( snapItem && ( shape == SHAPE_T::RECT || graphic->GetLength() > 0.0 ) )
 {
 commit.Add( graphic );
 commit.Push( _( "Draw a line segment" ) );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, graphic );
 }
 else
 {
 delete graphic;
 }
 
 graphic = nullptr;
 }
 
 preview.Clear();
 twoPointManager.Reset();
 break;
 }
 
 twoPointManager.SetEnd( GetClampedCoords( cursorPos ) );
 }
 else if( evt->IsMotion() )
 {
 VECTOR2I clampedCursorPos = cursorPos;
 
 if( shape == SHAPE_T::CIRCLE || shape == SHAPE_T::ARC )
 {
 clampedCursorPos = getClampedRadiusEnd( twoPointManager.GetOrigin(), cursorPos );
 }
 else
 {
 clampedCursorPos = getClampedDifferenceEnd( twoPointManager.GetOrigin(),
 cursorPos );
 }
 
 // 45 degree lines
 if( started && Is45Limited() )
 {
 const VECTOR2I lineVector( clampedCursorPos
 - VECTOR2I( twoPointManager.GetOrigin() ) );
 
 // get a restricted 45/H/V line from the last fixed point to the cursor
 VECTOR2I newEnd = GetVectorSnapped45( lineVector, ( shape == SHAPE_T::RECT ) );
 m_controls->ForceCursorPosition( true, VECTOR2I( twoPointManager.GetEnd() ) );
 twoPointManager.SetEnd( twoPointManager.GetOrigin() + newEnd );
 twoPointManager.SetAngleSnap( true );
 }
 else
 {
 twoPointManager.SetEnd( clampedCursorPos );
 twoPointManager.SetAngleSnap( false );
 }
 
 updateSegmentFromGeometryMgr( twoPointManager, graphic );
 m_view->Update( &preview );
 m_view->Update( &twoPointAsst );
 }
 else if( graphic && evt->IsAction( &PCB_ACTIONS::incWidth ) )
 {
 m_stroke.SetWidth( m_stroke.GetWidth() + WIDTH_STEP );
 graphic->SetStroke( m_stroke );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 }
 else if( graphic && evt->IsAction( &PCB_ACTIONS::decWidth ) )
 {
 if( (unsigned) m_stroke.GetWidth() > WIDTH_STEP )
 {
 m_stroke.SetWidth( m_stroke.GetWidth() - WIDTH_STEP );
 graphic->SetStroke( m_stroke );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 }
 }
 else if( started && evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 frame()->OnEditItemRequest( graphic );
 m_view->Update( &preview );
 frame()->SetMsgPanel( graphic );
 break;
 }
 else if( started && ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else if( evt->IsAction( &ACTIONS::resetLocalCoords ) )
 {
 isLocalOriginSet = true;
 evt->SetPassEvent();
 }
 else if( evt->IsAction( &ACTIONS::updateUnits ) )
 {
 if( frame()->GetUserUnits() != userUnits )
 {
 userUnits = frame()->GetUserUnits();
 twoPointAsst.SetUnits( userUnits );
 m_view->Update( &twoPointAsst );
 }
 evt->SetPassEvent();
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 if( !isLocalOriginSet ) // reset the relative coordinate if it was not set before
 m_frame->GetScreen()->m_LocalOrigin = VECTOR2D( 0, 0 );
 
 m_view->Remove( &twoPointAsst );
 m_view->Remove( &preview );
 
 if( selection().Empty() )
 m_frame->SetMsgPanel( board() );
 
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 m_controls->ForceCursorPosition( false );
 
 return !cancelled;
}

References _, COMMIT::Add(), SELECTION::Add(), KIGFX::VIEW::Add(), ARC, ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), CIRCLE, SELECTION::Clear(), COORDS_PADDING, PCB_ACTIONS::decWidth, DEFAULT, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), GetClampedCoords(), getClampedDifferenceEnd(), getClampedRadiusEnd(), PCB_BASE_FRAME::GetDesignSettings(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::GetEnd(), EDA_SHAPE::GetLength(), PCB_BASE_FRAME::GetMagneticItemsSettings(), KIGFX::VIEW_CONTROLS::GetMousePosition(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::GetOrigin(), PCB_BASE_FRAME::GetScreen(), getSegmentWidth(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), GetUserUnits(), UNITS_PROVIDER::GetUserUnits(), GetVectorSnapped45(), TOOL_BASE::getView(), STROKE_PARAMS::GetWidth(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_TOP, grid, PCB_ACTIONS::incWidth, InferBold(), PCB_TOOL_BASE::Is45Limited(), IsBackLayer(), KIGFX::VIEW::IsLayerVisible(), ZONE_FILLER_TOOL::IsZoneFillAction(), PCB_ACTIONS::layerChanged, m_controls, m_frame, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_KeepUpright, m_layer, BASE_SCREEN::m_LocalOrigin, TOOL_INTERACTIVE::m_menu, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Size, m_stroke, TEXT_ATTRIBUTES::m_StrokeWidth, m_textAttrs, TOOL_BASE::m_toolMgr, TEXT_ATTRIBUTES::m_Valign, m_view, MD_SHIFT, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), pcbIUScale, PENCIL, TOOLS_HOLDER::PopTool(), TOOL_MANAGER::PrimeTool(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), RECT, EDA_DRAW_PANEL_GAL::Refresh(), ACTIONS::refreshPreview, KIGFX::VIEW::Remove(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::Reset(), ACTIONS::resetLocalCoords, TOOL_MANAGER::RunAction(), SEGMENT, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetAngleSnap(), KIGFX::VIEW_CONTROLS::SetAutoPan(), STROKE_PARAMS::SetColor(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetEnd(), EDA_SHAPE::SetFilled(), BOARD_ITEM::SetLayer(), APPEARANCE_CONTROLS::SetLayerVisible(), EDA_DRAW_FRAME::SetMsgPanel(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetOrigin(), STROKE_PARAMS::SetPlotStyle(), EDA_SHAPE::SetShape(), PCB_SHAPE::SetStroke(), KIGFX::PREVIEW::TWO_POINT_ASSISTANT::SetUnits(), STROKE_PARAMS::SetWidth(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), KIGFX::VIEW::Update(), updateSegmentFromGeometryMgr(), ACTIONS::updateUnits, TOOL_INTERACTIVE::Wait(), and WIDTH_STEP.

Referenced by DrawCircle(), DrawLine(), and DrawRectangle().

DrawSpecificationStackup()

std::vector< BOARD_ITEM * > DRAWING_TOOL::DrawSpecificationStackup	(	const VECTOR2I &	origin,
		PCB_LAYER_ID	aLayer,
		bool	aDrawNow,
		VECTOR2I *	tablesize
	)

Definition at line 196 of file drawing_stackup_table_tool.cpp.

{
 BOARD_COMMIT commit( m_frame );
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( m_frame->GetModel() );
 
 std::vector<std::vector<PCB_TEXT*>> texts;
 
 // Style : Header
 std::unique_ptr<PCB_TEXT> headStyle = std::make_unique<PCB_TEXT>( footprint );
 headStyle->SetLayer( Eco1_User );
 headStyle->SetTextSize( VECTOR2I( pcbIUScale.mmToIU( 1.5 ), pcbIUScale.mmToIU( 1.5 ) ) );
 headStyle->SetTextThickness( pcbIUScale.mmToIU( 0.3 ) );
 headStyle->SetItalic( false );
 headStyle->SetTextPos( VECTOR2I( 0, 0 ) );
 headStyle->SetText( _( "Layer" ) );
 headStyle->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 headStyle->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 
 // Style : data
 std::unique_ptr<PCB_TEXT> dataStyle = std::make_unique<PCB_TEXT>( footprint );
 dataStyle->SetLayer( Eco1_User );
 dataStyle->SetTextSize( VECTOR2I( pcbIUScale.mmToIU( 1.5 ), pcbIUScale.mmToIU( 1.5 ) ) );
 dataStyle->SetTextThickness( pcbIUScale.mmToIU( 0.1 ) );
 dataStyle->SetItalic( false );
 dataStyle->SetTextPos( VECTOR2I( 0, 0 ) );
 dataStyle->SetText( _( "Layer" ) );
 dataStyle->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 dataStyle->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 
 //Get Layer names
 BOARD_DESIGN_SETTINGS& dsnSettings = m_frame->GetDesignSettings();
 BOARD_STACKUP& stackup = dsnSettings.GetStackupDescriptor();
 stackup.SynchronizeWithBoard( &dsnSettings );
 
 std::vector<BOARD_STACKUP_ITEM*> layers = stackup.GetList();
 
 std::vector<PCB_TEXT*> colLayer;
 std::vector<PCB_TEXT*> colType;
 std::vector<PCB_TEXT*> colMaterial;
 std::vector<PCB_TEXT*> colThickness;
 std::vector<PCB_TEXT*> colColor;
 std::vector<PCB_TEXT*> colEpsilon;
 std::vector<PCB_TEXT*> colTanD;
 PCB_TEXT* t;
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "Layer Name" ) );
 colLayer.push_back( t );
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "Type" ) );
 colType.push_back( t );
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "Material" ) );
 colMaterial.push_back( t );
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 
 switch( m_frame->GetUserUnits() )
 {
 case EDA_UNITS::MILLIMETRES: t->SetText( _( "Thickness (mm)" ) ); break;
 case EDA_UNITS::INCHES: t->SetText( _( "Thickness (inches)" ) ); break;
 case EDA_UNITS::MILS: t->SetText( _( "Thickness (mils)" ) ); break;
 default: wxFAIL_MSG( wxT( "Unhandled unit type" ) );
 }
 
 colThickness.push_back( t );
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "Color" ) );
 colColor.push_back( t );
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "Epsilon R" ) );
 colEpsilon.push_back( t );
 
 t = static_cast<PCB_TEXT*>( headStyle->Duplicate() );
 t->SetText( _( "Loss Tangent" ) );
 colTanD.push_back( t );
 
 for( int i = 0; i < stackup.GetCount(); i++ )
 {
 BOARD_STACKUP_ITEM* stackup_item = layers.at( i );
 
 for( int sublayer_id = 0; sublayer_id < stackup_item->GetSublayersCount(); sublayer_id++ )
 {
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 
 // Layer names are empty until we close at least once the board setup dialog.
 // If the user did not open the dialog, then get the names from the board.
 // But dielectric layer names will be missing.
 // In this case, for dielectric, a dummy name will be used
 if( stackup_item->GetLayerName().IsEmpty() )
 {
 wxString ly_name;
 
 if( IsValidLayer( stackup_item->GetBrdLayerId() ) )
 ly_name = m_frame->GetBoard()->GetLayerName( stackup_item->GetBrdLayerId() );
 
 if( ly_name.IsEmpty() && stackup_item->GetType() == BS_ITEM_TYPE_DIELECTRIC )
 ly_name = _( "Dielectric" );
 
 t->SetText( ly_name );
 }
 else
 {
 t->SetText( stackup_item->GetLayerName() );
 }
 
 colLayer.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup_item->GetTypeName() );
 colType.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup_item->GetMaterial( sublayer_id ) );
 colMaterial.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( m_frame->StringFromValue( stackup_item->GetThickness( sublayer_id ), true ) );
 colThickness.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( stackup_item->GetColor( sublayer_id ) );
 colColor.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::UNSCALED,
 stackup_item->GetEpsilonR( sublayer_id ), false ) );
 colEpsilon.push_back( t );
 
 t = static_cast<PCB_TEXT*>( dataStyle->Duplicate() );
 t->SetText( EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::UNSCALED,
 stackup_item->GetLossTangent( sublayer_id ), false ) );
 colTanD.push_back( t );
 }
 }
 
 texts.push_back( colLayer );
 texts.push_back( colType );
 texts.push_back( colMaterial );
 texts.push_back( colThickness );
 texts.push_back( colColor );
 texts.push_back( colEpsilon );
 texts.push_back( colTanD );
 std::vector<BOARD_ITEM*> table = initTextTable( texts, aOrigin, aLayer, tableSize, true );
 
 if( aDrawNow )
 {
 for( BOARD_ITEM* item : table )
 commit.Add( item );
 
 commit.Push( _( "Insert board stackup table" ) );
 }
 
 return table;
}

References _, COMMIT::Add(), BS_ITEM_TYPE_DIELECTRIC, Eco1_User, PCB_TOOL_BASE::footprint(), PCB_BASE_FRAME::GetBoard(), BOARD_STACKUP_ITEM::GetBrdLayerId(), BOARD_STACKUP_ITEM::GetColor(), BOARD_STACKUP::GetCount(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_STACKUP_ITEM::GetEpsilonR(), BOARD_STACKUP_ITEM::GetLayerName(), BOARD::GetLayerName(), BOARD_STACKUP::GetList(), BOARD_STACKUP_ITEM::GetLossTangent(), BOARD_STACKUP_ITEM::GetMaterial(), PCB_BASE_FRAME::GetModel(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), BOARD_STACKUP_ITEM::GetSublayersCount(), BOARD_STACKUP_ITEM::GetThickness(), BOARD_STACKUP_ITEM::GetType(), BOARD_STACKUP_ITEM::GetTypeName(), UNITS_PROVIDER::GetUserUnits(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_TOP, INCHES, initTextTable(), IsValidLayer(), m_frame, MILLIMETRES, MILS, EDA_IU_SCALE::mmToIU(), pcbIUScale, BOARD_COMMIT::Push(), EDA_TEXT::SetText(), EDA_UNIT_UTILS::UI::StringFromValue(), UNITS_PROVIDER::StringFromValue(), BOARD_STACKUP::SynchronizeWithBoard(), unityScale, and UNSCALED.

Referenced by PlaceStackup().

DrawVia()

int DRAWING_TOOL::DrawVia

(

const TOOL_EVENT &

aEvent

)

Definition at line 2730 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor )
 return 0;
 
 struct VIA_PLACER : public INTERACTIVE_PLACER_BASE
 {
 PCB_BASE_EDIT_FRAME* m_frame;
 PCB_GRID_HELPER m_gridHelper;
 std::shared_ptr<DRC_ENGINE> m_drcEngine;
 int m_drcEpsilon;
 int m_worstClearance;
 bool m_allowDRCViolations;
 
 VIA_PLACER( PCB_BASE_EDIT_FRAME* aFrame ) :
 m_frame( aFrame ),
 m_gridHelper( aFrame->GetToolManager(), aFrame->GetMagneticItemsSettings() ),
 m_drcEngine( aFrame->GetBoard()->GetDesignSettings().m_DRCEngine ),
 m_drcEpsilon( aFrame->GetBoard()->GetDesignSettings().GetDRCEpsilon() ),
 m_worstClearance( 0 )
 {
 ROUTER_TOOL* router = m_frame->GetToolManager()->GetTool<ROUTER_TOOL>();
 
 m_allowDRCViolations = router->Router()->Settings().AllowDRCViolations();
 
 try
 {
 m_drcEngine->InitEngine( aFrame->GetDesignRulesPath() );
 
 DRC_CONSTRAINT constraint;
 
 if( m_drcEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint ) )
 m_worstClearance = constraint.GetValue().Min();
 
 if( m_drcEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint ) )
 m_worstClearance = std::max( m_worstClearance, constraint.GetValue().Min() );
 
 for( FOOTPRINT* footprint : aFrame->GetBoard()->Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 m_worstClearance = std::max( m_worstClearance, pad->GetLocalClearance() );
 }
 }
 catch( PARSE_ERROR& )
 {
 }
 }
 
  virtual ~VIA_PLACER()
 {
 }
 
 PCB_TRACK* findTrack( PCB_VIA* aVia )
 {
 const LSET lset = aVia->GetLayerSet();
 VECTOR2I position = aVia->GetPosition();
 BOX2I bbox = aVia->GetBoundingBox();
 
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> items;
 KIGFX::PCB_VIEW* view = m_frame->GetCanvas()->GetView();
 std::vector<PCB_TRACK*> possible_tracks;
 
 view->Query( bbox, items );
 
 for( const KIGFX::VIEW::LAYER_ITEM_PAIR& it : items )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( it.first );
 
 if( !( item->GetLayerSet() & lset ).any() )
 continue;
 
 if( PCB_TRACK* track = dyn_cast<PCB_TRACK*>( item ) )
  {
 if( TestSegmentHit( position, track->GetStart(), track->GetEnd(),
 ( track->GetWidth() + aVia->GetWidth() ) / 2 ) )
 {
 possible_tracks.push_back( track );
 }
 }
 }
 
 PCB_TRACK* return_track = nullptr;
 int min_d = std::numeric_limits<int>::max();
 
 for( PCB_TRACK* track : possible_tracks )
 {
 SEG test( track->GetStart(), track->GetEnd() );
 int dist = ( test.NearestPoint( position ) - position ).EuclideanNorm();
 
 if( dist < min_d )
 {
 min_d = dist;
 return_track = track;
 }
 }
 
 return return_track;
 }
 
 bool hasDRCViolation( PCB_VIA* aVia, BOARD_ITEM* aOther )
 {
 DRC_CONSTRAINT constraint;
 int clearance;
 BOARD_CONNECTED_ITEM* connectedItem = dynamic_cast<BOARD_CONNECTED_ITEM*>( aOther );
 ZONE* zone = dynamic_cast<ZONE*>( aOther );
 
 if( zone && zone->GetIsRuleArea() )
 {
 if( zone->GetDoNotAllowVias() )
 return zone->Outline()->Collide( aVia->GetPosition(), aVia->GetWidth() / 2 );
 
 return false;
 }
 
 if( connectedItem )
 {
 int connectedItemNet = connectedItem->GetNetCode();
 
 if( connectedItemNet == 0 || connectedItemNet == aVia->GetNetCode() )
 return false;
 }
 
 for( PCB_LAYER_ID layer : aOther->GetLayerSet().Seq() )
 {
 // Bitmaps are "on" a copper layer but are not actually part of it
 if( !IsCopperLayer( layer ) || aOther->Type() == PCB_BITMAP_T )
 continue;
 
 constraint = m_drcEngine->EvalRules( CLEARANCE_CONSTRAINT, aVia, aOther, layer );
 clearance = constraint.GetValue().Min();
 
 if( clearance >= 0 )
 {
 std::shared_ptr<SHAPE> viaShape = aVia->GetEffectiveShape( layer );
 std::shared_ptr<SHAPE> otherShape = aOther->GetEffectiveShape( layer );
 
 if( viaShape->Collide( otherShape.get(), clearance - m_drcEpsilon ) )
 return true;
 }
 }
 
 if( aOther->HasHole() )
 {
 constraint = m_drcEngine->EvalRules( HOLE_CLEARANCE_CONSTRAINT, aVia, aOther,
 UNDEFINED_LAYER );
 clearance = constraint.GetValue().Min();
 
 if( clearance >= 0 )
 {
 std::shared_ptr<SHAPE> viaShape = aVia->GetEffectiveShape( UNDEFINED_LAYER );
 
 if( viaShape->Collide( aOther->GetEffectiveHoleShape().get(),
 clearance - m_drcEpsilon ) )
 {
 return true;
 }
 }
 }
 
 return false;
 }
 
 bool checkDRCViolation( PCB_VIA* aVia )
 {
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> items;
 std::set<BOARD_ITEM*> checkedItems;
 BOX2I bbox = aVia->GetBoundingBox();
 
 bbox.Inflate( m_worstClearance );
 m_frame->GetCanvas()->GetView()->Query( bbox, items );
 
 for( std::pair<KIGFX::VIEW_ITEM*, int> it : items )
 {
 BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( it.first );
 
 if( !item )
 continue;
 
 if( ( item->Type() == PCB_ZONE_T || item->Type() == PCB_FP_ZONE_T )
 && !static_cast<ZONE*>( item )->GetIsRuleArea() )
 {
 continue; // stitching vias bind to zones, so ignore them
 }
 else if( item->Type() == PCB_FOOTPRINT_T || item->Type() == PCB_GROUP_T )
 {
 continue; // check against children, but not against footprint itself
 }
 else if( item->Type() == PCB_FP_TEXT_T
 && !static_cast<FP_TEXT*>( item )->IsVisible() )
 {
 continue; // ignore hidden items
 }
 else if( checkedItems.count( item ) )
 {
 continue; // already checked
 }
 
 if( hasDRCViolation( aVia, item ) )
 return true;
 
 checkedItems.insert( item );
 }
 
 DRC_CONSTRAINT constraint = m_drcEngine->EvalRules( DISALLOW_CONSTRAINT, aVia, nullptr,
 UNDEFINED_LAYER );
 
 if( constraint.m_DisallowFlags && constraint.GetSeverity() != RPT_SEVERITY_IGNORE )
 return true;
 
 return false;
 }
 
 PAD* findPad( PCB_VIA* aVia )
 {
 const VECTOR2I position = aVia->GetPosition();
 const LSET lset = aVia->GetLayerSet();
 
 for( FOOTPRINT* fp : m_board->Footprints() )
 {
 for( PAD* pad : fp->Pads() )
 {
 if( pad->HitTest( position ) && ( pad->GetLayerSet() & lset ).any() )
 {
 if( pad->GetNetCode() > 0 )
  return pad;
 }
 }
 }
 
 return nullptr;
 }
 
 int findStitchedZoneNet( PCB_VIA* aVia )
 {
 const VECTOR2I position = aVia->GetPosition();
 const LSET lset = aVia->GetLayerSet();
 
 // first take the net of the active layer
 if( lset.test( m_frame->GetActiveLayer() ) )
 {
 for( ZONE* z : m_board->Zones() )
 {
 if( z->IsOnLayer( m_frame->GetActiveLayer() ) )
 {
 if( z->HitTestFilledArea( m_frame->GetActiveLayer(), position ) )
 return z->GetNetCode();
 }
 }
 }
 
 // none? take the topmost visible layer
 for( PCB_LAYER_ID layer : LSET( m_board->GetVisibleLayers() & lset ).Seq() )
 {
 for( ZONE* z : m_board->Zones() )
 {
 if( z->IsOnLayer( layer ) )
 {
 if( z->HitTestFilledArea( layer, position ) )
 return z->GetNetCode();
 }
 }
 }
 
 return -1;
 }
 
 void SnapItem( BOARD_ITEM *aItem ) override
 {
 m_gridHelper.SetSnap( !( m_modifiers & MD_SHIFT ) );
 
 MAGNETIC_SETTINGS* settings = m_frame->GetMagneticItemsSettings();
 PCB_VIA* via = static_cast<PCB_VIA*>( aItem );
 VECTOR2I position = via->GetPosition();
 
 if( settings->tracks == MAGNETIC_OPTIONS::CAPTURE_ALWAYS && m_gridHelper.GetSnap() )
 {
 PCB_TRACK* track = findTrack( via );
 
 if( track )
 {
 SEG trackSeg( track->GetStart(), track->GetEnd() );
 VECTOR2I snap = m_gridHelper.AlignToSegment( position, trackSeg );
 
 aItem->SetPosition( snap );
 }
 }
 else if( settings->pads == MAGNETIC_OPTIONS::CAPTURE_ALWAYS && m_gridHelper.GetSnap() )
 {
 PAD* pad = findPad( via );
 
 if( pad )
 {
 aItem->SetPosition( pad->GetPosition() );
 }
 }
 }
 
 bool PlaceItem( BOARD_ITEM* aItem, BOARD_COMMIT& aCommit ) override
 {
 WX_INFOBAR* infobar = m_frame->GetInfoBar();
 PCB_VIA* via = static_cast<PCB_VIA*>( aItem );
 VECTOR2I viaPos = via->GetPosition();
 PCB_TRACK* track = findTrack( via );
 PAD* pad = findPad( via );
 
 if( track )
 {
 via->SetNetCode( track->GetNetCode() );
 via->SetIsFree( false );
 }
 else if( pad )
 {
 via->SetNetCode( pad->GetNetCode() );
 via->SetIsFree( false );
 }
 else
 {
 via->SetNetCode( findStitchedZoneNet( via ) );
 via->SetIsFree( via->GetNetCode() > 0 );
 }
 
 if( checkDRCViolation( via ) )
 {
 m_frame->ShowInfoBarError( _( "Via location violates DRC." ), true,
 WX_INFOBAR::MESSAGE_TYPE::DRC_VIOLATION );
 
 if( !m_allowDRCViolations )
 return false;
 }
 else
 {
 if( infobar->GetMessageType() == WX_INFOBAR::MESSAGE_TYPE::DRC_VIOLATION )
 infobar->Dismiss();
 }
 
 aCommit.Add( via );
 
 // If the user explicitly disables snap (using shift), then don't break the tracks into
 // a chevron. This will prevent PNS from being able to connect the via and track but
 // it is explicitly requested by the user
 if( track && m_gridHelper.GetSnap() )
 {
 VECTOR2I trackStart = track->GetStart();
 VECTOR2I trackEnd = track->GetEnd();
 SEG trackSeg( trackStart, trackEnd );
 
 OPT_VECTOR2I joint1;
 OPT_VECTOR2I joint2;
 
 auto insertChevron =
 [&]()
 {
 if( ( trackStart - *joint1 ).SquaredEuclideanNorm()
 > ( trackStart - *joint2 ).SquaredEuclideanNorm() )
 {
 std::swap( joint1, joint2 );
 }
 
 aCommit.Modify( track );
 track->SetStart( trackStart );
 track->SetEnd( *joint1 );
 
 PCB_TRACK* newTrack = dynamic_cast<PCB_TRACK*>( track->Clone() );
 wxCHECK( newTrack, /* void */ );
 const_cast<KIID&>( newTrack->m_Uuid ) = KIID();
 
 newTrack->SetStart( *joint1 );
 newTrack->SetEnd( viaPos );
 aCommit.Add( newTrack );
 
 newTrack = dynamic_cast<PCB_TRACK*>( track->Clone() );
 wxCHECK( newTrack, /* void */ );
 const_cast<KIID&>( newTrack->m_Uuid ) = KIID();
 
 newTrack->SetStart( viaPos );
 newTrack->SetEnd( *joint2 );
 aCommit.Add( newTrack );
 
 newTrack = dynamic_cast<PCB_TRACK*>( track->Clone() );
 wxCHECK( newTrack, /* void */ );
 const_cast<KIID&>( newTrack->m_Uuid ) = KIID();
 
 newTrack->SetStart( *joint2 );
 newTrack->SetEnd( trackEnd );
 aCommit.Add( newTrack );
 };
 
 if( viaPos == trackStart || viaPos == trackEnd )
 return true;
 
 if( trackStart.x == trackEnd.x )
 {
 VECTOR2I splitPt = trackSeg.NearestPoint( viaPos );
 
 if( splitPt.x != viaPos.x
 && abs( splitPt.x - viaPos.x ) < abs( splitPt.y - trackStart.y )
 && abs( splitPt.x - viaPos.x ) < abs( splitPt.y - trackEnd.y ) )
 {
 int offset = abs( splitPt.x - viaPos.x );
 
 joint1 = VECTOR2I( splitPt.x, splitPt.y - offset );
 joint2 = VECTOR2I( splitPt.x, splitPt.y + offset );
 
 insertChevron();
 return true;
 }
 }
 else if( trackStart.y == trackEnd.y )
 {
 VECTOR2I splitPt = trackSeg.NearestPoint( viaPos );
 
 if( splitPt.y != viaPos.y
 && abs( trackStart.y - viaPos.y ) < abs( trackStart.x - viaPos.x )
 && abs( trackEnd.y - viaPos.y ) < abs( trackEnd.x - viaPos.x ) )
 {
 int offset = abs( splitPt.y - viaPos.y );
 
  joint1 = VECTOR2I( splitPt.x - offset, splitPt.y );
 joint2 = VECTOR2I( splitPt.x + offset, splitPt.y );
 
 insertChevron();
 return true;
 }
 }
 else if( abs( trackStart.y - trackEnd.y ) == abs( trackStart.x - trackEnd.x ) )
 {
 SEG horiz( VECTOR2I( -INT_MAX, viaPos.y ), VECTOR2I( INT_MAX, viaPos.y ) );
 SEG vert( VECTOR2I( viaPos.x, -INT_MAX ), VECTOR2I( viaPos.x, INT_MAX ) );
 
 if( track->GetBoundingBox().Contains( viaPos ) )
 {
 joint1 = trackSeg.Intersect( horiz, true, true );
 joint2 = trackSeg.Intersect( vert, true, true );
 
  if( !joint1 || !joint2 )
 return false;
 
 insertChevron();
 return true;
 }
 }
 
 aCommit.Modify( track );
 track->SetStart( trackStart );
 track->SetEnd( viaPos );
 
 PCB_TRACK* newTrack = dynamic_cast<PCB_TRACK*>( track->Clone() );
 const_cast<KIID&>( newTrack->m_Uuid ) = KIID();
 
 newTrack->SetStart( viaPos );
 newTrack->SetEnd( trackEnd );
 aCommit.Add( newTrack );
 }
 
 return true;
 }
 
 std::unique_ptr<BOARD_ITEM> CreateItem() override
 {
 BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
 PCB_VIA* via = new PCB_VIA( m_board );
 
 via->SetNetCode( 0 );
 via->SetViaType( bds.m_CurrentViaType );
 
 // for microvias, the size and hole will be changed later.
 via->SetWidth( bds.GetCurrentViaSize() );
 via->SetDrill( bds.GetCurrentViaDrill() );
 
 // Usual via is from copper to component.
 // layer pair is B_Cu and F_Cu.
 via->SetLayerPair( B_Cu, F_Cu );
 
 PCB_LAYER_ID first_layer = m_frame->GetActiveLayer();
 PCB_LAYER_ID last_layer;
 
 // prepare switch to new active layer:
 if( first_layer != m_frame->GetScreen()->m_Route_Layer_TOP )
 last_layer = m_frame->GetScreen()->m_Route_Layer_TOP;
 else
 last_layer = m_frame->GetScreen()->m_Route_Layer_BOTTOM;
 
 // Adjust the actual via layer pair
 switch( via->GetViaType() )
 {
 case VIATYPE::BLIND_BURIED:
 via->SetLayerPair( first_layer, last_layer );
 break;
 
 case VIATYPE::MICROVIA: // from external to the near neighbor inner layer
 {
 PCB_LAYER_ID last_inner_layer =
 ToLAYER_ID( ( m_board->GetCopperLayerCount() - 2 ) );
 
 if( first_layer == B_Cu )
 last_layer = last_inner_layer;
 else if( first_layer == F_Cu )
 last_layer = In1_Cu;
 else if( first_layer == last_inner_layer )
 last_layer = B_Cu;
 else if( first_layer == In1_Cu )
 last_layer = F_Cu;
 
 // else error: will be removed later
 via->SetLayerPair( first_layer, last_layer );
 
 // Update diameter and hole size, which where set previously for normal vias
 NETCLASS* netClass = via->GetEffectiveNetClass();
 
 via->SetWidth( netClass->GetuViaDiameter() );
 via->SetDrill( netClass->GetuViaDrill() );
 }
 break;
 
 default:
 break;
 }
 
 return std::unique_ptr<BOARD_ITEM>( via );
 }
 };
 
 VIA_PLACER placer( frame() );
 
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::VIA );
 
 doInteractiveItemPlacement( aEvent, &placer, _( "Place via" ), IPO_REPEAT | IPO_SINGLE_CLICK );
 
 return 0;
}

References _, std::abs(), COMMIT::Add(), PCB_GRID_HELPER::AlignToSegment(), PNS::ROUTING_SETTINGS::AllowDRCViolations(), B_Cu, BLIND_BURIED, CAPTURE_ALWAYS, CLEARANCE_CONSTRAINT, PCB_TRACK::Clone(), SHAPE_POLY_SET::Collide(), BOX2< Vec >::Contains(), DISALLOW_CONSTRAINT, WX_INFOBAR::Dismiss(), PCB_TOOL_BASE::doInteractiveItemPlacement(), WX_INFOBAR::DRC_VIOLATION, EuclideanNorm(), F_Cu, PCB_TOOL_BASE::footprint(), BOARD::Footprints(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), PCB_TRACK::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetCopperLayerCount(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), BOARD::GetDesignSettings(), ZONE::GetDoNotAllowVias(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), BOARD_ITEM::GetEffectiveHoleShape(), BOARD_ITEM::GetEffectiveShape(), PCB_VIA::GetEffectiveShape(), PCB_TRACK::GetEnd(), EDA_BASE_FRAME::GetInfoBar(), ZONE::GetIsRuleArea(), BOARD_ITEM::GetLayerSet(), PCB_VIA::GetLayerSet(), PCB_BASE_FRAME::GetMagneticItemsSettings(), WX_INFOBAR::GetMessageType(), BOARD_CONNECTED_ITEM::GetNetCode(), PCB_VIA::GetPosition(), PCB_BASE_FRAME::GetScreen(), DRC_CONSTRAINT::GetSeverity(), GRID_HELPER::GetSnap(), PCB_TRACK::GetStart(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), NETCLASS::GetuViaDiameter(), NETCLASS::GetuViaDrill(), DRC_CONSTRAINT::GetValue(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleLayers(), PCB_TRACK::GetWidth(), BOARD_ITEM::HasHole(), HOLE_CLEARANCE_CONSTRAINT, In1_Cu, BOX2< Vec >::Inflate(), SEG::Intersect(), PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_SINGLE_CLICK, IsCopperLayer(), m_board, BOARD_DESIGN_SETTINGS::m_CurrentViaType, DRC_CONSTRAINT::m_DisallowFlags, BOARD_DESIGN_SETTINGS::m_DRCEngine, m_frame, PCB_TOOL_BASE::m_isFootprintEditor, m_mode, PCB_SCREEN::m_Route_Layer_BOTTOM, PCB_SCREEN::m_Route_Layer_TOP, EDA_ITEM::m_Uuid, MD_SHIFT, MICROVIA, MINOPTMAX< T >::Min(), COMMIT::Modify(), SEG::NearestPoint(), ZONE::Outline(), pad, FOOTPRINT::Pads(), MAGNETIC_SETTINGS::pads, PCB_BITMAP_T, PCB_FOOTPRINT_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_ZONE_T, KIGFX::VIEW::Query(), PNS::TOOL_BASE::Router(), RPT_SEVERITY_IGNORE, LSET::Seq(), PCB_TRACK::SetEnd(), EDA_ITEM::SetPosition(), GRID_HELPER::SetSnap(), PCB_TRACK::SetStart(), PNS::ROUTER::Settings(), EDA_BASE_FRAME::ShowInfoBarError(), TestSegmentHit(), ToLAYER_ID(), MAGNETIC_SETTINGS::tracks, EDA_ITEM::Type(), UNDEFINED_LAYER, via, VIA, PCB_TOOL_BASE::view(), VECTOR2< T >::x, VECTOR2< T >::y, and BOARD::Zones().

Referenced by setTransitions().

DrawZone()

int DRAWING_TOOL::DrawZone

(

const TOOL_EVENT &

aEvent

)

Start interactively drawing a zone.

After invoking the function a zone settings dialog is displayed. After confirmation it allows the user to set points that are going to be used as a boundary polygon of the zone. Double click or clicking on the origin of the boundary polyline finishes the drawing.

The event parameter indicates which type of zone to draw:

• ADD add a new zone/keepout with fresh settings.
• CUTOUT add a cutout to an existing zone.
• SIMILAR add a new zone with the same settings as an existing one.

Definition at line 2501 of file drawing_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return 0;
 
 ZONE_MODE zoneMode = aEvent.Parameter<ZONE_MODE>();
 MODE drawMode = MODE::ZONE;
 
 if( aEvent.IsAction( &PCB_ACTIONS::drawRuleArea ) )
 drawMode = MODE::KEEPOUT;
 
 if( aEvent.IsAction( &PCB_ACTIONS::drawPolygon ) )
 drawMode = MODE::GRAPHIC_POLYGON;
 
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, drawMode );
 
 // get a source zone, if we need one. We need it for:
 // ZONE_MODE::CUTOUT (adding a hole to the source zone)
 // ZONE_MODE::SIMILAR (creating a new zone using settings of source zone
 ZONE* sourceZone = nullptr;
 
 if( !getSourceZoneForAction( zoneMode, &sourceZone ) )
 return 0;
 
 // Turn zones on if they are off, so that the created object will be visible after completion
 m_frame->SetObjectVisible( LAYER_ZONES );
 
 ZONE_CREATE_HELPER::PARAMS params;
 
 params.m_keepout = drawMode == MODE::KEEPOUT;
 params.m_mode = zoneMode;
 params.m_sourceZone = sourceZone;
 
 if( zoneMode == ZONE_MODE::SIMILAR )
 params.m_layer = sourceZone->GetLayer();
 else
 params.m_layer = m_frame->GetActiveLayer();
 
 ZONE_CREATE_HELPER zoneTool( *this, params );
 // the geometry manager which handles the zone geometry, and hands the calculated points
 // over to the zone creator tool
 POLYGON_GEOM_MANAGER polyGeomMgr( zoneTool );
 bool started = false;
 PCB_GRID_HELPER grid( m_toolMgr, m_frame->GetMagneticItemsSettings() );
 
 m_frame->PushTool( aEvent );
 
 auto setCursor =
 [&]()
 {
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };
 
 auto cleanup =
 [&] ()
 {
 polyGeomMgr.Reset();
 started = false;
 grid.ClearSkipPoint();
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 };
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 m_controls->ShowCursor( true );
 m_controls->ForceCursorPosition( false );
 // Set initial cursor
 setCursor();
 
 if( aEvent.HasPosition() )
 m_toolMgr->PrimeTool( aEvent.Position() );
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 
 LSET layers( m_frame->GetActiveLayer() );
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 
 VECTOR2I cursorPos = evt->HasPosition() ? evt->Position() : m_controls->GetMousePosition();
 cursorPos = GetClampedCoords( grid.BestSnapAnchor( cursorPos, layers ), COORDS_PADDING );
 
 m_controls->ForceCursorPosition( true, cursorPos );
 
 polyGeomMgr.SetLeaderMode( Is45Limited() ? POLYGON_GEOM_MANAGER::LEADER_MODE::DEG45
 : POLYGON_GEOM_MANAGER::LEADER_MODE::DIRECT );
 
 if( evt->IsCancelInteractive() )
 {
 if( polyGeomMgr.IsPolygonInProgress() )
 {
 cleanup();
 }
 else
 {
 // We've handled the cancel event. Don't cancel other tools
 evt->SetPassEvent( false );
 m_frame->PopTool( aEvent );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( polyGeomMgr.IsPolygonInProgress() )
 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
 {
 m_frame->PopTool( aEvent );
 break;
 }
 }
 else if( evt->IsAction( &PCB_ACTIONS::layerChanged ) )
 {
 if( zoneMode != ZONE_MODE::SIMILAR )
 params.m_layer = frame()->GetActiveLayer();
 
 if( !m_view->IsLayerVisible( params.m_layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( params.m_layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 // events that lock in nodes
 else if( evt->IsClick( BUT_LEFT )
 || evt->IsDblClick( BUT_LEFT )
 || evt->IsAction( &PCB_ACTIONS::closeOutline ) )
 {
 // Check if it is double click / closing line (so we have to finish the zone)
 const bool endPolygon = evt->IsDblClick( BUT_LEFT )
 || evt->IsAction( &PCB_ACTIONS::closeOutline )
 || polyGeomMgr.NewPointClosesOutline( cursorPos );
 
 if( endPolygon )
 {
 polyGeomMgr.SetFinished();
 polyGeomMgr.Reset();
 
 started = false;
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 }
 // adding a corner
 else if( polyGeomMgr.AddPoint( cursorPos ) )
 {
 if( !started )
 {
 started = true;
 
 m_controls->SetAutoPan( true );
 m_controls->CaptureCursor( true );
 
 if( !m_view->IsLayerVisible( params.m_layer ) )
 {
 m_frame->GetAppearancePanel()->SetLayerVisible( params.m_layer, true );
 m_frame->GetCanvas()->Refresh();
 }
 }
 }
 }
 else if( evt->IsAction( &PCB_ACTIONS::deleteLastPoint ) )
 {
 polyGeomMgr.DeleteLastCorner();
 
 if( !polyGeomMgr.IsPolygonInProgress() )
 {
 // report finished as an empty shape
 polyGeomMgr.SetFinished();
 
 // start again
 started = false;
 m_controls->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 }
 }
 else if( polyGeomMgr.IsPolygonInProgress()
 && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
 {
 polyGeomMgr.SetCursorPosition( cursorPos );
 }
 else if( started && ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else if( started&& evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 frame()->OnEditItemRequest( zoneTool.GetZone() );
 zoneTool.OnGeometryChange( polyGeomMgr );
 frame()->SetMsgPanel( zoneTool.GetZone() );
 }
 /*else if( evt->IsAction( &ACTIONS::updateUnits ) )
 {
 // If we ever have an assistant here that reports dimensions, we'll want to
 // update its units here....
 // zoneAsst.SetUnits( frame()->GetUserUnits() );
 // m_view->Update( &zoneAsst );
 evt->SetPassEvent();
 }*/
 else
 {
 evt->SetPassEvent();
 }
 
 } // end while
 
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 m_controls->ForceCursorPosition( false );
 controls()->SetAutoPan( false );
 m_controls->CaptureCursor( false );
 return 0;
}

References TOOL_INTERACTIVE::Activate(), POLYGON_GEOM_MANAGER::AddPoint(), ARROW, BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), PCB_ACTIONS::closeOutline, PCB_TOOL_BASE::controls(), COORDS_PADDING, POLYGON_GEOM_MANAGER::DEG45, POLYGON_GEOM_MANAGER::DeleteLastCorner(), PCB_ACTIONS::deleteLastPoint, POLYGON_GEOM_MANAGER::DIRECT, PCB_ACTIONS::drawPolygon, PCB_ACTIONS::drawRuleArea, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), GetClampedCoords(), ZONE::GetLayer(), PCB_BASE_FRAME::GetMagneticItemsSettings(), PCB_BASE_FRAME::GetModel(), KIGFX::VIEW_CONTROLS::GetMousePosition(), getSourceZoneForAction(), TOOL_BASE::getView(), ZONE_CREATE_HELPER::GetZone(), GRAPHIC_POLYGON, grid, TOOL_EVENT::HasPosition(), PCB_TOOL_BASE::Is45Limited(), TOOL_EVENT::IsAction(), KIGFX::VIEW::IsLayerVisible(), POLYGON_GEOM_MANAGER::IsPolygonInProgress(), ZONE_FILLER_TOOL::IsZoneFillAction(), KEEPOUT, LAYER_ZONES, PCB_ACTIONS::layerChanged, m_controls, m_frame, PCB_TOOL_BASE::m_isFootprintEditor, ZONE_CREATE_HELPER::PARAMS::m_keepout, ZONE_CREATE_HELPER::PARAMS::m_layer, TOOL_INTERACTIVE::m_menu, m_mode, ZONE_CREATE_HELPER::PARAMS::m_mode, ZONE_CREATE_HELPER::PARAMS::m_sourceZone, TOOL_BASE::m_toolMgr, m_view, MD_SHIFT, POLYGON_GEOM_MANAGER::NewPointClosesOutline(), PCB_BASE_EDIT_FRAME::OnEditItemRequest(), ZONE_CREATE_HELPER::OnGeometryChange(), TOOL_EVENT::Parameter(), PENCIL, TOOLS_HOLDER::PopTool(), TOOL_EVENT::Position(), TOOL_MANAGER::PrimeTool(), PCB_ACTIONS::properties, TOOLS_HOLDER::PushTool(), EDA_DRAW_PANEL_GAL::Refresh(), POLYGON_GEOM_MANAGER::Reset(), PCB_TOOL_BASE::selection(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), POLYGON_GEOM_MANAGER::SetCursorPosition(), POLYGON_GEOM_MANAGER::SetFinished(), APPEARANCE_CONTROLS::SetLayerVisible(), POLYGON_GEOM_MANAGER::SetLeaderMode(), EDA_DRAW_FRAME::SetMsgPanel(), PCB_BASE_EDIT_FRAME::SetObjectVisible(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), SIMILAR, TOOL_INTERACTIVE::Wait(), and ZONE.

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(), MICROWAVE_TOOL::createBaseFootprint(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EDIT_TOOL::doMoveSelection(), DrawSpecificationStackup(), 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 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(), drawArc(), DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), drawShape(), DrawVia(), 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(), 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(), 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(), 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().

getClampedDifferenceEnd()

VECTOR2I DRAWING_TOOL::getClampedDifferenceEnd ( const VECTOR2I &  aOrigin, const VECTOR2I &  aEnd  )

inlineprivate

Clamps the end vector to respect numeric limits of difference representation.

Parameters

aOrigin	- the origin vector.
aEnd	- the end vector.

Returns

clamped end vector.

Definition at line 284 of file drawing_tool.h.

 {
 typedef std::numeric_limits<int> coord_limits;
 const int guardValue = 1;
 
 VECTOR2I::extended_type maxDiff = coord_limits::max() - guardValue;
 
 VECTOR2I::extended_type xDiff = VECTOR2I::extended_type( aEnd.x ) - aOrigin.x;
 VECTOR2I::extended_type yDiff = VECTOR2I::extended_type( aEnd.y ) - aOrigin.y;
 
 if( xDiff > maxDiff )
 xDiff = maxDiff;
 if( yDiff > maxDiff )
 yDiff = maxDiff;
 
 if( xDiff < -maxDiff )
 xDiff = -maxDiff;
 if( yDiff < -maxDiff )
 yDiff = -maxDiff;
 
 return aOrigin + VECTOR2I( int( xDiff ), int( yDiff ) );
 }

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawShape().

getClampedRadiusEnd()

VECTOR2I DRAWING_TOOL::getClampedRadiusEnd ( const VECTOR2I &  aOrigin, const VECTOR2I &  aEnd  )

inlineprivate

Clamps the end vector to respect numeric limits of radius representation.

Parameters

aOrigin	- the origin vector.
aEnd	- the end vector.

Returns

clamped end vector. Return the appropriate width for a segment depending on the settings.

Definition at line 314 of file drawing_tool.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawShape().

GetDrawingMode()

DRAWING_TOOL::MODE DRAWING_TOOL::GetDrawingMode

(

)

const

Return the current drawing mode of the DRAWING_TOOL or #MODE::NONE if not currently in any drawing mode.

Definition at line 279 of file drawing_tool.cpp.

{
 return m_mode;
}

References m_mode.

Referenced by BOARD_EDITOR_CONTROL::Init().

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

getSegmentWidth()

int DRAWING_TOOL::getSegmentWidth ( PCB_LAYER_ID  aLayer ) const

private

Definition at line 3262 of file drawing_tool.cpp.

{
 assert( m_board );
 return m_board->GetDesignSettings().GetLineThickness( aLayer );
}

References BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetLineThickness(), and m_board.

Referenced by drawArc(), and drawShape().

getSourceZoneForAction()

bool DRAWING_TOOL::getSourceZoneForAction ( ZONE_MODE  aMode, ZONE **  aZone  )

private

Draw a polygon, that is added as a zone or a keepout area.

Parameters

aKeepout	dictates if the drawn polygon is a zone or a keepout area.
aMode	dictates the mode of the zone tool: ADD add a new zone/keepout with fresh settings CUTOUT add a cutout to an existing zone SIMILAR add a new zone with the same settings as an existing one Get a source zone item for an action that takes an existing zone into account (for example a cutout of an existing zone).

The source zone is taken from the current selection.

Parameters

aMode	mode of the zone tool
aZone	updated pointer to a suitable source zone, or nullptr if none found, or the action doesn't need a source

Returns

true if a suitable zone was found, or the action doesn't need a zone. False if the action needs a zone but none was found.

Definition at line 2467 of file drawing_tool.cpp.

{
 bool clearSelection = false;
 *aZone = nullptr;
 
 // not an action that needs a source zone
 if( aMode == ZONE_MODE::ADD || aMode == ZONE_MODE::GRAPHIC_POLYGON )
 return true;
 
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 const PCB_SELECTION& selection = selTool->GetSelection();
 
 if( selection.Empty() )
 {
 clearSelection = true;
 m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true );
 }
 
 // we want a single zone
 if( selection.Size() == 1 )
 *aZone = dyn_cast<ZONE*>( selection[0] );
 
 // expected a zone, but didn't get one
 if( !*aZone )
 {
 if( clearSelection )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 return false;
 }
 
 return true;
}

References ADD, SELECTION::Empty(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), GRAPHIC_POLYGON, TOOL_BASE::m_toolMgr, TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectionCursor, and SELECTION::Size().

Referenced by DrawZone().

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(), drawArc(), DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), drawShape(), 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(), PlaceImage(), PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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(), 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(), 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(), DrawCircle(), DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), 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(), 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(), 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(), CONVERT_TOOL::setTransitions(), 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 DRAWING_TOOL::Init ( )

overridevirtual

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 186 of file drawing_tool.cpp.

{
 auto haveHighlight =
 [&]( const SELECTION& sel )
 {
 KIGFX::RENDER_SETTINGS* cfg = m_toolMgr->GetView()->GetPainter()->GetSettings();
 
 return !cfg->GetHighlightNetCodes().empty();
 };
 
 auto activeToolFunctor =
 [this]( const SELECTION& aSel )
 {
 return m_mode != MODE::NONE;
 };
 
 // some interactive drawing tools can undo the last point
 auto canUndoPoint =
 [this]( const SELECTION& aSel )
 {
 return ( m_mode == MODE::ARC
 || m_mode == MODE::ZONE
 || m_mode == MODE::KEEPOUT
 || m_mode == MODE::GRAPHIC_POLYGON );
 };
 
 // functor for tools that can automatically close the outline
 auto canCloseOutline =
 [this]( const SELECTION& aSel )
 {
 return ( m_mode == MODE::ZONE
 || m_mode == MODE::KEEPOUT
 || m_mode == MODE::GRAPHIC_POLYGON );
 };
 
 auto arcToolActive =
 [this]( const SELECTION& aSel )
 {
 return m_mode == MODE::ARC;
 };
 
 auto viaToolActive =
 [this]( const SELECTION& aSel )
 {
 return m_mode == MODE::VIA;
 };
 
 CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
 
 // cancel current tool goes in main context menu at the top if present
 ctxMenu.AddItem( ACTIONS::cancelInteractive, activeToolFunctor, 1 );
 ctxMenu.AddSeparator( 1 );
 
 ctxMenu.AddItem( PCB_ACTIONS::clearHighlight, haveHighlight, 2 );
 ctxMenu.AddSeparator( haveHighlight, 2 );
 
 // tool-specific actions
 ctxMenu.AddItem( PCB_ACTIONS::closeOutline, canCloseOutline, 200 );
 ctxMenu.AddItem( PCB_ACTIONS::deleteLastPoint, canUndoPoint, 200 );
 ctxMenu.AddItem( PCB_ACTIONS::arcPosture, arcToolActive, 200 );
 
 ctxMenu.AddCheckItem( PCB_ACTIONS::toggleHV45Mode, SELECTION_CONDITIONS::ShowAlways, 250 );
 ctxMenu.AddSeparator( 500 );
 
 std::shared_ptr<VIA_SIZE_MENU> viaSizeMenu = std::make_shared<VIA_SIZE_MENU>();
 viaSizeMenu->SetTool( this );
 m_menu.RegisterSubMenu( viaSizeMenu );
 ctxMenu.AddMenu( viaSizeMenu.get(), viaToolActive, 500 );
 
 ctxMenu.AddSeparator( 500 );
 
 // Type-specific sub-menus will be added for us by other tools
 // For example, zone fill/unfill is provided by the PCB control tool
 
 // Finally, add the standard zoom/grid items
 getEditFrame<PCB_BASE_FRAME>()->AddStandardSubMenus( m_menu );
 
 return true;
}

References CONDITIONAL_MENU::AddCheckItem(), CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), CONDITIONAL_MENU::AddSeparator(), ARC, PCB_ACTIONS::arcPosture, ACTIONS::cancelInteractive, PCB_ACTIONS::clearHighlight, PCB_ACTIONS::closeOutline, PCB_ACTIONS::deleteLastPoint, KIGFX::RENDER_SETTINGS::GetHighlightNetCodes(), TOOL_MENU::GetMenu(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetView(), GRAPHIC_POLYGON, KEEPOUT, TOOL_INTERACTIVE::m_menu, m_mode, TOOL_BASE::m_toolMgr, NONE, TOOL_MENU::RegisterSubMenu(), SELECTION_CONDITIONS::ShowAlways(), PCB_ACTIONS::toggleHV45Mode, VIA, and ZONE.

InteractivePlaceWithPreview()

int DRAWING_TOOL::InteractivePlaceWithPreview	(	const TOOL_EVENT &	aEvent,
		std::vector< BOARD_ITEM * > &	aItems,
		std::vector< BOARD_ITEM * > &	aPreview,
		LSET *	aLayers
	)

Interactively place a set of BOARD_ITEM.

As a list of BOARD_ITEMs can be resource intesive to move around, we can use a reduced set of BOARD_ITEMs for preview purpose only.

Parameters

aEvent
aItems	BOARD_ITEMs to add to the board.
aPreview	BOARD_ITEMs only used during placement / preview.
aLayers	Set of allowed destination when asking the user. If set to NULL, the user is not asked and all BOARD_ITEMs remain on their layers.

Definition at line 540 of file drawing_stackup_table_tool.cpp.

{
 if( m_isFootprintEditor && !m_frame->GetModel() )
 return -1;
 
 bool cancelled = false;
 
 BOARD_COMMIT commit( m_frame );
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 // do not capture or auto-pan until we start placing the table
 SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::TEXT );
 
 m_frame->PushTool( aEvent );
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 m_controls->ShowCursor( true );
 
 if( aEvent.HasPosition() )
 m_toolMgr->PrimeTool( aEvent.Position() );
 
 // Main loop: keep receiving events
 VECTOR2I cursorPosition;
 VECTOR2I previousCursorPosition;
 
 view()->ClearPreview();
 view()->InitPreview();
 
 for( BOARD_ITEM* item : aPreview )
 {
 item->Move( cursorPosition - previousCursorPosition );
 view()->AddToPreview( item );
 }
 
 while( TOOL_EVENT* evt = Wait() )
 {
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 cursorPosition = m_controls->GetCursorPosition();
 
 if( evt->IsCancelInteractive() )
 {
 m_frame->PopTool( aEvent );
 cancelled = true;
 break;
 }
 else if( evt->IsMotion() )
 {
 view()->ShowPreview( false );
 
 for( BOARD_ITEM* item : aPreview )
 item->Move( cursorPosition - previousCursorPosition );
 
 view()->ShowPreview( true );
 
 previousCursorPosition = cursorPosition;
 }
 else if( evt->IsActivate() )
 {
 if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 cancelled = true;
 break;
 }
 else
 {
 m_frame->PopTool( aEvent );
 cancelled = true;
 break;
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsClick( BUT_LEFT ) )
 {
 if( aLayers != nullptr )
 {
 PCB_LAYER_ID destLayer = frame()->SelectOneLayer( PCB_LAYER_ID::PCB_LAYER_ID_COUNT,
 *aLayers, wxGetMousePosition() );
 
 view()->ClearPreview();
 
 if( destLayer == PCB_LAYER_ID::UNDEFINED_LAYER )
 {
 // The user did not pick any layer.
 m_frame->PopTool( aEvent );
 cancelled = true;
 break;
 }
 
 for( BOARD_ITEM* item : aItems )
 {
 if( item->Type() == PCB_GROUP_T )
 static_cast<PCB_GROUP*>( item )->SetLayerRecursive( destLayer, 200 );
 else
 item->SetLayer( destLayer );
 }
 }
 
 for( BOARD_ITEM* item : aItems )
 {
 item->Move( cursorPosition );
 
 if( item->Type() == PCB_GROUP_T )
 static_cast<PCB_GROUP*>( item )->AddChildrenToCommit( commit );
 
 commit.Add( item );
 }
 
 commit.Push( wxT( "Placing items" ) );
 m_frame->PopTool( aEvent );
 
 break;
 }
 // TODO: It'd be nice to be able to say "don't allow any non-trivial editing actions",
 // but we don't at present have that, so we just knock out some of the egregious ones.
 else if( ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 view()->ClearPreview();
 frame()->SetMsgPanel( board() );
 
 if( cancelled )
 return -1;
 
 return 0;
}

References TOOL_INTERACTIVE::Activate(), COMMIT::Add(), PCB_GROUP::AddChildrenToCommit(), KIGFX::VIEW::AddToPreview(), PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW::ClearPreview(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_BASE_FRAME::GetModel(), TOOL_EVENT::HasPosition(), KIGFX::VIEW::InitPreview(), ZONE_FILLER_TOOL::IsZoneFillAction(), m_controls, m_frame, PCB_TOOL_BASE::m_isFootprintEditor, TOOL_INTERACTIVE::m_menu, m_mode, TOOL_BASE::m_toolMgr, PCB_GROUP_T, PCB_LAYER_ID_COUNT, PENCIL, TOOLS_HOLDER::PopTool(), TOOL_EVENT::Position(), TOOL_MANAGER::PrimeTool(), BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_BASE_FRAME::SelectOneLayer(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PCB_GROUP::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), KIGFX::VIEW::ShowPreview(), TEXT, UNDEFINED_LAYER, PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

Referenced by PlaceCharacteristics(), and PlaceStackup().

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 drawArc(), DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), drawShape(), 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().

PlaceCharacteristics()

int DRAWING_TOOL::PlaceCharacteristics

(

const TOOL_EVENT &

aEvent

)

Definition at line 683 of file drawing_stackup_table_tool.cpp.

{
 VECTOR2I tableSize;
 
 LSET layerSet = ( layerSet.AllCuMask() | layerSet.AllTechMask() );
 layerSet = layerSet.set( Edge_Cuts ).set( Margin );
 layerSet = layerSet.reset( F_Fab ).reset( B_Fab );
 
 PCB_LAYER_ID layer = m_frame->GetActiveLayer();
 
 if( ( layerSet & LSET( layer ) ).count() ) // if layer is a forbidden layer
 m_frame->SetActiveLayer( Cmts_User );
 
 std::vector<BOARD_ITEM*> table = DrawBoardCharacteristics( { 0, 0 }, m_frame->GetActiveLayer(),
 false, &tableSize );
 std::vector<BOARD_ITEM*> preview;
 std::vector<BOARD_ITEM*> items;
 
 PCB_SHAPE* line1 = new PCB_SHAPE;
 PCB_SHAPE* line2 = new PCB_SHAPE;
 PCB_SHAPE* line3 = new PCB_SHAPE;
 PCB_SHAPE* line4 = new PCB_SHAPE;
 
 line1->SetStart( VECTOR2I( 0, 0 ) );
 line1->SetEnd( VECTOR2I( tableSize.x, 0 ) );
 
 line2->SetStart( VECTOR2I( 0, 0 ) );
 line2->SetEnd( VECTOR2I( 0, tableSize.y ) );
 
 line3->SetStart( VECTOR2I( tableSize.x, 0 ) );
 line3->SetEnd( tableSize );
 
 line4->SetStart( VECTOR2I( 0, tableSize.y ) );
 line4->SetEnd( tableSize );
 
 line1->SetLayer( m_frame->GetActiveLayer() );
 line2->SetLayer( m_frame->GetActiveLayer() );
 line3->SetLayer( m_frame->GetActiveLayer() );
 line4->SetLayer( m_frame->GetActiveLayer() );
 
 preview.push_back( line1 );
 preview.push_back( line2 );
 preview.push_back( line3 );
 preview.push_back( line4 );
 
 PCB_GROUP* group = new PCB_GROUP( m_board );
 group->SetName("group-boardCharacteristics");
 
 for( auto item : table )
 group->AddItem( static_cast<BOARD_ITEM*>( item ) );
 
 items.push_back( static_cast<BOARD_ITEM*>( group ) );
 
 if( InteractivePlaceWithPreview( aEvent, items, preview, &layerSet ) == -1 )
 m_frame->SetActiveLayer( layer );
 else
 m_frame->SetActiveLayer( table.front()->GetLayer() );
 
 return 0;
}

References LSET::AllCuMask(), LSET::AllTechMask(), B_Fab, Cmts_User, DrawBoardCharacteristics(), Edge_Cuts, F_Fab, PCB_BASE_FRAME::GetActiveLayer(), group, InteractivePlaceWithPreview(), m_board, m_frame, Margin, PCB_BASE_FRAME::SetActiveLayer(), EDA_SHAPE::SetEnd(), BOARD_ITEM::SetLayer(), EDA_SHAPE::SetStart(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

PlaceImage()

int DRAWING_TOOL::PlaceImage

(

const TOOL_EVENT &

aEvent

)

Display a dialog that allows one to select and image then decide where to place the image in the editor.

Definition at line 533 of file drawing_tool.cpp.

{
 if( m_inDrawingTool )
 return 0;
 
 REENTRANCY_GUARD guard( &m_inDrawingTool );
 
 PCB_BITMAP* image = aEvent.Parameter<PCB_BITMAP*>();
 bool immediateMode = image != nullptr;
 PCB_GRID_HELPER grid( m_toolMgr, m_frame->GetMagneticItemsSettings() );
 bool ignorePrimePosition = false;
 COMMON_SETTINGS* common_settings = Pgm().GetCommonSettings();
 
 VECTOR2I cursorPos = getViewControls()->GetCursorPosition();
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 BOARD_COMMIT commit( m_frame );
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 // Add all the drawable symbols to preview
 if( image )
 {
 image->SetPosition( cursorPos );
 m_view->ClearPreview();
 m_view->AddToPreview( image, false ); // Add, but not give ownership
 }
 
 m_frame->PushTool( aEvent );
 auto setCursor =
 [&]()
 {
 if( image )
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::MOVING );
 else
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };
 
 auto cleanup =
 [&] ()
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 m_view->ClearPreview();
 m_view->RecacheAllItems();
 delete image;
 image = nullptr;
 };
 
 Activate();
 
 // Must be done after Activate() so that it gets set into the correct context
 getViewControls()->ShowCursor( true );
 
 // Set initial cursor
 setCursor();
 
 // Prime the pump
 if( image )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else if( aEvent.HasPosition() )
 {
 m_toolMgr->PrimeTool( aEvent.