| PoSingleHistogram Class |
Class to build a single histogram.
Inheritance HierarchyOIV.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.GraphPoSingleHistogram
Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe PoSingleHistogram type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PoSingleHistogram | Default constructor. |
| PoSingleHistogram(SbVec2f, Single, PoHistogramTypes, Single, String) | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoBaseKit.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| 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. |
| 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). |
| 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. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| 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. |
| GetDomain | Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetFormat | Gets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of values of the histograms. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoBaseKit.) |
| GetMiscTextAttr | Gets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes. |
| GetName | Returns the name of an instance. |
| GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. |
| GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. |
| 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. |
| GetPrimitiveCount | (Inherited from SoBaseKit.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUpdateMethod | Gets update method. |
| 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. |
| IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. |
| IsBuilt | Indicates if the node kit has been built at least once. |
| IsModified | Return true, if the kit has been modified, else otherwise. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoBaseKit.) |
| Rebuild | Forces the node kit to be rebuilt immediately. |
| Search | (Inherited from SoBaseKit.) |
| Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. |
| Set(String, String) | This function allows field values of parts (nodes) to be set. |
| SetDataMapping | Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-value for coloring the bars. |
| SetDomain | Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. |
| SetFormat | Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of values of the histograms. |
| SetMiscTextAttr | Sets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetPart | Inserts the given node (not a copy) as the new part specified by partName. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| SetUpdateMethod | Sets scene graph update method. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| TouchKit | Indicates the node kit is modified. |
| Write | (Inherited from SoBaseKit.) |
Properties| Name | Description | |
|---|---|---|
 | barSpaceType | Type of bar spacing. |
| barSpaceValue | Spacing value. |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| color | Color list for the histogram bars. |
| coloring | Specifies how the histogram bars are colored. |
| end | Define the end point of the histogram. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| name | Names of each bars of the histogram. |
| nameFontName | Font name of bars names. |
| nameFontSize | Font size of bars names. |
| namePath | Bars names path. |
| namePosition | Bars names position in relation to histograms bars. |
| nameVisibility | Bars names visibility. |
| start | Define the start point of the histogram. |
| 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). |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| value | Values of each bars of the histogram. |
| valueAddString | String to be concatenated. |
| valueAddStringVisibility | Visibility of the string concatenated to the values. |
| valueFontName | Font name of values. |
| valueFontSize | Font size of values. |
| valuePath | Values path. |
| valuePosition | Values position in relation to histogram bars. |
| valueVisibility | Values visibility. |
Events| Name | Description | |
|---|---|---|
 | PostRebuild | (Inherited from PoBase.) |
| PreRebuild | (Inherited from PoBase.) |
RemarksClass 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
OIV.MeshViz.Graph.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 | "" |
<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading771">CATALOG PARTS</A></h4> <ul><b>PoSingleHistogram</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>nameTextApp </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>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> </body> </html>
See Also