KDE 4.0 API Reference kalzium
KalziumGradientType Class Reference
#include <kalziumgradienttype.h>
Detailed Description
Base class representing a gradient.Inherit it and add its instance to the factory to add it globally.
Definition at line 70 of file kalziumgradienttype.h.
Public Member Functions | |
| virtual | ~KalziumGradientType () |
| virtual QByteArray | name () const =0 |
| virtual QString | description () const =0 |
| virtual double | elementCoeff (int el) const |
| virtual double | value (int el) const =0 |
| virtual double | minValue () const =0 |
| virtual double | maxValue () const =0 |
| virtual bool | logarithmicGradient () const =0 |
| virtual QColor | firstColor () const |
| virtual QColor | secondColor () const |
| virtual QColor | notAvailableColor () const |
| QColor | calculateColor (const double coeff) const |
Static Public Member Functions | |
| static KalziumGradientType * | instance () |
Protected Member Functions | |
| KalziumGradientType () | |
Constructor & Destructor Documentation
| KalziumGradientType::~KalziumGradientType | ( | ) | [virtual] |
Definition at line 87 of file kalziumgradienttype.cpp.
| KalziumGradientType::KalziumGradientType | ( | ) | [protected] |
Definition at line 83 of file kalziumgradienttype.cpp.
Member Function Documentation
| KalziumGradientType * KalziumGradientType::instance | ( | ) | [static] |
Get its instance.
Reimplemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
Definition at line 91 of file kalziumgradienttype.cpp.
| virtual QByteArray KalziumGradientType::name | ( | ) | const [pure virtual] |
Returns the ID of this gradient.
Mainly used when saving/loading.
Implemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
| virtual QString KalziumGradientType::description | ( | ) | const [pure virtual] |
Returns the description of this gradient.
Used in all the visible places.
Implemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
| double KalziumGradientType::elementCoeff | ( | int | el | ) | const [virtual] |
Calculate the coefficient of the element with atomic number el according to this gradient.
The calculated coefficient will be always in the range [0, 1].
Definition at line 96 of file kalziumgradienttype.cpp.
| virtual double KalziumGradientType::value | ( | int | el | ) | const [pure virtual] |
Return the value, related to the current gradient, of the element with atomic number el.
It will return -1 if the data is not available.
Implemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
| virtual double KalziumGradientType::minValue | ( | ) | const [pure virtual] |
Returns the minimum value of the data this gradient represents.
Implemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
| virtual double KalziumGradientType::maxValue | ( | ) | const [pure virtual] |
Returns the maximum value of the data this gradient represents.
Implemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
| virtual bool KalziumGradientType::logarithmicGradient | ( | ) | const [pure virtual] |
Returns whether to use a logarithmic gradient instead of a linear one.
Implemented in KalziumCovalentRadiusGradientType, KalziumVanDerWaalsRadiusGradientType, KalziumMassGradientType, KalziumBoilingPointGradientType, KalziumMeltingPointGradientType, KalziumElectronegativityGradientType, KalziumDiscoverydateGradientType, KalziumElectronaffinityGradientType, and KalziumIonizationGradientType.
| QColor KalziumGradientType::firstColor | ( | ) | const [virtual] |
| QColor KalziumGradientType::secondColor | ( | ) | const [virtual] |
| QColor KalziumGradientType::notAvailableColor | ( | ) | const [virtual] |
Returns the color used to represent an element whose data is not available.
Definition at line 127 of file kalziumgradienttype.cpp.
| QColor KalziumGradientType::calculateColor | ( | const double | coeff | ) | const |
Calculates the color of an element which has a coeff which is a percentage of the maximum value.
- Parameters:
-
coeff is the coefficient in the range [0, 1], usually calculated with elementCoeff()
Definition at line 132 of file kalziumgradienttype.cpp.
The documentation for this class was generated from the following files:
