PoAutoCubeAxis.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-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef  _PO_AUTO_CUBE_AXIS_
#define  _PO_AUTO_CUBE_AXIS_
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFMatrix.h>
 
#include <MeshViz/graph/PoBaseAxis.h>
#include <MeshViz/graph/PbMiscTextAttr.h>
 
struct Pedge ;
class  PoCartesianAxis ;

class  PoAutoCubeAxis : public PoBaseAxis {
  SO_KIT_HEADER(PoAutoCubeAxis) ;
 
  /* Define fields for new parts */
  // Faces of the background
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundFaceSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundFaceApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(backgroundFace) ;
 
  // Grid lines of main graduations
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradGridSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradGridApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(mainGradGrid) ;
 
  // Grid lines of sub graduations
  SO_KIT_CATALOG_ENTRY_HEADER(subGradGridSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(subGradGridApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(subGradGrid) ;
 
  //--------------- X axes --------------------
  // X axis with vertices 0-3
  SO_KIT_CATALOG_ENTRY_HEADER(xAxisSwitch03) ;
  SO_KIT_CATALOG_ENTRY_HEADER(xAxis03) ;
 
  // X axis with vertices 1-2
  SO_KIT_CATALOG_ENTRY_HEADER(xAxisSwitch12) ;
  SO_KIT_CATALOG_ENTRY_HEADER(xAxis12) ;
 
  // X axis with vertices 6-5
  SO_KIT_CATALOG_ENTRY_HEADER(xAxisSwitch65) ;
  SO_KIT_CATALOG_ENTRY_HEADER(xAxis65) ;
 
  // X axis with vertices 7-4
  SO_KIT_CATALOG_ENTRY_HEADER(xAxisSwitch74) ;
  SO_KIT_CATALOG_ENTRY_HEADER(xAxis74) ;
 
  //--------------- Y axes --------------------
  // Y axis with vertices 0-1
  SO_KIT_CATALOG_ENTRY_HEADER(yAxisSwitch01) ;
  SO_KIT_CATALOG_ENTRY_HEADER(yAxis01) ;
 
  // Y axis with vertices 7-6
  SO_KIT_CATALOG_ENTRY_HEADER(yAxisSwitch76) ;
  SO_KIT_CATALOG_ENTRY_HEADER(yAxis76) ;
 
  // Y axis with vertices 4-5
  SO_KIT_CATALOG_ENTRY_HEADER(yAxisSwitch45) ;
  SO_KIT_CATALOG_ENTRY_HEADER(yAxis45) ;
 
  // Y axis with vertices 3-2
  SO_KIT_CATALOG_ENTRY_HEADER(yAxisSwitch32) ;
  SO_KIT_CATALOG_ENTRY_HEADER(yAxis32) ;
 
  //--------------- Z axes --------------------
  // Z axis with vertices 0-7
  SO_KIT_CATALOG_ENTRY_HEADER(zAxisSwitch07) ;
  SO_KIT_CATALOG_ENTRY_HEADER(zAxis07) ;
 
  // Z axis with vertices 3-4
  SO_KIT_CATALOG_ENTRY_HEADER(zAxisSwitch34) ;
  SO_KIT_CATALOG_ENTRY_HEADER(zAxis34) ;
 
  // Z axis with vertices 2-5
  SO_KIT_CATALOG_ENTRY_HEADER(zAxisSwitch25) ;
  SO_KIT_CATALOG_ENTRY_HEADER(zAxis25) ;
 
  // Z axis with vertices 1-6
  SO_KIT_CATALOG_ENTRY_HEADER(zAxisSwitch16) ;
  SO_KIT_CATALOG_ENTRY_HEADER(zAxis16) ;
 
 
 public:

  enum AxisType {
    LINEAR,      
    LOGARITHMIC, 
    GENERALIZED  
  } ;
 
  /* Fields */

  SoSFVec3f   start ;  

  SoSFVec3f   end   ;  

  SoSFVec3f gradStart;

  SoSFVec3f gradEnd;

  SoSFString  xTitle ; 

  SoSFString  yTitle ; 

  SoSFString  zTitle ; 
 
 

  SoSFBool    isGridLinesXVisible ; 

  SoSFBool    isGridLinesYVisible ; 

  SoSFBool    isGridLinesZVisible ; 

  SoSFBool    isBackgroundFacesVisible ;

  SoSFBool    isIntersectingGradsVisible ;

  SoSFMatrix  modellingMatrix  ;

  SoSFMatrix  viewingMatrix    ;

  SoSFMatrix  projectionMatrix ;
 
 
 
  /* Methods */

  PoAutoCubeAxis() ;

  PoAutoCubeAxis(const SbVec3f &_start, const SbVec3f &_end, AxisType xAxisType,
                 AxisType yAxisType, AxisType zAxisType, const char *xTtle = NULL, 
                 const char *yTtle = NULL, const char *zTtle = NULL) ;

  virtual void GLRender( SoGLRenderAction *action );
  virtual void rebuild() ;
 
 
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  virtual ~PoAutoCubeAxis() ;
  // Destructor
 
  // Methods
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  virtual void   setDefaultOnNonWritingFields() ;
  
 private:  
  // Init method
  void init(SbBool isDefault, const SbVec3f &_start, const SbVec3f &_end, 
            AxisType xAxisType, AxisType yAxisType, AxisType zAxisType, 
            const char *xTtle, const char *yTtle, const char *zTtle) ;
 
  // Compute the 8 vertices of the parallelepiped from the points start and end
  void computeParalVertices() ;
 
  // Compute the 6 normal of each face of the parallelepiped
  void computeParalFaceNormals() ;
 
  // Sets all attributes for the axis to build from to the edge it comes from 
  // and the coordinates of this edge (m_paralVertices)
  void buildAxis(const Pedge *edge, PoCartesianAxis *axis) ;
 
  // Draw all backgroud faces
  void drawBackgroundFaces() ;
 
  // Handle grads drawing
  void handleGradsDrawing(const int *indexVisibleEdges, int nbVisibleEdges,  PoCartesianAxis *axis[12]) ;
 
  // Eliminate intersecting graduations
  void eliminateIntersectingGrads(const int *indexVisibleEdges, const int nbVisibleEdges,
                                  PoCartesianAxis *axis[12]) ;
 
  // Draw grid lines for main and sub graduations
  void drawGridLines(PoCartesianAxis *axis[12]) ;
 
  // Reset all parts
  void resetAllParts() ;
 
  // Rebuild auto cube axis without taking into account
  // matrix transform
  void rebuildWithoutMatrix() ;
 
  // This method catch all actions on this nodekit
  // and if the nodekit is not update or modelling, viewing,
  // or projection matrix have changed then it rebuild the nodekit.
  static void catchActionCB(void *data, SoAction *action) ;
 
  // The 8 vertices of the parallelepiped
  SbVec3d m_paralVertices[8] ;
 
  // Indicate if the auto cube axis box must be rebuild
  // in function of matrix (modelling, viewing, projection) or
  // not (use for all action which not store modelling, viewing or
  // projection matrix.
  SbBool m_rebuildWithoutMatrix ;
          
  // Indicate if it the first instance of this class
  static SbBool m_firstInstance ;
  
  SoSFEnum xAxisType, yAxisType, zAxisType ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_AUTO_CUBE_AXIS_  */