copasi API  0.1
Public Member Functions
CColorScale Class Reference

#include <CColorScale.h>

Inheritance diagram for CColorScale:
CColorScale1 CColorScaleBiLog CColorScaleSimple CColorScaleAdvanced CColorScaleAverage

List of all members.

Public Member Functions

 CColorScale ()
virtual ~CColorScale ()
virtual QColor getColor (const C_FLOAT64 &number)=0
virtual void startAutomaticParameterCalculation ()
virtual void passValue (const C_FLOAT64 &)
virtual void finishAutomaticParameterCalculation ()
void setIsUsed (bool f)
bool isUsed () const

Detailed Description

Base class for color scales. The derived classes provide algorithms to map a double number to a QColor. The scaling parameters can either be set automatically (by using methods provided by the derived classes) or be determined automatically. For automatic scaling all numbers that are to be displayed (or at least a typical sample) have to be passed to the passValue() method before the getColor() method is used. This class is used by ArrayAnnotationWidget.


Constructor & Destructor Documentation

CColorScale::CColorScale ( ) [inline]
virtual CColorScale::~CColorScale ( ) [inline, virtual]

Member Function Documentation

virtual void CColorScale::finishAutomaticParameterCalculation ( ) [inline, virtual]

this finishes the calculation of the scaling parameters.

Reimplemented in CColorScaleBiLog, CColorScaleAverage, and CColorScaleSimple.

virtual QColor CColorScale::getColor ( const C_FLOAT64 &  number) [pure virtual]

this method maps a number to a color.

Implemented in CColorScaleBiLog, CColorScaleAdvanced, CColorScaleSimple, and CColorScale1.

bool CColorScale::isUsed ( ) const [inline]

if setIsUsed() was used isUsed() can be called to find out if the scaler is already in use. One scaler must not be used in several widgets.

virtual void CColorScale::passValue ( const C_FLOAT64 &  ) [inline, virtual]

with this method numbers are passed to the automatic scaling algorithm.

Reimplemented in CColorScaleBiLog, CColorScaleAverage, and CColorScaleSimple.

void CColorScale::setIsUsed ( bool  f) [inline]

this is called by the array annotation widget to indicate that the scaler is in use

virtual void CColorScale::startAutomaticParameterCalculation ( ) [inline, virtual]

this method starts the calculation of the scaling parameters.

Reimplemented in CColorScaleBiLog, CColorScaleAverage, and CColorScaleSimple.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines