KiCad PCB EDA Suite
marker_base.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) 2009-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2009-2020 KiCad Developers, see AUTHORS.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 
26 #ifndef MARKER_BASE_H
27 #define MARKER_BASE_H
28 
29 #include <memory>
30 
31 #include <rc_item.h>
32 #include <gr_basic.h>
33 #include <eda_rect.h>
34 
35 
36 class SHAPE_LINE_CHAIN;
37 
38 namespace KIGFX
39 {
40  class RENDER_SETTINGS;
41 }
42 
44 
45 
46 /*
47  * Marker are mainly used to show a DRC or ERC error or warning
48  */
50 {
51 public:
52  enum TYPEMARKER {
57  };
58 
59  MARKER_BASE( int aScalingFactor, std::shared_ptr<RC_ITEM> aItem,
60  TYPEMARKER aType = MARKER_UNSPEC );
61  virtual ~MARKER_BASE();
62 
66  int MarkerScale() const { return m_scalingFactor; }
67  void SetMarkerScale( int aScale ) { m_scalingFactor = aScale; }
68 
75  void ShapeToPolygon( SHAPE_LINE_CHAIN& aPolygon, int aScale = -1 ) const;
76 
80  void PrintMarker( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset );
81 
85  const wxPoint& GetPos() const { return m_Pos; }
86 
87  virtual const KIID GetUUID() const = 0;
88 
92  void SetMarkerType( enum TYPEMARKER aMarkerType ) { m_markerType = aMarkerType; }
93  enum TYPEMARKER GetMarkerType() const { return m_markerType; }
94 
95  bool IsExcluded() const { return m_excluded; }
96  void SetExcluded( bool aExcluded ) { m_excluded = aExcluded; }
97 
101  std::shared_ptr<RC_ITEM> GetRCItem() const { return m_rcItem; }
102 
109  bool HitTestMarker( const wxPoint& aHitPosition, int aAccuracy ) const;
110 
119 
120 protected:
121  virtual KIGFX::COLOR4D getColor() const = 0;
122 
123 public:
124  wxPoint m_Pos;
125 
126 protected:
127  TYPEMARKER m_markerType; // The type of marker (useful to filter markers)
128  bool m_excluded; // User has excluded this specific error
129  std::shared_ptr<RC_ITEM> m_rcItem;
130 
131  int m_scalingFactor; // Scaling factor to convert corners coordinates
132  // to internal units coordinates
133  EDA_RECT m_shapeBoundingBox; // Bounding box of the graphic symbol, relative
134  // to the position of the shape, in marker shape
135  // units
136 };
137 
138 
139 #endif // MARKER_BASE_H
const wxPoint & GetPos() const
Definition: marker_base.h:85
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:243
bool m_excluded
Definition: marker_base.h:128
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
virtual ~MARKER_BASE()
Definition: marker_base.cpp:85
wxPoint m_Pos
position of the marker
Definition: marker_base.h:124
TYPEMARKER m_markerType
Definition: marker_base.h:127
virtual KIGFX::COLOR4D getColor() const =0
EDA_RECT GetBoundingBoxMarker() const
Return the orthogonal, bounding box of this object for display purposes.
void PrintMarker(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset)
Print the shape is the polygon defined in m_Corners (array of wxPoints).
Definition: kiid.h:44
bool HitTestMarker(const wxPoint &aHitPosition, int aAccuracy) const
Test if the given wxPoint is within the bounds of this object.
Definition: marker_base.cpp:90
void SetExcluded(bool aExcluded)
Definition: marker_base.h:96
std::shared_ptr< RC_ITEM > m_rcItem
Definition: marker_base.h:129
EDA_RECT m_shapeBoundingBox
Definition: marker_base.h:133
bool IsExcluded() const
Definition: marker_base.h:95
void SetMarkerScale(int aScale)
Definition: marker_base.h:67
void SetMarkerType(enum TYPEMARKER aMarkerType)
Accessors to set/get marker type (DRC, ERC, or other)
Definition: marker_base.h:92
int m_scalingFactor
Definition: marker_base.h:131
void ShapeToPolygon(SHAPE_LINE_CHAIN &aPolygon, int aScale=-1) const
Return the shape polygon in internal units in a SHAPE_LINE_CHAIN the coordinates are relatives to the...
int MarkerScale() const
The scaling factor to convert polygonal shape coordinates to internal units.
Definition: marker_base.h:66
MARKER_BASE(int aScalingFactor, std::shared_ptr< RC_ITEM > aItem, TYPEMARKER aType=MARKER_UNSPEC)
Definition: marker_base.cpp:61
enum TYPEMARKER GetMarkerType() const
Definition: marker_base.h:93
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Handle the component boundary box.
Definition: eda_rect.h:42
virtual const KIID GetUUID() const =0
std::shared_ptr< RC_ITEM > GetRCItem() const
Definition: marker_base.h:101
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103