PoLegend.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_LEGEND_
#define  _PO_LEGEND_
 
#include <MeshViz/graph/PoGraphMaster.h>
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFUShort.h>
#include <Inventor/fields/SoSFString.h>
 
class PbMiscTextAttr ;
class PiText ;
 
class  PoLegend : public PoGraphMaster {
 
  SO_KIT_HEADER(PoLegend) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(background) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundBorderSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundBorderApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundBorder) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(boxSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(boxApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(box) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(boxBorderSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(boxBorderApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(boxBorder) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(titleSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(titleApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(title) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(valueTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(valueTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(valueText) ;
 
 
 public:
 
  enum Visibility {
    VISIBILITY_OFF, 
    VISIBILITY_ON   
  } ;
 
  enum TextPath {
    PATH_RIGHT,   
    PATH_LEFT,    
    PATH_UP,      
    PATH_DOWN     
  } ;
 
  enum Position {
    POS_BOTTOM,  
    POS_TOP,     
    POS_RIGHT,   
    POS_LEFT     
  } ;
 
  enum MarginType {
    REL_MARGIN,  
    FIXED_MARGIN 
  } ;
 
  enum IncrementType {
    VERTICAL_INCREMENT,   
    HORIZONTAL_INCREMENT  
  } ;
 
 
 
  /* Fields */
 
  /* title attributes */
 
  SoSFEnum   titleVisibility ;
 
  SoSFEnum   titlePosition ;
 
  SoSFEnum   titlePath ;
 
  SoSFFloat  titleFontSize ;
 
  SoSFString titleFontName ;
 
  SoSFString titleString ;
 
  /* values attributes */
 
  SoSFEnum   valueVisibility ;
 
  SoSFEnum   valuePosition ;
 
  SoSFString valueFontName ;
 
  SoSFBool   valueAddStringVisibility ;
 
  SoSFString valueAddString ;
 
  /* margin attributes */
 
  SoSFEnum   marginType ;
 
  SoSFFloat  marginLeft ;
 
  SoSFFloat  marginRight ;
 
  SoSFFloat  marginBottom ;
 
  SoSFFloat  marginTop ;
 
 
 
  SoSFEnum   incrementType ;
 
  SoSFUShort numColumns ;
 
 
 
  SoSFFloat  boxRatio ;
 
 
 
  /* Methods */
 
  void setMiscTextAttr(PbMiscTextAttr *textAttr) ;
 
  const PbMiscTextAttr *getMiscTextAttr() const ;
 
  /*----------------------------------------------------------------------------*/
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  struct LegendAttr {
    float    titleFontSize ;
    SbString titleFontName ;
 
    float    valueFontSize ;
    SbString valueFontName ;
  } ;
 
  // Methods
  virtual void   setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
 
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  //******************* Methods for automatic legends *************************
 
  // Compute margin for auto legend
  void computeMarginA(const SbVec2f &ptBoxOrig, float boxWidth,
                      float boxHeight, SbVec2f &ptLegendOrig,
                      float &legendWidth, float &legendHeight) ;
 
  // Compute title font size for auto legend
  void computeTitleSizeA(float legendWidth, float legendHeight,
                         float &titleWidth, float &titleHeight) ;
 
  // Draw background for auto legend
  void drawBackgroundA(const SbVec2f &ptBoxOrig, float boxWidth, float boxHeight) ;
 
  // Draw title for auto legend
  void drawTitleA(float titleHeight, float titleWidth, Plimit &limit) ;
 
  // Draw boxes for auto legend constitued of several boxes 
  void drawBoxesLegendBoxesA(SbBool isBoxVisible, float boxWidth, float boxHeight,
                             int nb_lines, int nb_columns, 
                             int numItems, const float *maxTextSizePerCol,
                             const SbVec2f &space_box, const Plimit &limit) ;
  
  // Draw a box with an interior color
  virtual void drawBoxLegendBoxesA(SoGroup *boxBorderGroup, SoGroup *boxGroup,
                                   const SbVec2f &topLeftCorner, float width, 
                                   float height, int repIndex) ;
 
  // Draw values for auto legend constitued of several boxes
  void drawValuesLegendBoxesA(int nb_lines, int nb_columns, int numStrings, 
                              const SbString *strings, const float *maxTextSizePerCol,
                              const SbVec2f &space_box, const Plimit &limit, 
                              PiText &valText) ;
 
  // Compute graphic size use to draw values in  auto legend constitued 
  // of several boxes
  virtual void computeGraphicSizeForValues(float &width, float &height,
                                           float &text_space) ;
 
  // Determines if the legend must be reverted or not.
  virtual void setRevertOrder(float startY, float endY) 
    { m_revertOrder =  (startY <= endY ? FALSE : TRUE) ; }
  SbBool isRevertOrder() const
    { return m_revertOrder ; }
 
  // Indicate if the values and boxes are
  // drawn from down to up (FALSE)
  // or from up to down (TRUE)
  SbBool m_revertOrder ;
  //****************** Methods for non automatic legend ************************
  
  // Set default attributes
  void setDefaultAttr() ;
 
  // Constructor
  PoLegend() ;
 
  // Destructor
  virtual ~PoLegend() ;
 
  // Overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
 
  // Attributes computed 
  LegendAttr m_legendAttr ;
 
 private:
  // Miscellaneous text attribute
  PbMiscTextAttr *m_miscTextAttr, *m_defaultMiscTextAttr ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_LEGEND_ */