PoLegend Class Reference
[Legend]

Abstract class for legend representations. More...

#include <MeshViz/graph/PoLegend.h>

Inheritance diagram for PoLegend:

List of all members.

Classes
struct	LegendAttr
Public Types
enum	Visibility {   VISIBILITY_OFF,   VISIBILITY_ON }
enum	TextPath {   PATH_RIGHT,   PATH_LEFT,   PATH_UP,   PATH_DOWN }
enum	Position {   POS_BOTTOM,   POS_TOP,   POS_RIGHT,   POS_LEFT }
enum	MarginType {   REL_MARGIN,   FIXED_MARGIN }
enum	IncrementType {   VERTICAL_INCREMENT,   HORIZONTAL_INCREMENT }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
void	setMiscTextAttr (PbMiscTextAttr *textAttr)
const PbMiscTextAttr *	getMiscTextAttr () const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFEnum	titleVisibility
SoSFEnum	titlePosition
SoSFEnum	titlePath
SoSFFloat	titleFontSize
SoSFString	titleFontName
SoSFString	titleString
SoSFEnum	valueVisibility
SoSFEnum	valuePosition
SoSFString	valueFontName
SoSFBool	valueAddStringVisibility
SoSFString	valueAddString
SoSFEnum	marginType
SoSFFloat	marginLeft
SoSFFloat	marginRight
SoSFFloat	marginBottom
SoSFFloat	marginTop
SoSFEnum	incrementType
SoSFUShort	numColumns
SoSFFloat	boxRatio

---

Detailed Description

Abstract class for legend representations.

This class handles the title, the values, the margins and the path of the legend.

All legend texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node PoMiscTextAttr).

---

Member Enumeration Documentation

enum PoLegend::IncrementType

Type of values incrementation.

Enumerator:

VERTICAL_INCREMENT	Values of the legend are vertically incremented.
HORIZONTAL_INCREMENT	Values of the legend are horizontally incremented.

enum PoLegend::MarginType

Type of margins.

Enumerator:

REL_MARGIN	Relative margin.
FIXED_MARGIN	Absolute margin.

enum PoLegend::Position

Type of position.

Enumerator:

POS_BOTTOM	Bottom position.
POS_TOP	Top position.
POS_RIGHT	Right position.
POS_LEFT	Left position.

enum PoLegend::TextPath

Text path.

Enumerator:

PATH_RIGHT	Writing from left to right.
PATH_LEFT	Writing from right to left.
PATH_UP	Writing from bottom to top.
PATH_DOWN	Writing from top to bottom.

enum PoLegend::Visibility

Type of visibility.

Enumerator:

VISIBILITY_OFF	Invisible.
VISIBILITY_ON	Visible.

---

Member Function Documentation

static const SoNodekitCatalog* PoLegend::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoGraphMaster.

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

static SoType PoLegend::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoGraphMaster.

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

const PbMiscTextAttr* PoLegend::getMiscTextAttr

(

)

const

Gets a reference to a PbMiscTextAttr for miscellaneous text attributes.

virtual const SoNodekitCatalog* PoLegend::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

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

virtual SoType PoLegend::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

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

void PoLegend::setMiscTextAttr

(

PbMiscTextAttr *

textAttr

)

Sets a reference to a PbMiscTextAttr for miscellaneous text attributes of all legend texts.

If this method is not called (or called passing NULL as argument), this is the miscellaneous text attributes defined in the current inherited state (defined with the property node PoMiscTextAttr) which are used.

---

Member Data Documentation

SoSFFloat PoLegend::boxRatio

Ratio between width and height of the colored boxes in the legend.

SoSFEnum PoLegend::incrementType

Increment type for the values of legend.

(the values can be incremented vertically or horizontally).

SoSFFloat PoLegend::marginBottom

Bottom margin.

SoSFFloat PoLegend::marginLeft

Left margin.

SoSFFloat PoLegend::marginRight

Right margin.

SoSFFloat PoLegend::marginTop

Top margin.

SoSFEnum PoLegend::marginType

Margin type.

SoSFUShort PoLegend::numColumns

Number of columns of the legend.

SoSFString PoLegend::titleFontName

Font name of the title.

If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.

SoSFFloat PoLegend::titleFontSize

Font size of the title.

SoSFEnum PoLegend::titlePath

Title path.

Use enum TextPath.

SoSFEnum PoLegend::titlePosition

Title position.

SoSFString PoLegend::titleString

Title string.

SoSFEnum PoLegend::titleVisibility

Title visibility.

SoSFString PoLegend::valueAddString

String to be concatenated.

SoSFBool PoLegend::valueAddStringVisibility

Visibility of a string concatenated to the values.

SoSFString PoLegend::valueFontName

Font name of values.

If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.

SoSFEnum PoLegend::valuePosition

Values positions.

SoSFEnum PoLegend::valueVisibility

Values visibility.

---

The documentation for this class was generated from the following file:

• MeshViz/graph/PoLegend.h