NPlot::StepGradient Class Reference

Class for creating a rainbow legend. More...

Inheritance diagram for NPlot::StepGradient:

NPlot::IGradient List of all members.

Public Types

enum  Type { Rainbow, RGB }
 Types of step gradient defined. More...

Public Member Functions

 StepGradient ()
 Default Constructor.
 StepGradient (Type stepType)
 Constructor.
Color GetColor (double prop)
 Gets a color corresponding to a number between 0.0 and 1.0 inclusive.

Properties

Type StepType
 Sets the type of step gradient.
Type stepType_ = Type.RGB

Detailed Description

Class for creating a rainbow legend.

Definition at line 60 of file StepGradient.cs.


Member Enumeration Documentation

enum NPlot::StepGradient::Type
 

Types of step gradient defined.

Enumerator:
Rainbow  Rainbow gradient type (colors of the rainbow).
RGB  RGB gradient type (red, green blud).

Definition at line 66 of file StepGradient.cs.


Constructor & Destructor Documentation

NPlot::StepGradient::StepGradient  )  [inline]
 

Default Constructor.

Definition at line 99 of file StepGradient.cs.

NPlot::StepGradient::StepGradient Type  stepType  )  [inline]
 

Constructor.

Parameters:
stepType type of gradient

Definition at line 108 of file StepGradient.cs.

References stepType_.


Member Function Documentation

Color NPlot::StepGradient::GetColor double  prop  )  [inline]
 

Gets a color corresponding to a number between 0.0 and 1.0 inclusive.

The color will be a linear interpolation of the min and max colors.

Parameters:
prop the number to get corresponding color for (between 0.0 and 1.0)
Returns:
The color corresponding to the supplied number.

Implements NPlot::IGradient.

Definition at line 119 of file StepGradient.cs.

References stepType_.


Property Documentation

Type NPlot::StepGradient::StepType [get, set]
 

Sets the type of step gradient.

Definition at line 83 of file StepGradient.cs.

Type NPlot::StepGradient::stepType_ = Type.RGB [private]
 

Definition at line 93 of file StepGradient.cs.

Referenced by GetColor(), and StepGradient().


The documentation for this class was generated from the following file:
Generated on Sat Nov 5 01:04:09 2005 for NPlot by  doxygen 1.4.5