PoAxis.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_AXIS_
#define  _PO_AXIS_
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFUShort.h>
#include <Inventor/fields/SoSFBool.h>
 
#include <MeshViz/graph/PoBaseAxis.h>
#include <MeshViz/graph/PbMiscTextAttr.h>
 
#include <Inventor/STL/vector>
 
class PiText ;
 
 
class  PoAxis : public PoBaseAxis {
 
  SO_KIT_HEADER(PoAxis) ;
 
  // Define fields for new parts
  SO_KIT_CATALOG_ENTRY_HEADER(transform) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(bodySep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(bodyApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(body) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(arrowSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(arrowApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(arrow) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(titleSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(titleApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(title) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(subGradTickSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(subGradTickApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(subGradTick) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(subGradGridSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(subGradGridApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(subGradGrid) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradTickSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradTickApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradTick) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradGridSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradGridApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradGrid) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradText) ;
 
 
 public:
 
  enum Visibility {
    VISIBILITY_OFF,   
    VISIBILITY_ON,    
    VISIBILITY_DEPEND 
  } ;
 
 
 
  enum TextPath {
    PATH_RIGHT,  
    PATH_LEFT,   
    PATH_UP,     
    PATH_DOWN,   
    PATH_DEPEND  
  } ;
 
 
 
  enum GradPosition {
    GRAD_ABOVE,  
    GRAD_BELOW,  
    GRAD_DEPEND  
  } ;
 
 
 
  enum MarginType {
    REL_MARGIN,  
    FIXED_MARGIN 
  } ;
 
 
 
  enum TickPosition {
    TICK_GRAD_SIDE,       
    TICK_GRAD_OTHER_SIDE, 
    TICK_ACROSS_AXIS      
  } ;
 
 
 
  enum TitlePosition {
    TITLE_MIDDLE,  
    TITLE_END,     
    TITLE_DEPEND   
  } ;
 
 
 
  enum TickSubDef {
    NUM_SUB_TICK,     
    PERIOD_MAIN_TICK  
  } ;
 
 
 
  enum AxisReverse {
    AXIS_NO_REVERSE,    
    AXIS_REVERSE,       
    AXIS_REVERSE_DEPEND 
  } ;
 
 
 
  /* Fields */
 
 
 
  /* Graduations attributes */
 
  SoSFEnum   gradVisibility ;  
 
  SoSFEnum   gradPosition ;    
 
  SoSFEnum   gradPath ;        
 
  SoSFString gradFontName ;    
 
  SoSFFloat  gradFontSize ;
 
  SoSFFloat  gradDistAxis ;
 
  SoSFBool   gradAddStringVisibility ;
 
  SoSFString gradAddString ;
 
 
 
  /* Margins attributes */
 
  SoSFEnum   marginType ;
 
  SoSFFloat  marginStart ;
 
  SoSFFloat  marginEnd  ;
 
 
 
  /* Title attributes */
 
  SoSFEnum   titleVisibility ;
 
  SoSFEnum   titlePosition ;
 
  SoSFEnum   titlePath ;
 
  SoSFString titleFontName ;
 
  SoSFFloat  titleFontSize ;
 
  SoSFFloat  titleDistAxis ;
 
  SoSFString titleString ;
 
 
 
  /* Grid lines attributes */
 
  SoSFEnum   gridVisibility ;
 
  SoSFFloat  gridLengthGradSide ;
 
  SoSFFloat  gridLengthGradOtherSide ;
 
 
 
  /* Arrow attributes */
 
  SoSFEnum   arrowVisibility ;
 
  SoSFFloat  arrowHeight ;
 
  SoSFFloat  arrowLength ;
 
 
 
  /* Tick mark attributes */
 
  SoSFEnum   tickVisibility ;
 
  SoSFEnum   tickPosition ;
 
  SoSFFloat  tickMainLength ;
 
  SoSFFloat  tickSubLength ;
 
  SoSFEnum   tickSubDef ;
 
  SoSFUShort tickNumOrPeriod ;
 
  SoSFUShort tickFirstGrad ;
 
  SoSFUShort tickLastGrad ;
 
  SoSFEnum   reverseFlag ;
 
 
 
 
 
  /* Methods */
 
  void setMiscTextAttr(PbMiscTextAttr *textAttr) ;
 
  const PbMiscTextAttr *getMiscTextAttr() const ;
 
  /* Get axis attributes methods */
 
  void getGrad(Visibility &visibility, GradPosition &position, TextPath &path,
               SbString &fontName, float &fontSize, float &distAxis, SbBool
               &addStringVisibility, SbString &addString) const ;
 
  void getMargin(MarginType &type, float &start, float &end) const ;
 
  void getTitle(Visibility &visibility, TitlePosition &position, TextPath
                &path,SbString &fontName, float &fontSize, float &distAxis, 
                SbString &string) const ;
 
  void getGrid(Visibility &visibility, float &lengthGradSide, float
               &lengthGradOtherSide) const ;
 
  void getArrow(Visibility &visibility, float &height, float &length) const ;
 
  void getTick(Visibility &visibility, TickPosition &position, float &mainLength,
               float &subLength, TickSubDef &def, unsigned short &numOrPeriod, 
               unsigned short &firstGrad, unsigned short &lastGrad) const ;
 
  AxisReverse getReverseFlag() const ;
 
  /*----------------------------------------------------------------------------*/
 private:
  static void initClass() ;
    static void exitClass() ;
 
  struct GradAttr {
    Visibility         visibility ;
    GradPosition       position   ;
    TextPath           path       ;
    float              fontSize   ;
    SbString           fontName   ;
    float              distAxis   ;
  } ;
  // Grad attributes
 
  // Margin attributes
  struct MarginAttr {
    MarginType type  ;
    float      start ;
    float      end   ;
  } ;
 
  // Title attributes
  struct TitleAttr {
    Visibility    visibility ;
    TitlePosition position   ;
    TextPath      path       ; 
    float         fontSize   ;
    SbString      fontName   ;
    float         distAxis   ;
  } ;
 
  // Grid line attributes
  struct GridAttr {
    Visibility visibility       ;
    float      lenGradSide      ; 
    float      lenGradOtherSide ;
  } ;
 
  // Arrow attibutes
  struct ArrowAttr {
    Visibility visibility ;
    float      height     ;
    float      length     ;
  } ;
 
  // Tick mark attributes
  struct TickAttr {
    Visibility       visibility  ;
    TickPosition     position    ;
    float            mainLength  ;
    float            subLength   ;
    TickSubDef       subDef      ;
    int              numOrPeriod ;
    int              firstGrad   ;
    int              lastGrad    ;
  } ;
 
  // Miscellaneous attributes
  struct MiscAttr {
    float   deltaX          ;
    float   deltaY          ;
    Plimit  limit           ;
    char    endLineChar     ;
    int     lineLength      ;
    std::vector<float> mainGradCoords;
    std::vector<float> subGradCoords;
  } ;
 
  enum Plane {
    XY,
    XZ,
    YX, 
    YZ, 
    ZX,
    ZY  
  } ;
 
  // Return main graduation coordinates and its number
  // For the moment available only for linear, log and gen axis
  int getMainGradCoords(const float* &coords) const ;
 
  // Return sub graduation coordinates and its number
  // For the moment available only for linear, log and gen axis
  int getSubGradCoords(const float* &coords) const ;
 
 private:
  // Constructor
  PoAxis() ;
  // Destructor
  virtual ~PoAxis() ;
 
  // Axis attributes
  struct AxisAttr {
    GradAttr     grad        ;
    MarginAttr   margin      ;
    TitleAttr    title       ;
    GridAttr     grid        ;
    ArrowAttr    arrow       ;
    TickAttr     tick        ;
    AxisReverse  reverseFlag ;
    MiscAttr     misc        ;
  } ;
 
  // Methods
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  virtual void   setDefaultOnNonWritingFields() ;
 
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  // Save all axis attributes which can be modified by MeshViz.
  virtual void   saveAxisAttr() ;
  
  // Set Default attributes
  virtual void setDefaultAttr(Plane plane = XY) ;
 
  // Compute limit coordinate for display graduation
  virtual void computeGradLimit(float xOrig, float xExtr, float &xmOrig, float &xmExtr) ;
 
  // Compute tick length
  virtual void computeTickLen(size_t numGrad, float &mainTickLen, float &secdTickLen) ;
 
  // Build arrow - The arrow is built under the node "group"
  virtual void buildArrow(float orig, float extr, SoGroup *group) ;
 
  // Build tick - The ticks are built under the node "group"
  virtual void buildTick(const std::vector<float>& xGrad, float tickLen, 
                         SoGroup *group) ;
 
  // Build grid lines - The grid lines are built under the node "group"
  virtual void buildGridLines(const std::vector<float>& xGrad, SoGroup *group) ;
 
  // Build title - The title is built under the node "group"
  void buildTitle(float xOrig, float xExtr, SoGroup *group) ;
 
  // Build graduations - The graduations are built under the node "group"
  // (used only by generalised, linear and polar linear axis)
  virtual void buildGrads(const std::vector<float>& xGrad, const char **gradStr, 
                          SoGroup *group) ;
 
  // Build multiplicative facot - The multiplicative factor is built under the node "group"
  // (used by log, linear, polar linear and polar log axis) 
  void buildMultFactorAtExtr(int tenPower, float xOrig, float xExtr, float &distAxis,
                             SoGroup *group) ;
 
  // Compute axis grad list 
  // (used by linear, angular, generalised, polar linear axis)
  void computeGradList(float xOrig, float xExtr, float step, size_t numAllGrad, 
                       const char** allGradStr, const std::vector<float>& allGradX,
                       char **mainGradStr,
                       std::vector<float> &mainGradX, std::vector<float> &secondaryGradX) ;
 
  // Allocate strings for graduations.
  static char **allocGradString(size_t numStr) ;
 
  // Overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
 
  //----------- These methods, types and vars are used ---------------------
  //--------------- only by log and polar log axis -------------------------
 
  enum LogGradType {
    TDECIMAL_TYPE,
    TDIGIT_TYPE,
    TPOWER_TYPE
  } ;
  
  struct SecondaryLogGrad 
  {
    float coord;
    int powerOfTen;
    int decade;
  };
 
  // Convert log grad to string
  static void convertLogGradToStr(SbBool isMainGrad, LogGradType grad_type, int grad, 
                                  int ten_pow, char *string1, char *string2) ;
  
  // Compute min distance betwwen log graduations.
  static void computeLogGradMinDist(const std::vector<float>& mainGradX, 
                                    const std::vector<float>& secdGradX,
                                    float &min_grad_dist);
  
  // Compute decade list
  static void computeDecadeGradList(size_t numMainGrad, int **decades, 
                                    size_t &numDecades) ;
 
  // Compute width for a log grad text
  void computeLogGradWidth(const char *str, const char *tenPowStr,
                           float fontSize, float &width) ;
 
  // Compute max width for a list of log grad text
  void computeLogGradsMaxWidth(const char **strs, const char **tenPowStrs,
                               size_t numStr, float fontSize, float &width,
                               int &indexMaxWidth) ;
 
  // Draw a list of log graduations
  void drawLogGrad(float pyAtMax, float pyAtMin, float fontSize, 
                   LogGradType gradType, const std::vector<float>& gradX, 
                   const char **gradStr, const char **tenPowStr,
                   SoGroup *group) ;
 
  static char    *PStringToConcat ;
  static PiText  *PLogGradText ;
 
  //--------------------------- End log axis ------------------------------------
 
  // Computed axis attributes
  AxisAttr       axisAttr ;
 
 private:
  // Methods
  void buildTitleP(SbBool isTitleBuild, float xOrig, float xExtr, 
                   SoGroup *group, Plimit &limit) ;
 
  // Miscellaneous text attribute
  PbMiscTextAttr *m_miscTextAttr, m_defaultMiscTextAttr ;
 
  // Sensors
  FieldSensorList fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_AXIS_  */