Click or drag to resize
PoMultipleHistogram Class

Class to build a multiple histogram.

Inheritance Hierarchy

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class PoMultipleHistogram : PoHistogram

The PoMultipleHistogram type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

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.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetDataMapping

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

(Inherited from PoHistogram.)
Public methodGetDomain

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

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetFormat

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

(Inherited from PoHistogram.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMiscTextAttr

Gets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes.

(Inherited from PoHistogram.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

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.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateMethod

Gets update method.

(Inherited from PoBase.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsBuilt

Indicates if the node kit has been built at least once.

(Inherited from PoBase.)
Public methodIsModified

Return true, if the kit has been modified, else otherwise.

(Inherited from PoBase.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRebuild

Forces the node kit to be rebuilt immediately.

(Inherited from PoBase.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetDataMapping

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

(Inherited from PoHistogram.)
Public methodSetDomain

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

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

(Inherited from PoHistogram.)
Public methodSetMiscTextAttr

Sets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes.

(Inherited from PoHistogram.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetUpdateMethod

Sets scene graph update method.

(Inherited from PoBase.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodTouchKit

Indicates the node kit is modified.

(Inherited from PoBase.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertybarHeight

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

Public propertybarSpaceType

Type of bar spacing.

(Inherited from PoHistogram.)
Public propertybarSpaceValue

Spacing value.

(Inherited from PoHistogram.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertycolor

Color list for the histogram bars.

(Inherited from PoHistogram.)
Public propertycoloring

Specifies how the histogram bars are colored.

(Inherited from PoHistogram.)
Public propertycolumnName

List of numColumns names of the columns.

Public propertyend

Define the end point of the histogram.

(Inherited from PoHistogram.)
Public propertyhistogPath

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

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertynameFontName

Font name of bars names.

(Inherited from PoHistogram.)
Public propertynameFontSize

Font size of bars names.

(Inherited from PoHistogram.)
Public propertynamePath

Bars names path.

(Inherited from PoHistogram.)
Public propertynamePosition

Bars names position in relation to histograms bars.

(Inherited from PoHistogram.)
Public propertynameVisibility

Bars names visibility.

(Inherited from PoHistogram.)
Public propertynumColumns

Number of columns of the matrix of values.

Public propertynumRows

Number of rows of the matrix of values.

Public propertyrepresentation

Representation type of the multiple histogram.

Public propertyrowName

List of numRows names of the rows.

Public propertystart

Define the start point of the histogram.

(Inherited from PoHistogram.)
Public propertysumFontName

Font name of bars sums.

Public propertysumFontSize

Font size of bars sums.

Public propertysumPath

Writing path of bars sums.

Public propertysumPosition

Position of sums in relation to bars.

Public propertysumVisibility

Bars sums visibility.

Public propertytype

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.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvalue

Matrix of values.

Public propertyvalueAddString

String to be concatenated.

(Inherited from PoHistogram.)
Public propertyvalueAddStringVisibility

Visibility of the string concatenated to the values.

(Inherited from PoHistogram.)
Public propertyvalueFontName

Font name of values.

(Inherited from PoHistogram.)
Public propertyvalueFontSize

Font size of values.

(Inherited from PoHistogram.)
Public propertyvaluePath

Values path.

(Inherited from PoHistogram.)
Public propertyvaluePosition

Values position in relation to histogram bars.

(Inherited from PoHistogram.)
Public propertyvalueVisibility

Values visibility.

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

See Also