Claw  1.7.3
color_palette.tpp
1 /*
2  CLAW - a C++ Library Absolutely Wonderful
3 
4  CLAW is a free library without any particular aim but being useful to
5  anyone.
6 
7  Copyright (C) 2005-2011 Julien Jorge
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 
23  contact: julien.jorge@gamned.org
24 */
25 /**
26  * \file color_palette.tpp
27  * \brief Implementation of the claw::graphic::color_palette class.
28  * \author Julien Jorge
29  */
30 #include <cassert>
31 
32 /*----------------------------------------------------------------------------*/
33 /**
34  * \brief Constructor.
35  * \param n The size of the palette.
36  */
37 template< typename Color >
38 claw::graphic::color_palette<Color>::color_palette(unsigned int n)
39  : m_palette(n)
40 {
41 
42 } // color_palette::color_palette()
43 
44 /*----------------------------------------------------------------------------*/
45 /**
46  * \brief Get the number of colors in the palette.
47  */
48 template< typename Color >
49 unsigned int claw::graphic::color_palette<Color>::size() const
50 {
51  return m_palette.size();
52 } // color_palette::size()
53 
54 /*----------------------------------------------------------------------------*/
55 /**
56  * \brief Get a color from the palette.
57  * \param i The index of the color.
58  * \pre \a i is a valid color index.
59  */
60 template< typename Color >
61 typename claw::graphic::color_palette<Color>::color_type&
62 claw::graphic::color_palette<Color>::operator[]( unsigned int i )
63 {
64  assert( i < m_palette.size() );
65 
66  return m_palette[i];
67 } // color_palette::operator[]()
68 
69 /*----------------------------------------------------------------------------*/
70 /**
71  * \brief Get the value of a color from the palette.
72  * \param i The index of the color.
73  * \pre \a i is a valid color index.
74  */
75 template< typename Color >
76 const typename claw::graphic::color_palette<Color>::color_type&
77 claw::graphic::color_palette<Color>::operator[]( unsigned int i ) const
78 {
79  assert( i < m_palette.size() );
80 
81  return m_palette[i];
82 } // color_palette::operator[]() [const]
83 
84 /*----------------------------------------------------------------------------*/
85 /**
86  * \brief Get the value of a color from the palette.
87  * \param i The index of the color.
88  * \pre \a i is a valid color index.
89  */
90 template< typename Color >
91 const typename claw::graphic::color_palette<Color>::color_type&
92 claw::graphic::color_palette<Color>::operator()( unsigned int i ) const
93 {
94  assert( i < m_palette.size() );
95 
96  return m_palette[i];
97 } // color_palette::operator()()
98