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 footprints when the user requests them.
32
enum class
MICROWAVE_FOOTPRINT_SHAPE
33
{
34
GAP
,
35
STUB
,
36
STUB_ARC
,
37
FUNCTION_SHAPE
,
38
};
39
43
struct
MICROWAVE_INDUCTOR_PATTERN
44
{
45
public
:
46
wxPoint
m_Start
;
47
wxPoint
m_End
;
48
int
m_Length
;
// full length trace.
49
int
m_Width
;
// Trace width.
50
};
51
52
58
class
MICROWAVE_TOOL
:
public
PCB_TOOL_BASE
59
{
60
public
:
61
MICROWAVE_TOOL
();
62
~MICROWAVE_TOOL
();
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
89
FOOTPRINT
*
createFootprint
(
MICROWAVE_FOOTPRINT_SHAPE
aFootprintShape );
90
91
FOOTPRINT
*
createPolygonShape
();
92
96
FOOTPRINT
*
createMicrowaveInductor
(
MICROWAVE_INDUCTOR_PATTERN
& aPattern, wxString& aErrorMessage );
97
109
FOOTPRINT
*
createBaseFootprint
(
const
wxString& aValue,
int
aTextSize,
int
aPadCount );
110
};
111
112
113
#endif // TOOLS_MICROWAVE_TOOL_H
MICROWAVE_TOOL::createPolygonShape
FOOTPRINT * createPolygonShape()
Definition:
microwave_polygon.cpp:243
MICROWAVE_FOOTPRINT_SHAPE::STUB_ARC
MICROWAVE_INDUCTOR_PATTERN::m_Width
int m_Width
Definition:
microwave_tool.h:49
MICROWAVE_FOOTPRINT_SHAPE::GAP
MICROWAVE_TOOL::~MICROWAVE_TOOL
~MICROWAVE_TOOL()
Definition:
microwave_tool.cpp:46
PCB_TOOL_BASE
Definition:
pcb_tool_base.h:71
MICROWAVE_TOOL
MICROWAVE_TOOL.
Definition:
microwave_tool.h:58
MICROWAVE_TOOL::Reset
void Reset(RESET_REASON aReason) override
React to model/view changes
Definition:
microwave_tool.cpp:50
VECTOR2< int >
MICROWAVE_TOOL::createMicrowaveInductor
FOOTPRINT * createMicrowaveInductor(MICROWAVE_INDUCTOR_PATTERN &aPattern, wxString &aErrorMessage)
Creates an S-shaped coil footprint for microwave applications.
Definition:
microwave_inductor.cpp:326
MICROWAVE_INDUCTOR_PATTERN::m_Start
wxPoint m_Start
Definition:
microwave_tool.h:46
MICROWAVE_TOOL::createFootprint
FOOTPRINT * createFootprint(MICROWAVE_FOOTPRINT_SHAPE aFootprintShape)
Creates a footprint "GAP" or "STUB" used in micro wave designs.
Definition:
microwave_footprint.cpp:32
pcb_tool_base.h
MICROWAVE_TOOL::createInductorBetween
void createInductorBetween(const VECTOR2I &aStart, const VECTOR2I &aEnd)
Create an inductor between the two points
Definition:
microwave_inductor.cpp:293
TOOL_EVENT
Generic, UI-independent tool event.
Definition:
tool_event.h:170
MICROWAVE_TOOL::setTransitions
void setTransitions() override
Bind handlers to corresponding TOOL_ACTIONs
Definition:
microwave_tool.cpp:243
MICROWAVE_TOOL::MICROWAVE_TOOL
MICROWAVE_TOOL()
Definition:
microwave_tool.cpp:40
MICROWAVE_INDUCTOR_PATTERN::m_End
wxPoint m_End
Definition:
microwave_tool.h:47
MICROWAVE_TOOL::drawMicrowaveInductor
int drawMicrowaveInductor(const TOOL_EVENT &aEvent)
Draw a microwave inductor interactively
Definition:
microwave_tool.cpp:109
MICROWAVE_FOOTPRINT_SHAPE::STUB
MICROWAVE_TOOL::addMicrowaveFootprint
int addMicrowaveFootprint(const TOOL_EVENT &aEvent)
Main interactive tool
Definition:
microwave_tool.cpp:55
MICROWAVE_TOOL::createBaseFootprint
FOOTPRINT * createBaseFootprint(const wxString &aValue, int aTextSize, int aPadCount)
Create a basic footprint for micro wave applications.
Definition:
microwave_footprint.cpp:185
MICROWAVE_FOOTPRINT_SHAPE::FUNCTION_SHAPE
TOOL_BASE::RESET_REASON
RESET_REASON
Determine the reason of reset for a tool.
Definition:
tool_base.h:78
MICROWAVE_INDUCTOR_PATTERN::m_Length
int m_Length
Definition:
microwave_tool.h:48
tool_menu.h
MICROWAVE_FOOTPRINT_SHAPE
MICROWAVE_FOOTPRINT_SHAPE
Definition:
microwave_tool.h:32
MICROWAVE_INDUCTOR_PATTERN
Parameters for construction of a microwave inductor.
Definition:
microwave_tool.h:43
FOOTPRINT
Definition:
footprint.h:108
pcbnew
microwave
microwave_tool.h
Generated on Thu Jan 21 2021 04:12:52 for KiCad PCB EDA Suite by
1.8.15