KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_drawing_tools.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) 2019-2023 CERN
5 * Copyright (C) 2019-2023 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 SCH_DRAWING_TOOLS_H
26#define SCH_DRAWING_TOOLS_H
27
28#include "sch_sheet_path.h"
29#include <tools/ee_tool_base.h>
30#include <sch_base_frame.h>
31#include <sch_label.h>
32#include <status_popup.h>
34
35class SCH_SYMBOL;
37class SCH_EDIT_FRAME;
40
41
46class SCH_DRAWING_TOOLS : public EE_TOOL_BASE<SCH_EDIT_FRAME>
47{
48public:
50 ~SCH_DRAWING_TOOLS() override { }
51
53 bool Init() override;
54
55 int PlaceSymbol( const TOOL_EVENT& aEvent );
56 int SingleClickPlace( const TOOL_EVENT& aEvent );
57 int TwoClickPlace( const TOOL_EVENT& aEvent );
58 int DrawShape( const TOOL_EVENT& aEvent );
59 int DrawTable( const TOOL_EVENT& aEvent );
60 int DrawSheet( const TOOL_EVENT& aEvent );
61 int PlaceImage( const TOOL_EVENT& aEvent );
62 int ImportGraphics( const TOOL_EVENT& aEvent );
63 int SyncSheetsPins( const TOOL_EVENT& aEvent );
64 int SyncAllSheetsPins( const TOOL_EVENT& aEvent );
65
66private:
67 SCH_LINE* findWire( const VECTOR2I& aPosition );
68
70 wxString findWireLabelDriverName( SCH_LINE* aWire );
71
72 SCH_TEXT* createNewText( const VECTOR2I& aPosition, int aType );
73
74 SCH_SHEET_PIN* createNewSheetPin( SCH_SHEET* aSheet, const VECTOR2I& aPosition );
75
76 void sizeSheet( SCH_SHEET* aSheet, const VECTOR2I& aPos );
77
79 void setTransitions() override;
80
81 int doSyncSheetsPins( std::list<SCH_SHEET_PATH> aSheets );
82
83 std::vector<PICKED_SYMBOL> m_symbolHistoryList;
84 std::vector<PICKED_SYMBOL> m_powerHistoryList;
85
104 wxString m_mruPath;
106
107 bool m_inDrawingTool; // Re-entrancy guard
108 std::unique_ptr<STATUS_TEXT_POPUP> m_statusPopup;
109 std::unique_ptr<DIALOG_SYNC_SHEET_PINS> m_dialogSyncSheetPin;
110};
111
112#endif /* SCH_DRAWING_TOOLS_H */
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Class for a wire to bus entry.
Tool responsible for drawing/placing items (symbols, wires, buses, labels, etc.).
STROKE_PARAMS m_lastTextboxStroke
GR_TEXT_V_ALIGN_T m_lastTextboxVJustify
int DrawSheet(const TOOL_EVENT &aEvent)
SPIN_STYLE m_lastTextOrientation
int SyncSheetsPins(const TOOL_EVENT &aEvent)
STROKE_PARAMS m_lastStroke
SCH_TEXT * createNewText(const VECTOR2I &aPosition, int aType)
GR_TEXT_H_ALIGN_T m_lastTextboxHJustify
std::vector< PICKED_SYMBOL > m_powerHistoryList
int SingleClickPlace(const TOOL_EVENT &aEvent)
SCH_LINE * findWire(const VECTOR2I &aPosition)
Gets the (global) label name driving this wire, if it is driven by a label.
void sizeSheet(SCH_SHEET *aSheet, const VECTOR2I &aPos)
Set up handlers for various events.
LABEL_FLAG_SHAPE m_lastGlobalLabelShape
LABEL_FLAG_SHAPE m_lastNetClassFlagShape
GR_TEXT_H_ALIGN_T m_lastTextHJustify
int ImportGraphics(const TOOL_EVENT &aEvent)
EDA_ANGLE m_lastTextboxAngle
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup
int TwoClickPlace(const TOOL_EVENT &aEvent)
SCH_SHEET_PIN * createNewSheetPin(SCH_SHEET *aSheet, const VECTOR2I &aPosition)
int SyncAllSheetsPins(const TOOL_EVENT &aEvent)
wxString findWireLabelDriverName(SCH_LINE *aWire)
int DrawTable(const TOOL_EVENT &aEvent)
GR_TEXT_V_ALIGN_T m_lastTextVJustify
int doSyncSheetsPins(std::list< SCH_SHEET_PATH > aSheets)
LABEL_FLAG_SHAPE m_lastSheetPinType
int DrawShape(const TOOL_EVENT &aEvent)
std::unique_ptr< DIALOG_SYNC_SHEET_PINS > m_dialogSyncSheetPin
bool Init() override
Init() is called once upon a registration of the tool.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
~SCH_DRAWING_TOOLS() override
int PlaceSymbol(const TOOL_EVENT &aEvent)
int PlaceImage(const TOOL_EVENT &aEvent)
std::vector< PICKED_SYMBOL > m_symbolHistoryList
Schematic editor (Eeschema) main window.
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:40
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
Schematic symbol object.
Definition: sch_symbol.h:108
Simple container to manage line stroke parameters.
Definition: stroke_params.h:81
Generic, UI-independent tool event.
Definition: tool_event.h:167
FILL_T
Definition: eda_shape.h:55
LABEL_FLAG_SHAPE
Definition: sch_label.h:91
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
GR_TEXT_H_ALIGN_T
GR_TEXT_V_ALIGN_T