microwave_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef TOOLS_MICROWAVE_TOOL_H
#define TOOLS_MICROWAVE_TOOL_H

#include <tools/pcb_tool_base.h>

#include <tool/tool_menu.h>

// Microwave shapes that are created as board footprints when the user requests them.
enum class MICROWAVE_FOOTPRINT_SHAPE
{
    GAP,
    STUB,
    STUB_ARC,
    FUNCTION_SHAPE,
};

struct MICROWAVE_INDUCTOR_PATTERN
{
public:
    wxPoint m_Start;
    wxPoint m_End;
    int     m_Length;       // full length trace.
    int     m_Width;        // Trace width.
};


class MICROWAVE_TOOL : public PCB_TOOL_BASE
{
public:
    MICROWAVE_TOOL();
    ~MICROWAVE_TOOL();

    void Reset( RESET_REASON aReason ) override;

    void setTransitions() override;

private:
    int addMicrowaveFootprint( const TOOL_EVENT& aEvent );

    void createInductorBetween( const VECTOR2I& aStart, const VECTOR2I& aEnd );

    int drawMicrowaveInductor( const TOOL_EVENT& aEvent );

    FOOTPRINT* createFootprint( MICROWAVE_FOOTPRINT_SHAPE aFootprintShape );

    FOOTPRINT* createPolygonShape();

    FOOTPRINT* createMicrowaveInductor( MICROWAVE_INDUCTOR_PATTERN& aPattern,
                                        wxString& aErrorMessage );

    FOOTPRINT* createBaseFootprint( const wxString& aValue, int aTextSize, int aPadCount );
};


#endif // TOOLS_MICROWAVE_TOOL_H