PoSingleHistogram Class Reference
[Histogram]

Class to build a single histogram. More...

#include <MeshViz/graph/PoSingleHistogram.h>

Inheritance diagram for PoSingleHistogram:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoSingleHistogram ()
	PoSingleHistogram (const SbVec2f &_start, float _end, PoHistogram::Type _type, int numValues, const float *_value, const char **_name)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoMFFloat	value
SoMFString	name

---

Detailed Description

Class to build a single histogram.

Class to build a single histogram in the plane XY. This histogram is based on simple statistical data.

Simple statistical data is composed of a list of names associated to a list of values. 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.

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), color.getNum() must be greater or equal to value.getNum(), otherwise all the bars get the same color which is the inherited color.

FILE FORMAT/DEFAULT

PoSingleHistogram {

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
value	0
name	""

}

CATALOG PARTS

PoSingleHistogram {
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 nameTextApp (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.
}
}
}

---

Constructor & Destructor Documentation

PoSingleHistogram::PoSingleHistogram

(

)

[inline]

Default constructor.

PoSingleHistogram::PoSingleHistogram	(	const SbVec2f &	_start,
		float	_end,
		PoHistogram::Type	_type,
		int	numValues,
		const float *	_value,
		const char **	_name
	)			[inline]

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoSingleHistogram::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoHistogram.

static SoType PoSingleHistogram::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoHistogram.

virtual const SoNodekitCatalog* PoSingleHistogram::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoHistogram.

virtual SoType PoSingleHistogram::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoHistogram.

virtual void PoSingleHistogram::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoMFString PoSingleHistogram::name

Names of each bars of the histogram.

If name.getNum() != value.getNum() no name is associated to the bars.

SoMFFloat PoSingleHistogram::value

Values of each bars of the histogram.

---

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