KiCad PCB EDA Suite
sch_marker.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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2004-2019 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 #ifndef TYPE_SCH_MARKER_H_
26 #define TYPE_SCH_MARKER_H_
27 
28 #include <sch_item.h>
29 #include <marker_base.h>
30 
31 
32 class SCH_MARKER : public SCH_ITEM, public MARKER_BASE
33 {
34 public:
35  SCH_MARKER( TYPEMARKER aType );
36 
37  // Do not create a copy constructor. The one generated by the compiler is adequate.
38 
39  static inline bool ClassOf( const EDA_ITEM* aItem )
40  {
41  return aItem && SCH_MARKER_T == aItem->Type();
42  }
43 
44  wxString GetClass() const override
45  {
46  return wxT( "SCH_MARKER" );
47  }
48 
49  const KIID GetUUID() const override { return m_Uuid; }
50 
51  void SwapData( SCH_ITEM* aItem ) override;
52 
53  void ViewGetLayers( int aLayers[], int& aCount ) const override;
54 
56 
57  void Print( wxDC* aDC, const wxPoint& aOffset ) override;
58 
59  void Plot( PLOTTER* aPlotter ) override
60  {
61  // SCH_MARKERs should not be plotted. However, SCH_ITEM will fail an
62  // assertion if we do not confirm this by locally implementing a no-op
63  // Plot().
64  (void) aPlotter;
65  }
66 
67  EDA_RECT const GetBoundingBox() const override;
68 
69  // Geometric transforms (used in block operations):
70 
71  void Move( const wxPoint& aMoveVector ) override
72  {
73  m_Pos += aMoveVector;
74  }
75 
76  void MirrorY( int aYaxis_position ) override;
77  void MirrorX( int aXaxis_position ) override;
78  void Rotate( wxPoint aPosition ) override;
79 
89  bool Matches( wxFindReplaceData& aSearchData, void* aAuxDat ) override;
90 
91  void GetMsgPanelInfo( EDA_UNITS aUnits, std::vector<MSG_PANEL_ITEM>& aList ) override;
92 
93  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override
94  {
95  return wxString( _( "ERC Marker" ) );
96  }
97 
98  BITMAP_DEF GetMenuImage() const override;
99 
100  wxPoint GetPosition() const override { return m_Pos; }
101  void SetPosition( const wxPoint& aPosition ) override { m_Pos = aPosition; }
102 
103  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
104 
105  EDA_ITEM* Clone() const override;
106 
107 #if defined(DEBUG)
108  void Show( int nestLevel, std::ostream& os ) const override;
109 #endif
110 
111 protected:
112  KIGFX::COLOR4D getColor() const override;
113 };
114 
115 #endif // TYPE_SCH_MARKER_H_
EDA_UNITS
Definition: common.h:184
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
Definition: sch_marker.cpp:147
EDA_RECT const GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_marker.cpp:122
PNG memory record (file in memory).
Definition: bitmap_def.h:29
SCH_LAYER_ID GetColorLayer() const
Definition: sch_marker.cpp:87
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
Definition: sch_marker.cpp:55
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_marker.h:100
wxPoint m_Pos
position of the marker
Definition: marker_base.h:51
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
Definition: sch_marker.cpp:155
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_marker.h:71
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_marker.cpp:135
bool Matches(wxFindReplaceData &aSearchData, void *aAuxDat) override
Compare DRC marker main and auxiliary text against search string.
Definition: sch_marker.cpp:114
Definition: common.h:65
void Plot(PLOTTER *aPlotter) override
Function Plot plots the schematic item to aPlotter.
Definition: sch_marker.h:59
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: sch_marker.cpp:163
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_marker.h:39
void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers returns the layers the item is drawn on (which may be more than its "home" lay...
Definition: sch_marker.cpp:72
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
Definition: sch_marker.h:101
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_marker.h:93
SCH_LAYER_ID
Eeschema drawing layers.
const KIID m_Uuid
Definition: base_struct.h:169
const KIID GetUUID() const override
Definition: sch_marker.h:49
Base plotter engine class.
Definition: plotter.h:104
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
Definition: sch_marker.cpp:141
KIGFX::COLOR4D getColor() const override
Definition: sch_marker.cpp:101
void Print(wxDC *aDC, const wxPoint &aOffset) override
Function Print Print a schematic item.
Definition: sch_marker.cpp:108
#define _(s)
Definition: 3d_actions.cpp:33
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_marker.cpp:49
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_marker.h:44
void GetMsgPanelInfo(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Definition: sch_marker.cpp:128
SCH_MARKER(TYPEMARKER aType)
Definition: sch_marker.cpp:42
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40