PoArrow.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_ARROW_
#define  _PO_ARROW_
 
#include <MeshViz/graph/PoGraphMaster.h>
 
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFVec2f.h>
 
 
class  PoArrow : public PoGraphMaster {
  
  SO_KIT_HEADER(PoArrow) ;
  
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(bodySep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(bodyApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(body)    ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(startSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(startApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(start)    ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(endSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(endApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(end)    ;
 
 
 public:
 
  enum PatternType {
    NO_PATTERN,        
    DIRECT_TRIANGLE,   
    INDIRECT_TRIANGLE, 
    RECTANGLE          
  } ;
 
  /* Fields */
 
  SoMFVec2f point ;
 
  SoSFEnum  startPatternType ;
 
  SoSFEnum  endPatternType ;
 
  SoSFFloat patternWidth ;
 
  SoSFFloat patternHeight ;
 
 
 
  /* Methods */
 
  PoArrow()
    { init(TRUE) ; }
 
  PoArrow(int numPoints, const SbVec2f *_point, PatternType startType = NO_PATTERN,
          PatternType endType = NO_PATTERN, float _patternWidth = 0.05f, 
          float _patternHeight = 0.03f)
    { init(FALSE, numPoints, _point, startType, endType, _patternWidth, _patternHeight) ; } 
 
  virtual void rebuild() ;
 
  /*----------------------------------------------------------------------------*/
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  // Methods
  // Destructor
  virtual ~PoArrow() ;
  virtual void   setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
 
 private:
  // Enumeration
  enum RefererenType {
    RELATIVE_WC,
    RELATIVE_01
  } ;
  
  // Init method
  void init(SbBool isDefault, int numPoints = 0, const SbVec2f *_point = NULL, 
            PatternType startType = NO_PATTERN,  PatternType endType = NO_PATTERN, 
            float _patternWidth = 0.05f, float _patternHeight = 0.03f) ;
  
  // Build pattern shape for the arrow
  void arrowShape(RefererenType refType, PatternType patType, const SbVec2f &start, 
                  const SbVec2f &end, SoGroup *group) ;
 
  // Sensors
  FieldSensorList fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /*  _PO_ARROW_ */