Files
create/src/Gui/MouseSelection.h
2024-02-26 17:38:01 +01:00

259 lines
7.7 KiB
C++

/***************************************************************************
* Copyright (c) 2005 Werner Mayer <wmayer[at]users.sourceforge.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library 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 Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef MOUSESELECTION_H
#define MOUSESELECTION_H
#include <bitset>
#include <vector>
#include <QCursor>
#include <Gui/GLPainter.h>
#include <Gui/Namespace.h>
// forwards
class QMouseEvent;
class QWheelEvent;
class QKeyEvent;
class QPaintEvent;
class QResizeEvent;
class SbVec2s;
class SoEvent;
class SbViewportRegion;
class SoMouseButtonEvent;
class SoLocation2Event;
class SoKeyboardEvent;
namespace Gui {
class View3DInventorViewer;
/**
* The mouse selection base class
* In derived classes you must implement the methods @ref initialize() and @ref terminate()
* For all drawing stuff you just have to reimplement the @ref draw() method.
* In general you need not to do anything else.
* \author Werner Mayer and Jürgen Riegel
*/
class GuiExport AbstractMouseSelection
{
public:
enum { Continue=0, Restart=1, Finish=2, Cancel=3, Ignore=4 };
AbstractMouseSelection();
virtual ~AbstractMouseSelection() = default;
/// implement this in derived classes
virtual void initialize() = 0;
/// implement this in derived classes
virtual void terminate(bool abort = false) = 0;
void grabMouseModel(Gui::View3DInventorViewer*);
void releaseMouseModel(bool abort = false);
const std::vector<SbVec2s>& getPositions() const {
return _clPoly;
}
SelectionRole selectedRole() const {
return m_selectedRole;
}
/** @name Mouse events*/
//@{
int handleEvent(const SoEvent* const ev, const SbViewportRegion& vp);
//@}
protected:
virtual int mouseButtonEvent(const SoMouseButtonEvent* const, const QPoint&) {
return 0;
}
virtual int locationEvent(const SoLocation2Event* const, const QPoint&) {
return 0;
}
virtual int keyboardEvent(const SoKeyboardEvent* const){
return 0;
}
/// drawing stuff
virtual void draw() {}
protected:
Gui::View3DInventorViewer* _pcView3D{nullptr};
QCursor m_cPrevCursor;
int m_iXold, m_iYold;
int m_iXnew, m_iYnew;
SelectionRole m_selectedRole;
std::vector<SbVec2s> _clPoly;
};
// -----------------------------------------------------------------------------------
/**
* The standard mouse selection class
* \author Jürgen Riegel
*/
class GuiExport BaseMouseSelection : public AbstractMouseSelection
{
public:
BaseMouseSelection();
~BaseMouseSelection() override = default;
};
// -----------------------------------------------------------------------------------
/**
* The poly picker mouse selection class
* Create a polygon
* \author Werner Mayer
*/
class GuiExport PolyPickerSelection : public BaseMouseSelection
{
public:
PolyPickerSelection();
~PolyPickerSelection() override;
void setLineWidth(float l);
void setColor(float r, float g, float b, float a = 1.0);
void initialize() override;
void terminate(bool abort = false) override;
protected:
int mouseButtonEvent(const SoMouseButtonEvent* const e, const QPoint& pos) override;
int locationEvent(const SoLocation2Event* const e, const QPoint& pos) override;
int keyboardEvent(const SoKeyboardEvent* const e) override;
/// draw the polygon
void draw() override;
virtual int popupMenu();
protected:
Gui::Polyline polyline;
bool lastConfirmed;
};
// -----------------------------------------------------------------------------------
/**
* The poly clip mouse model class
* Create a polygon
* \author Werner Mayer
*/
class GuiExport PolyClipSelection : public PolyPickerSelection
{
public:
PolyClipSelection();
~PolyClipSelection() override;
inline void setRole(SelectionRole pos, bool on) {
selectionBits.set(static_cast<size_t>(pos), on);
}
inline bool testRole(SelectionRole pos) const {
return selectionBits.test(static_cast<size_t>(pos));
}
protected:
int popupMenu() override;
private:
std::bitset<8> selectionBits;
};
// -----------------------------------------------------------------------------------
/**
* The freehand selection class
* \author Werner Mayer
*/
class GuiExport FreehandSelection : public PolyPickerSelection
{
public:
FreehandSelection();
~FreehandSelection() override;
void setClosed(bool c);
protected:
int popupMenu() override;
int mouseButtonEvent(const SoMouseButtonEvent* const e, const QPoint& pos) override;
int locationEvent(const SoLocation2Event* const e, const QPoint& pos) override;
};
// -----------------------------------------------------------------------------------
/**
* The selection mouse model class
* Draws a rectangle for selection
* \author Werner Mayer
*/
class GuiExport RubberbandSelection : public BaseMouseSelection
{
public:
RubberbandSelection();
~RubberbandSelection() override;
void setColor(float r, float g, float b, float a = 1.0);
void initialize() override;
void terminate(bool abort = false) override;
protected:
int mouseButtonEvent(const SoMouseButtonEvent* const e, const QPoint& pos) override;
int locationEvent(const SoLocation2Event* const e, const QPoint& pos) override;
int keyboardEvent(const SoKeyboardEvent* const e) override;
/// draw the rectangle
void draw() override;
protected:
Gui::Rubberband rubberband;
};
// -----------------------------------------------------------------------------------
/**
* The selection mouse model class
* Draws a rectangle for selection
* \author Werner Mayer
*/
class GuiExport RectangleSelection : public RubberbandSelection
{
public:
RectangleSelection();
~RectangleSelection() override;
};
// -----------------------------------------------------------------------------------
/**
* The box zoom mouse model class
* Draws a rectangle for box zooming
* \author Werner Mayer
*/
class GuiExport BoxZoomSelection : public RubberbandSelection
{
public:
BoxZoomSelection();
~BoxZoomSelection() override;
void terminate(bool abort = false) override;
};
} // namespace Gui
#endif // MOUSESELECTION_H