PoPieChart.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef  _PO_PIE_CHART_
#define  _PO_PIE_CHART_
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFFloat.h>
#include <Inventor/fields/SoMFString.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFShort.h>
#include <Inventor/fields/SoMFColor.h>
 
#include <MeshViz/graph/PoGraphMaster.h>
#include <MeshViz/graph/PbMiscTextAttr.h>
#include <MeshViz/graph/PbNumericDisplayFormat.h>
 
class PiText ;
 
class  PoPieChart : public PoGraphMaster {
  SO_KIT_HEADER(PoPieChart) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(sliceSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(sliceApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(slice) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(sliceBorderSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(sliceBorderApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(sliceBorder) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotBoxSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotBoxApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotBox) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotBoxBorderSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotBoxBorderApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotBoxBorder) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotText) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotValueSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotValueApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotValue) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotPercentSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotPercentApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(extAnnotPercent) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(arrowSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(arrowApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(arrow) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotBoxSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotBoxApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotBox) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotBoxBorderSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotBoxBorderApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotBoxBorder) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotText) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotValueSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotValueApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotValue) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotPercentSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotPercentApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(intAnnotPercent) ;
 
 
 public:
 
  enum IntAnnotPosition {
    RADIAL_INT_POS, 
    HOR_INT_POS     
  } ;
 
  enum ExtAnnotPosition {
    RADIAL_EXT_POS,         
    HOR_EXT_POS,            
    HOR_ALIGNED_EXT_POS,    
    VERT_ALIGNED_EXT_POS,   
    SQUARE_ALIGNED_EXT_POS  
  } ;
 
  enum Alignment {
    LEFT_ALIGN,        
    CENTER_ALIGN,      
    RIGHT_ALIGN,       
    INWARDS_ALIGN,     
    OUTWARDS_ALIGN     
  } ;
 
#ifdef ABSOLUTE
 
#undef ABSOLUTE
 
