kicad/pagelayout_editor/tools/pl_point_editor.h

107 lines
3.1 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 CERN
* Copyright (C) 2019 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 PL_POINT_EDITOR_H
#define PL_POINT_EDITOR_H
#include <tool/tool_interactive.h>
#include <tool/edit_points.h>
#include <tool/selection.h>
#include <tool/tool_menu.h>
class PL_SELECTION_TOOL;
class PL_EDITOR_FRAME;
/**
* PL_POINT_EDITOR
*
* Tool that displays edit points allowing to modify items by dragging the points.
*/
class PL_POINT_EDITOR : public TOOL_INTERACTIVE
{
public:
PL_POINT_EDITOR();
/// @copydoc TOOL_INTERACTIVE::Reset()
void Reset( RESET_REASON aReason ) override;
/// @copydoc TOOL_INTERACTIVE::Init()
bool Init() override;
int Main( const TOOL_EVENT& aEvent );
/**
* Indicates the cursor is over an edit point. Used to coordinate cursor shapes with
* other tools.
*/
bool HasPoint() { return m_editedPoint != nullptr; }
///> Sets up handlers for various events.
void setTransitions() override;
private:
///> Updates item's points with edit points.
void updateItem() const;
///> Updates edit points with item's points.
void updatePoints();
///> Updates which point is being edited.
void updateEditedPoint( const TOOL_EVENT& aEvent );
///> Sets the current point being edited. NULL means none.
void setEditedPoint( EDIT_POINT* aPoint );
///> Returns true if aPoint is the currently modified point.
inline bool isModified( const EDIT_POINT& aPoint ) const
{
return m_editedPoint == &aPoint;
}
inline int getEditedPointIndex() const
{
for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
{
if( m_editedPoint == &m_editPoints->Point( i ) )
return i;
}
return wxNOT_FOUND;
}
int modifiedSelection( const TOOL_EVENT& aEvent );
private:
PL_EDITOR_FRAME* m_frame;
PL_SELECTION_TOOL* m_selectionTool;
///> Currently edited point, NULL if there is none.
EDIT_POINT* m_editedPoint;
///> Currently available edit points.
std::shared_ptr<EDIT_POINTS> m_editPoints;
};
#endif // PL_POINT_EDITOR_H