kicad/include/tool/picker_tool.h

150 lines
3.9 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
2019-08-14 08:28:07 +00:00
* Copyright (C) 2019 CERN
2020-12-27 00:41:04 +00:00
* Copyright (C) 2019-2020 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 PICKER_TOOL_H
#define PICKER_TOOL_H
#include <core/optional.h>
#include <gal/cursors.h>
#include <math/vector2d.h>
#include <tool/tool_interactive.h>
class EDA_DRAW_FRAME;
class PICKER_TOOL_BASE
{
public:
2020-12-27 00:41:04 +00:00
///< Event handler types.
typedef std::function<bool(const VECTOR2D&)> CLICK_HANDLER;
typedef std::function<void(const VECTOR2D&)> MOTION_HANDLER;
typedef std::function<void(void)> CANCEL_HANDLER;
typedef std::function<void(const int&)> FINALIZE_HANDLER;
enum pickerEndState
{
WAIT_CANCEL,
CLICK_CANCEL,
END_ACTIVATE,
EVT_CANCEL,
EXCEPTION_CANCEL
};
PICKER_TOOL_BASE() :
m_frame( nullptr )
{
reset();
}
inline void SetCursor( KICURSOR aCursor ) { m_cursor = aCursor; }
inline void SetSnapping( bool aSnap ) { m_snap = aSnap; }
/**
2020-12-27 00:41:04 +00:00
* Set a handler for mouse click event.
*
* The handler may decide to receive further click by returning true.
*/
inline void SetClickHandler( CLICK_HANDLER aHandler )
{
wxASSERT( !m_clickHandler );
m_clickHandler = aHandler;
}
/**
2020-12-27 00:41:04 +00:00
* Set a handler for mouse motion.
*
* This is used for roll-over highlighting.
*/
inline void SetMotionHandler( MOTION_HANDLER aHandler )
{
wxASSERT( !m_motionHandler );
m_motionHandler = aHandler;
}
/**
2020-12-27 00:41:04 +00:00
* Set a handler for cancel events (ESC or context-menu Cancel).
*/
inline void SetCancelHandler( CANCEL_HANDLER aHandler )
{
wxASSERT( !m_cancelHandler );
m_cancelHandler = aHandler;
}
/**
2020-12-27 00:41:04 +00:00
* Set a handler for the finalize event.
*
* Takes the state of the exit from the main loop.
*/
inline void SetFinalizeHandler( FINALIZE_HANDLER aHandler )
{
wxASSERT( !m_finalizeHandler );
m_finalizeHandler = aHandler;
}
protected:
2020-12-27 00:41:04 +00:00
///< Reinitializes tool to its initial state.
virtual void reset();
EDA_DRAW_FRAME* m_frame;
KICURSOR m_cursor;
bool m_snap;
OPT<CLICK_HANDLER> m_clickHandler;
OPT<MOTION_HANDLER> m_motionHandler;
OPT<CANCEL_HANDLER> m_cancelHandler;
OPT<FINALIZE_HANDLER> m_finalizeHandler;
OPT<VECTOR2D> m_picked;
};
class PICKER_TOOL : public TOOL_INTERACTIVE, public PICKER_TOOL_BASE
{
public:
PICKER_TOOL();
PICKER_TOOL( const std::string& aName );
virtual ~PICKER_TOOL() = default;
/// @copydoc TOOL_INTERACTIVE::Init()
bool Init() override;
/// @copydoc TOOL_INTERACTIVE::Reset()
void Reset( RESET_REASON aReason ) override { }
///< Main event loop.
int Main( const TOOL_EVENT& aEvent );
protected:
///< Applies the requested VIEW_CONTROLS settings.
void setControls();
///< @copydoc TOOL_INTERACTIVE::setTransitions();
void setTransitions() override;
};
#endif /* PICKER_TOOL_H */