Developer Documentation
CursorPainter.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #ifndef CURSORPAINTER_HH
45 #define CURSORPAINTER_HH
46 
47 //== INCLUDES =================================================================
48 
49 #include <QObject>
50 #include <QCursor>
51 #include <QVector>
52 #include <QRectF>
53 
54 #include <ACG/GL/GLState.hh>
56 
57 //== NAMESPACES ===============================================================
58 
59 //== FORWARDDECLARATIONS ======================================================
60 class glViewer;
61 
62 //== CLASS DEFINITION =========================================================
63 
64 
68 class DLLEXPORT CursorPainter : public QObject
69 {
70  Q_OBJECT
71 
72  public:
74  explicit CursorPainter (QObject *_parent = 0);
75 
77  ~CursorPainter ();
78 
80  void setCursor (const QCursor &_cursor);
81 
83  void initializeGL ();
84 
86  void registerViewer (glViewer *_viewer);
87 
89  void paintCursor (ACG::GLState *_state);
90 
92  void updateCursorPosition (QPointF _scenePos);
93 
95  QPointF cursorPosition ();
96 
98  void setEnabled (bool _enabled);
99 
101  void setForceNative (bool _enabled);
102 
104  bool enabled ();
105 
107  void setMouseIn (bool _in);
108 
110  QRectF cursorBoundingBox ();
111 
112  private:
113  // Create a texture for the cursor
114  void cursorToTexture ();
115  void cursorToCursor ();
116 
117  private:
118  QCursor cursor_;
119  QCursor nativeCursor_;
120  QPointF cursorPos_;
121 
122  bool initialized_;
123 
124  QVector<glViewer *> views_;
125 
126  bool enabled_;
127  bool mouseIn_;
128  bool forceNative_;
129 
130  // x and y offset between click position and texture (hotspot)
131  int xOff_;
132  int yOff_;
133  GLuint texture_;
134  bool hasCursor_;
135 };
136 
137 //=============================================================================
138 #endif
139 //=============================================================================
#define DLLEXPORT