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) 1992-2014 KiCad Developers, see CHANGELOG.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 <rc_item.h>
30 #include <gr_basic.h>
31 #include <eda_rect.h>
32 
33 
34 class SHAPE_LINE_CHAIN;
35 
36 namespace KIGFX
37 {
38  class RENDER_SETTINGS;
39 }
40 
42 
43 
44 /*
45  * Marker are mainly used to show a DRC or ERC error or warning
46  */
47 
48 
50 {
51 public:
52  enum TYPEMARKER {
57  };
58 
60 
61 protected:
62  TYPEMARKER m_markerType; // The type of marker (useful to filter markers)
63  bool m_excluded; // User has excluded this specific error
65 
66  int m_scalingFactor; // Scaling factor to convert corners coordinates
67  // to internat units coordinates
68  EDA_RECT m_shapeBoundingBox; // Bounding box of the graphic symbol, relative
69  // to the position of the shape, in marker shape
70  // units
71 
72 public:
73 
74  MARKER_BASE( int aScalingFactor, RC_ITEM* aItem, TYPEMARKER aType = MARKER_UNSPEC );
75 
76  virtual ~MARKER_BASE();
77 
80  int MarkerScale() const { return m_scalingFactor; }
81 
86  void ShapeToPolygon( SHAPE_LINE_CHAIN& aPolygon) const;
87 
92  void PrintMarker( RENDER_SETTINGS* aSettings, const wxPoint& aOffset );
93 
98  const wxPoint& GetPos() const { return m_Pos; }
99 
100  virtual const KIID GetUUID() const = 0;
101 
105  void SetMarkerType( enum TYPEMARKER aMarkerType ) { m_markerType = aMarkerType; }
106  enum TYPEMARKER GetMarkerType() const { return m_markerType; }
107 
108  bool IsExcluded() const { return m_excluded; }
109  void SetExcluded( bool aExcluded ) { m_excluded = aExcluded; }
110 
117  RC_ITEM* GetRCItem() { return m_rcItem; }
118  const RC_ITEM* GetRCItem() const { return m_rcItem; }
119 
125  bool HitTestMarker( const wxPoint& aHitPosition, int aAccuracy ) const;
126 
135 
136 protected:
137  virtual KIGFX::COLOR4D getColor() const = 0;
138 };
139 
140 
141 #endif // MARKER_BASE_H
const wxPoint & GetPos() const
Function GetPos.
Definition: marker_base.h:98
MARKER_BASE(int aScalingFactor, RC_ITEM *aItem, TYPEMARKER aType=MARKER_UNSPEC)
Definition: marker_base.cpp:62
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:175
RC_ITEM * GetRCItem()
Function GetReporter returns the DRC_ITEM held within this MARKER so that its interface may be used.
Definition: marker_base.h:117
bool m_excluded
Definition: marker_base.h:63
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
virtual ~MARKER_BASE()
Definition: marker_base.cpp:86
RC_ITEM is a holder for a DRC (in Pcbnew) or ERC (in Eeschema) error item.
Definition: rc_item.h:77
wxPoint m_Pos
position of the marker
Definition: marker_base.h:59
TYPEMARKER m_markerType
Definition: marker_base.h:62
virtual KIGFX::COLOR4D getColor() const =0
EDA_RECT GetBoundingBoxMarker() const
Function GetBoundingBoxMarker returns the orthogonal, bounding box of this object for display purpose...
RC_ITEM * m_rcItem
Definition: marker_base.h:64
Definition: common.h:68
bool HitTestMarker(const wxPoint &aHitPosition, int aAccuracy) const
Tests if the given wxPoint is within the bounds of this object.
Definition: marker_base.cpp:92
void SetExcluded(bool aExcluded)
Definition: marker_base.h:109
EDA_RECT m_shapeBoundingBox
Definition: marker_base.h:68
void PrintMarker(RENDER_SETTINGS *aSettings, const wxPoint &aOffset)
Function PrintMarker Prints the shape is the polygon defined in m_Corners (array of wxPoints).
void ShapeToPolygon(SHAPE_LINE_CHAIN &aPolygon) const
Returns the shape polygon in internal units in a SHAPE_LINE_CHAIN the coordinates are relatives to th...
bool IsExcluded() const
Definition: marker_base.h:108
void SetMarkerType(enum TYPEMARKER aMarkerType)
accessors to set/get marker type (DRC, ERC, or other)
Definition: marker_base.h:105
int m_scalingFactor
Definition: marker_base.h:66
int MarkerScale() const
The scaling factor to convert polygonal shape coordinates to internal units.
Definition: marker_base.h:80
enum TYPEMARKER GetMarkerType() const
Definition: marker_base.h:106
SHAPE_LINE_CHAIN.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const RC_ITEM * GetRCItem() const
Definition: marker_base.h:118
virtual const KIID GetUUID() const =0
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99