Gui::SoFCColorBarBase Class Reference
The abstract color bar base class to get most important information on how to convert a scalar to an RGB color. More...
#include <SoFCColorBar.h>
Public Member Functions | |
| virtual bool | customize ()=0 |
| Opems a dialog to customie the current settings of the color bar. | |
| virtual App::Color | getColor (float fVal) const =0 |
| Returns the associated color to the value fVal. | |
| virtual const char * | getColorBarName () const =0 |
| Returns the name of the color bar. | |
| virtual float | getMaxValue (void) const =0 |
| Returns the current maximum of the parameter range. | |
| virtual float | getMinValue (void) const =0 |
| Returns the current minimum of the parameter range. | |
| virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
| virtual bool | isVisible (float fVal) const =0 |
| Returns always true if the color bar is in mode to show colors to arbitrary values of fVal, otherwise true is returned if fVal is within the specified parameter range, if not false is returned. | |
| virtual void | setOutsideGrayed (bool bVal)=0 |
| Sets whether values outside the range should be in gray,. | |
| virtual void | setRange (float fMin, float fMax, int prec=3)=0 |
| Sets the range of the colorbar from the maximum fMax to the minimum fMin. | |
Static Public Member Functions | |
| static void | finish (void) |
| static void | initClass (void) |
Protected Member Functions | |
| virtual void | setViewportSize (const SbVec2s &size)=0 |
| Sets the current viewer size to recalculate the new position. | |
| SoFCColorBarBase (void) | |
| virtual | ~SoFCColorBarBase () |
Detailed Description
The abstract color bar base class to get most important information on how to convert a scalar to an RGB color.
Definition at line 47 of file SoFCColorBar.h.
Constructor & Destructor Documentation
| SoFCColorBarBase::SoFCColorBarBase | ( | void | ) | [protected] |
Constructor.
Definition at line 45 of file SoFCColorBar.cpp.
| SoFCColorBarBase::~SoFCColorBarBase | ( | ) | [protected, virtual] |
Destructor.
Definition at line 53 of file SoFCColorBar.cpp.
Member Function Documentation
| virtual bool Gui::SoFCColorBarBase::customize | ( | ) | [pure virtual] |
Opems a dialog to customie the current settings of the color bar.
Returns true if the settings have been changed, false otherwise.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Referenced by Gui::SoFCColorBar::customize().
| void SoFCColorBarBase::finish | ( | void | ) | [static] |
Reimplemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Definition at line 64 of file SoFCColorBar.cpp.
| virtual App::Color Gui::SoFCColorBarBase::getColor | ( | float | fVal | ) | const [pure virtual] |
Returns the associated color to the value fVal.
This method must be implemented in subclasses.
Implements App::ValueFloatToRGB.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Referenced by Gui::SoFCColorBar::getColor().
| virtual const char* Gui::SoFCColorBarBase::getColorBarName | ( | ) | const [pure virtual] |
Returns the name of the color bar.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
| virtual float Gui::SoFCColorBarBase::getMaxValue | ( | void | ) | const [pure virtual] |
Returns the current maximum of the parameter range.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Referenced by Gui::SoFCColorBar::getMaxValue().
| virtual float Gui::SoFCColorBarBase::getMinValue | ( | void | ) | const [pure virtual] |
Returns the current minimum of the parameter range.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Referenced by Gui::SoFCColorBar::getMinValue().
| void SoFCColorBarBase::GLRenderBelowPath | ( | SoGLRenderAction * | action | ) | [virtual] |
Definition at line 69 of file SoFCColorBar.cpp.
References setViewportSize().
| void SoFCColorBarBase::initClass | ( | void | ) | [static] |
Reimplemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Definition at line 59 of file SoFCColorBar.cpp.
Referenced by Gui::SoFCDB::init().
| virtual bool Gui::SoFCColorBarBase::isVisible | ( | float | fVal | ) | const [pure virtual] |
Returns always true if the color bar is in mode to show colors to arbitrary values of fVal, otherwise true is returned if fVal is within the specified parameter range, if not false is returned.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Referenced by Gui::SoFCColorBar::isVisible().
| virtual void Gui::SoFCColorBarBase::setOutsideGrayed | ( | bool | bVal | ) | [pure virtual] |
Sets whether values outside the range should be in gray,.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
| virtual void Gui::SoFCColorBarBase::setRange | ( | float | fMin, | |
| float | fMax, | |||
| int | prec = 3 | |||
| ) | [pure virtual] |
Sets the range of the colorbar from the maximum fMax to the minimum fMin.
prec indicates the post decimal positions, prec should be in between 0 and 6.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
| virtual void Gui::SoFCColorBarBase::setViewportSize | ( | const SbVec2s & | size | ) | [protected, pure virtual] |
Sets the current viewer size to recalculate the new position.
This method must be implemented in subclasses.
Implemented in Gui::SoFCColorBar, Gui::SoFCColorGradient, and Gui::SoFCColorLegend.
Referenced by GLRenderBelowPath().
The documentation for this class was generated from the following files:
