KiCad PCB EDA Suite
sch_marker.cpp
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 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 1992-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 #include <fctsys.h>
26 #include <sch_draw_panel.h>
27 #include <trigo.h>
28 #include <msgpanel.h>
29 #include <bitmaps.h>
30 #include <base_units.h>
31 
32 #include <sch_marker.h>
33 #include <erc.h>
34 
36 #define SCALING_FACTOR Millimeter2iu( 0.1 )
37 
38 
40 {
41 }
42 
43 
44 SCH_MARKER::SCH_MARKER( const wxPoint& pos, const wxString& text ) :
45  SCH_ITEM( NULL, SCH_MARKER_T ),
46  MARKER_BASE( 0, pos, text, pos, SCALING_FACTOR )
47 {
48 }
49 
50 
52 {
53  return new SCH_MARKER( *this );
54 }
55 
56 
58 {
59  std::swap( *((SCH_MARKER*) this), *((SCH_MARKER*) aItem ) );
60 }
61 
62 
63 #if defined(DEBUG)
64 
65 void SCH_MARKER::Show( int nestLevel, std::ostream& os ) const
66 {
67  // for now, make it look like XML:
68  NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str()
69  << GetPos() << "/>\n";
70 }
71 
72 #endif
73 
74 
75 void SCH_MARKER::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset )
76 {
77  COLOR4D tmp = m_Color;
78 
80  {
83  }
84 
85  DrawMarker( aPanel, aDC, aOffset );
86  m_Color = tmp;
87 }
88 
89 
90 bool SCH_MARKER::Matches( wxFindReplaceData& aSearchData, void* aAuxData,
91  wxPoint * aFindLocation )
92 {
93  if( SCH_ITEM::Matches( m_drc.GetErrorText(), aSearchData ) ||
94  SCH_ITEM::Matches( m_drc.GetMainText(), aSearchData ) ||
95  SCH_ITEM::Matches( m_drc.GetAuxiliaryText(), aSearchData ) )
96  {
97  if( aFindLocation )
98  *aFindLocation = m_Pos;
99 
100  return true;
101  }
102 
103  return false;
104 }
105 
106 
107 void SCH_MARKER::ViewGetLayers( int aLayers[], int& aCount ) const
108 {
109  aCount = 1;
111 }
112 
113 
115 {
116  return GetBoundingBoxMarker();
117 }
118 
119 
121 {
122  aList.push_back( MSG_PANEL_ITEM( _( "Electronics Rule Check Error" ),
123  GetReporter().GetErrorText(), DARKRED ) );
124 }
125 
126 
127 BITMAP_DEF SCH_MARKER::GetMenuImage() const
128 {
129  return erc_xpm;
130 }
131 
132 
133 void SCH_MARKER::Rotate( wxPoint aPosition )
134 {
135  RotatePoint( &m_Pos, aPosition, 900 );
136 }
137 
138 
139 void SCH_MARKER::MirrorX( int aXaxis_position )
140 {
141  m_Pos.y -= aXaxis_position;
142  m_Pos.y = -m_Pos.y;
143  m_Pos.y += aXaxis_position;
144 }
145 
146 
147 void SCH_MARKER::MirrorY( int aYaxis_position )
148 {
149  m_Pos.x -= aYaxis_position;
150  m_Pos.x = -m_Pos.x;
151  m_Pos.x += aYaxis_position;
152 }
153 
154 
155 bool SCH_MARKER::HitTest( const wxPoint& aPosition, int aAccuracy ) const
156 {
157  return HitTestMarker( aPosition, aAccuracy );
158 }
const wxPoint & GetPos() const
Function GetPos.
Definition: marker_base.h:153
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
Definition: sch_marker.cpp:139
EDA_RECT const GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_marker.cpp:114
wxString GetErrorText() const
Function GetErrorText returns the string form of a drc error code.
Definition: drc_item.cpp:36
MARKER_SEVERITY m_ErrorLevel
Specify the severity of the error.
Definition: marker_base.h:60
const DRC_ITEM & GetReporter() const
Function GetReporter returns the DRC_ITEM held within this MARKER so that its interface may be used.
Definition: marker_base.h:243
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
Definition: sch_marker.cpp:57
Implementation of conversion functions that require both schematic and board internal units.
#define SCALING_FACTOR
Factor to convert the maker unit shape to internal units:
Definition: sch_marker.cpp:36
MARKER_SEVERITY GetErrorLevel() const
Definition: marker_base.h:175
void GetMsgPanelInfo(EDA_UNITS_T 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:120
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset) override
Function Draw Draw a schematic item.
Definition: sch_marker.cpp:75
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:458
wxPoint m_Pos
position of the marker
Definition: marker_base.h:54
wxString GetMainText() const
Access to A and B texts.
Definition: drc_item.h:169
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:174
Definition: colors.h:54
EDA_RECT GetBoundingBoxMarker() const
Function GetBoundingBoxMarker returns the orthogonal, bounding box of this object for display purpose...
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
Definition: sch_marker.cpp:147
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_marker.cpp:127
bool HitTestMarker(const wxPoint &aHitPosition, int aAccuracy) const
Tests if the given wxPoint is within the bounds of this object.
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:155
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:107
COLOR4D m_Color
color
Definition: marker_base.h:61
bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation) override
Compare DRC marker main and auxiliary text against search string.
Definition: sch_marker.cpp:90
void DrawMarker(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset)
Function DrawMarker draws the shape is the polygon defined in m_Corners (array of wxPoints).
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
Definition: sch_marker.cpp:133
enum TYPEMARKER GetMarkerType() const
Definition: marker_base.h:187
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_marker.cpp:51
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:157
std::vector< MSG_PANEL_ITEM > MSG_PANEL_ITEMS
Definition: msgpanel.h:102
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_marker.h:41
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
Message panel definition file.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
wxString GetAuxiliaryText() const
Definition: drc_item.h:170
DRC_ITEM m_drc
Definition: marker_base.h:64
EDA_UNITS_T
Definition: common.h:157
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39