KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_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) 2009-2018 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2021 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 PCB_MARKER_H
26#define PCB_MARKER_H
27
28
29#include <board_item.h>
30#include <pcb_shape.h>
31#include <rc_item.h>
32#include <marker_base.h>
33
34class DRC_ITEM;
35
36// Coordinates count for the basic shape marker
37#define MARKER_SHAPE_POINT_COUNT 9
38
39class MSG_PANEL_ITEM;
40
41
42class PCB_MARKER : public BOARD_ITEM, public MARKER_BASE
43{
44public:
45 PCB_MARKER( std::shared_ptr<RC_ITEM> aItem, const VECTOR2I& aPos, int aLayer = F_Cu );
46
48
49 static inline bool ClassOf( const EDA_ITEM* aItem )
50 {
51 return aItem && PCB_MARKER_T == aItem->Type();
52 }
53
54 const KIID GetUUID() const override { return m_Uuid; }
55
56 wxString SerializeToString() const;
57
58 static PCB_MARKER* DeserializeFromString( const wxString& data );
59
60 void Move( const VECTOR2I& aMoveVector ) override
61 {
62 m_Pos += aMoveVector;
63 }
64
65 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
66
67 void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
68
69 VECTOR2I GetPosition() const override { return m_Pos; }
70 void SetPosition( const VECTOR2I& aPos ) override { m_Pos = aPos; }
71
72 VECTOR2I GetCenter() const override
73 {
74 return GetPosition();
75 }
76
77 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override
78 {
80 return false;
81 else
82 return HitTestMarker( aPosition, aAccuracy );
83 }
84
85 EDA_ITEM* Clone() const override
86 {
87 return new PCB_MARKER( *this );
88 }
89
91
92 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer,
93 FLASHING aFlash = FLASHING::DEFAULT ) const override;
94
95 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
96
97 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override
98 {
99 return BOARD_ITEM::Matches( m_rcItem->GetErrorMessage(), aSearchData );
100 }
101
102 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
103
104 BITMAPS GetMenuImage() const override;
105
106 void SetZoom( double aZoomFactor );
107
108 const BOX2I ViewBBox() const override;
109
110 const BOX2I GetBoundingBox() const override;
111
112 void ViewGetLayers( int aLayers[], int& aCount ) const override;
113
114 SEVERITY GetSeverity() const override;
115
116 double Similarity( const BOARD_ITEM& aBoardItem ) const override
117 {
118 return 0.0;
119 }
120
121 bool operator==( const BOARD_ITEM& aBoardItem ) const override
122 {
123 return false;
124 }
125
126#if defined(DEBUG)
127 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
128#endif
129
133 virtual wxString GetClass() const override
134 {
135 return wxT( "PCB_MARKER" );
136 }
137
138 std::vector<PCB_SHAPE> GetShapes1() const { return m_shapes1; };
139 std::vector<PCB_SHAPE> GetShapes2() const { return m_shapes2; };
140
141 void SetShapes1( const std::vector<PCB_SHAPE>& aShapes ) { m_shapes1 = aShapes; };
142 void SetShapes2( const std::vector<PCB_SHAPE>& aShapes ) { m_shapes2 = aShapes; };
143
144
145protected:
146 KIGFX::COLOR4D getColor() const override;
147 std::vector<PCB_SHAPE> m_shapes1; // Shown on LAYER_DRC_SHAPE1
148 std::vector<PCB_SHAPE> m_shapes2; // Shown on LAYER_DRC_SHAPE2
149};
150
151#endif // PCB_MARKER_H
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
const KIID m_Uuid
Definition: eda_item.h:489
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:377
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Definition: kiid.h:49
bool HitTestMarker(const VECTOR2I &aHitPosition, int aAccuracy) const
Test if the given VECTOR2I is within the bounds of this object.
Definition: marker_base.cpp:90
VECTOR2I m_Pos
position of the marker
Definition: marker_base.h:135
std::shared_ptr< RC_ITEM > m_rcItem
Definition: marker_base.h:141
enum MARKER_T GetMarkerType() const
Definition: marker_base.h:96
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
const KIID GetUUID() const override
Definition: pcb_marker.h:54
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: pcb_marker.cpp:197
std::vector< PCB_SHAPE > m_shapes2
Definition: pcb_marker.h:148
bool operator==(const BOARD_ITEM &aBoardItem) const override
Definition: pcb_marker.h:121
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: pcb_marker.cpp:260
std::vector< PCB_SHAPE > m_shapes1
Definition: pcb_marker.h:147
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_marker.cpp:275
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: pcb_marker.h:60
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: pcb_marker.cpp:362
virtual wxString GetClass() const override
Get class name.
Definition: pcb_marker.h:133
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_marker.cpp:351
SEVERITY GetSeverity() const override
Definition: pcb_marker.cpp:281
static PCB_MARKER * DeserializeFromString(const wxString &data)
Definition: pcb_marker.cpp:143
std::vector< PCB_SHAPE > GetShapes1() const
Definition: pcb_marker.h:138
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition: pcb_marker.cpp:254
void SetShapes2(const std::vector< PCB_SHAPE > &aShapes)
Definition: pcb_marker.h:142
VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition: pcb_marker.h:72
wxString SerializeToString() const
Definition: pcb_marker.cpp:97
GAL_LAYER_ID GetColorLayer() const
Definition: pcb_marker.cpp:326
VECTOR2I GetPosition() const override
Definition: pcb_marker.h:69
KIGFX::COLOR4D getColor() const override
Definition: pcb_marker.cpp:338
static bool ClassOf(const EDA_ITEM *aItem)
Definition: pcb_marker.h:49
std::vector< PCB_SHAPE > GetShapes2() const
Definition: pcb_marker.h:139
double Similarity(const BOARD_ITEM &aBoardItem) const override
Return a measure of how likely the other object is to represent the same object.
Definition: pcb_marker.h:116
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_marker.h:97
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: pcb_marker.cpp:268
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_marker.h:85
void SetShapes1(const std::vector< PCB_SHAPE > &aShapes)
Definition: pcb_marker.h:141
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
Definition: pcb_marker.cpp:302
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition: pcb_marker.h:77
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: pcb_marker.cpp:248
void SetZoom(double aZoomFactor)
Definition: pcb_marker.cpp:345
void SetPosition(const VECTOR2I &aPos) override
Definition: pcb_marker.h:70
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:147
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:192
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_Cu
Definition: layer_ids.h:64
FLIP_DIRECTION
Definition: mirror.h:27
SEVERITY
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition: typeinfo.h:99