Developer Documentation

ColorTranslator.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 //
45 // CLASS ColorTranslator
46 //
47 //=============================================================================
48
49 #ifndef ACG_COLORTRANSLATOR_HH
50 #define ACG_COLORTRANSLATOR_HH
51
52
53 //== INCLUDES =================================================================
54
55
56 #include "gl.hh"
57 #include <ACG/Config/ACGDefines.hh>
58 #include <ACG/Math/VectorT.hh>
59
60
61 //== NAMESPACES ===============================================================
62
63
64 namespace ACG {
65
66 class GLState;
67
68 //== CLASS DEFINITION =========================================================
69
70
75 class ACGDLLEXPORT ColorTranslator
76 {
77 public:
78
80 ColorTranslator() : initialized_(false),
81 red_bits_(0), green_bits_(0), blue_bits_(0), alpha_bits_(0),
82 red_mask_(0), green_mask_(0), blue_mask_(0), alpha_mask_(0),
83 red_shift_(0), green_shift_(0), blue_shift_(0), alpha_shift_(0),
84 red_round_(0), green_round_(0), blue_round_(0), alpha_round_(0)
85 {};
86
88 ~ColorTranslator() {};
89
90
93 void initialize(ACG::GLState*);
94
96 bool initialized() const { return initialized_; }
97
98
100 Vec4uc index2color(const size_t _idx) const;
101
103 size_t color2index(const Vec4uc _rgba) const;
104
105
107 size_t max_index() const;
108
109
110 private:
111
112 bool initialized_;
113 GLint red_bits_, green_bits_, blue_bits_, alpha_bits_;
114 GLuint red_mask_, green_mask_, blue_mask_, alpha_mask_;
115 GLuint red_shift_, green_shift_, blue_shift_, alpha_shift_;
116 GLuint red_round_, green_round_, blue_round_, alpha_round_;
117 };
118
119
120 //=============================================================================
121 } // namespace ACG
122 //=============================================================================
123 #endif // ACG_COLORTRANSLATOR_HH defined
124 //=============================================================================
125
ACG
Namespace providing different geometric functions concerning angles.
Definition: BaseObjectData.hh:68
ACG::ColorTranslator::~ColorTranslator
~ColorTranslator()
Destructor.
Definition: ColorTranslator.hh:88
ACG::GLState
Definition: GLState.hh:213
ACG::ColorTranslator::initialized
bool initialized() const
has it been initialized?
Definition: ColorTranslator.hh:96
ACG::ColorTranslator
Definition: ColorTranslator.hh:75
ACG::ColorTranslator::ColorTranslator
ColorTranslator()
Default constructor.
Definition: ColorTranslator.hh:80
OpenMesh::VectorT
Definition: Vector11T.hh:83