KiCad PCB EDA Suite
class_marker_pcb.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, jean-pierre.charras@ujf-grenoble.fr
5  * Copyright (C) 1992-2012 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 
30 #ifndef CLASS_MARKER_PCB_H
31 #define CLASS_MARKER_PCB_H
32 
33 
34 #include <class_board_item.h>
35 #include <marker_base.h>
36 
37 
38 class MSG_PANEL_ITEM;
39 
40 
41 class MARKER_PCB : public BOARD_ITEM, public MARKER_BASE
42 {
43 
44 public:
45 
46  MARKER_PCB( BOARD_ITEM* aParent );
47 
57  MARKER_PCB( EDA_UNITS_T aUnits, int aErrorCode, const wxPoint& aMarkerPos,
58  BOARD_ITEM* aItem, const wxPoint& aPos,
59  BOARD_ITEM* bItem = nullptr, const wxPoint& bPos = wxPoint() );
60 
70  MARKER_PCB( int aErrorCode, const wxPoint& aMarkerPos,
71  const wxString& aText, const wxPoint& aPos,
72  const wxString& bText = wxEmptyString, const wxPoint& bPos = wxPoint() );
73 
74  ~MARKER_PCB();
75 
76  static inline bool ClassOf( const EDA_ITEM* aItem )
77  {
78  return aItem && PCB_MARKER_T == aItem->Type();
79  }
80 
83  static int MarkerScale() {return Millimeter2iu( 0.1 ); }
84 
85  void Move(const wxPoint& aMoveVector) override
86  {
87  m_Pos += aMoveVector;
88  }
89 
90  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
91 
92  void Flip( const wxPoint& aCentre ) override;
93 
94  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
95  GR_DRAWMODE aDrawMode, const wxPoint& aOffset = ZeroOffset ) override
96  {
97  DrawMarker( aPanel, aDC, aDrawMode, aOffset );
98  }
99 
100  const wxPoint GetPosition() const override { return m_Pos; }
101  void SetPosition( const wxPoint& aPos ) override { m_Pos = aPos; }
102 
103  bool HitTest( const wxPoint& aPosition ) const override
104  {
105  return HitTestMarker( aPosition );
106  }
107 
108  bool IsOnLayer( PCB_LAYER_ID aLayer ) const override;
109 
110  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
111 
112  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
113 
114  BITMAP_DEF GetMenuImage() const override;
115 
116  const BOX2I ViewBBox() const override
117  {
118  // The following is based on the PCB_PAINTER::draw( const MARKER_PCB* )
119  // the value 13 comes from the max relative coordinate of the shape)
120  return BOX2I( m_Pos, VECTOR2I( 13*MarkerScale(), 13*MarkerScale() ) );
121  }
122 
123  const EDA_RECT GetBoundingBox() const override;
124 
125  void ViewGetLayers( int aLayers[], int& aCount ) const override;
126 
127 #if defined(DEBUG)
128  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
129 #endif
130 
134  virtual wxString GetClass() const override
135  {
136  return wxT( "MARKER_PCB" );
137  }
138 
139 protected:
142 };
143 
144 #endif // CLASS_MARKER_PCB_H
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
Function Draw BOARD_ITEMs have their own color information.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
bool HitTestMarker(const wxPoint &ref_pos) const
Function HitTestMarker tests if the given wxPoint is within the bounds of this object.
const wxPoint GetPosition() const override
PNG memory record (file in memory).
Definition: bitmap_types.h:41
void Flip(const wxPoint &aCentre) override
Function Flip Flip this object, i.e.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Classes BOARD_ITEM and BOARD_CONNECTED_ITEM.
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
wxPoint m_Pos
position of the marker
Definition: marker_base.h:54
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
void DrawMarker(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset)
Function DrawMarker draws the shape is the polygon defined in m_Corners (array of wxPoints)...
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
static wxPoint ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
virtual wxString GetClass() const override
Get class name.
const BOARD_ITEM * m_item
Pointer to BOARD_ITEM that causes DRC error.
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it&#39;s internal state for displ...
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
PCB_LAYER_ID
A quick note on layer IDs:
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
static int MarkerScale()
A scaling factor to create the marker symbol.
MARKER_PCB(BOARD_ITEM *aParent)
const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers. ...
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:99
void Rotate(const wxPoint &aRotCentre, double aAngle) override
Function Rotate Rotate this object.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
static bool ClassOf(const EDA_ITEM *aItem)
void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on...
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
void Move(const wxPoint &aMoveVector) override
Function Move move this object.
EDA_UNITS_T
Definition: common.h:159
void SetPosition(const wxPoint &aPos) override