SoToHTMLAction.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : R. ALBOU (Sep 1998)
**=======================================================================*/
 
#ifndef  _SO_TO_HTML_ACTION_
#define  _SO_TO_HTML_ACTION_
 
#include <Inventor/SbColor.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/actions/SoAction.h>
#include <Inventor/SoOffscreenRenderArea.h>
 
#include <Inventor/actions/SoSubAction.h>
 
#include <Inventor/SoLists.h>
#include <Inventor/SbBox.h>
 
class SoNode ;
class SoAction ;
 
/*----------------------------------------------------------------------------*/
 
class  SoToHTMLAction : public SoAction {
 
  SO_ACTION_HEADER(SoToHTMLAction);
 
 public: 
  typedef void* SoToHTMLReallocCB(void *ptr, size_t newSize) ;
 
  enum ShapeType { 
    NONE, 
    RECTANGLE,  
    CIRCLE,
    POLYGON         
  } ;
 
  enum Components { 
    LUMINANCE = 1, 
    LUMINANCE_TRANSPARENCY = 2,
    RGB = 3, 
    RGB_TRANSPARENCY = 4
  };
 
  enum ImageFormat { 
    BMP_FORMAT, 
    JPEG_FORMAT
  };
        
  SoToHTMLAction() ;
        
  ~SoToHTMLAction() ;
        
  SoNONUNICODE SbBool openHTMLFile(const char *filename) ;
 
 
  SbBool openHTMLFile( const SbString& filename );
 
  void closeHTMLFile() ;
        
  void setHTMLFilePointer(FILE *newFP) ;
  FILE* getHTMLFilePointer() const ;
 
  void setHTMLBuffer(void *bufPointer, size_t initSize,
                     SoToHTMLReallocCB *reallocFunc, int32_t offset=0) ;
  SbBool getHTMLBuffer(void *&bufPointer, size_t &nBytes) const ;
  void   resetHTMLBuffer() ;
 
  void setImageURLName(const char *name) ;
  const char *getImageURLName() const ;
 
  void setImageFilePointer(FILE *newFP) ;
  FILE* getImageFilePointer() const ;
        
  void setRegionShapeType(ShapeType type) ;
  ShapeType getRegionShapeType() const ;
 
  void setImageBackgroundColor(const SbColor &c);
  const SbColor & getImageBackgroundColor() const ;
 
  void setImageComponents( Components components );
  Components getImageComponents() const ;
 
  void setImageFormat(ImageFormat format) ;
  ImageFormat getImageFormat() const ;
 
  void setImageQuality(float quality) ;
  float getImageQuality() const ;
 
  void setViewportRegion(const SbViewportRegion &region);
  const SbViewportRegion& getViewportRegion() const;
 
  void setMapHighlight(SbBool onOff);
  SbBool isMapHighlight();
 
  virtual void apply(SoNode *scene) ;
  virtual void apply(SoPath *path) ;
  virtual void apply(const SoPathList &pathList, SbBool flag = FALSE) ;
 
 private:
  // Internally used to initialize the class.
  static void initClass() ;
  static void exitClass() ;
 
 private:
  // Callbacks
  static void stencilCB(void *d, SoAction* action) ;
  static void stencilEndCB(void *d, SoAction* action) ;
  static void initStencilCB(void *d, SoAction* action) ;
 
  // Compute bounding for each anchor from the stencil
  // buffer
  void computeAnchorsBBoxList() ;
 
  // Adds/removes a callback node as first child of 
  // each anchor group node
  void addCallbackAtFirstForAnchors() ;
  void removeAnchorsCallbacks() ;
 
  // Adds/removes a callback as first child of
  // the root scene graph
  void addInitStencilCallback() ;
  void removeInitStencilCallback() ;
 
  // Retreives anchor URL at a specific index
  // From the scene graph
  const char* retreiveAnchorURL(int index) ;
 
  // Read the stencil buffer
  void readStencilBuffer() ;
 
  // HTML Instructions
  void writelnHTMLTag(const char *tag) ;
  void writeHTMLTag(const char *tag)  ;
  void writeHTMLMaps() ;
  void writeHTMLImage() ;
  void writeHTML(const char *str) ;
 
  // Generate the HTML output
  void generateHTMLOutput() ;
 
  // Seachs all SoWWWAnchor
  // and updates the anchor list.
  void updateAnchorsList() ;
 
  // Compute an approximation from a polygon with angle of two consecutive
  // segments inferior to the chordal deviation.
  // The indices and their number corresponding to approximation of the original 
  // polygon are returned.
  int* computeApproximatePolygon(const SbVec2s *polygon, int numPolyPoints,
                                 int &numApproxIndices) ;
 
  // Fill a bounding box of the stencil buffer with all values == valueToReplace 
  // by replaceValue.
  void fillStencilBuffer(const SbBox2s &box, int valueToReplace, int replaceValue) ;
 
  // Return the base name of an URL
  // ex : https://www.openinventor.com//file.jpg return file.jpg
  const char* getImageURLBaseName() const ;
 
  // File descriptor for the image and the HTML file
  FILE* m_HTMLFP ;
  FILE* m_imageFP ;
 
  // Indicates if the stencil has been initialize
  // in order to prevent from several initializations 
  // (SoAnnotation node could cause this problem)
  SbBool m_isStencilInit ;
 
  // Image URL name
  SbString m_imageURLName ;
 
  // Nodelist for SoWWWAnchor
  SoNodeList m_anchorList ;
 
  // Array of bounding box for each anchors
  SbBox2s *m_boxAnchorList ;
 
  // Current scene graph
  SoNode *m_scene ;
 
  SoRef<SoOffscreenRenderArea> m_osRenderArea;
 
  // Current stencil buffer
  unsigned char* m_stencilBuffer ;
 
  // Viewport region for image
  SbViewportRegion m_vpRegion ;
 
  // Image components
  Components       m_imageComponents ;
 
  // Image background color
  SbColor m_imageBackgroundColor ;
 
  // Image format
  ImageFormat m_imageFormat ;
 
  // Image quality
  float m_imageQuality ;
 
  // Region shape type
  ShapeType m_regionShapeType ;
 
  // Map number
  static int m_mapNumber ;
 
  // Indicate whether an HTML file has been
  // opened with openHTMLFile().
  SbBool m_isOpenHTMLFile ;
 
  // Map highlighting
  SbBool m_isMapHighlight;
 
  /* Management of a buffer for HTML file */
  SbBool m_isHTMLBuffer ;
  void*  m_HTMLBuffer ;
  char*  m_curHTMLBuffer ;
  size_t m_HTMLBufferSize ;
  SoToHTMLReallocCB *m_reallocHTMLFunc ;
 
  SbBool makeRoomInBuf(size_t nBytes) ;
 
};
 
#endif // _SO_TO_HTML_ACTION_