ColorStack.hh 6.51 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
2
3
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
Jan Möbius's avatar
Jan Möbius committed
4
 *      Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen      *
Jan Möbius's avatar
Jan Möbius committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper 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 Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
34

Jan Möbius's avatar
Jan Möbius committed
35
36
/*===========================================================================*\
 *                                                                           *
Jan Möbius's avatar
Jan Möbius committed
37
38
39
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
Jan Möbius's avatar
Jan Möbius committed
40
41
 *                                                                           *
\*===========================================================================*/
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58



//=============================================================================
//
//  CLASS ColorStack
//
//=============================================================================

#ifndef ACG_COLORSTACK_HH
#define ACG_COLORSTACK_HH


//== INCLUDES =================================================================

#include <vector>

Jan Möbius's avatar
Jan Möbius committed
59
#include "ACG/GL/gl.hh"
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#include "../Math/VectorT.hh"
#include "ColorTranslator.hh"


//== NAMESPACES ===============================================================


namespace ACG {


//== CLASS DEFINITION =========================================================


/** This class can be used to implement a gl picking stack based on colors
*/
class ACGDLLEXPORT ColorStack
{
public:
   
  /// Default constructor.
  ColorStack();
   /// Destructor.
  ~ColorStack();

  
  /// init (takes current GL context/ like glInitNames (); glPushName (0))
  void initialize();
  /// has it been initialized?
  bool initialized() const { return initialized_; }

  /// sets the maximum index number used in current node 
  bool setMaximumIndex (unsigned int _idx);

  /// sets the current color the given index (like glLoadName)
  void setIndex (unsigned int _idx);

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
96
97
98
  /// gets the color instead of setting it directly
  Vec4uc getIndexColor (unsigned int _idx);

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
99
100
101
102
103
104
105
  /// creates a new node the stack (like glPushName)
  void pushIndex (unsigned int _idx);

  /// pops the current node from the stack (like glPopName)
  void popIndex ();

  /// converts the given color to index values on the stack
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
106
  std::vector<unsigned int> colorToStack (Vec4uc _rgba) const;
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

  /// returns maximal available index count
  unsigned int freeIndicies () const;

  /// Did an error occur during picking
  bool error () const { return error_ && initialized_; };

  /// returns the current color index
  unsigned int currentIndex () const;

private:

  // Internal class used realize the color stack

  class Node {
    public:
      Node (unsigned int _idx, Node *_parent, ColorTranslator *_ct);
      ~Node ();

      /// sets the maximum index number used in current node 
      bool setMaximumIndex (unsigned int _idx);

      /// sets the current color the given index (like glLoadName)
      bool setIndex (unsigned int _idx) const;

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
132
133
134
      /// gets the color instead of setting it directly
      bool getIndexColor (unsigned int _idx, Vec4uc &_rgba) const;

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
      /// creates a new node the stack (like glPushName)
      Node * pushIndex (unsigned int _idx);

      /// pops the current node from the stack (like glPopName)
      Node * popIndex ();

      void colorToStack (std::vector<unsigned int> &_stack, unsigned int _index);

      unsigned int startIndex () { return startIdx_; };
      unsigned int endIndex () { return endIdx_; };
      unsigned int colorIndex () { return colorStartIdx_; };

    private:
      Node                *parent_;
      unsigned int        index_;
      ColorTranslator     *translator_;
      std::vector<Node *> nodes_;

      unsigned int startIdx_;
      unsigned int endIdx_;
      unsigned int colorStartIdx_;
      unsigned int colorEndIdx_;

  };

  bool            initialized_;
  ColorTranslator translator_;
  Node            *root_;
  Node            *currentNode_;
  bool            error_;
};


//=============================================================================
} // namespace ACG
//=============================================================================
#endif // ACG_COLORSTACK_HH defined
//=============================================================================