SoMarker.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-2022 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Feb 2008)
**=======================================================================*/
 
 
#ifndef  _SO_MARKER_H_
#define  _SO_MARKER_H_
 
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoMFUInt32.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFUByte.h>
#include <Inventor/fields/SoSFVec2s.h>
#include <Inventor/fields/SoSFInt32.h>
 
class SoState;
class SoGLObjectCache;
 
#define MARKER_HASH_TAB_SIZE 151
 
class  SoMarker : public SoNode
{
  SO_NODE_HEADER(SoMarker);
 
public:
 
  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
  };
 
  SoMarker();
 
  SoMFUByte bitmap;
 
  SoMFUInt32 orderedRGBA;
 
  SoSFBool upToDown;
 
  SoSFBool isLSBFirst;
 
  SoSFVec2s size;
 
  SoSFInt32 index;
 
private:
 
  static void initClass();
  static void exitClass();
 
  virtual void notify( SoNotList* list );
  
  int getMarkerIndex() 
  { return m_markerIndex; }
 
  void setMarkerIndex( const int tindex ) 
  { m_markerIndex = tindex; }
 
  static int getNumDefinedMarkers();
 
  static int getMaxIndexDefinedMarker();
 
  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 removeMarker(int markerIndex);
  
  static SoMarker* getMarkerDesc( int markerInd );
 
  static SbBool isMarkerBitSet(int markerIndex, int bitNumber) ;
 
  // Update the list of all instancied SoMarkerSet
  static void updateListInstanciedMarkerSet();
  static void addMarkerSetDependency(SoNode* );
  static void removeMarkerSetDependency(SoNode* );
 
private:
  virtual ~SoMarker();
 
  SbBool useDL;
 
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
 
private:
 
  // Index of the marker
  int m_markerIndex;
 
  // Marker associated displayList
  SoGLObjectCache* m_objCache;
 
  // Marker hash table
  static SbPList m_markerHashTab[MARKER_HASH_TAB_SIZE];
 
  // Create/Destroy the list of predefined markers
  static void createListOfPreDefinedMarkers();
  static void destroyListOfPreDefinedMarkers();
  static bool m_isBuildingPredefinedMarkers;
 
  // Return the marker hash table index from a marker index
  static inline int getMarkerHashTabIndex(int markerIndex);
 
  // List of instancied SoMarkerSet
  static SbPList m_listInstanciedMarkerSet;
 
  void setPredefined(bool b);
 
  bool m_predefined;
  bool m_prevUpToDown;
 
  // Cache last marker used by isMarkerBitSet() method
  static int s_cachedCurrentMarkerIndex;
};
 
#endif // !_SO_MARKER_H_