Gui::SoFCColorLegend Class Reference

#include <SoFCColorLegend.h>

Inheritance diagram for Gui::SoFCColorLegend:

Public Member Functions
unsigned long	countColors (void) const
bool	customize ()
	Opems a dialog to customie the current settings of the color bar.
App::Color	getColor (float fVal) const
	Returns the associated color to the value fVal.
const char *	getColorBarName () const
	Returns the name of the color bar.
unsigned short	getColorIndex (float fVal) const
float	getMaxValue (void) const
	Returns the current maximum of the parameter range.
float	getMinValue (void) const
	Returns the current minimum of the parameter range.
bool	isVisible (float fVal) const
	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.
void	setColorModel (App::ColorGradient::TColorModel tModel)
	Sets the color model of the underlying color ramp to tModel.
void	setMarkerLabel (const SoMFString &label)
void	setOutsideGrayed (bool bVal)
	Sets whether values outside the range should be in gray,.
void	setRange (float fMin, float fMax, int prec=3)
	Sets the range of the colorbar from the maximum fMax to the minimum fMin.
	SoFCColorLegend (void)
Static Public Member Functions
static void	finish (void)
static void	initClass (void)
Protected Member Functions
void	setViewportSize (const SbVec2s &size)
	Sets the current viewer size to recalculate the new position.
virtual	~SoFCColorLegend ()
Protected Attributes
SoCoordinate3 *	coords
SoSeparator *	labels

Detailed Description

Definition at line 37 of file SoFCColorLegend.h.

Constructor & Destructor Documentation

SoFCColorLegend::SoFCColorLegend ( void )

Constructor.

Definition at line 47 of file SoFCColorLegend.cpp.

References coords, SketcherExample::f, App::ColorGradient::FLOW, labels, setColorModel(), setRange(), App::ColorGradient::setStyle(), and App::ColorGradient::TRIA.

SoFCColorLegend::~SoFCColorLegend ( ) [protected, virtual]

Destructor.

Definition at line 64 of file SoFCColorLegend.cpp.

References coords, and labels.

Member Function Documentation

unsigned long Gui::SoFCColorLegend::countColors ( void ) const [inline]

Definition at line 66 of file SoFCColorLegend.h.

bool Gui::SoFCColorLegend::customize ( ) [inline, 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.

Implements Gui::SoFCColorBarBase.

Definition at line 68 of file SoFCColorLegend.h.

void SoFCColorLegend::finish ( void ) [static]

Reimplemented from Gui::SoFCColorBarBase.

Definition at line 77 of file SoFCColorLegend.cpp.

App::Color Gui::SoFCColorLegend::getColor ( float fVal ) const [inline, virtual]

Returns the associated color to the value fVal.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

Definition at line 61 of file SoFCColorLegend.h.

const char* Gui::SoFCColorLegend::getColorBarName ( ) const [inline, virtual]

Returns the name of the color bar.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

Definition at line 69 of file SoFCColorLegend.h.

unsigned short Gui::SoFCColorLegend::getColorIndex ( float fVal ) const [inline]

Definition at line 60 of file SoFCColorLegend.h.

float Gui::SoFCColorLegend::getMaxValue ( void ) const [inline, virtual]

Returns the current maximum of the parameter range.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

Definition at line 65 of file SoFCColorLegend.h.

float Gui::SoFCColorLegend::getMinValue ( void ) const [inline, virtual]

Returns the current minimum of the parameter range.

This method must be implemented in subclasses.

Implements Gui::SoFCColorBarBase.

Definition at line 64 of file SoFCColorLegend.h.

void SoFCColorLegend::initClass ( void ) [static]

Reimplemented from Gui::SoFCColorBarBase.

Definition at line 72 of file SoFCColorLegend.cpp.

Referenced by Gui::SoFCDB::init().

bool Gui::SoFCColorLegend::isVisible ( float fVal ) const [inline, 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.

Implements Gui::SoFCColorBarBase.

Definition at line 63 of file SoFCColorLegend.h.

void SoFCColorLegend::setColorModel ( App::ColorGradient::TColorModel tModel )

Sets the color model of the underlying color ramp to tModel.

tModel either can be TRIA, INVERSE_TRIA or GRAY

Definition at line 188 of file SoFCColorLegend.cpp.

References App::ColorModel::_pclColors, App::ColorModel::_usColors, App::Color::b, coords, SketcherExample::f, App::Color::g, App::ColorGradient::getColorModel(), Py::int, k, labels, App::Color::r, App::ColorGradient::setColorModel(), and RobotExample::w.