CLAW Library (a C++ Library Absolutely Wonderful) 1.5.5
Public Types | Public Member Functions | Private Attributes

claw::graphic::color_palette< Color > Class Template Reference

A palette of colors, for palettized images. More...

#include <color_palette.hpp>

List of all members.

Public Types

typedef Color color_type
 The type of the colors stored in the palette.

Public Member Functions

 color_palette (unsigned int n)
 Constructor.
unsigned int size () const
 Get the number of colors in the palette.
color_typeoperator[] (unsigned int i)
 Get a color from the palette.
const color_typeoperator[] (unsigned int i) const
 Get the value of a color from the palette.
const color_typeoperator() (unsigned int i) const
 Get the value of a color from the palette.

Private Attributes

std::vector< color_typem_palette
 The colors in the palette.

Detailed Description

template<typename Color>
class claw::graphic::color_palette< Color >

A palette of colors, for palettized images.

Author:
Julien Jorge

Definition at line 44 of file color_palette.hpp.


Member Typedef Documentation

template<typename Color>
typedef Color claw::graphic::color_palette< Color >::color_type

The type of the colors stored in the palette.

Definition at line 48 of file color_palette.hpp.


Constructor & Destructor Documentation

template<typename Color >
claw::graphic::color_palette< Color >::color_palette ( unsigned int  n)

Constructor.

Parameters:
nThe size of the palette.

Definition at line 38 of file color_palette.tpp.

  : m_palette(n)
{

} // color_palette::color_palette()

Member Function Documentation

template<typename Color >
const claw::graphic::color_palette< Color >::color_type & claw::graphic::color_palette< Color >::operator() ( unsigned int  i) const

Get the value of a color from the palette.

Parameters:
iThe index of the color.
Precondition:
i is a valid color index.

Definition at line 92 of file color_palette.tpp.

{
  assert( i < m_palette.size() );

  return m_palette[i];
} // color_palette::operator()()
template<typename Color >
claw::graphic::color_palette< Color >::color_type & claw::graphic::color_palette< Color >::operator[] ( unsigned int  i)

Get a color from the palette.

Parameters:
iThe index of the color.
Precondition:
i is a valid color index.

Definition at line 62 of file color_palette.tpp.

{
  assert( i < m_palette.size() );

  return m_palette[i];
} // color_palette::operator[]()
template<typename Color >
const claw::graphic::color_palette< Color >::color_type & claw::graphic::color_palette< Color >::operator[] ( unsigned int  i) const

Get the value of a color from the palette.

Parameters:
iThe index of the color.
Precondition:
i is a valid color index.

Definition at line 77 of file color_palette.tpp.

{
  assert( i < m_palette.size() );

  return m_palette[i];
} // color_palette::operator[]() [const]
template<typename Color >
unsigned int claw::graphic::color_palette< Color >::size ( ) const

Member Data Documentation

template<typename Color>
std::vector<color_type> claw::graphic::color_palette< Color >::m_palette [private]

The colors in the palette.

Definition at line 62 of file color_palette.hpp.


The documentation for this class was generated from the following files: