PoPieChartRep Class

PoPieChartRep Class

Class to build a 3D pie chart.

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.GraphPoChart
                    OIV.MeshViz.GraphPoPieChartRep

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class PoPieChartRep : PoChart

Public Class PoPieChartRep
	Inherits PoChart

public ref class PoPieChartRep : public PoChart

type PoPieChartRep =  
    class
        inherit PoChart
    end

The PoPieChartRep type exposes the following members.

Constructors

	Name	Description
	PoPieChartRep	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.
	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.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoBaseKit.)
	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.)
	GetPickedSliceNumber	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).
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetSliceToTranslate	Gets the current translation of a slice.
	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.)
	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.)
	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.)
	SetSliceToTranslate	Convenience methods to set the fields sliceToTranslateNumber and sliceToTranslateRadius.
	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
	annoDistToCenter	Defines the distance from the pie chart center of the displayed annotations (name/value/percentage).
	annoFontSize	Define the font size of the annotation.
	annoHeightFromSlice	Defines the height of the displayed annotations (name/value/percentage) from the top of each slice.
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	colorBinding	Specify how the colors are bound to the representation. (Inherited from PoChart.)
	colorValuesIndex	Defines the index of the set of values for the coloring. (Inherited from PoChart.)
	height	Defines the height of the pie chart if the field yValuesIndex is different from -1.
	isAnnoSliceColor	Determines if the color of for annotation is the same as slices.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	isNameVisible	Defines if the name of each slice is visible.
	isPercentageVisible	Defines if the percentage of each slice is visible.
	isValueVisible	Defines if the value of each slice is visible.
	material	Defines the list of materials used for the coloring. (Inherited from PoChart.)
	radiusMax	Defines the maximum radius of the pie chart.
	radiusMin	Defines the mininum radius of the pie chart.
	sliceToTranslateNumber	Numbers (slice numbers begin at 0) of the slices to translate.
	sliceToTranslateRadius	Translation values along the bisectors of the slices.
	stringsIndex	Defines the index of the set of strings used for the names attached to slices.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	yValuesIndex	Defines the index of the set of values used by a charting representation as a y-coordinate of each mesh node. (Inherited from PoChart.)

Top

Events

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

Top

Remarks

Builds a 3D pie chart on 1D mesh (OIV.MeshViz.Nodes.PoIrregularMesh1D or OIV.MeshViz.Nodes.PoRegularMesh1D). The size (angle) of each slice is given by the geometry of the current mesh 1D, and the height of each slice is given by one of the value-set of the current mesh 1D specified by the field yValuesIndex. Names attached to each slice are given by one of the string-set of the current mesh 1D specified by the field stringsIndex. With this mecanism all slices have not necessary the same height. On contrary, if all slices must have the same height, set the field yValuesIndex to -1 and set the field height to the desired height. The pie chart origin is at (0,0,0) after applying the current transformation.

The current label hints (OIV.MeshViz.Nodes.PoLabelHints) is used to specify the appearance of annotations for each slice. All annotations depend on the current miscellaneous text attributes which defines the font names, line length and so on (OIV.MeshViz.Nodes.PoMiscTextAttr). All numerical values depend on the current numerical display format (OIV.MeshViz.Nodes.PoNumericDisplayFormat). Each slice can be beveled thanks to the current beveled edge values (OIV.MeshViz.Nodes.PoBevelEdge). The current complexity (OIV.Inventor.Nodes.SoComplexity) is used to determine the tessellation of slices.

The interpretation of colorBinding is the following :

INHERITED: All slices are colored with the same inherited color.
PER_PART, PER_VERTEX: A color is used for each slice.

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.PoPieChartRep {
colorBinding INHERITED
yValuesIndex -1
colorValuesIndex 1
material NULL
stringsIndex 0
radiusMin 0.0
radiusMax 1.0
sliceToTranslateNumber 0
sliceToTranslateRadius 0.0
height 0.3
isNameVisible false
isValueVisible false
isPercentageVisible true
annoDistToCenter 0.5
annoHeightFromSlice 0.2
isAnnoSliceColor true
annoFontSize 0.1
}

<html> <head> <title></title> </head> <body> <h4><a name="Heading249">CATALOG PARTS</a></h4> <blockquote> PoPieChartRep { </blockquote> <blockquote> <blockquote> Separator <tt>alternateRep</tt> (from PoBase) { </blockquote> <blockquote> <blockquote> AppearanceKit <tt>appearance</tt> (from PoBase) </blockquote> </blockquote> <blockquote> <blockquote> Specifies the appearance of all the kit. By default lightModel.model=PHONG. </blockquote> </blockquote> <blockquote> <blockquote> MatrixTransform <tt>domainTransform</tt> (from PoBase) </blockquote> </blockquote> <blockquote> <blockquote> Corresponds to the domain transformation. Separator <tt>sliceSep</tt> { Contains properties and shapes to draw the slices. <ul> AppearanceKit <tt>sliceApp</tt> </ul> <ul> Specifies the appearance of the slices. </ul> <ul> Group <tt>slice</tt> </ul> <ul> Contains a list of couple SoMaterial and SoIndexedFaceSet shapes to draw the slices. </ul> } Separator <tt>annotationSep</tt> { Contains properties and shapes to draw the annotations. <ul> AppearanceKit <tt>annotationApp</tt> </ul> <ul> Specifies the appearance of the annotations. font.size and font.name are set when the kit is rebuilt. </ul> <ul> Group <tt>annotation</tt> </ul> <blockquote> Contains a list of couple SoMaterial and SoText3/SoAnnoText3/SoAsciiText (cf PoBase.setTextType() and PoBase.setVRML2Mode() for choosing the text type) if the field colorBinding is different from INHERITED and the field isAnnoSliceColor is set to true, a list of SoText3/SoAnnoText3/SoAsciiText otherwise. </blockquote> } Separator <tt>annotationLineSep</tt> { Contains properties and shapes to draw lines from the annotations to the slices. <ul> AppearanceKit <tt>annotationLineApp</tt> </ul> <ul> Specifies the appearance of the lines. </ul> <ul> Group <tt>annotationLine</tt> </ul> <ul> Contains a list of couple SoMaterial and SoLineSet shape to draw the label lines if the field colorBinding is different from INHERITED and the field isAnnoSliceColor is set to true, a list of SoLineSet otherwise. </ul> } </blockquote> } </blockquote> </blockquote> <blockquote> } </blockquote> </body> </html>

Reference

OIV.MeshViz.Graph Namespace

colorBinding	INHERITED
yValuesIndex	-1
colorValuesIndex	1
material	NULL
stringsIndex	0
radiusMin	0.0
radiusMax	1.0
sliceToTranslateNumber	0
sliceToTranslateRadius	0.0
height	0.3
isNameVisible	false
isValueVisible	false
isPercentageVisible	true
annoDistToCenter	0.5
annoHeightFromSlice	0.2
isAnnoSliceColor	true
annoFontSize	0.1