PoMultipleHistogram Class Reference

Class to build a multiple histogram. More...

#include <MeshViz/graph/PoMultipleHistogram.h>

Inheritance diagram for PoMultipleHistogram:

Public Types
enum	HistogPath {   ROW_COLUMN ,   COLUMN_ROW }
enum	Representation {   JUXTAPOSED ,   ACCUMULATED ,   PERCENTAGE }
	Type of presentation of multiple histogram. More...
Public Types inherited from PoHistogram
enum	Type {   X ,   Y }
	Type of orientation of the histogram's bars. More...
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 }
	Type of positions relative to a histogram bar. More...
enum	Visibility {   VISIBILITY_OFF ,   VISIBILITY_ON }
	Type of visibility. More...
enum	TextPath {   PATH_RIGHT ,   PATH_LEFT ,   PATH_UP ,   PATH_DOWN ,   PATH_DEPEND }
	Type of text path. More...
enum	BarSpaceType {   REL_SPACE ,   FIXED_SPACE }
	Type of spacing between bars. More...
enum	Coloring {   COLOR_LIST ,   DATA_MAPPING }
	Type of coloration of the bars. More...
Public Types inherited from PoBase
enum	UpdateMethodType {   UPDATE_METHOD_IMMEDIATE ,   UPDATE_METHOD_ON_ACTION }
	Type of update method. More...
enum	NodeWriteFormat {   FOLD_NODE_WRITE_FORMAT ,   UNFOLD_NODE_WRITE_FORMAT }
	Type of write format. More...
enum	TextType {   SO_TEXT3 ,   SO_ANNO_TEXT3 }
	Type of Text. More...
typedef void	PoRebuildCB(void *userData, PoBase *base)

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.
	PoMultipleHistogram ()
	Default constructor.
	PoMultipleHistogram (const SbVec2f &_start, float _end, PoHistogram::Type _type, int _numRows, int _numColumns, const float *_value, const char **_rowName, const char **_columnName)
	Constructor.
	PoMultipleHistogram (const SbVec2f &_start, float _end, PoHistogram::Type _type, int _numRows, int _numColumns, const float **_value, const char **_rowName, const char **_columnName)
	Constructor.
virtual void	rebuild ()
	Forces node-kit rebuilding.
Public Member Functions inherited from PoHistogram
void	setMiscTextAttr (PbMiscTextAttr *textAttr)
	Sets a reference to a PbMiscTextAttr for miscellaneous text attributes.
const PbMiscTextAttr *	getMiscTextAttr () const
	Gets a reference to a PbMiscTextAttr for miscellaneous text attributes.
void	setDataMapping (PbDataMapping *dataMapping)
	Sets a reference to a PbDataMapping object to the association color-value for coloring the bars.
const PbDataMapping *	getDataMapping () const
	Gets a reference to a PbDataMapping object to the association color-value for coloring the bars.
void	setFormat (PbNumericDisplayFormat *format)
	Sets a reference to a PbNumericDisplayFormat object for the numerical display format of values of the histograms.
const PbNumericDisplayFormat *	getFormat () const
	Gets a reference to a PbNumericDisplayFormat object for the numerical display format of values of the histograms.
Public Member Functions inherited from PoBase
void	setUpdateMethod (UpdateMethodType type)
	Sets scene graph update method.
UpdateMethodType	getUpdateMethod () const
	Gets update method.
void	setDomain (PbDomain *dom)
	Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
const PbDomain *	getDomain () const
	Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
void	touchKit ()
	Indicates the node kit is modified.
SbBool	isModified () const
	Return TRUE, if the kit has been modified, else otherwise.
SbBool	isBuilt () const
	Indicates if the node kit has been built at least once.
void	addPreRebuildCallback (PoRebuildCB *cb, void *data)
	Add a callback function to call when the node kit is rebuilt.
void	addPostRebuildCallback (PoRebuildCB *cb, void *data)
	Add a callback function to call when the node kit is rebuilt.
void	removePreRebuildCallback (PoRebuildCB *cb, void *data=NULL)
	Remove a callback function to call when the node kit is rebuilt.
void	removePostRebuildCallback (PoRebuildCB *cb, void *data)
	Remove a callback function to call when the node kit is rebuilt.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Copy method.
virtual SbBool	affectsState () const
	See SoNode::affectsState() for explanations.
Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.
virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.
template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.
SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.
virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.
virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.
SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.
SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.
SoNONUNICODE SbBool	set (const char *partNameString, const char *parameterString)
	This function allows field values of parts (nodes) to be set.
SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.
virtual	~SoGetView ()
virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.
virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.
virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoHistogram
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoGraphMaster
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoBase
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
static void	setNodeWriteFormat (NodeWriteFormat format)
	Sets the node write format.
static NodeWriteFormat	getNodeWriteFormat ()
	Gets the node write format.
static void	setTextType (TextType type)
	Sets the type of text used.
static TextType	getTextType ()
	Gets the type of text used.
static void	setVRML2Mode (SbBool flag)
	Set the VRML2 mode.
static SbBool	isVRML2Mode ()
	Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)
Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.
static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.
static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFUShort	numRows
	Number of rows of the matrix of values.
