KiCad PCB EDA Suite
microwave_tool.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) 2017 Kicad Developers, see change_log.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 TOOLS_MICROWAVE_TOOL_H
25 #define TOOLS_MICROWAVE_TOOL_H
26 
27 #include <tools/pcb_tool_base.h>
28 
29 #include <tool/tool_menu.h>
30 
31 // Microwave shapes that are created as board modules when the user requests them.
33 {
34  GAP,
35  STUB,
36  STUB_ARC,
38 };
39 
44 {
45 public:
48  int m_length; // full length trace.
49  int m_Width; // Trace width.
50 };
51 
52 
59 {
60 public:
63 
65  void Reset( RESET_REASON aReason ) override;
66 
68  void setTransitions() override;
69 
70 private:
72  int addMicrowaveFootprint( const TOOL_EVENT& aEvent );
73 
75  void createInductorBetween( const VECTOR2I& aStart, const VECTOR2I& aEnd );
76 
78  int drawMicrowaveInductor( const TOOL_EVENT& aEvent );
79 
90 
92 
96  MODULE* createMicrowaveInductor( MICROWAVE_INDUCTOR_PATTERN& aPattern, wxString& aErrorMessage );
97 
109  MODULE* createBaseFootprint( const wxString& aValue, int aTextSize, int aPadCount );
110 };
111 
112 
113 #endif // TOOLS_MICROWAVE_TOOL_H
MODULE * createMicrowaveInductor(MICROWAVE_INDUCTOR_PATTERN &aPattern, wxString &aErrorMessage)
Creates an S-shaped coil footprint for microwave applications.
MODULE * createBaseFootprint(const wxString &aValue, int aTextSize, int aPadCount)
Create a basic footprint for micro wave applications.
MICROWAVE_TOOL.
void Reset(RESET_REASON aReason) override
React to model/view changes
MODULE * createPolygonShape()
void createInductorBetween(const VECTOR2I &aStart, const VECTOR2I &aEnd)
Create an inductor between the two points
TOOL_EVENT.
Definition: tool_event.h:171
void setTransitions() override
Bind handlers to corresponding TOOL_ACTIONs
int drawMicrowaveInductor(const TOOL_EVENT &aEvent)
Draw a microwave inductor interactively
int addMicrowaveFootprint(const TOOL_EVENT &aEvent)
Main interactive tool
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:79
MODULE * createFootprint(MICROWAVE_FOOTPRINT_SHAPE aFootprintShape)
Creates a module "GAP" or "STUB" used in micro wave designs.
MICROWAVE_FOOTPRINT_SHAPE
Parameters for construction of a microwave inductor.