Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
PoPieChartRep Class Reference

MeshViz Class to build a 3D pie chart. More...

#include <MeshViz/graph/PoPieChartRep.h>

+ Inheritance diagram for PoPieChartRep:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
virtual const SoNodekitCataloggetNodekitCatalog () const
 Returns the SoNodekitCatalog for this instance.
 
 PoPieChartRep ()
 Constructor.
 
SbBool getPickedSliceNumber (const SoPath *path, int &sliceNumber) const
 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).
 
void setSliceToTranslate (int sliceNumber, float radius)
 Convenience methods to set the fields sliceToTranslateNumber and sliceToTranslateRadius.
 
float getSliceToTranslate (int sliceNumber) const
 Gets the current translation of a slice.
 
- Public Member Functions inherited from PoBase
void setUpdateMethod (UpdateMethodType type)
 Sets scene graph update method.
 
UpdateMethodType getUpdateMethod () const
 Gets update method.
 
void setDomain (PbDomain *dom)
 Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
 
const PbDomaingetDomain () const
 Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
 
void touchKit ()
 Indicates the node kit is modified.
 
SbBool isModified () const
 Return TRUE, if the kit has been modified, else otherwise.
 
SbBool isBuilt () const
 Indicates if the node kit has been built at least once.
 
void addPreRebuildCallback (PoRebuildCB *cb, void *data)
 Add a callback function to call when the node kit is rebuilt.
 
void addPostRebuildCallback (PoRebuildCB *cb, void *data)
 Add a callback function to call when the node kit is rebuilt.
 
void removePreRebuildCallback (PoRebuildCB *cb, void *data=NULL)
 Remove a callback function to call when the node kit is rebuilt.
 
void removePostRebuildCallback (PoRebuildCB *cb, void *data)
 Remove a callback function to call when the node kit is rebuilt.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Copy method.
 
virtual SbBool affectsState () const
 See SoNode::affectsState() for explanations.
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit ()
 Constructor.
 
virtual SoNodegetPart (const SbName &partName, SbBool makeIfNeeded)
 Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
 
template<typename PartType >
PartType * getPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.
 
template<typename PartType >
PartType * checkPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.
 
SbString getPartString (const SoBase *part)
 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.
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
 Returns a path that begins at this nodekit and ends at partName.
 
virtual SbBool setPart (const SbName &partName, SoNode *newPart)
 Inserts the given node (not a copy) as the new part specified by partName.
 
SoNONUNICODE SbBool set (char *nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SbBool set (const SbString &nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SoNONUNICODE SbBool set (const char *partNameString, const char *parameterString)
 This function allows field values of parts (nodes) to be set.
 
SbBool set (const SbString &partNameString, const SbString &parameterString)
 This function allows field values of parts (nodes) to be set.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 
- Public Member Functions inherited from SoGetView
 SoGetView ()
 Default constructor.
 
virtual ~SoGetView ()
 
virtual SbBool getViewportIsEnabled () const
 Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.
 
virtual const SbVec2f getViewportOrigin () const
 Returns SbViewportRegion origin.
 
virtual const SbVec2f getViewportSize () const
 Returns SbViewportRegion size.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoChart
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoGraphMaster
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoBase
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
static void setNodeWriteFormat (NodeWriteFormat format)
 Sets the node write format.
 
static NodeWriteFormat getNodeWriteFormat ()
 Gets the node write format.
 
static void setTextType (TextType type)
 Sets the type of text used.
 
static TextType getTextType ()
 Gets the type of text used.
 
static void setVRML2Mode (SbBool flag)
 Set the VRML2 mode.
 
static SbBool isVRML2Mode ()
 Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)
 
- Static Public Member Functions inherited from SoBaseKit
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for the class SoBaseKit.
 
static void setSearchingChildren (SbBool newVal)
 Sets if nodekit children are searched during SoSearchAction traversal.
 
static SbBool isSearchingChildren ()
 Returns TRUE if nodekit children are searched during SoSearchAction traversal.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFInt32 stringsIndex
 Defines the index of the set of strings used for the names attached to slices.
 
SoSFFloat radiusMin
 Defines the mininum radius of the pie chart.
 
SoSFFloat radiusMax
 Defines the maximum 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.
 
SoSFFloat height
 Defines the height of the pie chart if the field yValuesIndex is different from -1.
 
SoSFBool isNameVisible
 Defines if the name of each slice is visible.
 
SoSFBool isValueVisible
 Defines if the value of each slice is visible.
 
SoSFBool isPercentageVisible
 Defines if the percentage of each slice is visible.
 
SoSFFloat annoDistToCenter
 Defines the distance from the pie chart center of the displayed annotations (name/value/percentage).
 
SoSFFloat annoHeightFromSlice
 Defines the height of the displayed annotations (name/value/percentage) from the top of each slice.
 
SoSFFloat annoFontSize
 Define the font size of the annotation.
 
SoSFBool isAnnoSliceColor
 Determines if the color of for annotation is the same as slices.
 
- Public Attributes inherited from PoChart
SoSFEnum colorBinding
 Specify how the colors are bound to the representation.
 
SoSFInt32 yValuesIndex
 Defines the index of the set of values used by a charting representation as a y-coordinate of each mesh node.
 
SoSFInt32 colorValuesIndex
 Defines the index of the set of values for the coloring.
 
SoSFNode material
 Defines the list of materials used for the coloring.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Public Types inherited from PoChart
enum  ColorBinding {
  INHERITED ,
  PER_VERTEX ,
  PER_PART
}
 Color binding. More...
 
- Public Types inherited from PoBase
enum  UpdateMethodType {
  UPDATE_METHOD_IMMEDIATE ,
  UPDATE_METHOD_ON_ACTION
}
 Type of update method. More...
 
enum  NodeWriteFormat {
  FOLD_NODE_WRITE_FORMAT ,
  UNFOLD_NODE_WRITE_FORMAT
}
 Type of write format. More...
 
enum  TextType {
  SO_TEXT3 ,
  SO_ANNO_TEXT3
}
 Type of Text. More...
 
typedef void PoRebuildCB(void *userData, PoBase *base)
 

Detailed Description

MeshViz 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
    }

    CATALOG PARTS

    PoPieChartRep {

    Separator alternateRep (from PoBase) {

    AppearanceKit appearance (from PoBase)

    Specifies the appearance of all the kit. By default lightModel.model=PHONG.

    MatrixTransform domainTransform (from PoBase)

    Corresponds to the domain transformation.

    Separator sliceSep {

    Contains properties and shapes to draw the slices.

      AppearanceKit sliceApp

      Specifies the appearance of the slices.

      Group slice

      Contains a list of couple SoMaterial and SoIndexedFaceSet shapes to draw the slices.

    }

    Separator annotationSep {

    Contains properties and shapes to draw the annotations.

      AppearanceKit annotationApp

      Specifies the appearance of the annotations.  font.size and font.name are set when the kit is rebuilt.

      Group annotation

    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.

    }

    Separator annotationLineSep {

    Contains properties and shapes to draw lines from the annotations to the slices.

      AppearanceKit annotationLineApp

      Specifies the appearance of the lines.

      Group annotationLine

      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.

    }

    }

    }

    Definition at line 100 of file PoPieChartRep.h.

