PoAngularAxis.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_ANGULAR_AXIS_
#define  _PO_ANGULAR_AXIS_
 
#include <MeshViz/graph/PoAxis.h>
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
 
#define PATH_HOR      PATH_RIGHT
#define PATH_RADIAL   PATH_LEFT
#define PATH_TANGENT  PATH_UP
 
#define GRAD_INSIDE   GRAD_ABOVE
#define GRAD_OUTSIDE  GRAD_BELOW
 
class  PoAngularAxis : public PoAxis {
 
  SO_KIT_HEADER(PoAngularAxis) ;
 
 
 public:
 
  enum GradFit {
    GRAD_FIT,  
    GRAD_UNFIT 
  } ;
 
 
 
  /* Fields */
 
  SoSFFloat offset ;
 
  SoSFFloat startAngle ;
 
  SoSFFloat endAngle ;
 
  SoSFFloat radius ;
 
  SoSFFloat angleStep ;
 
  SoSFEnum  gradFit ;
 
 
 
  /* Methods */
 
  PoAngularAxis() ;
 
  PoAngularAxis(float _offset, float _startAngle, float _endAngle, float _radius, 
                float _angleStep)
    { init(_offset, _startAngle, _endAngle, _radius, _angleStep) ; } 
 
  virtual void rebuild() ;
 
  float getAngleStep() const ;
 
  /*----------------------------------------------------------------------------*/
 
 
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  struct AngularAxisAttr {
    float angleStep ;
    float startAngle ;
  } ;
  // Angular axis attr
 
  // Methods
  // Destructor
  ~PoAngularAxis() ;
  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:
  // Compute limit coordinate for display graduation
  virtual void computeGradLimit(float sAngle, float eAngle, 
                                float &smAngle, float &emAngle) ;
 
  // Compute tick length
  virtual void computeAngularTickLen(size_t numGrad, float theta, 
                                     float &mainTickLen, float &secdTickLen) ;
 
  // Set Default attributes
  virtual void setDefaultAttr(Plane plane = XY) ;
 
  // Build arrow - The arrow is built under the node "group"
  virtual void buildArrow(float radius, float angle, SoGroup *group) ;
  
  // Build title - The title is built under the node "group"
  void buildTitle(float start_angle, float theta, SoGroup *group) ;
 
  // Build tick - The ticks are built under the node "group"
  virtual void buildTick(const std::vector<float>& gradAngleList,
                         float tickLen, SoGroup *group) ;
 
  // Build grid lines - The grid lines are built under the node "group"
  virtual void buildGridLines(const std::vector<float>& gradAngleList,
                              SoGroup *group) ;
 
  // Compute the step
  void computeGradStep(float _radius, float theta, float &step) ;
 
  // Compute grad list str
  void computeGradListStr(float theta_m, float start_angle_m, float s_angle_m, 
                          float angle_step, size_t &num_grad, std::vector<float>& grad_angle_list,
                          char **grad_str) ;
 
  // 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>& gradAngleList,
                          const char **gradStr, SoGroup *group) ;
 
  // Draw an angular text in polar coordinate
  void drawAngularText(PiText *text, TextPath path, GradPosition pos,
                       float rad, float angle, const SbString& str) ;
 
  // Init method
  void init(float offset, float startAngle, float endAngle, float radius, 
            float angleStep) ;
 
  // Computed axis attributes
  AngularAxisAttr angularAxisAttr ;
 
  // Sensors
  FieldSensorList fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_ANGULAR_AXIS_ */