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-2017 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 #include <fctsys.h>
31 #include <sch_draw_panel.h>
32 #include <trigo.h>
33 #include <msgpanel.h>
34 #include <bitmaps.h>
35 #include <base_units.h>
36 
37 #include <sch_marker.h>
38 #include <erc.h>
39 
41 #define SCALING_FACTOR Millimeter2iu( 0.1 )
42 
43 
45 {
46 }
47 
48 
49 SCH_MARKER::SCH_MARKER( const wxPoint& pos, const wxString& text ) :
50  SCH_ITEM( NULL, SCH_MARKER_T ),
51  MARKER_BASE( 0, pos, text, pos, SCALING_FACTOR )
52 {
53 }
54 
55 
57 {
58  return new SCH_MARKER( *this );
59 }
60 
61 
62 #if defined(DEBUG)
63 
64 void SCH_MARKER::Show( int nestLevel, std::ostream& os ) const
65 {
66  // for now, make it look like XML:
67  NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str()
68  << GetPos() << "/>\n";
69 }
70 
71 #endif
72 
73 
74 void SCH_MARKER::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
75  const wxPoint& aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor )
76 {
78  COLOR4D tmp = color;
79 
81  {
84  }
85 
86  if( aColor == COLOR4D::UNSPECIFIED )
87  m_Color = color;
88  else
89  m_Color = aColor;
90 
91  DrawMarker( aPanel, aDC, aDrawMode, aOffset );
92  m_Color = tmp;
93 }
94 
95 
96 bool SCH_MARKER::Matches( wxFindReplaceData& aSearchData, void* aAuxData,
97  wxPoint * aFindLocation )
98 {
99  if( SCH_ITEM::Matches( m_drc.GetErrorText(), aSearchData ) ||
100  SCH_ITEM::Matches( m_drc.GetMainText(), aSearchData ) ||
101  SCH_ITEM::Matches( m_drc.GetAuxiliaryText(), aSearchData ) )
102  {
103  if( aFindLocation )
104  *aFindLocation = m_Pos;
105 
106  return true;
107  }
108 
109  return false;
110 }
111 
112 
113 void SCH_MARKER::ViewGetLayers( int aLayers[], int& aCount ) const
114 {
115  aCount = 1;
117 }
118 
119 
121 {
122  return GetBoundingBoxMarker();
123 }
124 
125 
127 {
128  aList.push_back( MSG_PANEL_ITEM( _( "Electronics Rule Check Error" ),
129  GetReporter().GetErrorText(), DARKRED ) );
130 }
131 
132 
133 BITMAP_DEF SCH_MARKER::GetMenuImage() const
134 {
135  return erc_xpm;
136 }
137 
138 
139 void SCH_MARKER::Rotate( wxPoint aPosition )
140 {
141  RotatePoint( &m_Pos, aPosition, 900 );
142 }
143 
144 
145 void SCH_MARKER::MirrorX( int aXaxis_position )
146 {
147  m_Pos.y -= aXaxis_position;
148  m_Pos.y = -m_Pos.y;
149  m_Pos.y += aXaxis_position;
150 }
151 
152 
153 void SCH_MARKER::MirrorY( int aYaxis_position )
154 {
155  m_Pos.x -= aYaxis_position;
156  m_Pos.x = -m_Pos.x;
157  m_Pos.x += aYaxis_position;
158 }
159 
160 
161 bool SCH_MARKER::IsSelectStateChanged( const wxRect& aRect )
162 {
163  bool previousState = IsSelected();
164 
165  if( aRect.Contains( m_Pos ) )
166  SetFlags( SELECTED );
167  else
168  ClearFlags( SELECTED );
169 
170  return previousState != IsSelected();
171 }
172 
173 
174 bool SCH_MARKER::HitTest( const wxPoint& aPosition, int aAccuracy ) const
175 {
176  return HitTestMarker( aPosition );
177 }
const wxPoint & GetPos() const
Function GetPos.
Definition: marker_base.h:154
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
Definition: sch_marker.cpp:145
EDA_RECT const GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_marker.cpp:120
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:244
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDraw_mode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
Function Draw Draw a schematic item.
Definition: sch_marker.cpp:74
bool IsSelected() const
Definition: base_struct.h:224
bool HitTestMarker(const wxPoint &aHitPosition) const
Tests if the given wxPoint is within the bounds of this object.
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:41
bool HitTest(const wxPoint &aPosition, int aAccuracy) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: sch_marker.cpp:174
MARKER_SEVERITY GetErrorLevel() const
Definition: marker_base.h:176
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:126
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:420
SCH_MARKER class definition.
int color
Definition: DXF_plotter.cpp:62
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:162
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:174
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).
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:153
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_marker.cpp:133
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
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:113
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:96
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
Definition: sch_marker.cpp:139
enum TYPEMARKER GetMarkerType() const
Definition: marker_base.h:188
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_marker.cpp:56
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:154
std::vector< MSG_PANEL_ITEM > MSG_PANEL_ITEMS
Definition: msgpanel.h:102
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_marker.h:46
bool IsSelectStateChanged(const wxRect &aRect) override
Function IsSelectStateChanged checks if the selection state of an item inside aRect has changed.
Definition: sch_marker.cpp:161
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...
wxString GetAuxiliaryText() const
Definition: drc_item.h:163
DRC_ITEM m_drc
Definition: marker_base.h:64
EDA_UNITS_T
Definition: common.h:160
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39