PoValueLegend Class Reference
[Legend]

Abstract class for values legend. More...

#include <MeshViz/graph/PoValueLegend.h>

Inheritance diagram for PoValueLegend:

Classes
struct	BoxRepresentation
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
void	setIsovaluesList (PbIsovaluesList *isovaluesList)
const PbIsovaluesList *	getIsovaluesList () const
void	setDataMapping (PbDataMapping *dataMapping)
const PbDataMapping *	getDataMapping () const
void	setFormat (PbNumericDisplayFormat *format)
const PbNumericDisplayFormat *	getFormat () const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFString	upperUndefString
SoSFString	lowerUndefString
SoSFUShort	periodValue
SoSFUShort	firstValue
SoSFUShort	lastValue

Detailed Description

Abstract class for values legend.

This class handles a period of values, a first value and a last value to be displayed in a legend, specific strings.

Values of the legends depend on :

the current list of isovalues only if this list exists. In this case, values of the legend are the values defined by the current list of isovalues. The current data mapping is only used for coloring boxes of the legend.
the current data mapping only if the current list of isovalues does no exist. In this case, the values of the legend are the values of the current data mapping. If the current data mapping is linear, about ten values are computed. If the current data mapping is non linear of type PbNonLinearDataMapping or it does not exist, the list of legend values is empty. If the current data mapping is non linear of type PbNonLinearDataMapping2, values of the legend are the values defined by the current data mapping.

If setIsovaluesList(isovaluesList) method is called with "isovaluesList" derived from PbIsovaluesList, the current isovalues list is "isovaluesList". Otherwise the current isovalues list is specified in the current inherited state (cf PoIsovaluesList property node). The current isovalues list does not exist if setIsovaluesList() method is not called and no PoIsovaluesList node is traversed before in the scene graph.

If setDataMapping(dataMapping) method is called with "dataMapping" derived from PbDataMapping, the current data mapping is "dataMapping". Otherwise the current data mapping is specified in the current inherited state (cf property node PoDataMapping and its derived classes). The current data mapping does not exist if setDataMapping() method is not called and no PoDataMapping node is traversed before in the scene graph.

Values format depends on the current numerical display format. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the current numerical display format is specified in the current inherited state (cf property node PoNumericDisplayFormat).

Member Function Documentation

static const SoNodekitCatalog* PoValueLegend::getClassNodekitCatalog ( ) [static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoLegend.

Reimplemented in PoAutoValueLegend, PoLinearValueLegend, PoNonLinearValueLegend1, PoNonLinearValueLegend2, and PoNonLinearValueLegend3.

static SoType PoValueLegend::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from PoLegend.

Reimplemented in PoAutoValueLegend, PoLinearValueLegend, PoNonLinearValueLegend1, PoNonLinearValueLegend2, and PoNonLinearValueLegend3.

const PbDataMapping* PoValueLegend::getDataMapping ( ) const

Gets a reference to a PbDataMapping object to the association color-values.

const PbNumericDisplayFormat* PoValueLegend::getFormat ( ) const

Gets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values.

const PbIsovaluesList* PoValueLegend::getIsovaluesList ( ) const

Gets a reference to a PbIsovaluesList object.

virtual const SoNodekitCatalog* PoValueLegend::getNodekitCatalog ( ) const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoLegend.

Reimplemented in PoAutoValueLegend, PoLinearValueLegend, PoNonLinearValueLegend1, PoNonLinearValueLegend2, and PoNonLinearValueLegend3.

virtual SoType PoValueLegend::getTypeId ( ) const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoLegend.

Reimplemented in PoAutoValueLegend, PoLinearValueLegend, PoNonLinearValueLegend1, PoNonLinearValueLegend2, and PoNonLinearValueLegend3.

void PoValueLegend::setDataMapping ( PbDataMapping * dataMapping )

Sets a reference to a PbDataMapping object to the association color-values.

If this method is not called (or called passing NULL as argument), this is the data mapping defined in the current inherited state (defined with the property node PoDataMapping and its derived classes) which is used.

void PoValueLegend::setFormat ( PbNumericDisplayFormat * format )

Sets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values.

If this method is not called (or called passing NULL as argument), this is the numerical display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) which is used.

void PoValueLegend::setIsovaluesList ( PbIsovaluesList * isovaluesList )

Sets a reference to a PbIsovaluesList object.

A PbIsovaluesList object defines an isovalue list used for the legend values. If this method is not called (or called passing NULL as argument), this is the isovalue list defined in the current inherited state (defined with the property node PoIsovaluesList) which is used.