SoSFUShort	numColumns
	Number of columns of the matrix of values.
SoMFFloat	value
	Matrix of values.
SoMFString	rowName
	List of numRows names of the rows.
SoMFString	columnName
	List of numColumns names of the columns.
SoSFEnum	representation
	Representation type of the multiple histogram.
SoSFFloat	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).
SoSFEnum	histogPath
	Indicates that the histogram shows rows as a function of columns, or columns as a function of rows.
SoSFEnum	sumVisibility
	Bars sums visibility.
SoSFEnum	sumPosition
	Position of sums in relation to bars.
SoSFEnum	sumPath
	Writing path of bars sums.
SoSFFloat	sumFontSize
	Font size of bars sums.
SoSFString	sumFontName
	Font name of bars sums.
Public Attributes inherited from PoHistogram
SoSFVec2f	start
	Define the start point of the histogram.
SoSFFloat	end
	Define the end point of the histogram.
SoSFEnum	type
	Defines if the histogram is an X histogram (bars are perpendicular to the X- axis) or a Y histogram (bars are perpendicular to the Y-axis).
SoMFColor	color
	Color list for the histogram bars.
SoSFEnum	coloring
	Specifies how the histogram bars are colored.
SoSFEnum	valueVisibility
	Values visibility.
SoSFEnum	valuePosition
	Values position in relation to histogram bars.
SoSFEnum	valuePath
	Values path.
SoSFFloat	valueFontSize
	Font size of values.
SoSFString	valueFontName
	Font name of values.
SoSFBool	valueAddStringVisibility
	Visibility of the string concatenated to the values.
SoSFString	valueAddString
	String to be concatenated.
SoSFEnum	nameVisibility
	Bars names visibility.
SoSFEnum	namePosition
	Bars names position in relation to histograms bars.
SoSFEnum	namePath
	Bars names path.
SoSFFloat	nameFontSize
	Font size of bars names.
SoSFString	nameFontName
	Font name of bars names.
SoSFEnum	barSpaceType
	Type of bar spacing.
SoSFFloat	barSpaceValue
	Spacing value.
Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

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.
}
}
}



Definition at line 105 of file PoMultipleHistogram.h.

Member Enumeration Documentation

HistogPath

enum PoMultipleHistogram::HistogPath

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

Definition at line 117 of file PoMultipleHistogram.h.

Representation

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.

Definition at line 133 of file PoMultipleHistogram.h.

Constructor & Destructor Documentation

PoMultipleHistogram() [1/3]

PoMultipleHistogram::PoMultipleHistogram ( )

inline

Default constructor.

Definition at line 234 of file PoMultipleHistogram.h.

PoMultipleHistogram() [2/3]

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.

Definition at line 241 of file PoMultipleHistogram.h.

PoMultipleHistogram() [3/3]

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

getClassNodekitCatalog()

static const SoNodekitCatalog * PoMultipleHistogram::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

getClassTypeId()

static SoType PoMultipleHistogram::getClassTypeId ( )

static

Returns the type identifier for this class.

getNodekitCatalog()

virtual const SoNodekitCatalog * PoMultipleHistogram::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoHistogram.

getTypeId()

virtual SoType PoMultipleHistogram::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoHistogram.

rebuild()

virtual void PoMultipleHistogram::rebuild ( )

virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

Member Data Documentation

barHeight

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

Definition at line 187 of file PoMultipleHistogram.h.

columnName

SoMFString PoMultipleHistogram::columnName

List of numColumns names of the columns.

Definition at line 175 of file PoMultipleHistogram.h.

histogPath

SoSFEnum PoMultipleHistogram::histogPath

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

Definition at line 193 of file PoMultipleHistogram.h.

numColumns

SoSFUShort PoMultipleHistogram::numColumns

Number of columns of the matrix of values.

Definition at line 160 of file PoMultipleHistogram.h.

numRows

SoSFUShort PoMultipleHistogram::numRows

Number of rows of the matrix of values.

Definition at line 155 of file PoMultipleHistogram.h.

representation

SoSFEnum PoMultipleHistogram::representation

Representation type of the multiple histogram.

Definition at line 180 of file PoMultipleHistogram.h.

rowName

SoMFString PoMultipleHistogram::rowName

List of numRows names of the rows.

Definition at line 170 of file PoMultipleHistogram.h.

sumFontName

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

Definition at line 225 of file PoMultipleHistogram.h.

sumFontSize

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

Definition at line 218 of file PoMultipleHistogram.h.

sumPath

SoSFEnum PoMultipleHistogram::sumPath

Writing path of bars sums.

Use enum TextPath.

Definition at line 211 of file PoMultipleHistogram.h.

sumPosition

SoSFEnum PoMultipleHistogram::sumPosition

Position of sums in relation to bars.

Use enum Position.

Definition at line 205 of file PoMultipleHistogram.h.

sumVisibility

SoSFEnum PoMultipleHistogram::sumVisibility

Bars sums visibility.

Use enum Visibility.

Definition at line 199 of file PoMultipleHistogram.h.

value

SoMFFloat PoMultipleHistogram::value

Matrix of values.

Definition at line 165 of file PoMultipleHistogram.h.

---

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

• MeshViz/graph/PoMultipleHistogram.h