#endif
 
 
 
  enum PercentStatus {
    ABSOLUTE,
    PERCENTAGE
  } ;
 
 
 
 
 
  /* Fields */
 
  SoSFFloat  radius ;
 
 
 
  /* Slice attributes */
 
  SoMFString sliceText  ;
 
  SoMFFloat  sliceValue ;
 
  SoMFColor  sliceColor ;
 
 
 
  /* Internal annotation attributes */
 
  SoSFEnum   intAnnotPosition            ;
 
  SoSFEnum   intAnnotAlignment           ;
 
  SoSFBool   intAnnotTextVisibility      ;
 
  SoSFBool   intAnnotValueVisibility     ;
 
  SoSFBool   intAnnotPercentVisibility   ;
 
  SoSFBool   intAnnotAddStringVisibility ;
 
  SoSFString intAnnotAddString           ;
 
  SoSFString intAnnotTextFontName        ;
 
  SoSFFloat  intAnnotTextFontSize        ;
 
  SoSFString intAnnotValueFontName       ;
 
  SoSFFloat  intAnnotValueFontSize       ;
 
  SoSFString intAnnotPercentFontName     ;
 
  SoSFFloat  intAnnotPercentFontSize     ;
 
  SoSFFloat  intAnnotDistance            ;
 
 
 
  /* External annotation attributes */
 
  SoSFEnum   extAnnotPosition            ;
 
  SoSFEnum   extAnnotAlignment           ;
 
  SoSFBool   extAnnotTextVisibility      ;
 
  SoSFBool   extAnnotValueVisibility     ;
 
  SoSFBool   extAnnotPercentVisibility   ;
 
  SoSFBool   extAnnotAddStringVisibility ;
 
  SoSFString extAnnotAddString           ;
 
  SoSFString extAnnotTextFontName        ;
 
  SoSFFloat  extAnnotTextFontSize        ;
 
  SoSFString extAnnotValueFontName       ;
 
  SoSFFloat  extAnnotValueFontSize       ;
 
  SoSFString extAnnotPercentFontName     ;
 
  SoSFFloat  extAnnotPercentFontSize     ;
 
  SoSFFloat  extAnnotDistance1           ;
 
  SoSFFloat  extAnnotDistance2           ;
 
  SoSFFloat  extAnnotDistance3           ;
 
 
 
  /* Arrow attributes */
 
  SoSFBool   arrowVisibility ;
 
  SoSFFloat  arrowHeight     ;
 
  SoSFFloat  arrowWidth      ;
 
 
 
  /* Small value regrouping attributes */
 
  SoSFBool   sliceGroupActive   ; 
 
  SoSFFloat  sliceGroupMinValue ;
 
  SoSFEnum   sliceGroupFlagMin  ;
 
  SoSFString sliceGroupString   ;
 
 
 
  /* Slices to translate attributes */
 
  SoMFShort sliceToTranslateNumber ;
 
  SoMFFloat sliceToTranslateValue  ;
 
  SoSFFloat sliceAngleStep ;
 
 
 
 
 
  /* Methods */
 
  void setMiscTextAttr(PbMiscTextAttr *textAttr) ;
 
  const PbMiscTextAttr *getMiscTextAttr() const ;
 
  void setFormat(PbNumericDisplayFormat *format) ;
 
  const PbNumericDisplayFormat *getFormat() const ;
 
  SbBool getPickedSliceNumber(const SoPath *path, int &sliceNumber) const ;
 
  void  setSliceToTranslate(int sliceNumber, float translateValue) ;
 
  float getSliceToTranslate(int sliceNumber) const ;
 
  /*----------------------------------------------------------------------------*/
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  // Computed by GraphMaster attributes
  struct PieChartAttr {
    SbString intTextFontName ;
    float    intTextFontSize ;
 
    SbString extTextFontName ;
    float    extTextFontSize ;
 
    SbString intValFontName ;
    float    intValFontSize ;
 
    SbString extValFontName ;
    float    extValFontSize ;
 
    SbString intPercentFontName ;
    float    intPercentFontSize ;
 
    SbString extPercentFontName ;
    float    extPercentFontSize ;
 
    float    intDist ;
 
    float    extDist1 ;
    float    extDist2 ;
    float    extDist3 ;
 
    float    arrowWidth ;
    float    arrowHeight ;
 
    SbString sliceNames[360] ;
 
    int      numSlices ;
    int      displayedSlicesNum ;
    int      displayedSlices[360] ;
    float    slicesPercentages[360] ;
    SbString slicesValuesString[360] ;
    SbString slicesPercentagesString[360] ;
    float    slicesValues[360] ;
    float    slicesTranslation[360] ;
 
    int      slicesLowValuesNumbers ;
 
    char     endLineChar ;
    int      lineLength ;
  } ;
 
  PieChartAttr m_pieChartAttr ;
 
  enum AnnotPosPieChart { // Position of an annotation relative to the Pie Chart
    RIGHT_PIE_CHART,
    LEFT_PIE_CHART,
    UP_PIE_CHART,
    DOWN_PIE_CHART
  } ;
  
  // Constructors
  PoPieChart(SbBool isDefault=TRUE, float _radius=1., short numSlices=0,
             const char **_sliceTexts=NULL, const float *_sliceValues=NULL,
             int numSliceColors=0, const SbColor *_sliceColors=NULL) ;
  // Destructor
  virtual ~PoPieChart() ;
 
  // Methods
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  virtual void   setDefaultOnNonWritingFields() ;
  virtual void   basicObjectChange(PbBase *basicObj) ;
 
  // Save all pie chart attributes which can be modified by MeshViz.
  void  savePieChartAttr() ;
 
  // Compute slice part values to display.
  void computeSlicePartValuesToDisplay() ;
 
  // Compute  percentage or value (following isPercentage flag) 
  // strings to display with the request numeric display format.
  void computeStringsToDisplay(const float *values, int numValues, SbBool isPercentage) ;
 
  // Draw internal annotations
  void drawInternalAnnotations(const SbVec2f &pieChartCenter, const SbVec2f &pointz) ;
 
  // Draw an internal annotation
  void drawInternalAnnot(int sliceNum, const SbVec2f &annotCenterPoint, const SbVec2f &pointz,
                         AnnotPosPieChart annotPosPieChart, int nbAnnot, float rotateAnnotAngle,
                         PiText *intText, PiText *intValue, PiText *intPercent, 
                         SoGroup *intAnnotBoxGroup, SoGroup *intAnnotBoxBorderGroup) ;
 
  // Draw external annotations
  void drawExternalAnnotations(const SbVec2f &pieChartCenter, const SbVec2f &pointz) ;
 
  // Draw an external annotation
  void drawExternalAnnot(int sliceNum, const SbVec3f &arrowStartPoint, const SbVec2f &pointz,
                         AnnotPosPieChart annotPosPieChart, int nbAnnot, float rotateAnnotAngle, 
                         PiText *extText, PiText *extValue, PiText *extPercent, 
                         SoGroup *extAnnotBoxGroup, SoGroup *extAnnotBoxBorderGroup) ;
 
  // Set all part to NULL
  void resetAllPart() ;
 
  // Compute slice names
  void computeSliceNames() ;
 
  // Overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
 
 private:
  // Miscellaneous text attributes
  PbMiscTextAttr *m_miscTextAttr, m_defaultMiscTextAttr ;
 
  // Numeric Display format
  PbNumericDisplayFormat *m_numericDisplayFormat, m_defaultNumericDisplayFormat ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_PIE_CHART_  */