Antiprism 0.23
Public Member Functions

color_map_spread Class Reference

A colour map with a good spread of colours. More...

#include <col_map.h>

Inheritance diagram for color_map_spread:
Inheritance graph
[legend]
Collaboration diagram for color_map_spread:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual bool init (const char *name, char *errmsg=0)
 Initialise from a string.
color_mapclone () const
 Get a copy of the map.
virtual col_val get_col (int idx) const
 Get the colour value for an index number.

Detailed Description

A colour map with a good spread of colours.


Member Function Documentation

color_map* color_map_spread::clone ( ) const [inline, virtual]

Get a copy of the map.

Returns:
a pointer to the dynamically allocated copy, which must be freed by the caller with delete, 0 indicates that the clone failed.

Reimplemented from color_map_range.

col_val color_map_spread::get_col ( int  idx) const [virtual]

Get the colour value for an index number.

Parameters:
idxthe index.
Returns:
The colour.

Reimplemented from color_map_range.

bool color_map_spread::init ( const char *  name,
char *  errmsg = 0 
) [virtual]

Initialise from a string.

Parameters:
namethe map name.
errmsgan array at least MSG_SZ chars long to return any error message.
Returns:
true if the file could be read, otherwise false and the error is detailed in errmsg.

Reimplemented from color_map_range.


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