PoHistogram.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_HISTOGRAM_
#define  _PO_HISTOGRAM_
 
#include <MeshViz/graph/PoGraphMaster.h>
 
#include <Inventor/fields/SoSFVec2f.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFColor.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFString.h>
 
 
class PbMiscTextAttr ;
class PbDataMapping ;
class PbNumericDisplayFormat ;
 
class PiText ;
 
class  PoHistogram : public PoGraphMaster {
 
  SO_KIT_HEADER(PoHistogram) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(transform) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(barSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(barApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(bar) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(valueTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(valueTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(valueText) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(nameTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(nameTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(nameText) ;
 
 
 public:
 
  enum Type {
    X, 
    Y  
  } ;
 
  enum Position {
    POS_TOP_OUT,   
    POS_TOP_IN,    
    POS_BOTTOM_OUT,
    POS_BOTTOM_IN, 
    POS_RIGHT_OUT, 
    POS_RIGHT_IN,  
    POS_LEFT_OUT,  
    POS_LEFT_IN,   
    POS_CENTER,    
    POS_DEPEND     
  } ;
 
  enum Visibility {
    VISIBILITY_OFF,  
    VISIBILITY_ON    
  } ;
 
  enum TextPath {
    PATH_RIGHT,   
    PATH_LEFT,    
    PATH_UP,      
    PATH_DOWN,    
    PATH_DEPEND   
  } ;
 
  enum BarSpaceType {
    REL_SPACE,    
    FIXED_SPACE   
  } ;
 
  enum Coloring {
    COLOR_LIST,   
    DATA_MAPPING  
  } ;
 
 
 
 
 
  /* Fields */
 
  SoSFVec2f  start ;
 
  SoSFFloat  end ;
 
  SoSFEnum   type ;
 
  SoMFColor  color ;
 
  SoSFEnum   coloring ;
 
  /* Attribute of values */
 
  SoSFEnum   valueVisibility ;
 
  SoSFEnum   valuePosition ;
 
  SoSFEnum   valuePath ;
 
  SoSFFloat  valueFontSize ;
 
  SoSFString valueFontName ;
 
  SoSFBool   valueAddStringVisibility ;
 
  SoSFString valueAddString ;
 
  /* Attribute of bar names */
 
  SoSFEnum   nameVisibility ;
 
  SoSFEnum   namePosition ;
 
  SoSFEnum   namePath ;
 
  SoSFFloat  nameFontSize ; 
 
  SoSFString nameFontName ;
 
  SoSFEnum   barSpaceType ;
 
  SoSFFloat  barSpaceValue ;
 
 
 
 
 
  /* Methods */
 
  void setMiscTextAttr(PbMiscTextAttr *textAttr) ;
 
  const PbMiscTextAttr *getMiscTextAttr() const ;
 
  void setDataMapping(PbDataMapping *dataMapping) ;
 
  const PbDataMapping* getDataMapping() const ;
 
  void setFormat(PbNumericDisplayFormat *format) ;
 
  const PbNumericDisplayFormat *getFormat() const ;
 private:
  static void initClass() ;
    static void exitClass() ;
 
  struct ValueAttr {
    Position position ;
    TextPath path ;
    float    fontSize ;
    SbString fontName ;
  } ;
 
  struct NameAttr {
    Position position ;
    TextPath path ;
    float    fontSize ;
    SbString fontName ;
  } ;
 
 private:
  struct HistogAttr {
    ValueAttr   value ;
    NameAttr    name ;
    float       scaleFactor ;
  } ;
 
  HistogAttr m_histogAttr ;
 
  // Methods
  virtual void   setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  virtual void setDefaultAttr() ;
  virtual void colorBars(SoGroup *group) ;
 
  // Constructor
  PoHistogram() ;
 
  // Destructor
  virtual ~PoHistogram() ;
 
  // Compute a reference point from a rectangle,
  // a position type relative to this one and the 
  // fontSize.
  static void computeTextPos(const SbVec2f *rectangle, Position textPos, float
                             fontSize, SbVec2f &pointText) ;
 
  // Compute text alignment for a position type and a path
  static void computeTextAlignPath(Position textPos, TextPath path, PiText *text) ;
 
  // Overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
  
 private:
  // Miscellaneous text attribute
  PbMiscTextAttr *m_miscTextAttr, *m_defaultMiscTextAttr ;
 
  // Data Mapping
  PbDataMapping *m_dataMap ;
 
  // Numeric display format
  PbNumericDisplayFormat *m_numericDisplayFormat, *m_defaultNumericDisplayFormat ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_HISTOGRAM_ */