KiCad PCB EDA Suite
two_point_assistant.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) 2020 Kicad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
25#define PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
26
27#include <eda_item.h>
29#include <layer_ids.h>
30
31namespace KIGFX
32{
33namespace PREVIEW
34{
35
36// TODO: required until EDA_SHAPE_TYPE_T is moved into commons or a better approach is found
37enum class GEOM_SHAPE
38{
39 SEGMENT = 0,
40 RECT,
41 ARC,
42 CIRCLE,
43 POLYGON,
44 CURVE
45};
46
51{
52public:
54 GEOM_SHAPE aShape );
55
56 const BOX2I ViewBBox() const override;
57
58 void ViewGetLayers( int aLayers[], int& aCount ) const override
59 {
60 aLayers[0] = LAYER_SELECT_OVERLAY; // Assistant graphics
61 aLayers[1] = LAYER_GP_OVERLAY; // Drop shadows
62 aCount = 2;
63 }
64
68 void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override final;
69
70#if defined( DEBUG )
71 void Show( int x, std::ostream& st ) const override
72 {
73 }
74#endif
75
80 wxString GetClass() const override
81 {
82 return "TWO_POINT_ASSISTANT";
83 }
84
85 void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }
86
87private:
91};
92
93} // namespace PREVIEW
94} // namespace KIGFX
95
96#endif // PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
Represent basic circle geometry with utility geometry functions.
Definition: circle.h:33
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
Represents an assistant draw when interactively drawing a line or circle on a canvas.
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
TWO_POINT_ASSISTANT(const TWO_POINT_GEOMETRY_MANAGER &aManager, EDA_UNITS aUnits, GEOM_SHAPE aShape)
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override final
Draw the assistance (with reference to the construction manager.
const TWO_POINT_GEOMETRY_MANAGER & m_constructMan
wxString GetClass() const override
Get class name.
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
Represent a very simple geometry manager for items that have a start and end point.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
EDA_UNITS
Definition: eda_units.h:39
@ LAYER_GP_OVERLAY
general purpose overlay
Definition: layer_ids.h:218
@ LAYER_SELECT_OVERLAY
currently selected items overlay
Definition: layer_ids.h:219
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:243