Abstract class for values legend. More...
#include <MeshViz/graph/PoValueLegend.h>
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 |
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 :
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).
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.
Number of the first value to display.
Number of the last value to display.
String indicating the lower undefined level.
(Corresponds to the minimum threshold of data mapping Not used if no data mapping object is specified or if the minimum threshold is disabled).
Period to display the values in the legend.
String indicating the upper undefined level.
(Corresponds to the maximum threshold of data mapping. Not used if no data mapping object is specified or if the maximum threshold is disabled).