PoLogAxis.h

/*=======================================================================
 *** 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_LOG_AXIS_
#define  _PO_LOG_AXIS_
 
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFUShort.h>
#include <Inventor/fields/SoSFString.h>
 
 
#include <MeshViz/graph/PoCartesianAxis.h>
 
class  PoLogAxis : public PoCartesianAxis {
 
  SO_KIT_HEADER(PoLogAxis) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(multFactorSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(multFactorApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(multFactor) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(decadeTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(decadeTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(decadeText) ;
 
 
 public:
 
  enum DecadeListDef {
    DECADE_LIST_AUTO,    
    DECADE_LIST_NON_AUTO 
  } ;
 
  enum TenPowGradRep {
    TEN_POWER_POW10,    
    TEN_POWER_DECIMAL,  
    TEN_POWER_AUTO      
  } ;
 
  enum DecadeRep {
    DECADE_NONE,         
    DECADE_AS_TEN_POWER, 
    DECADE_DECIMAL,      
    DECADE_DIGIT,        
    DECADE_AUTO          
  } ;
 
  enum MultFactorPosition {
    MULT_FACTOR_START,   
    MULT_FACTOR_END,     
    MULT_FACTOR_EXTR,    
    MULT_FACTOR_GRAD     
  } ;
 
 
 
  /* Fields */
 
  SoMFUShort decadeList ;
 
  SoSFEnum   decadeListDef ;
 
  SoSFEnum   tenPowerRep ;
 
  SoSFEnum   decadeRep ;
 
  SoSFString decadeFontName ;
 
  SoSFFloat  decadeFontSize ;
 
  SoSFEnum   multFactorPosition ;
 
  SoSFFloat  multFactorDistAxis ;
 
  SoSFUShort maxGradNum;
 
  PoLogAxis()
    { init(TRUE, SbVec3f(0.,0.,0.), 1, XY, DECADE_LIST_AUTO, NULL, 0, 0.0,0.0) ; }
 
   PoLogAxis(const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, 
            DecadeListDef _decadeListDef = DECADE_LIST_AUTO,
            const unsigned short *_decadeList = NULL, short _numDecade = 0) 
    { init(FALSE, _start, _end, _type, _decadeListDef, _decadeList, _numDecade, 0.0,0.0) ; }
 
   PoLogAxis(const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, 
            float _gradStart, float _gradEnd, 
            DecadeListDef _decadeListDef = DECADE_LIST_AUTO,
            const unsigned short *_decadeList = NULL, short _numDecade = 0) 
    { init(FALSE, _start, _end, _type, _decadeListDef, _decadeList, _numDecade, _gradStart, _gradEnd) ; }
 
  /* Methods */
 
  virtual void   rebuild() ;
 
  void getLogGrad(unsigned short &numDecade, unsigned short decadeList[8],
                  TenPowGradRep &tenPowerRep, DecadeRep &decadeRep, 
                  SbString &decadeFontName, float &decadeFontSize) const ;
 
  void getMultFactor(MultFactorPosition &position, float &distAxis) const ;
 
  /*----------------------------------------------------------------------------*/
 
 
 private:
  static void initClass() ;
    static void exitClass() ;
 
  struct MultFactor {
    MultFactorPosition position ;
    float              distAxis ;
  } ;
  
  struct Decade {
    DecadeRep       rep ;
    DecadeListDef   listDef ;
    int             *values ;
    size_t          number ;
    SbString        fontName ;
    float           fontSize ;
  } ;
 
 private:
  struct LogAxisAttr {
    MultFactor      multFactor ;
    TenPowGradRep   tenPowerRep ;
    Decade          decadeGrad ;
 
    // coord of the first and last graduations
    // theses coord is either X, Y or Z depending on the axis orientation
    double          firstAxisCoord; 
    double          lastAxisCoord;
  } ;
  // Log axis attr
 
  // Methods
  // Destructor
  virtual ~PoLogAxis() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  virtual void   setDefaultOnNonWritingFields() ;
 
  // Save all axis attributes which can be modified by MeshViz.
  virtual void saveAxisAttr() ;
 
 private:
 
 
  // Init method
  void init(SbBool isDefault, const SbVec3f &start, float end, Type typeAxis, 
            DecadeListDef decadeListDef, const unsigned short *decadeList, 
            short numDecade,float _gradStart, float _gradEnd) ;
 
  void getLogGrads(float firstVal, float lastVal, float &stepValue, float &firstMainValue, size_t &numMainGrad);
 
  // Returns the coord of a grad according to its value.
  // The value of a graduation is the value used to build the text of the graduation.
  // 
  // The coord equals its value if the iv fields gradStart and gradEnd are equal.
  // Otherwise a mapping is done between intervals [gradStart,gradEnd] and
  // this.start,this.end]
  double getGradCoord(double gradValue) const;
 
  // Returns the value of a grad according to its coordinate.
  // Reverse method of getGradCoord
  double getGradValue(double coord) const;
 
  // Build log graduations - The graduations (main grad and decades grad)
  // are built under the nodes mainGroup and secondaryGroup.
  void buildLogGrad(std::vector<float> &mainGradX, std::vector<SecondaryLogGrad> &subGraduations,
                    float stepValue, SoGroup *mainGroup, SoGroup *secondaryGroup) ;
 
  // Compute log grad font size
  void computeLogGradFontSize(size_t numMainGrad, float stepValue, const char **main_str, 
                              const char **main_ten_pow_str, size_t numSecdGrad, 
                              const char **secd_str, const char **secd_ten_pow_str, 
                              float min_grad_dist, SbBool main_grad_pres_auto,
                              float &main_font_size, float &secd_font_size) ;
 
  // Computed logarithmic axis attributes
  LogAxisAttr  logAxisAttr ;
 
  // Sensors
  FieldSensorList fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_LOG_AXIS_ */