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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef CURSORPAINTER_HH
51 #define CURSORPAINTER_HH
52 
53 //== INCLUDES =================================================================
54 
55 #include <QObject>
56 #include <QCursor>
57 #include <QVector>
58 #include <QRectF>
59 
60 #include <ACG/GL/GLState.hh>
62 
63 //== NAMESPACES ===============================================================
64 
65 //== FORWARDDECLARATIONS ======================================================
66 class glViewer;
67 
68 //== CLASS DEFINITION =========================================================
69 
70 
74 class DLLEXPORT CursorPainter : public QObject
75 {
76  Q_OBJECT
77 
78  public:
80  CursorPainter (QObject *_parent = 0);
81 
83  ~CursorPainter ();
84 
86  void setCursor (const QCursor &_cursor);
87 
89  void initializeGL ();
90 
92  void registerViewer (glViewer *_viewer);
93 
95  void paintCursor (ACG::GLState *_state);
96 
98  void updateCursorPosition (QPointF _scenePos);
99 
101  QPointF cursorPosition ();
102 
104  void setEnabled (bool _enabled);
105 
107  void setForceNative (bool _enabled);
108 
110  bool enabled ();
111 
113  void setMouseIn (bool _in);
114 
116  QRectF cursorBoundingBox ();
117 
118  private:
119  // Create a texture for the cursor
120  void cursorToTexture ();
121  void cursorToCursor ();
122 
123  private:
124  QCursor cursor_;
125  QCursor nativeCursor_;
126  QPointF cursorPos_;
127 
128  bool initialized_;
129 
130  QVector<glViewer *> views_;
131 
132  bool enabled_;
133  bool mouseIn_;
134  bool forceNative_;
135 
136  // x and y offset between click position and texture (hotspot)
137  int xOff_;
138  int yOff_;
139  GLuint texture_;
140  bool hasCursor_;
141 };
142 
143 //=============================================================================
144 #endif
145 //=============================================================================
#define DLLEXPORT