Constructor & Destructor Documentation

◆ PoPieChartRep()

PoPieChartRep::PoPieChartRep ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoPieChartRep::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoPieChartRep::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoPieChartRep::getNodekitCatalog ( ) const
virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoChart.

◆ getPickedSliceNumber()

SbBool PoPieChartRep::getPickedSliceNumber ( const SoPath path,
int &  sliceNumber 
) const

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.

◆ getSliceToTranslate()

float PoPieChartRep::getSliceToTranslate ( int  sliceNumber) const

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.

◆ getTypeId()

virtual SoType PoPieChartRep::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from PoChart.

◆ setSliceToTranslate()

void PoPieChartRep::setSliceToTranslate ( int  sliceNumber,
float  radius 
)

Convenience methods to set the fields sliceToTranslateNumber and sliceToTranslateRadius.

This is equivalent to the following pseudo code:

if (sliceNumber == sliceToTranslateNumber[i]) break;
sliceToTranslateNumber[i] = sliceNumber;
SoMFFloat sliceToTranslateRadius
Translation values along the bisectors of the slices.
SoMFShort sliceToTranslateNumber
Numbers (slice numbers begin at 0) of the slices to translate.
int getNum() const
Returns the number of values currently in the field.
Definition SoMField.h:146

Member Data Documentation

◆ annoDistToCenter

SoSFFloat PoPieChartRep::annoDistToCenter

Defines the distance from the pie chart center of the displayed annotations (name/value/percentage).

Definition at line 180 of file PoPieChartRep.h.

◆ annoFontSize

SoSFFloat PoPieChartRep::annoFontSize

Define the font size of the annotation.

Definition at line 191 of file PoPieChartRep.h.

◆ annoHeightFromSlice

SoSFFloat PoPieChartRep::annoHeightFromSlice

Defines the height of the displayed annotations (name/value/percentage) from the top of each slice.

Definition at line 186 of file PoPieChartRep.h.

◆ height

SoSFFloat PoPieChartRep::height

Defines the height of the pie chart if the field yValuesIndex is different from -1.

Definition at line 157 of file PoPieChartRep.h.

◆ isAnnoSliceColor

SoSFBool PoPieChartRep::isAnnoSliceColor

Determines if the color of for annotation is the same as slices.

Definition at line 196 of file PoPieChartRep.h.

◆ isNameVisible

SoSFBool PoPieChartRep::isNameVisible

Defines if the name of each slice is visible.

Slice names are given by the set of strings defined by the field stringsIndex.

Definition at line 164 of file PoPieChartRep.h.

◆ isPercentageVisible

SoSFBool PoPieChartRep::isPercentageVisible

Defines if the percentage of each slice is visible.

Definition at line 174 of file PoPieChartRep.h.

◆ isValueVisible

SoSFBool PoPieChartRep::isValueVisible

Defines if the value of each slice is visible.

Definition at line 169 of file PoPieChartRep.h.

◆ radiusMax

SoSFFloat PoPieChartRep::radiusMax

Defines the maximum radius of the pie chart.

Definition at line 138 of file PoPieChartRep.h.

◆ radiusMin

SoSFFloat PoPieChartRep::radiusMin

Defines the mininum radius of the pie chart.

If this value is equal to zero, then we obtain sectors otherwise we obtain rings.

Definition at line 133 of file PoPieChartRep.h.

◆ sliceToTranslateNumber

SoMFShort PoPieChartRep::sliceToTranslateNumber

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

sliceToTranslateNumber[i] is the number of the i-th slice to translate.

Definition at line 144 of file PoPieChartRep.h.

◆ sliceToTranslateRadius

SoMFFloat PoPieChartRep::sliceToTranslateRadius

Translation values along the bisectors of the slices.

sliceToTranslateRadius[i] is the translate value along the bisector of the i-th slice.

Definition at line 151 of file PoPieChartRep.h.

◆ stringsIndex

SoSFInt32 PoPieChartRep::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.

Definition at line 127 of file PoPieChartRep.h.


The documentation for this class was generated from the following file: