KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drawing_tool.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2014-2017 CERN
5 * Copyright (C) 2018-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef __DRAWING_TOOL_H
28#define __DRAWING_TOOL_H
29
30#include <stack>
31#include <optional>
32#include <tool/tool_menu.h>
33#include <tools/pcb_tool_base.h>
34#include <tools/pcb_actions.h>
35
36namespace KIGFX
37{
38 class VIEW;
39 class VIEW_CONTROLS;
40}
41
42class BOARD;
44class PCB_SHAPE;
47class STATUS_MIN_MAX_POPUP;
48
49
55{
56public:
59
61 bool Init() override;
62
64 void Reset( RESET_REASON aReason ) override;
65
67 enum class MODE
68 {
69 NONE,
70 LINE,
72 CIRCLE,
73 ARC,
74 IMAGE,
75 TEXT,
76 ANCHOR,
77 DXF,
79 KEEPOUT,
80 ZONE,
82 VIA,
83 TUNING
84 };
85
90 MODE GetDrawingMode() const;
91
94 std::vector<BOARD_ITEM*> DrawBoardCharacteristics( const VECTOR2I& origin, PCB_LAYER_ID aLayer,
95 bool aDrawNow, VECTOR2I* tablesize );
96
99 std::vector<BOARD_ITEM*> DrawSpecificationStackup( const VECTOR2I& origin, PCB_LAYER_ID aLayer,
100 bool aDrawNow, VECTOR2I* tablesize );
101
104 int PlaceCharacteristics( const TOOL_EVENT& aEvent );
105
108 int PlaceStackup( const TOOL_EVENT& aEvent );
109
112 int PlaceTuningPattern( const TOOL_EVENT& aEvent );
113
121 int DrawLine( const TOOL_EVENT& aEvent );
122
129 int DrawRectangle( const TOOL_EVENT& aEvent );
130
137 int DrawCircle( const TOOL_EVENT& aEvent );
138
146 int DrawArc( const TOOL_EVENT& aEvent );
147
152 int PlaceReferenceImage( const TOOL_EVENT& aEvent );
153
158 int PlaceText( const TOOL_EVENT& aEvent );
159
167 int DrawDimension( const TOOL_EVENT& aEvent );
168
182 int DrawZone( const TOOL_EVENT& aEvent );
183
184 int DrawVia( const TOOL_EVENT& aEvent );
185
189 int PlaceImportedGraphics( const TOOL_EVENT& aEvent );
190
203 int InteractivePlaceWithPreview( const TOOL_EVENT& aEvent,
204 std::vector<BOARD_ITEM*>& aItems,
205 std::vector<BOARD_ITEM*>& aPreview, LSET* aLayers );
206
207
211 int SetAnchor( const TOOL_EVENT& aEvent );
212
216 int ToggleHV45Mode( const TOOL_EVENT& toolEvent );
217
219 void setTransitions() override;
220
221 void SetStroke( const STROKE_PARAMS& aStroke, PCB_LAYER_ID aLayer )
222 {
223 m_layer = aLayer;
224 m_stroke = aStroke;
225 }
226
227 void UpdateStatusBar() const;
228
229private:
241 bool drawShape( const TOOL_EVENT& aTool, PCB_SHAPE** aGraphic,
242 std::optional<VECTOR2D> aStartingPoint,
243 std::stack<PCB_SHAPE*>* aCommittedGraphics );
244
253 bool drawArc( const TOOL_EVENT& aTool, PCB_SHAPE** aGraphic,
254 std::optional<VECTOR2D> aStartingPoint );
255
278 bool getSourceZoneForAction( ZONE_MODE aMode, ZONE** aZone );
279
286
294 VECTOR2I getClampedDifferenceEnd( const VECTOR2I& aOrigin, const VECTOR2I& aEnd )
295 {
296 typedef std::numeric_limits<int> coord_limits;
297 const int guardValue = 1;
298
299 VECTOR2I::extended_type maxDiff = coord_limits::max() - guardValue;
300
301 VECTOR2I::extended_type xDiff = VECTOR2I::extended_type( aEnd.x ) - aOrigin.x;
302 VECTOR2I::extended_type yDiff = VECTOR2I::extended_type( aEnd.y ) - aOrigin.y;
303
304 if( xDiff > maxDiff )
305 xDiff = maxDiff;
306 if( yDiff > maxDiff )
307 yDiff = maxDiff;
308
309 if( xDiff < -maxDiff )
310 xDiff = -maxDiff;
311 if( yDiff < -maxDiff )
312 yDiff = -maxDiff;
313
314 return aOrigin + VECTOR2I( int( xDiff ), int( yDiff ) );
315 }
316
324 VECTOR2I getClampedRadiusEnd( const VECTOR2I& aOrigin, const VECTOR2I& aEnd )
325 {
326 typedef std::numeric_limits<int> coord_limits;
327 const int guardValue = 10;
328
329 VECTOR2I::extended_type xDiff = VECTOR2I::extended_type( aEnd.x ) - aOrigin.x;
330 VECTOR2I::extended_type yDiff = VECTOR2I::extended_type( aEnd.y ) - aOrigin.y;
331
332 double maxRadius = coord_limits::max() / 2 - guardValue;
333 double radius = std::hypot( xDiff, yDiff );
334
335 if( radius > maxRadius )
336 {
337 double scaleFactor = maxRadius / radius;
338
339 xDiff = KiROUND<double, int>( xDiff * scaleFactor );
340 yDiff = KiROUND<double, int>( yDiff * scaleFactor );
341 }
342
343 return aOrigin + VECTOR2I( int( xDiff ), int( yDiff ) );
344 }
345
351 bool m_inDrawingTool; // Re-entrancy guard
352
353 PCB_LAYER_ID m_layer; // The layer we last drew on
354 STROKE_PARAMS m_stroke; // Current stroke for multi-segment drawing
356
360
361 static const unsigned int WIDTH_STEP; // Amount of width change for one -/+ key press
362 static const unsigned int COORDS_PADDING; // Padding from coordinates limits for this tool
363
364
365 friend class ZONE_CREATE_HELPER; // give internal access to helper classes
366};
367
368#endif /* __DRAWING_TOOL_H */
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
Definition: drawing_tool.h:55
TEXT_ATTRIBUTES m_textAttrs
Definition: drawing_tool.h:355
MODE GetDrawingMode() const
Return the current drawing mode of the DRAWING_TOOL or MODE::NONE if not currently in any drawing mod...
void SetStroke(const STROKE_PARAMS &aStroke, PCB_LAYER_ID aLayer)
Definition: drawing_tool.h:221
PCB_SELECTION m_preview
Definition: drawing_tool.h:357
PCB_LAYER_ID m_layer
Definition: drawing_tool.h:353
int SetAnchor(const TOOL_EVENT &aEvent)
Place the footprint anchor (only in footprint editor).
int DrawDimension(const TOOL_EVENT &aEvent)
Start interactively drawing a dimension.
int DrawVia(const TOOL_EVENT &aEvent)
KIGFX::VIEW_CONTROLS * m_controls
Definition: drawing_tool.h:347
KIGFX::VIEW * m_view
Definition: drawing_tool.h:346
STROKE_PARAMS m_stroke
Definition: drawing_tool.h:354
int DrawZone(const TOOL_EVENT &aEvent)
Start interactively drawing a zone.
int DrawLine(const TOOL_EVENT &aEvent)
Start interactively drawing a line.
int DrawArc(const TOOL_EVENT &aEvent)
Start interactively drawing an arc.
VECTOR2I getClampedDifferenceEnd(const VECTOR2I &aOrigin, const VECTOR2I &aEnd)
Clamps the end vector to respect numeric limits of difference representation.
Definition: drawing_tool.h:294
BOARD_CONNECTED_ITEM * m_pickerItem
Definition: drawing_tool.h:358
int ToggleHV45Mode(const TOOL_EVENT &toolEvent)
Toggle the horizontal/vertical/45-degree constraint for drawing tools.
int PlaceCharacteristics(const TOOL_EVENT &aEvent)
bool drawShape(const TOOL_EVENT &aTool, PCB_SHAPE **aGraphic, std::optional< VECTOR2D > aStartingPoint, std::stack< PCB_SHAPE * > *aCommittedGraphics)
Start drawing a selected shape (i.e.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int PlaceImportedGraphics(const TOOL_EVENT &aEvent)
Place a drawing imported from a DXF or SVG file in footprint editor.
int PlaceStackup(const TOOL_EVENT &aEvent)
VECTOR2I getClampedRadiusEnd(const VECTOR2I &aOrigin, const VECTOR2I &aEnd)
Clamps the end vector to respect numeric limits of radius representation.
Definition: drawing_tool.h:324
bool m_inDrawingTool
Definition: drawing_tool.h:351
static const unsigned int WIDTH_STEP
Definition: drawing_tool.h:361
static const unsigned int COORDS_PADDING
Definition: drawing_tool.h:362
bool drawArc(const TOOL_EVENT &aTool, PCB_SHAPE **aGraphic, std::optional< VECTOR2D > aStartingPoint)
Start drawing an arc.
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.
std::vector< BOARD_ITEM * > DrawBoardCharacteristics(const VECTOR2I &origin, PCB_LAYER_ID aLayer, bool aDrawNow, VECTOR2I *tablesize)
int DrawCircle(const TOOL_EVENT &aEvent)
Start interactively drawing a circle.
int PlaceTuningPattern(const TOOL_EVENT &aEvent)
std::vector< BOARD_ITEM * > DrawSpecificationStackup(const VECTOR2I &origin, PCB_LAYER_ID aLayer, bool aDrawNow, VECTOR2I *tablesize)
BOARD * m_board
Definition: drawing_tool.h:348
int DrawRectangle(const TOOL_EVENT &aEvent)
Start interactively drawing a rectangle.
bool Init() override
Init() is called once upon a registration of the tool.
void constrainDimension(PCB_DIMENSION_BASE *aDim)
Force the dimension lime to be drawn on multiple of 45 degrees.
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 t...
PCB_BASE_EDIT_FRAME * m_frame
Definition: drawing_tool.h:349
void UpdateStatusBar() const
int PlaceReferenceImage(const TOOL_EVENT &aEvent)
Display a dialog that allows one to select a reference image and then decide where to place the image...
PCB_TUNING_PATTERN * m_tuningPattern
Definition: drawing_tool.h:359
bool getSourceZoneForAction(ZONE_MODE aMode, ZONE **aZone)
Draw a polygon, that is added as a zone or a keepout area.
An interface for classes handling user events controlling the view behavior such as zooming,...
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:573
Common, abstract interface for edit frames.
Abstract dimension API.
Class that handles the drawing of a polygon, including management of last corner deletion and drawing...
Simple container to manage line stroke parameters.
Definition: stroke_params.h:81
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:167
VECTOR2_TRAITS< int >::extended_type extended_type
Definition: vector2d.h:72
An adjunct helper to the DRAWING_TOOL interactive tool, which handles incoming geometry changes from ...
Handle a list of polygons defining a copper zone.
Definition: zone.h:72
void Reset() override
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:247
ZONE_MODE
Definition: pcb_actions.h:35
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588