Click or drag to resize
PoPieChart Class

Abstract class for pie chart representation.

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 PoPieChart : PoGraphMaster

The PoPieChart type exposes the following members.

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 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 pie chart.

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.

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 methodGetPickedSliceNumber

Allow the user to retreive the slice number (sliceNumber argument) which has been picked from a picked path (path argument) (cf OIV.Inventor.Nodes.SoSelection node for more information about picking).

Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetSliceToTranslate

Gets the current translation of a slice.

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 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 pie chart.

Public methodSetMiscTextAttr

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

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 methodSetSliceToTranslate

Convenience methods to set the fields sliceToTranslateNumber and sliceToTranslateValue.

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 propertyarrowHeight

Height of the arrow.

Public propertyarrowVisibility

Visibility of the arrow.

Public propertyarrowWidth

Width of the arrow.

Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertyextAnnotAddString

String concatened with exterior values.

Public propertyextAnnotAddStringVisibility

Specify the visibility of a string concatenated with the exterior values (if they are visible).

Public propertyextAnnotAlignment

Exterior annotation alignment.

Public propertyextAnnotDistance1

Distance from the pie chart center to the end of the arrow.

Public propertyextAnnotDistance2

Distance from the end of the arrow to the middle of the arrow.

Public propertyextAnnotDistance3

Distance from the middle of the arrow to the start of the arrow.

Public propertyextAnnotPercentFontName

Exterior percentage font name.

Public propertyextAnnotPercentFontSize

Font size of exterior percentages.

Public propertyextAnnotPercentVisibility

Exterior percent visibility (percent are computed from sliceValue field)

Public propertyextAnnotPosition

Exterior annotation position.

Public propertyextAnnotTextFontName

Exterior text (texts of sliceText field) font name.

Public propertyextAnnotTextFontSize

Font size of exterior texts (texts of sliceText field).

Public propertyextAnnotTextVisibility

Exterior text visibility (texts of sliceText field).

Public propertyextAnnotValueFontName

Exterior value (values of sliceValue field) font name.

Public propertyextAnnotValueFontSize

Font size of exterior values (values of sliceValue field).

Public propertyextAnnotValueVisibility

Exterior value visibility (values of sliceValue field).

Public propertyintAnnotAddString

String concatened with interior values.

Public propertyintAnnotAddStringVisibility

Specify the visibility of a string concatenated with the interior values (if they are visible).

Public propertyintAnnotAlignment

Interior annotation alignment.

Public propertyintAnnotDistance

Distance from the pie chart center to the interior annotation box center.

Public propertyintAnnotPercentFontName

Interior percentage font name.

Public propertyintAnnotPercentFontSize

Font size of interior percentages.

Public propertyintAnnotPercentVisibility

Interior percent visibility (percent are computed from sliceValue field)

Public propertyintAnnotPosition

Interior annotation position.

Public propertyintAnnotTextFontName

Interior text (texts of sliceText field) font name.

Public propertyintAnnotTextFontSize

Font size of interior texts (texts of sliceText field).

Public propertyintAnnotTextVisibility

Interior text visibility (texts of sliceText field).

Public propertyintAnnotValueFontName

Interior value (values of sliceValue field) font name.

Public propertyintAnnotValueFontSize

Font size of interior values (values of sliceValue field).

Public propertyintAnnotValueVisibility

Interior value visibility (values of sliceValue field).

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

Radius of the pie chart.

Public propertysliceAngleStep

Slice are approximated by a polygon, that is a sequence of straight line segments.

Public propertysliceColor

Color associated to each slice of the pie chart.

Public propertysliceGroupActive

Activate or Deactivate the regrouping of small values.

Public propertysliceGroupFlagMin

Indicate if the value sliceGroupMinValue is interpreted as percentage (PERCENTAGE) or not (ABSOLUTE).

Public propertysliceGroupMinValue

Threshold underneath the slice are regrouped.

Public propertysliceGroupString

String for the regrouping slice.

Public propertysliceText

Text associated to each slice of the pie chart.

Public propertysliceToTranslateNumber

Numbers (slice numbers begin at 0) of the slices to translate.

Public propertysliceToTranslateValue

Translation values along the bisectors of the slices.

Public propertysliceValue

Value associated to each slice of the pie chart.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Events
  NameDescription
Public eventPostRebuild
(Inherited from PoBase.)
Public eventPreRebuild
(Inherited from PoBase.)
Top
Remarks

Abstract class for all pie chart representations. This class handles all pie chart attributes. A pie chart represents the relative size of one datum in relation to a set of data. Each datum is given by a numerical value which is expressed as a percentage of the sum of the values of the entire set of data. This percentage is used to calculate the angle of the slice representing the datum. All slices together make up a pie chart.

The slices of which the value is small can be regroup in a same slice. This slice is called the grouping slice.

There are 2 types of pie chart annotations. Internal annotations and external annotations. Futhermore annotations can be framed by a box. All annotations are draw with the Z-Buffer desactivated, that is, they are always visible.

There are 5 groups of fields attributes

  • Geometric and data of the pie chart.

    • radius

    • sliceText

    • sliceValue

    • sliceColor

    • sliceAngleStep

  • Attribute of internal annotations : annotations drawn inside each slices.

    • intAnnotPosition

    • intAnnotAlignment

    • intAnnotTextVisibility

    • intAnnotValueVisibility

    • intAnnotPercentVisibility

    • intAnnotAddStringVisibility

    • intAnnotTextFontName

    • intAnnotTextFontSize

    • intAnnotValueFontName

    • intAnnotValueFontSize

    • intAnnotPercentFontName

    • intAnnotPercentFontSize

    • intAnnotAddString

    • intAnnotDistance

  • Attribute of external annotations : annotations drawn outside each slices.

    • extAnnotPosition

    • extAnnotAlignment

    • extAnnotTextVisibility

    • extAnnotValueVisibility

    • extAnnotPercentVisibility

    • extAnnotAddStringVisibility

    • extAnnotTextFontName

    • extAnnotTextFontSize

    • extAnnotValueFontName

    • extAnnotValueFontSize

    • extAnnotPercentFontName

    • extAnnotPercentFontSize

    • extAnnotAddString

    • extAnnotDistance1

    • extAnnotDistance2

    • extAnnotDistance3

  • Attribute of arrows : an arrow is drawn between slices and each external annotations.

    • arrowVisibility

    • arrowHeight

    • arrowWidth

  • Attribute for the translation of slices.

    • sliceToTranslateNumber

    • sliceToTranslateValue

  • Attribute of the grouping slice : The slices of which the value is small can be regroup in a same slice, call grouping slice.

    • sliceGroupActive

    • sliceGroupMinValue

    • sliceGroupFlagMin

    • sliceGroupString

)

All pie chart texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes is "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoMiscTextAttr).

All pie chart numerical values depend on the current numerical display format. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the current numerical display format is specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoNumericDisplayFormat).

See Also