PoPieChartRep

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.fields.SoFieldContainer
    - - com.openinventor.inventor.nodes.SoNode
      - com.openinventor.inventor.nodekits.SoBaseKit
        
        com.openinventor.meshviz.graph.PoBase
        
        com.openinventor.meshviz.graph.PoGraphMaster
        
        com.openinventor.meshviz.graph.PoChart
        
        com.openinventor.meshviz.graph.PoPieChartRep

All Implemented Interfaces:: SafeDisposable, SoGetView

public class PoPieChartRep
extends PoChart

Class to build a 3D pie chart. Builds a 3D pie chart on 1D mesh (PoIrregularMesh1D or 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 (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 (PoMiscTextAttr). All numerical values depend on the current numerical display format (PoNumericDisplayFormat). Each slice can be beveled thanks to the current beveled edge values (PoBevelEdge). The current complexity (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:

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> <link REL="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta name="GENERATOR" content="Microsoft FrontPage 3.0"> <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>

Nested Class Summary
- Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoChart
  PoChart.ColorBindings
- Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase
  PoBase.NodeWriteFormats, PoBase.TextTypes, PoBase.UpdateMethodTypes
- Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
  Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`SoSFFloat`	`annoDistToCenter` Defines the distance from the pie chart center of the displayed annotations (name/value/percentage).
`SoSFFloat`	`annoFontSize` Define the font size of the annotation.
`SoSFFloat`	`annoHeightFromSlice` Defines the height of the displayed annotations (name/value/percentage) from the top of each slice.
`SoSFFloat`	`height` Defines the height of the pie chart if the field yValuesIndex is different from -1.
`SoSFBool`	`isAnnoSliceColor` Determines if the color of for annotation is the same as slices.
`SoSFBool`	`isNameVisible` Defines if the name of each slice is visible.
`SoSFBool`	`isPercentageVisible` Defines if the percentage of each slice is visible.
`SoSFBool`	`isValueVisible` Defines if the value of each slice is visible.
`SoSFFloat`	`radiusMax` Defines the maximum radius of the pie chart.
`SoSFFloat`	`radiusMin` Defines the mininum radius of the pie chart.
`SoMFShort`	`sliceToTranslateNumber` Numbers (slice numbers begin at 0) of the slices to translate.
`SoMFFloat`	`sliceToTranslateRadius` Translation values along the bisectors of the slices.
`SoSFInt32`	`stringsIndex` Defines the index of the set of strings used for the names attached to slices.

Fields inherited from class com.openinventor.meshviz.graph.PoChart
colorBinding, colorValuesIndex, INHERITED, material, PER_PART, PER_VERTEX, yValuesIndex

Fields inherited from class com.openinventor.meshviz.graph.PoBase
FOLD_NODE_WRITE_FORMAT, SO_ANNO_TEXT3, SO_TEXT3, UNFOLD_NODE_WRITE_FORMAT, UPDATE_METHOD_IMMEDIATE, UPDATE_METHOD_ON_ACTION

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description

PoPieChartRep()
Constructor.

Constructors
Constructor and Description
`PoPieChartRep()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.
`int`	`getPickedSliceNumber(SoPath path)` Allow the user to retreive the slice number (sliceNumber argument) which has been picked from a picked path (path argument) (cf `SoSelection` node for more information about picking).
`float`	`getSliceToTranslate(int sliceNumber)` Gets the current translation of a slice.
`void`	`setSliceToTranslate(int sliceNumber, float radius)` Convenience methods to set the fields sliceToTranslateNumber and sliceToTranslateRadius.

Methods inherited from class com.openinventor.meshviz.graph.PoBase
addPostRebuildCallback, addPreRebuildCallback, getDomain, getNodeWriteFormat, getTextType, getUpdateMethod, isBuilt, isModified, isVRML2Mode, rebuild, setDomain, setNodeWriteFormat, setTextType, setUpdateMethod, setVRML2Mode, touchKit

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit
getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren

Methods inherited from class com.openinventor.inventor.nodes.SoNode
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
 - stringsIndex
```
public final SoSFInt32 stringsIndex
```
 Defines the index of the set of strings used for the names attached to slices. If the field value is negative, no names is attached to slices.
 - radiusMin
```
public final SoSFFloat radiusMin
```
 Defines the mininum radius of the pie chart. If this value is equal to zero, then we obtain sectors otherwise we obtain rings.
 - radiusMax
```
public final SoSFFloat radiusMax
```
 Defines the maximum radius of the pie chart.
 - sliceToTranslateNumber
```
public final SoMFShort sliceToTranslateNumber
```
 Numbers (slice numbers begin at 0) of the slices to translate. sliceToTranslateNumber[i] is the number of the i-th slice to translate.
 - sliceToTranslateRadius
```
public final SoMFFloat sliceToTranslateRadius
```
 Translation values along the bisectors of the slices. sliceToTranslateRadius[i] is the translate value along the bisector of the i-th slice.
 - height
```
public final SoSFFloat height
```
 Defines the height of the pie chart if the field yValuesIndex is different from -1.
 - isNameVisible
```
public final SoSFBool isNameVisible
```
 Defines if the name of each slice is visible. Slice names are given by the set of strings defined by the field stringsIndex.
 - isValueVisible
```
public final SoSFBool isValueVisible
```
 Defines if the value of each slice is visible.
 - isPercentageVisible
```
public final SoSFBool isPercentageVisible
```
 Defines if the percentage of each slice is visible.
 - annoDistToCenter
```
public final SoSFFloat annoDistToCenter
```
 Defines the distance from the pie chart center of the displayed annotations (name/value/percentage).
 - annoHeightFromSlice
```
public final SoSFFloat annoHeightFromSlice
```
 Defines the height of the displayed annotations (name/value/percentage) from the top of each slice.
 - annoFontSize
```
public final SoSFFloat annoFontSize
```
 Define the font size of the annotation.
 - isAnnoSliceColor
```
public final SoSFBool isAnnoSliceColor
```
 Determines if the color of for annotation is the same as slices.
- Constructor Detail
 - PoPieChartRep
```
public PoPieChartRep()
```
 Constructor.
- Method Detail
 - getSliceToTranslate
```
public float getSliceToTranslate(int sliceNumber)
```
 Gets the current translation of a slice. Returns 0 if sliceNumber slice does not exist or sliceNumber slice is not translated, the translation radius otherwise.
 - setSliceToTranslate
```
public void setSliceToTranslate(int sliceNumber,
 float radius)
```
 Convenience methods to set the fields sliceToTranslateNumber and sliceToTranslateRadius. This is equivalent to the following pseudo code:
```
 for (i=0; i < min(sliceToTranslateNumber.getNum(),sliceToTranslateRadius.getNum()); i++)
 if (sliceNumber == sliceToTranslateNumber[i]) break;
 sliceToTranslateRadius[i] = radius;
 sliceToTranslateNumber[i] = sliceNumber;
```
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.
 - getPickedSliceNumber
```
public int getPickedSliceNumber(SoPath path)
```
 Allow the user to retreive the slice number (sliceNumber argument) which has been picked from a picked path (path argument) (cf SoSelection node for more information about picking). Return false, if the picked path does not correspond to a slice of the pie chart (sliceNumber is not significative), true otherwise.

Class PoPieChartRep

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoChart

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.meshviz.graph.PoChart

Fields inherited from class com.openinventor.meshviz.graph.PoBase

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.meshviz.graph.PoBase

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Methods inherited from class com.openinventor.inventor.nodes.SoNode

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

stringsIndex

radiusMin

radiusMax

sliceToTranslateNumber

sliceToTranslateRadius

height

isNameVisible

isValueVisible

isPercentageVisible

annoDistToCenter

annoHeightFromSlice

annoFontSize

isAnnoSliceColor

Constructor Detail

PoPieChartRep

Method Detail

getSliceToTranslate

setSliceToTranslate

getClassNodekitCatalog

getPickedSliceNumber