MIRA
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
GradientColormap Class Referenceabstract

A class for creating continuous color maps based on linear gradients between predefined points. More...

#include <image/Colormap.h>

Inheritance diagram for GradientColormap:
Inheritance graph
[legend]

Public Types

typedef iterator const_iterator
 

Public Member Functions

 GradientColormap (std::size_t size=256)
 
void setColorAt (float position, const Color::RGB &color)
 Sets a color key at the given position with the given color. More...
 
void clear ()
 Removes all color keys. More...
 
virtual Color::RGB getf (float f) const
 Accesses the continuous colors. More...
 
void resize (std::size_t pSize)
 Sets a certain size of this colormap. More...
 
virtual std::size_t size () const
 Returns the set size. More...
 
virtual Color::RGB get (std::size_t idx) const
 Returns the color at the specified index (must be >= 0 and < size) More...
 
Color::RGB operator() (std::size_t idx)
 Returns the color in the colormap at the given index. More...
 
Color::RGB operator[] (std::size_t idx)
 Returns the color in the colormap at the given index. More...
 
iterator begin ()
 Gives an iterator to the beginning of the colormap. More...
 
const_iterator begin () const
 Gives a const iterator to the beginning of the colormap. More...
 
iterator end ()
 Gives an iterator to the end of the colormap. More...
 
const_iterator end () const
 Gives an const iterator to the end of the colormap. More...
 
Class const & getClass () const
 call the virtual internalGetClass(). More...
 

Static Public Member Functions

static PseudoClass const & CLASS ()
 

Protected Member Functions

void setColorAt (float position, int r, int g, int b)
 
virtual Class const & internalGetClass () const =0
 

Detailed Description

A class for creating continuous color maps based on linear gradients between predefined points.

Each point represents a color at a specific position within the color gradient.

Member Typedef Documentation

◆ const_iterator

typedef iterator const_iterator
inherited

Constructor & Destructor Documentation

◆ GradientColormap()

GradientColormap ( std::size_t  size = 256)
inline

Member Function Documentation

◆ setColorAt() [1/2]

void setColorAt ( float  position,
const Color::RGB color 
)
inline

Sets a color key at the given position with the given color.

The given position must be in the range 0 to 1.

◆ clear()

void clear ( )
inline

Removes all color keys.

◆ getf()

virtual Color::RGB getf ( float  f) const
virtualinherited

Accesses the continuous colors.

The specified floating point value must be within the interval [0,1].

Implements ContinuousColormap.

◆ setColorAt() [2/2]

void setColorAt ( float  position,
int  r,
int  g,
int  b 
)
inlineprotectedinherited

◆ resize()

void resize ( std::size_t  pSize)
inlineinherited

Sets a certain size of this colormap.

◆ size()

virtual std::size_t size ( ) const
inlinevirtualinherited

Returns the set size.

Implements Colormap.

◆ get()

virtual Color::RGB get ( std::size_t  idx) const
inlinevirtualinherited

Returns the color at the specified index (must be >= 0 and < size)

Implements Colormap.

◆ operator()()

Color::RGB operator() ( std::size_t  idx)
inlineinherited

Returns the color in the colormap at the given index.

◆ operator[]()

Color::RGB operator[] ( std::size_t  idx)
inlineinherited

Returns the color in the colormap at the given index.

◆ begin() [1/2]

iterator begin ( )
inlineinherited

Gives an iterator to the beginning of the colormap.

◆ begin() [2/2]

const_iterator begin ( ) const
inlineinherited

Gives a const iterator to the beginning of the colormap.

◆ end() [1/2]

iterator end ( )
inlineinherited

Gives an iterator to the end of the colormap.

◆ end() [2/2]

const_iterator end ( ) const
inlineinherited

Gives an const iterator to the end of the colormap.

◆ getClass()

Class const& getClass ( ) const
inlineinherited

call the virtual internalGetClass().

◆ CLASS()

static PseudoClass const& CLASS ( )
inlinestaticinherited

◆ internalGetClass()

virtual Class const& internalGetClass ( ) const
protectedpure virtualinherited

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