KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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, see <https://www.gnu.org/licenses/>.
18 */
19
20#ifndef PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
21#define PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
22
23#include <eda_item.h>
24#include <eda_units.h>
26#include <layer_ids.h>
27
28namespace KIGFX
29{
30namespace PREVIEW
31{
32
33// TODO: required until EDA_SHAPE_TYPE_T is moved into commons or a better approach is found
43
48{
49public:
50 TWO_POINT_ASSISTANT( const TWO_POINT_GEOMETRY_MANAGER& aManager, const EDA_IU_SCALE& aIuScale,
51 EDA_UNITS aUnits, GEOM_SHAPE aShape );
52
53 const BOX2I ViewBBox() const override;
54
55 std::vector<int> ViewGetLayers() const override
56 {
57 return { LAYER_SELECT_OVERLAY, // Assistant graphics
58 LAYER_GP_OVERLAY }; // Drop shadows
59 }
60
64 void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override final;
65
66#if defined( DEBUG )
67 void Show( int x, std::ostream& st ) const override
68 {
69 }
70#endif
71
76 wxString GetClass() const override
77 {
78 return "TWO_POINT_ASSISTANT";
79 }
80
81 void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }
82
83private:
88};
89
90} // namespace PREVIEW
91} // namespace KIGFX
92
93#endif // PREVIEW_ITEMS_TWO_POINT_ASSISTANT_H
BOX2< VECTOR2I > BOX2I
Definition box2.h:918
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:37
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override final
Draw the assistance (with reference to the construction manager.
std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
const TWO_POINT_GEOMETRY_MANAGER & m_constructMan
wxString GetClass() const override
Get class name.
TWO_POINT_ASSISTANT(const TWO_POINT_GEOMETRY_MANAGER &aManager, const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, GEOM_SHAPE aShape)
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:63
EDA_UNITS
Definition eda_units.h:44
@ LAYER_GP_OVERLAY
General purpose overlay.
Definition layer_ids.h:275
@ LAYER_SELECT_OVERLAY
Selected items overlay.
Definition layer_ids.h:276
The Cairo implementation of the graphics abstraction layer.
Definition eda_group.h:29