/* * 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 * * 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 #include #include #include namespace KIGFX { class VIEW; class VIEW_CONTROLS; } class BOARD; class PCB_BASE_EDIT_FRAME; class PCB_SHAPE; class POLYGON_GEOM_MANAGER; /** * Tool responsible for drawing graphical elements like lines, arcs, circles, etc. */ class DRAWING_TOOL : public PCB_TOOL_BASE { public: DRAWING_TOOL(); ~DRAWING_TOOL(); /// @copydoc TOOL_INTERACTIVE::Init() bool Init() override; /// @copydoc TOOL_INTERACTIVE::Reset() void Reset( RESET_REASON aReason ) override; ///< The possible drawing modes of DRAWING_TOOL enum class MODE { NONE, LINE, RECTANGLE, CIRCLE, ARC, TEXT, ANCHOR, DXF, DIMENSION, KEEPOUT, ZONE, GRAPHIC_POLYGON, VIA }; /** * Return the current drawing mode of the DRAWING_TOOL or #MODE::NONE if not currently in * any drawing mode. */ MODE GetDrawingMode() const; /** */ std::vector DrawBoardCharacteristics( const wxPoint& origin, PCB_LAYER_ID aLayer, bool aDrawNow, wxPoint* tablesize ); /** */ std::vector DrawSpecificationStackup( const wxPoint& origin, PCB_LAYER_ID aLayer, bool aDrawNow, wxPoint* tablesize ); /** */ int PlaceCharacteristics( const TOOL_EVENT& aEvent ); /** */ int PlaceStackup( const TOOL_EVENT& aEvent ); /** * Start interactively drawing a line. * * After invoking the function it expects the user to click at least two times to determine * the origin and the end for a line. If there are more clicks, the line is drawn as a * continuous polyline. */ int DrawLine( const TOOL_EVENT& aEvent ); /** * Start interactively drawing a rectangle. * * After invoking the function it expects the user to first click on a point that is going * to be used as the top-left of the rectangle. The second click determines the bottom-right. */ int DrawRectangle( const TOOL_EVENT& aEvent ); /** * Start interactively drawing a circle. * * After invoking the function it expects the user to first click on a point that is going * to be used as the center of the circle. The second click determines the circle radius. */ int DrawCircle( const TOOL_EVENT& aEvent ); /** * Start interactively drawing an arc. * * After invoking the function it expects the user to first click on a point that is going * to be used as the center of the arc. The second click determines the origin and radius, * the third one - the angle. */ int DrawArc( const TOOL_EVENT& aEvent ); /** * Display a dialog that allows one to input text and its settings and then lets the user * decide where to place the text in editor. */ int PlaceText( const TOOL_EVENT& aEvent ); /** * Start interactively drawing a dimension. * * After invoking the function it expects the user to first click on a point that is going * to be used as the origin of the dimension. The second click determines the end and the * third click modifies its height. */ int DrawDimension( const TOOL_EVENT& aEvent ); /** * Start interactively drawing a zone. * * After invoking the function a zone settings dialog is displayed. After confirmation it * allows the user to set points that are going to be used as a boundary polygon of the * zone. Double click or clicking on the origin of the boundary polyline finishes the * drawing. * * The event parameter indicates which type of zone to draw: * - ADD add a new zone/keepout with fresh settings. * - CUTOUT add a cutout to an existing zone. * - SIMILAR add a new zone with the same settings as an existing one. */ int DrawZone( const TOOL_EVENT& aEvent ); int DrawVia( const TOOL_EVENT& aEvent ); /** * Place a drawing imported from a DXF or SVG file in footprint editor. */ int PlaceImportedGraphics( const TOOL_EVENT& aEvent ); /** * Interactively place a set of @ref BOARD_ITEM. * As a list of BOARD_ITEMs can be resource intesive to move around, * we can use a reduced set of BOARD_ITEMs for preview purpose only. * * @param aEvent * @param aItems BOARD_ITEMs to add to the board. * @param aPreview BOARD_ITEMs only used during placement / preview. * @param aLayers Set of allowed destination when asking the user. * If set to NULL, the user is not asked and all BOARD_ITEMs remain on * their layers. */ int InteractivePlaceWithPreview( const TOOL_EVENT& aEvent, std::vector& aItems, std::vector& aPreview, LSET* aLayers ); /** * Place the footprint anchor (only in footprint editor). */ int SetAnchor( const TOOL_EVENT& aEvent ); /** * Toggle the horizontal/veritcal/45-degree constraint for drawing tools. */ int ToggleHV45Mode( const TOOL_EVENT& toolEvent ); ///< Set up handlers for various events. void setTransitions() override; void SetStroke( const STROKE_PARAMS& aStroke, PCB_LAYER_ID aLayer ) { m_layer = aLayer; m_stroke = aStroke; } private: /** * Start drawing a selected shape (i.e. PCB_SHAPE). * * @param aGraphic is an object that is going to be used by the tool for drawing. Must be * already created. The tool deletes the object if it is not added to a BOARD. * @param aStartingPoint is a starting point for this new PCB_SHAPE. If it exists the new * item has its start point set to aStartingPoint, and its settings * (width, layer) set to the current default values. * @return False if the tool was canceled before the origin was set or origin and end are * the same point. */ bool drawSegment( const std::string& aTool, PCB_SHAPE** aGraphic, OPT aStartingPoint ); /** * Start drawing an arc. * * @param aGraphic is an object that is going to be used by the tool for drawing. Must be * already created. The tool deletes the object if it is not added to a BOARD. * @return False if the tool was canceled before the origin was set or origin and end are * the same point. */ bool drawArc( const std::string& aTool, PCB_SHAPE** aGraphic, OPT aStartingPoint ); /** * Draw a polygon, that is added as a zone or a keepout area. * * @param aKeepout dictates if the drawn polygon is a zone or a keepout area. * @param aMode dictates the mode of the zone tool: * - ADD add a new zone/keepout with fresh settings * - CUTOUT add a cutout to an existing zone * - SIMILAR add a new zone with the same settings as an existing one */ /** * Get a source zone item for an action that takes an existing zone into account (for * example a cutout of an existing zone). * * The source zone is taken from the current selection. * * @param aMode mode of the zone tool * @param aZone updated pointer to a suitable source zone, or nullptr if none found, or * the action doesn't need a source * @return true if a suitable zone was found, or the action doesn't need a zone. False if * the action needs a zone but none was found. */ bool getSourceZoneForAction( ZONE_MODE aMode, ZONE** aZone ); /** * Force the dimension lime to be drawn on multiple of 45 degrees. * * @param aDimension is the dimension element currently being drawn. */ void constrainDimension( PCB_DIMENSION_BASE* aDim ); ///< Return the appropriate width for a segment depending on the settings. 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 PCB_LAYER_ID m_layer; // The layer we last drew on STROKE_PARAMS m_stroke; // Current stroke for multi-segment drawing TEXT_ATTRIBUTES m_textAttrs; 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 */