kicad/pcbnew/tools/picker_tool.h

152 lines
4.3 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 CERN
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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 <boost/optional/optional.hpp>
#include "pcb_tool.h"
/**
* @brief Generic tool for picking a point.
*/
class PICKER_TOOL : public PCB_TOOL
{
public:
PICKER_TOOL();
~PICKER_TOOL() {}
///> Event handler types.
typedef std::function<bool(const VECTOR2D&)> CLICK_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
};
///> @copydoc TOOL_INTERACTIVE::Reset()
void Reset( RESET_REASON aReason ) override {}
///> Main event loop.
int Main( const TOOL_EVENT& aEvent );
/**
* Function SetSnapping()
* Sets cursor snapping to grid for the period when the tool is active.
*/
inline void SetSnapping( bool aEnable ) { m_cursorSnapping = aEnable; }
/**
* Function SetCursorVisible()
* Sets cursor visibility for the period when the tool is active.
*/
inline void SetCursorVisible( bool aEnable ) { m_cursorVisible = aEnable; }
/**
* Function SetAutoPanning()
* Sets autopanning mode for the period when the tool is active.
*/
inline void SetAutoPanning( bool aEnable ) { m_autoPanning = aEnable; }
/**
* Function SetAutoPanning()
* Toggles cursor capture mode for the period when the tool is active.
*/
inline void SetCursorCapture( bool aEnable ) { m_cursorCapture = aEnable; }
/**
* Function SetLayerSet()
* Sets the tool's snap layer set
*/
inline void SetLayerSet( LSET aLayerSet ) { m_layerMask = aLayerSet; }
/**
* Function SetClickHandler()
* Sets a handler for mouse click event. Handler may decide to receive further click by
* returning true.
*/
inline void SetClickHandler( CLICK_HANDLER aHandler )
{
assert( !m_clickHandler );
m_clickHandler = aHandler;
}
/**
* Function SetCancelHandler()
* Sets a handler for cancel events (ESC or context-menu Cancel).
*/
inline void SetCancelHandler( CANCEL_HANDLER aHandler )
{
assert( !m_cancelHandler );
m_cancelHandler = aHandler;
}
/**
* Function SetFinalizeHandler()
* Sets a handler for the finalize event. Takes the state of the exit from the Main loop
*/
inline void SetFinalizeHandler( FINALIZE_HANDLER aHandler )
{
assert( !m_finalizeHandler );
m_finalizeHandler = aHandler;
}
///> @copydoc TOOL_INTERACTIVE::setTransitions();
void setTransitions() override;
private:
// Tool settings.
bool m_cursorSnapping;
bool m_cursorVisible;
bool m_cursorCapture;
bool m_autoPanning;
///> The layer set to use for optional snapping
LSET m_layerMask;
///> Optional event handlers.
OPT<CLICK_HANDLER> m_clickHandler;
OPT<CANCEL_HANDLER> m_cancelHandler;
///> Picked point (if any).
OPT<VECTOR2D> m_picked;
///> Optional finalize state handler.
OPT<FINALIZE_HANDLER> m_finalizeHandler;
///> Reinitializes tool to its initial state.
void reset();
///> Applies the requested VIEW_CONTROLS settings.
void setControls();
};
#endif /* PICKER_TOOL_H */