PoLabelField.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_LABEL_FIELD_
#define  _PO_LABEL_FIELD_
 
#include <MeshViz/graph/PoGraphMaster.h>
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFFloat.h>
#include <Inventor/fields/SoMFVec2f.h>
#include <Inventor/fields/SoMFString.h>
 
class PbNumericDisplayFormat ;
 
 
class  PoLabelField : public PoGraphMaster {
  
  SO_KIT_HEADER(PoLabelField) ;
  
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(transform) ;
  SO_KIT_CATALOG_ENTRY_HEADER(labelField) ;
 
 
 public:
 
  enum Justification {
    LEFT,   
    RIGHT,  
    CENTER  
  } ;
 
  
 
  enum VerticalJustification {
    TOP,    
    CAP,    
    HALF,   
    BASE,   
    BOTTOM  
  } ;
 
 
 
  enum CoordinateType {
    COORDINATE_IN_DOMAIN,       
    COORDINATE_IN_CURRENT_UNIT  
  } ;
 
  enum ConcatType {
    STRING_BEFORE_VALUE, 
    VALUE_BEFORE_STRING, 
    STRING_ABOVE_VALUE,  
    VALUE_ABOVE_STRING   
  } ;
 
 
 
  /* Fields */
 
  SoMFVec2f  point ;
 
  SoMFString string ;
 
  SoMFFloat  value ;
 
  SoSFEnum   concatType ;
 
  SoSFFloat  fontSize ;
 
  SoSFEnum   justification ;
 
  SoSFEnum   verticalJustification ;
 
  SoSFEnum   coordinateType ;
 
  /* Methods */
 
  PoLabelField()
    { init(TRUE) ; }
 
  PoLabelField(int numPoints, const SbVec2f *_point, const char **_string, 
               const float *_value, float _fontSize, 
               ConcatType type = STRING_BEFORE_VALUE, Justification _justification 
               = LEFT, VerticalJustification _verticalJustification = BASE)
    { init(FALSE, numPoints, _point, _string, _value, _fontSize, type, _justification, 
           _verticalJustification) ; } 
 
  void setFormat(PbNumericDisplayFormat *format) ;
 
  const PbNumericDisplayFormat *getFormat() const ;
 
  virtual void rebuild() ;
 
  /*----------------------------------------------------------------------------*/
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  // Methods
  // Destructor
  virtual ~PoLabelField() ;
  virtual void   setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
 
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  // Overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
  
 private:
  // Init method
  void init(SbBool isDefault, int numPoints=0, const SbVec2f *_point=NULL, 
            const char **_string=NULL, 
            const float *_value=NULL, float _fontSize=1.0, 
            ConcatType type = STRING_BEFORE_VALUE, Justification _justification 
            = LEFT, VerticalJustification _verticalJustification = BASE) ;
 
  // Numeric Display format
  PbNumericDisplayFormat *m_numericDisplayFormat, *m_defaultNumericDisplayFormat ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /*  _PO_LABEL_FIELD_ */