KiCad PCB EDA Suite
two_point_assistant.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) 2020 Kicad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
25 #define PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
26 
27 #include <eda_item.h>
30 
31 namespace KIGFX
32 {
33 namespace PREVIEW
34 {
35 
36 // TODO: required until PCB_SHAPE_TYPE_T is moved into commons or a better approach is found
37 enum class GEOM_SHAPE
38 {
39  SEGMENT = 0,
40  RECT,
41  ARC,
42  CIRCLE,
43  POLYGON,
44  CURVE
45 };
46 
51 {
52 public:
54  GEOM_SHAPE aShape );
55 
56  const BOX2I ViewBBox() const override;
57 
58  void ViewGetLayers( int aLayers[], int& aCount ) const override
59  {
60  aLayers[0] = LAYER_SELECT_OVERLAY; // Assitant graphics
61  aLayers[1] = LAYER_GP_OVERLAY; // Drop shadows
62  aCount = 2;
63  }
64 
68  void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override final;
69 
70 #if defined( DEBUG )
71  void Show( int x, std::ostream& st ) const override
72  {
73  }
74 #endif
75 
80  wxString GetClass() const override
81  {
82  return "TWO_POINT_ASSISTANT";
83  }
84 
85  void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }
86 
87 private:
91 };
92 
93 } // namespace PREVIEW
94 } // namespace KIGFX
95 
96 #endif // PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:175
const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
Represents an assistant draw when interactively drawing a line or circle on a canvas.
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override final
Draw the assistance (with reference to the contstruction manager.
wxString GetClass() const override
Get class name.
const TWO_POINT_GEOMETRY_MANAGER & m_constructMan
EDA_UNITS
Definition: eda_units.h:38
void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.
Board layer functions and definitions.
currently selected items overlay
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
TWO_POINT_ASSISTANT(const TWO_POINT_GEOMETRY_MANAGER &aManager, EDA_UNITS aUnits, GEOM_SHAPE aShape)
VIEW.
Definition: view.h:63