PoMeshContouring.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_MESHCONTOURING_
#define  _PO_MESHCONTOURING_
 
#include <MeshViz/3Ddata/PoMesh2D.h>
#include <MeshViz/graph/PbNumericDisplayFormat.h>
#include <MeshViz/graph/PbMiscTextAttr.h>
 
#include <Inventor/projection/SbProjection.h>
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFUShort.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFVec2f.h>
 
class  PoMeshContouring : public PoMesh2D {
 
  SO_KIT_HEADER(PoMeshContouring) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(transform) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(majorContourLineSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(majorContourLineApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(majorContourLine) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(minorContourLineSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(minorContourLineApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(minorContourLine) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(annotBackgroundSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(annotBackgroundApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(annotBackground) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(annotBackgroundBorderSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(annotBackgroundBorderApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(annotBackgroundBorder) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(annotTextSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(annotTextApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(annotText) ;
 
 
 public:
 
  PoMeshContouring() ;
 
  virtual void   rebuild() ;
 
  enum AnnotPath {
    TANGENTIAL_PATH,  
    HORIZONTAL_PATH,  
    VERTICAL_PATH     
  } ;
 
  
 
  enum AnnotCrossStatus {
    CROSS_CONTOUR,         
    CROSS_MINOR_CONTOUR,   
    DONT_CROSS_CONTOUR     
  } ;
 
 
 
  SoSFUShort  majorPeriod ;
 
  SoSFUShort  firstMajor ;
 
  SoSFBool    annotIsVisible ;
 
  SoSFEnum    annotPath ;
 
  SoSFEnum    annotCrossStatus ;
 
  SoSFBool    annotIsBackground ;
 
  SoSFBool    annotIsContourClip ;
 
  SoSFFloat   annotGap ;
 
  SoMFVec2f   annotClippingPolygon ;
 
  SoSFFloat   annotFontSize ;
 
  SoSFFloat   annotFontFactor;
 
  void setFormat(PbNumericDisplayFormat *format) ;
 
  const PbNumericDisplayFormat *getFormat() const;
 
  void setMiscTextAttr(PbMiscTextAttr *textAttr) ;
 
  const PbMiscTextAttr* getMiscTextAttr() const;
 
  /*----------------------------------------------------------------------------*/
 private:
  struct Parallelogram3 { Ppoint3 points[5] ; } ;
 
  static void initClass() ;
    static void exitClass() ;
 
 private:
  // Methods
 
  // Destructor
  virtual ~PoMeshContouring() ;  
  virtual void   basicObjectChange(PbBase *basicObj) ;
  virtual void   setDefaultOnNonWritingFields();
  virtual void   addElementsAllCaches() ;
  virtual void   preRebuild();
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
 
  const PbMiscTextAttr           *m_miscTextAttr;
  const PbNumericDisplayFormat   *m_format;
 
  // Projection to apply
  SbProjection                   *m_projection, m_defaultProjection;
 
  const SbProjection* getProjection() const ;
 
  /*----------------------------------------------------------------------------*/
 private:
  struct StoreAnnotSpace {
    Parallelogram3 space ;     // Coords of the annotation
    float          isovalue ;  // Value of the annotation
    Plimit         bbox ;   // Bounding box of the annotation
  } ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
 
  SoMFVec2f m_annotClippingPolygon ;
 
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
 
  PbMiscTextAttr           *m_miscTextAttrSet, m_defaultMiscTextAttr ;
  PbNumericDisplayFormat   *m_formatSet, m_defaultFormat ;
 
  void getMeshLimit(Ppoint_list_list3 &limit);
  void freeMeshLimit(Ppoint_list_list3 &limit);
 
  //**************************************************************************
  //* All following methods are used to build annotations of contour lines   *
  //**************************************************************************
 
  // Determine if the place (annot_space) of the annotation is available.
  SbBool isAvailableAnnotArea(const StoreAnnotSpace *occuped_annot_space, 
                              int nb_annot, const Plimit *annot_space) ;
 
  // Compute the coordinates of the parallelogram of an annotation
  void calculateAnnotBox(const Ppoint3 *p_center, const Ppoint3 *pt_inter_circle1, 
                         const Ppoint3 *pt_inter_circle2, float annot_width, 
                         float annot_height, Ppoint *annot_space, 
                         Ppoint *annot_space_with_margin) ;
 
  // Generate shapes to draw the annotations
  void drawAnnotation(const char *annot_str, const Ppoint3 *annot_pos, 
                      const Ppoint3 *annot_space, SoCoordinate3 *backgroundCoords, 
                      SoCoordinate3 *backgroundBorderCoords) ;
 
  // Determine if an annotation intersects other contour lines
  SbBool isIntersAnnotContourLines(const Tisoline_list *contourLinesList, 
                                   const Ppoint_list3 *currentContourLine, 
                                   const Plimit *annotBBox,
                                   const Ppoint *annot_space, float isovalue) ;
 
  // Determine undefined values inferior and superior.
  void searchUpperLowerIsoval(const Tisoline_list *contourLineList, SbBool isMinThreshold, 
                              SbBool isMaxThreshold) ;
 
  // Clip contour lines by annotations
  void clipContourLinesByAnnot(SbBool isMajor, SbBool is3DContourLines, 
                               const Tisoline_list *contourLineList,
                               const StoreAnnotSpace *occuped_annot_space, 
                               int nb_annot) ;
 
  // Determine if an annotation is within polygon of annotation 
  SbBool annotWithinClipPolygon(const Ppoint *annot_space, const Plimit *annotBBox, 
                                const Plimit *clipPolygBBox) ;
 
  // Main method to generate the annotations of contour lines
  void computeContourLineAnnot(const Tisoline_list *majorContourLineList, 
                               const Tisoline_list *minorContourLineList, 
                               const Tisoline_list *allContourLineList, 
                               const Ppoint_list_list3 *mesh_contour, 
                               SbBool is3DContourLines, SbBool work_in_wc_flag) ;
  
  // Draw contour lines
  void drawContourLines(Tisoline_list *contourLinesList, 
                        const Ppoint_list_list3 *meshLimit) ;
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_MESHCONTOURING_ */