SoMarkerSet.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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : R. ALBOU (May 1998)
**=======================================================================*/
 
/* include files */
#ifndef _SO_MARKER_SET_
#define _SO_MARKER_SET_
 
#include <Inventor/nodes/SoPointSet.h>
#include <Inventor/fields/SoMFInt32.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFFloat.h>
 
class SbThreadMutex;
class SoMarker;
 
namespace markerset {
    class SoMarkerSetRenderer;
}
class SoMarkerSizeCache;
/*----------------------------------------------------------------------------*/
 
class  SoMarkerSet : public SoPointSet {
  SO_NODE_HEADER(SoMarkerSet) ;
 
 public:
  SoMFInt32 markerIndex;
 
  SoMFFloat markerScale;
 
  SoSFFloat markerGlobalScale;
 
  SoMarkerSet() ;
 
  enum MarkerType {
    CROSS_5_5,
    PLUS_5_5,
    MINUS_5_5,
    SLASH_5_5,
    BACKSLASH_5_5,
    BAR_5_5,
    STAR_5_5,
    Y_5_5,
    LIGHTNING_5_5,
    WELL_5_5,
 
    CIRCLE_LINE_5_5,
    SQUARE_LINE_5_5,
    DIAMOND_LINE_5_5,
    TRIANGLE_LINE_5_5,
    RHOMBUS_LINE_5_5,
    HOURGLASS_LINE_5_5,
    SATELLITE_LINE_5_5,
    PINE_TREE_LINE_5_5,
    CAUTION_LINE_5_5,
    SHIP_LINE_5_5,
 
    CIRCLE_FILLED_5_5,
    SQUARE_FILLED_5_5,
    DIAMOND_FILLED_5_5,
    TRIANGLE_FILLED_5_5,
    RHOMBUS_FILLED_5_5,
    HOURGLASS_FILLED_5_5,
    SATELLITE_FILLED_5_5,
    PINE_TREE_FILLED_5_5,
    CAUTION_FILLED_5_5,
    SHIP_FILLED_5_5,
 
    CROSS_7_7,
    PLUS_7_7,
    MINUS_7_7,
    SLASH_7_7,
    BACKSLASH_7_7,
    BAR_7_7,
    STAR_7_7,
    Y_7_7,
    LIGHTNING_7_7,
    WELL_7_7,
 
    CIRCLE_LINE_7_7,
    SQUARE_LINE_7_7,
    DIAMOND_LINE_7_7,
    TRIANGLE_LINE_7_7,
    RHOMBUS_LINE_7_7,
    HOURGLASS_LINE_7_7,
    SATELLITE_LINE_7_7,
    PINE_TREE_LINE_7_7,
    CAUTION_LINE_7_7,
    SHIP_LINE_7_7,
 
    CIRCLE_FILLED_7_7,
    SQUARE_FILLED_7_7,
    DIAMOND_FILLED_7_7,
    TRIANGLE_FILLED_7_7,
    RHOMBUS_FILLED_7_7,
    HOURGLASS_FILLED_7_7,
    SATELLITE_FILLED_7_7,
    PINE_TREE_FILLED_7_7,
    CAUTION_FILLED_7_7,
    SHIP_FILLED_7_7,
 
    CROSS_9_9,
    PLUS_9_9,
    MINUS_9_9,
    SLASH_9_9,
    BACKSLASH_9_9,
    BAR_9_9,
    STAR_9_9,
    Y_9_9,
    LIGHTNING_9_9,
    WELL_9_9,
 
    CIRCLE_LINE_9_9,
    SQUARE_LINE_9_9,
    DIAMOND_LINE_9_9,
    TRIANGLE_LINE_9_9,
    RHOMBUS_LINE_9_9,
    HOURGLASS_LINE_9_9,
    SATELLITE_LINE_9_9,
    PINE_TREE_LINE_9_9,
    CAUTION_LINE_9_9,
    SHIP_LINE_9_9,
 
    CIRCLE_FILLED_9_9,
    SQUARE_FILLED_9_9,
    DIAMOND_FILLED_9_9,
    TRIANGLE_FILLED_9_9,
    RHOMBUS_FILLED_9_9,
    HOURGLASS_FILLED_9_9,
    SATELLITE_FILLED_9_9,
    PINE_TREE_FILLED_9_9,
    CAUTION_FILLED_9_9,
    SHIP_FILLED_9_9
  };
 
  static int getNumDefinedMarkers();
 
  static void addMarker(int markerIndex, const SbVec2s &size, const unsigned char *bytes,
                        SbBool isLSBFirst = TRUE, SbBool isUpToDown = TRUE);
 
  static void addMarker(int markerIndex, const SbVec2s &size,
                        const unsigned char *bytes,
                        const uint32_t *orderedRGBA,
                        SbBool isLSBFirst = TRUE, SbBool isUpToDown = TRUE);
 
  static void addMarker(int markerIndex, SoMarker* marker );
 
  static SbBool getMarker(int markerIndex,
                          SbVec2s &size,
                          const unsigned char *&bytes,
                          SbBool &isLSBFirst);
 
  static SbBool getMarker(int markerIndex,
                          SbVec2s &size,
                          const unsigned char *&bytes,
                          const uint32_t *&orderedRGBA,
                          SbBool &isLSBFirst);
 
  static SoMarker* getMarker( int markerIndex );
 
  static SbBool removeMarker(int markerIndex);
 
private:
  // Generates markers representing marker set
  virtual void generatePrimitives(SoAction *action);
 
  // Destructor.
  virtual ~SoMarkerSet();
 
private:
  virtual void  GLRender(SoGLRenderAction *action);
  virtual void  getPrimitiveCount(SoGetPrimitiveCountAction *action);
 
  // Computes bounding box
  virtual void  computeBBox( SoAction *action, SbBox3f &box, SbVec3f &center );
 
  static SbBool isMarkerBitSet(int markerIndex, int bitNumber);
 
private:
  static void initClass();
  static void exitClass();
 
  // manage notification
  virtual void notify(SoNotList *list);
 
private:
 
  markerset::SoMarkerSetRenderer* m_MarkerSetShaderRenderer;
 
  void updateRenderer(markerset::SoMarkerSetRenderer* renderer, SoNotList* list);
 
  markerset::SoMarkerSetRenderer* chooseRenderer(SoState* state);
 
  // Cache storage for marker sizes during rayPick action
  SoRayPickAction* m_currentPickAction;
  SoMarkerSizeCache* m_markerSizeCache;
};
 
#endif // !_SO_MARKER_SET_