PoItemLegend.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_ITEM_LEGEND_
#define  _PO_ITEM_LEGEND_
 
#include <MeshViz/graph/PoLegend.h>
 
#include <Inventor/fields/SoSFVec2f.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFString.h>
#include <Inventor/fields/SoMFColor.h>
#include <Inventor/fields/SoMFUShort.h>
#include <Inventor/fields/SoMFFloat.h>
 
class PiText ;
 
class  PoItemLegend : public PoLegend {
 
  SO_KIT_HEADER(PoItemLegend) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(lineSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(lineApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(line) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(markerSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(markerApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(marker) ;
 
 
 public:
 
  /* Fields */
 
  SoSFVec2f   start ;
 
  SoSFVec2f   end ;
 
  SoMFString  item ;
 
 
 
  SoSFBool    boxVisibility ;
 
  SoMFColor   boxColor ;
 
 
 
  SoSFBool    lineVisibility ;
 
  SoMFColor   lineColor ;
 
  SoMFFloat   lineSize ;
 
  SoMFUShort  linePattern ;
 
 
 
  SoSFBool    markerVisibility ;
 
  SoMFColor   markerColor ;
 
  SoMFFloat   markerSize ;
 
  SoMFString  markerString ;
 
 
 
  /* Methods */
 
  PoItemLegend()
    { init(TRUE, SbVec2f(0.,0.), SbVec2f(1.,1.), 0, NULL, NULL) ; }
 
  PoItemLegend(const SbVec2f &_start, const SbVec2f &_end, int _numItems, 
               const char** _item, const SbColor *_boxColor=NULL)
    { init(FALSE, _start, _end, _numItems, _item, _boxColor) ; }
 
  virtual void rebuild() ;
 
  /*----------------------------------------------------------------------------*/
 
 
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  // Methods
  virtual void   setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  
  // Destructor
  virtual ~PoItemLegend() ;
 
  // Determines if the legend must be reverted or not.
  virtual void setRevertOrder(float startY, float endY) 
    { m_revertOrder =  (startY <= endY ? TRUE : FALSE) ; }
 
 private:
  // Init method
  void init(SbBool isDefault, const SbVec2f &_start, const SbVec2f &_end, 
            int _numItems, const char** _item, const SbColor *_boxColor) ;
 
  // Compute items font size
  void computeItemFontSize(float legend_width, float legend_height, int nb_lines, 
                           int nb_columns, float f0, float *maxTextSizePerCol, 
                           SbVec2f &space_box) ;
    
  // Draw a box with an interior color
  void drawBoxLegendBoxesA(SoGroup *boxBorderGroup, SoGroup *boxGroup,
                           const SbVec2f &topLeftCorner, float width, float height,
                           int repIndex) ;
  
  // Draw lines
  void drawLines(int nb_lines, int nb_columns, int numItems, 
                 const float *maxTextSizePerCol, const SbVec2f &space_box, 
                 const Plimit &current_limit) ;
 
  // Draw a horizontal line with color, pattern and size
  void drawHorLine(SoGroup *lineGroup, const SbVec2f &orig, float size, 
                   SbBool isColor, SbBool isSize, SbBool isPattern, int repIndex) ;
 
  // Draw markers
  void drawMarkers(int nb_lines, int nb_columns, int numItems, 
                   const float *maxTextSizePerCol, const SbVec2f &space_box, 
                   const Plimit &current_limit) ;
 
  // Draw a marker with color, type and size
  void drawMarker(SoGroup *markerGroup, const SbVec2f &orig, SbBool isColor, 
                  SbBool isSize, SbBool isType, int repIndex) ;
 
  // Compute graphic size use to draw values in  auto legend constitued 
  // of several boxes
  void computeGraphicSizeForValues(float &width, float &height, 
                                   float &text_space) ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_ITEM_LEGEND_ */