drawing_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) 2014-2017 CERN
 * Copyright (C) 2018-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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 __DRAWING_TOOL_H
#define __DRAWING_TOOL_H

#include <core/optional.h>
#include <tool/tool_menu.h>
#include <tools/pcb_tool_base.h>
#include <tools/pcb_actions.h>

namespace KIGFX
{
 class VIEW;
 class VIEW_CONTROLS;
}

class BOARD;
class PCB_BASE_EDIT_FRAME;
class PCB_SHAPE;
class POLYGON_GEOM_MANAGER;

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

 bool Init() override;

 void Reset( RESET_REASON aReason ) override;

 enum class MODE
 {
 NONE,
 LINE,
 RECTANGLE,
 CIRCLE,
 ARC,
 TEXT,
 ANCHOR,
 DXF,
 DIMENSION,
 KEEPOUT,
 ZONE,
 GRAPHIC_POLYGON,
 VIA
 };

 MODE GetDrawingMode() const;

 std::vector<BOARD_ITEM*> DrawBoardCharacteristics( const wxPoint& origin, PCB_LAYER_ID aLayer,
 bool aDrawNow, wxPoint* tablesize );

 std::vector<BOARD_ITEM*> DrawSpecificationStackup( const wxPoint& origin, PCB_LAYER_ID aLayer,
 bool aDrawNow, wxPoint* tablesize );

 int PlaceCharacteristics( const TOOL_EVENT& aEvent );

 int PlaceStackup( const TOOL_EVENT& aEvent );

 int DrawLine( const TOOL_EVENT& aEvent );

 int DrawRectangle( const TOOL_EVENT& aEvent );

 int DrawCircle( const TOOL_EVENT& aEvent );

 int DrawArc( const TOOL_EVENT& aEvent );

 int PlaceText( const TOOL_EVENT& aEvent );

 int DrawDimension( const TOOL_EVENT& aEvent );

 int DrawZone( const TOOL_EVENT& aEvent );

 int DrawVia( const TOOL_EVENT& aEvent );

 int PlaceImportedGraphics( const TOOL_EVENT& aEvent );

 int InteractivePlaceWithPreview( const TOOL_EVENT& aEvent,
 std::vector<BOARD_ITEM*>& aItems,
 std::vector<BOARD_ITEM*>& aPreview, LSET* aLayers );


 int SetAnchor( const TOOL_EVENT& aEvent );

 int ToggleLine45degMode( const TOOL_EVENT& aEvent );

 void setTransitions() override;

private:
 bool drawSegment( const std::string& aTool, PCB_SHAPE** aGraphic,
 OPT<VECTOR2D> aStartingPoint );

 bool drawArc( const std::string& aTool, PCB_SHAPE** aGraphic, bool aImmediateMode );

 bool getSourceZoneForAction( ZONE_MODE aMode, ZONE** aZone );

 void constrainDimension( PCB_DIMENSION_BASE* aDim );

 int getSegmentWidth( PCB_LAYER_ID aLayer ) const;

 void updateStatusBar() const;

 KIGFX::VIEW* m_view;
 KIGFX::VIEW_CONTROLS* m_controls;
 BOARD* m_board;
 PCB_BASE_EDIT_FRAME* m_frame;
 MODE m_mode;
 bool m_inDrawingTool; // Re-entrancy guard

 unsigned int m_lineWidth; // Current line width for multi-segment drawing
 static const unsigned int WIDTH_STEP; // Amount of width change for one -/+ key press


 friend class ZONE_CREATE_HELPER; // give internal access to helper classes
};

#endif /* __DRAWING_TOOL_H */