coolray.org FAQ Contact Us
CoolRay Banner
CoolRay / Documentation
Main Page   Class Hierarchy   Compound List   Compound Members   Related Pages  

ColorMap Class Reference

This class maps a range of value(s) to colors. More...

#include <ColorMap.h>

Inheritance diagram for ColorMap

Inheritance graph
[legend]
Collaboration diagram for ColorMap:

Collaboration graph
[legend]
List of all members.

Public Methods

 DECLARE_ABSTRACT_CLASS (ColorMap,Object)
 ColorMap ()
virtual ~ColorMap ()
virtual Color getColor (const double value)
 Calculates the color for the given value. More...

virtual Color getColor (const Vector2 value)
 Calculates the color for the given vector. More...

virtual Color getColor (const Vector3 value)
 Calculates the color for the given vector. More...


Detailed Description

This class maps a range of value(s) to colors.

The input to this class and its childs are either a single value or a two or three dimensional vector. The vector is typically generated by a Pattern Object. Each component of the value has a range of 0..1. The result is a color value. The inharetee of this class has to specify how the value maps to color (e.g. a bitmap or a calculated relation).

Author(s):
Stefan Michel
See also:
XYZPigment , Pattern


Member Function Documentation

Color ColorMap::getColor ( const Vector3 value ) [virtual]
 

Calculates the color for the given vector.

Default implementation is to call the on dimensional version of this method with the x-component of the vector.

Parameters:
value   The value of each component must be in the intervall of 0..1

Color ColorMap::getColor ( const Vector2 value ) [virtual]
 

Calculates the color for the given vector.

Default implementation is to call the on dimensional version of this method with the x-component of the vector.

Parameters:
value   The value of each component must be in the intervall of 0..1

Color ColorMap::getColor ( const double value ) [virtual]
 

Calculates the color for the given value.

Parameters:
value   The value must be in the intervall of 0..1


The documentation for this class was generated from the following file:
  • ColorMap.h
You are visitor No.

counter

Copyright (c) 2001 Stefan Michel, All Rights Reserved.
Last modified: