PoLinearAxis.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_LINEAR_AXIS_
#define  _PO_LINEAR_AXIS_
 
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
 
 
#include <MeshViz/graph/PoCartesianAxis.h>
#include <MeshViz/graph/PiNumericFormat.h>
#include <MeshViz/graph/PbNumericDisplayFormat.h>
 
class  PoLinearAxis : public PoCartesianAxis {
 
  SO_KIT_HEADER(PoLinearAxis) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(multFactorSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(multFactorApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(multFactor) ;
 
 
 public:
 
  enum GradFit {
    GRAD_FIT,   
    GRAD_UNFIT  
  } ;
 
  enum MultFactorPosition {
    MULT_FACTOR_START,  
    MULT_FACTOR_END,    
    MULT_FACTOR_EXTR,   
    MULT_FACTOR_GRAD    
  } ;
 
 
 
  /* Fields */
 
  SoSFFloat step ;
 
  SoSFEnum  gradFit ;
 
  /* Ten power attributes */
 
  SoSFEnum  multFactorPosition ;
 
  SoSFFloat multFactorDistAxis ;
 
  /* Methods */
 
  PoLinearAxis()
    { init(SbVec3f(0.,0.,0.), 1., XY, 0.0,0.0, 0.) ; }
 
  PoLinearAxis(const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, float _step = 0.0) 
    { init(_start, _end, _type, 0.0,0.0, _step) ; }
 
  PoLinearAxis(const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, 
               float _gradStart, float _gradEnd, float _step = 0.0) 
  { init(_start, _end, _type, _gradStart, _gradEnd,_step) ; }
 
  virtual void   rebuild() ;
 
  void setFormat(PbNumericDisplayFormat *format) ;
 
  const PbNumericDisplayFormat *getFormat() const ;
 
  float getStep() const ;
 
  void  getMultFactor(MultFactorPosition &position, float &distAxis) const ;
 
  /*----------------------------------------------------------------------------*/
 private:
 
  static void initClass() ;
    static void exitClass() ;
 
  // Compute step for linear graduations.
  // If requestStep <= 0., a step is automatically compute thanks
  // to deltaValue
  static void getLinGradStep(float deltaValue, float &requestStep) ;
 
  // Determine the firstGrad and the number of graduations for a linear axis
  // from graduation fit, the origin and and the extremity of the axis, and
  // the step between graduations requested.
  static void getLinGradFirstGrad(GradFit fit, float firstVal,
                                  float lastVal, float step, float &firstGrad,
                                  size_t &numGrad) ;
 
  // This method combines the two previous methods
  static void getLinGrads(GradFit fit, float firstVal, float lastVal,
                          float &requestStep, float &firstGrad, size_t &numGrad) ;
 
  struct MultFactor {
    MultFactorPosition position ;
    float              distAxis ;
  } ;
 
 private:
 
  // Linear axis attr
  struct LinAxisAttr {
    MultFactor      multFactor ;
    PiNumericFormat numericFormat ;
  
    float           step ;
    // value of the first graduation (used to build its text)
    float           firstVal ;
 
    // coord of the first and last graduations
    // theses coord is either X, Y or Z depending on the axis orientation
    double          firstAxisCoord; 
    double          lastAxisCoord;
  } ;
 
  // Methods
  // Destructor
  virtual ~PoLinearAxis() ;
  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() ;
 
  // overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
 
 private:
  // Init method
  void init(const SbVec3f &start, float end, Type typeAxis, float _gradStart, float _gradEnd, float s = 0.0) ;
 
  // 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 equals.
  // 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;
 
  // Numeric Display format
  PbNumericDisplayFormat *m_numericDisplayFormat, m_defaultNumericDisplayFormat ;
 
  // Computed linear axis attributes
  LinAxisAttr  linAxisAttr ;
 
  // Sensors
  FieldSensorList fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_LINEAR_AXIS_ */