PoHistogram Class Reference
[Histogram]

Abstract class for histogram representations. More...

#include <MeshViz/graph/PoHistogram.h>

Inheritance diagram for PoHistogram:

Classes
struct	HistogAttr
struct	NameAttr
struct	ValueAttr
Public Types
enum	Type { X, Y }
enum	Position { POS_TOP_OUT, POS_TOP_IN, POS_BOTTOM_OUT, POS_BOTTOM_IN, POS_RIGHT_OUT, POS_RIGHT_IN, POS_LEFT_OUT, POS_LEFT_IN, POS_CENTER, POS_DEPEND }
enum	Visibility { VISIBILITY_OFF, VISIBILITY_ON }
enum	TextPath { PATH_RIGHT, PATH_LEFT, PATH_UP, PATH_DOWN, PATH_DEPEND }
enum	BarSpaceType { REL_SPACE, FIXED_SPACE }
enum	Coloring { COLOR_LIST, DATA_MAPPING }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
void	setMiscTextAttr (PbMiscTextAttr *textAttr)
const PbMiscTextAttr *	getMiscTextAttr () 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
SoSFVec2f	start
SoSFFloat	end
SoSFEnum	type
SoMFColor	color
SoSFEnum	coloring
SoSFEnum	valueVisibility
SoSFEnum	valuePosition
SoSFEnum	valuePath
SoSFFloat	valueFontSize
SoSFString	valueFontName
SoSFBool	valueAddStringVisibility
SoSFString	valueAddString
SoSFEnum	nameVisibility
SoSFEnum	namePosition
SoSFEnum	namePath
SoSFFloat	nameFontSize
SoSFString	nameFontName
SoSFEnum	barSpaceType
SoSFFloat	barSpaceValue

Detailed Description

Abstract class for histogram representations.

This class handles the start, the end, the values of the bars, the names of the bars and the bars spacing of a histogram.

All histogram 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).

All histogram numerical values depend 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).

If coloring = DATA_MAPPING, colors of histogram bars depend on the current data mapping. If the method setDataMapping(dataMapping) is called, 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). If there is no current data-mapping (i.e setDataMapping() not called and no PoDataMapping node traversed before in the scene graph), all bars get the same color which is the inherited color.

Member Enumeration Documentation

enum PoHistogram::BarSpaceType

Type of spacing between bars.

Enumerator:

REL_SPACE	Relative histogram bar spacing.
FIXED_SPACE	Fixed histogram bar spacing.

enum PoHistogram::Coloring

Type of coloration of the bars.

Enumerator:

COLOR_LIST	Histogram bars are colored by a list of colors.
DATA_MAPPING	Histogram bars are colored by data mapping.

enum PoHistogram::Position

Type of positions relative to a histogram bar.

Enumerator:

POS_TOP_OUT	At the top outside the bar.
POS_TOP_IN	At the top inside the bar.
POS_BOTTOM_OUT	At the bottom outside the bar.
POS_BOTTOM_IN	At the bottom inside the bar.
POS_RIGHT_OUT	At the right outside the bar.
POS_RIGHT_IN	At the right inside the bar.
POS_LEFT_OUT	At the left outside the bar.
POS_LEFT_IN	At the left inside the bar.
POS_CENTER	Centered in the bar.
POS_DEPEND	Depends on the type of histogram.

enum PoHistogram::TextPath

Type of 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.
PATH_DEPEND	Depends on the type of histogram.

enum PoHistogram::Type

Type of orientation of the histogram's bars.

Enumerator:

X	Histogram bars are perpendicular to X-Axis.
Y	Histogram bars are perpendicular to Y-Axis.

enum PoHistogram::Visibility

Type of visibility.

Enumerator:

VISIBILITY_OFF	Invisible.
VISIBILITY_ON	Visible.

Member Function Documentation

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

Returns the SoNodekitCatalog for this class.

Reimplemented from PoGraphMaster.

Reimplemented in PoMultipleHistogram, and PoSingleHistogram.

static SoType PoHistogram::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from PoGraphMaster.

Reimplemented in PoMultipleHistogram, and PoSingleHistogram.

const PbDataMapping* PoHistogram::getDataMapping ( ) const

Gets a reference to a PbDataMapping object to the association color-value for coloring the bars.

const PbNumericDisplayFormat* PoHistogram::getFormat ( ) const

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

const PbMiscTextAttr* PoHistogram::getMiscTextAttr ( ) const

Gets a reference to a PbMiscTextAttr for miscellaneous text attributes.

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

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

Reimplemented in PoMultipleHistogram, and PoSingleHistogram.

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

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

Reimplemented in PoMultipleHistogram, and PoSingleHistogram.

void PoHistogram::setDataMapping ( PbDataMapping * dataMapping )

Sets a reference to a PbDataMapping object to the association color-value for coloring the bars.

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. This method is ignored if coloring = COLOR_LIST.

void PoHistogram::setFormat ( PbNumericDisplayFormat * format )

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

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 PoHistogram::setMiscTextAttr ( PbMiscTextAttr * textAttr )

Sets a reference to a PbMiscTextAttr for miscellaneous text attributes.

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

SoSFEnum PoHistogram::barSpaceType

Type of bar spacing.

The spacing between bars modifies the thickness of the histogram bars.

SoSFFloat PoHistogram::barSpaceValue

Spacing value.

If barSpaceType = REL_SPACE, real_spacing = barSpaceValue * width_bar, where width_bar is the distance between the histogram origin and the end point divided by the number of main bars. If barSpaceType = FIXED_SPACE, the real spacing is equal to barSpaceValue.

SoMFColor PoHistogram::color

Color list for the histogram bars.

This field is used only if coloring = COLOR_LIST. If the number of colors is less than the number of bars, all the bars get the same color which is the inherited color.

SoSFEnum PoHistogram::coloring

Specifies how the histogram bars are colored.

if coloring = COLOR_LIST, the bars are colored using the color list field color, otherwise the bars are colored according to their values (see the current data mapping for the association color-value at the header description).

SoSFFloat PoHistogram::end

Define the end point of the histogram.

SoSFString PoHistogram::nameFontName

Font name of bars names.

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

SoSFFloat PoHistogram::nameFontSize

Font size of bars names.

if this value is less or equal to 0, the font size is fixed at 0.04. This value is a percentage of the current domain (cf PoBase description).

SoSFEnum PoHistogram::namePath

Bars names path.

Use enum TextPath.

SoSFEnum PoHistogram::namePosition