PoMultipleHistogram Class

Class to build a multiple histogram.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.MeshViz.GraphPoBase
                OIV.MeshViz.GraphPoGraphMaster
                  OIV.MeshViz.GraphPoHistogram
                    OIV.MeshViz.GraphPoMultipleHistogram

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2024.1.1.0 (2024.1.1)

Syntax

C++

Copy

public class PoMultipleHistogram : PoHistogram

Public Class PoMultipleHistogram
	Inherits PoHistogram

public ref class PoMultipleHistogram : public PoHistogram

type PoMultipleHistogram =  
    class
        inherit PoHistogram
    end

The PoMultipleHistogram type exposes the following members.

Constructors

	Name	Description
	PoMultipleHistogram	Default constructor.
	PoMultipleHistogram(SbVec2f, Single, PoHistogramTypes, Int32, Int32, Single, String, String)	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoBaseKit.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	CreatePathToPart(String, Boolean)	Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.)
	CreatePathToPart(String, Boolean, SoPath)	Returns a path that begins at this nodekit and ends at partName. (Inherited from SoBaseKit.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoBaseKit.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Inherited from SoBaseKit.)
	GetClassNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.
	GetDataMapping	Gets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-value for coloring the bars. (Inherited from PoHistogram.)
	GetDomain	Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. (Inherited from PoBase.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetFormat	Gets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of values of the histograms. (Inherited from PoHistogram.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoBaseKit.)
	GetMiscTextAttr	Gets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes. (Inherited from PoHistogram.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. (Inherited from SoBaseKit.)
	GetPart	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. (Inherited from SoBaseKit.)
	GetPartString	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. (Inherited from SoBaseKit.)
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUpdateMethod	Gets update method. (Inherited from PoBase.)
	GetViewportIsEnabled	(Inherited from SoBaseKit.)
	GetViewportOrigin	(Inherited from SoBaseKit.)
	GetViewportSize	(Inherited from SoBaseKit.)
	GLRender	(Inherited from SoBaseKit.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoBaseKit.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. (Inherited from SoBaseKit.)
	IsBuilt	Indicates if the node kit has been built at least once. (Inherited from PoBase.)
	IsModified	Return true, if the kit has been modified, else otherwise. (Inherited from PoBase.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoBaseKit.)
	Rebuild	Forces the node kit to be rebuilt immediately. (Inherited from PoBase.)
	Search	(Inherited from SoBaseKit.)
	Set(String)	This function allows field values of parts (nodes) to be set in several different parts simultaneously. (Inherited from SoBaseKit.)
	Set(String, String)	This function allows field values of parts (nodes) to be set. (Inherited from SoBaseKit.)
	SetDataMapping	Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-value for coloring the bars. (Inherited from PoHistogram.)
	SetDomain	Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. (Inherited from PoBase.)
	SetFormat	Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of values of the histograms. (Inherited from PoHistogram.)
	SetMiscTextAttr	Sets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes. (Inherited from PoHistogram.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetPart	Inserts the given node (not a copy) as the new part specified by partName. (Inherited from SoBaseKit.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	SetUpdateMethod	Sets scene graph update method. (Inherited from PoBase.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	TouchKit	Indicates the node kit is modified. (Inherited from PoBase.)
	Write	(Inherited from SoBaseKit.)

Top

Properties

	Name	Description
	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).
	barSpaceType	Type of bar spacing. (Inherited from PoHistogram.)
	barSpaceValue	Spacing value. (Inherited from PoHistogram.)
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	color	Color list for the histogram bars. (Inherited from PoHistogram.)
	coloring	Specifies how the histogram bars are colored. (Inherited from PoHistogram.)
	columnName	List of numColumns names of the columns.
	end	Define the end point of the histogram. (Inherited from PoHistogram.)
	histogPath	Indicates that the histogram shows rows as a function of columns, or columns as a function of rows.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	nameFontName	Font name of bars names. (Inherited from PoHistogram.)
	nameFontSize	Font size of bars names. (Inherited from PoHistogram.)
	namePath	Bars names path. (Inherited from PoHistogram.)
	namePosition	Bars names position in relation to histograms bars. (Inherited from PoHistogram.)
	nameVisibility	Bars names visibility. (Inherited from PoHistogram.)
	numColumns	Number of columns of the matrix of values.
	numRows	Number of rows of the matrix of values.
	representation	Representation type of the multiple histogram.
	rowName	List of numRows names of the rows.
	start	Define the start point of the histogram. (Inherited from PoHistogram.)
	sumFontName	Font name of bars sums.
	sumFontSize	Font size of bars sums.
	sumPath	Writing path of bars sums.
	sumPosition	Position of sums in relation to bars.
	sumVisibility	Bars sums visibility.
	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). (Inherited from PoHistogram.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	value	Matrix of values.
	valueAddString	String to be concatenated. (Inherited from PoHistogram.)
	valueAddStringVisibility	Visibility of the string concatenated to the values. (Inherited from PoHistogram.)
	valueFontName	Font name of values. (Inherited from PoHistogram.)
	valueFontSize	Font size of values. (Inherited from PoHistogram.)
	valuePath	Values path. (Inherited from PoHistogram.)
	valuePosition	Values position in relation to histogram bars. (Inherited from PoHistogram.)
	valueVisibility	Values visibility. (Inherited from PoHistogram.)

Top

Events

	Name	Description
	PostRebuild	(Inherited from PoBase.)
	PreRebuild	(Inherited from PoBase.)

Top

Remarks

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

OIV.MeshViz.Graph.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 ""
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading780">CATALOG PARTS</A></h4> <ul>PoMultipleHistogram {</ul> <ul><ul>Separator <tt>alternateRep</tt> (from PoBase) { </ul></ul> <ul><ul><ul>AppearanceKit <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Corresponds to the domain transformation.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>transform</tt> (from PoHistogram)</ul></ul></ul> <ul><ul><ul>Corresponds to the orientation of the histogram.</ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul>Separator <tt>barSep</tt> (from PoHistogram) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the bars of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>barApp </tt>(from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the bars of the histogram. material.diffuseColor is set (only if bars are colored) when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>bar</tt> (from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the bars of the histogram.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>valueTextSep</tt> (from PoHistogram) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the text of values of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>valueTexApp </tt>(from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>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.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>valueText</tt> (from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw the text of values of the histogram.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>nameTextSep</tt> (from PoHistogram) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the bars names text of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>nameTexApp </tt>(from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>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.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>nameText</tt> (from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shape to draw the bars names text of the histogram.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>sumTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the bars sums text of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>sumTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>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.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>sumText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shape to draw the bars sums text of the histogram.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Reference

OIV.MeshViz.Graph Namespace