PoMultipleHistogram Class Reference
[Histogram]

Class to build a multiple histogram. More...

#include <MeshViz/graph/PoMultipleHistogram.h>

Inheritance diagram for PoMultipleHistogram:

List of all members.

Classes
struct	MultHistogAttr
struct	SumAttr
Public Types
enum	HistogPath {   ROW_COLUMN,   COLUMN_ROW }
enum	Representation {   JUXTAPOSED,   ACCUMULATED,   PERCENTAGE }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoMultipleHistogram ()
	PoMultipleHistogram (const SbVec2f &_start, float _end, PoHistogram::Type _type, int _numRows, int _numColumns, const float *_value, const char **_rowName, const char **_columnName)
	PoMultipleHistogram (const SbVec2f &_start, float _end, PoHistogram::Type _type, int _numRows, int _numColumns, const float **_value, const char **_rowName, const char **_columnName)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFUShort	numRows
SoSFUShort	numColumns
SoMFFloat	value
SoMFString	rowName
SoMFString	columnName
SoSFEnum	representation
SoSFFloat	barHeight
SoSFEnum	histogPath
SoSFEnum	sumVisibility
SoSFEnum	sumPosition
SoSFEnum	sumPath
SoSFFloat	sumFontSize
SoSFString	sumFontName

---

Detailed Description

Class to build a multiple histogram.

Class to build a multiple histogram in the plane XY. This histogram is based on multiple statistical data. Multiple statistical data is composed of a matrix of values associated to a list of column names and a list of row names.

The histogram bars are perpendicular to the X-axis or to the Y-axis (according to the field type). The statistic values correspond to the height (or width) of the bars.

There are three possible representations of multiple histograms:

• The histogram values are juxtaposed.
• The histogram values are accumulated.
• The histogram values are percentages.

The bars of the histogram can be colored using the fields color and coloring. If the bars colors are defined by a list of colors (coloring = COLOR_LIST), according to the field histogPath, the list of colors is associated to the rows or to the columns and color.getNum() must be greater or equal to getNum(), otherwise all the bars get the same color which is the inherited color.

FILE FORMAT/DEFAULT

PoMultipleHistogram {

start	0 0
end	1
type	X
color	0 0 0
coloring	COLOR_LIST
valueVisibility	VISIBILITY_ON
valuePosition	POS_DEPEND
valuePath	PATH_DEPEND
valueFontSize	0.0
valueFontName	""
valueAddStringVisibility	FALSE
valueAddString	""
nameVisibility	VISIBILITY_ON
namePosition	POS_DEPEND
namePath	PATH_DEPEND
nameFontSize	0.0
nameFontName	""
barSpaceType	REL_SPACE
barSpaceValue	0.25
representation	JUXTAPOSED
barHeight	1.0
numRows	1
numColumns	1
value	0
rowName	""
columnName	""
histogPath	ROW_COLUM
sumVisibility	VISIBILITY_ON
sumPosition	POS_DEPEND
sumPath	PATH_DEPEND
sumFontSize	0.0
sumFontName	""

}

CATALOG PARTS

PoMultipleHistogram {
Separator alternateRep (from PoBase) {

AppearanceKit appearance (from PoBase)
Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.
MatrixTransform domainTransform (from PoBase)
Corresponds to the domain transformation.
MatrixTransform transform (from PoHistogram)
Corresponds to the orientation of the histogram.
Separator barSep (from PoHistogram) {
Contains properties and shapes to draw the bars of the histogram.
AppearanceKit barApp (from PoHistogram)
Specifies the appearance of the bars of the histogram. material.diffuseColor is set (only if bars are colored) when the kit is rebuilt.
Group bar (from PoHistogram)
Contains a SoFaceSet shape to draw the bars of the histogram.
}

Separator valueTextSep (from PoHistogram) {
Contains properties and shapes to draw the text of values of the histogram.
AppearanceKit valueTexApp (from PoHistogram)
Specifies the appearance of the text of values of the histogram. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.
Group valueText (from PoHistogram)
Contains a list of SoAnnoText3 shapes to draw the text of values of the histogram.
}

Separator nameTextSep (from PoHistogram) {
Contains properties and shapes to draw the bars names text of the histogram.
AppearanceKit nameTexApp (from PoHistogram)
Specifies the appearance of the bars names text of the histogram. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.
Group nameText (from PoHistogram)
Contains a list of SoAnnoText3 shape to draw the bars names text of the histogram.
}

Separator sumTextSep {
Contains properties and shapes to draw the bars sums text of the histogram.
AppearanceKit sumTextApp
Specifies the appearance of the bars sums text of the histogram. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.
Group sumText
Contains a list of SoAnnoText3 shape to draw the bars sums text of the histogram.
}
}
}



---

Member Enumeration Documentation

enum PoMultipleHistogram::HistogPath

Enumerator:

ROW_COLUMN	Histogram shows rows in function of columns.
COLUMN_ROW	Histogram shows columns in function of rows.

enum PoMultipleHistogram::Representation

Type of presentation of multiple histogram.

Enumerator:

JUXTAPOSED	Histogram bars are juxtaposed.
ACCUMULATED	Histogram bars are accumulated.
PERCENTAGE	Histogram bars are percentage.

---

Constructor & Destructor Documentation

PoMultipleHistogram::PoMultipleHistogram

(

)

[inline]

Default constructor.

PoMultipleHistogram::PoMultipleHistogram	(	const SbVec2f &	_start,
		float	_end,
		PoHistogram::Type	_type,
		int	_numRows,
		int	_numColumns,
		const float *	_value,
		const char **	_rowName,
		const char **	_columnName
	)			[inline]

Constructor.

PoMultipleHistogram::PoMultipleHistogram	(	const SbVec2f &	_start,
		float	_end,
		PoHistogram::Type	_type,
		int	_numRows,
		int	_numColumns,
		const float **	_value,
		const char **	_rowName,
		const char **	_columnName
	)

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoMultipleHistogram::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoHistogram.

static SoType PoMultipleHistogram::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoHistogram.

virtual const SoNodekitCatalog* PoMultipleHistogram::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoHistogram.

virtual SoType PoMultipleHistogram::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoHistogram.

virtual void PoMultipleHistogram::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFFloat PoMultipleHistogram::barHeight

This field is used only for percentage histogram representation (representation = PERCENTAGE) and it corresponds to the height of the histogram (in this representation, all the bars have the same size).

SoMFString PoMultipleHistogram::columnName

List of numColumns names of the columns.

SoSFEnum PoMultipleHistogram::histogPath

Indicates that the histogram shows rows as a function of columns, or columns as a function of rows.

SoSFUShort PoMultipleHistogram::numColumns

Number of columns of the matrix of values.

SoSFUShort PoMultipleHistogram::numRows

Number of rows of the matrix of values.

SoSFEnum PoMultipleHistogram::representation

Representation type of the multiple histogram.

SoMFString PoMultipleHistogram::rowName

List of numRows names of the rows.

SoSFString PoMultipleHistogram::sumFontName

Font name of bars sums.

If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes (cf PoHistogram description).

SoSFFloat PoMultipleHistogram::sumFontSize

Font size of bars sums.

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 PoMultipleHistogram::sumPath

Writing path of bars sums.

Use enum TextPath.

SoSFEnum PoMultipleHistogram::sumPosition

Position of sums in relation to bars.

Use enum Position.

SoSFEnum PoMultipleHistogram::sumVisibility

Bars sums visibility.

Use enum Visibility.

SoMFFloat PoMultipleHistogram::value

Matrix of values.

---

The documentation for this class was generated from the following file:
• MeshViz/graph/PoMultipleHistogram.h