Inventor/nodes/SoExtTexture2.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : C. OGNIER (Oct 2000)
**=======================================================================*/

#ifndef _SO_EXTTEXTURE_2_
#define _SO_EXTTEXTURE_2_

#include <Inventor/nodes/SoTexture.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFFilePathString.h>
#include <Inventor/fields/SoSFTime.h>
#include <Inventor/threads/SbThreadStorage.h>
#include <Inventor/caches/SoGLTexCacheList.h>

#include <Inventor/image/SbRasterImage.h>
#include <Inventor/sys/SoGLType.h>

class SoSensor;
class SoDither;

#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif

//
//  Class: SoExtTexture2
//
//  Extented 2D Texture node.
//

class SoExtTexture2;
typedef SbBool ExtPrequalifyFileCallback(const SbString &, void *, SoExtTexture2 *);

class  SoExtTexture2 : public SoTexture {
  
  SO_NODE_HEADER(SoExtTexture2);
  
 public:
  typedef void SoExtTexture2CB(void *userData, SoExtTexture2 *tex);

   enum Sync 
   {
    SYNCHRONOUS = 0,

    ASYNCHRONOUS
  };

  enum Loading {    
    AUTO = 0,

    MANUAL
  };

  SoSFFilePathString filename;

  SoSFEnum wrapT;

  SoSFBool loadingStatus;

  SoSFEnum syncMode;

  SoSFEnum loadingMode;

  SoSFInt32 loadingThreadPriority;

  SoExtTexture2();

  static void setPrequalifyFileCallBack(ExtPrequalifyFileCallback *p_cb, void *u_data);

  void allowPrequalifyFile(SbBool);
  
  void getImageSize(SbVec2s &size, int &nc);
  
  static void setMemorySpace(double megaBytes);

  static double getMemorySpace();

  static double getGlobalMemoryUsed();
  
  static void useTexturePalette(SbBool value);
  
  // Load callbacks
  
  void addOnLoadStartCB(SoExtTexture2CB* cb, void* userData);
  
  void addOnLoadFinishCB(SoExtTexture2CB* cb, void* userData);
  
  void addOnUnloadCB(SoExtTexture2CB* cb, void* userData);

  // Manual loading
  
  void loadTexture();

 private:
  virtual void doAction(SoAction *action);
  virtual void GLRender(SoGLRenderAction *action);
  virtual void write(SoWriteAction* action);
  
 private:
  
  enum textureFormat {   // Image format
    RGB_FORMAT,
    PALETTED,
    COLORTABLE
  };
    
  static void initClass();
  static void exitClass();

  const SbString &getOverrideURL() { return overrideURL; }
  void setOverrideURL(const SbString &path) { overrideURL = path; }
  
  // Loads and process the texture ()
  static void *manageLoading(void *userData, SbBool isCallTouch=TRUE);

  // Loads and process the texture ()
  // Call manageLoading with isCallTouch=TRUE.
  // A new prototype is necessary because SbThread::create() accept only
  // 1 parameter.
  static void *manageLoadingThread(void *userData);
    
  // Get system time at last traversal
  SoSFTime sysTime;
  
  // Returns the next index available for a texture name (multiviewer)
  int getNextTexNameIndex();

  // Manages field dependencies, when one of them change
  virtual void fieldHasChanged( SoField *field ); // override of SoFieldContainer

  // OpenGL Extensions
  static int glLUTExt; 
  
 private:

  // Reads stuff into instance. Returns FALSE on error.
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
  
  virtual ~SoExtTexture2();
  
  virtual void copyContents(const SoFieldContainer *fromFC, 
                            SbBool copyConnections);
 
 private:
  // Check OpenGL Extensions
  static void checkOGLExtensions() ;

  // Display list info for this texture:
  SbThreadStorage< SoGLTexCacheList* > m_texList;
  SbThreadRWMutex* m_mutex;

  // Temporary data 
  //unsigned char *m_bytes;
  unsigned char *m_palette;
  
  // File loading thread
  SbThread *m_loadingThread;
  
  SbString overrideURL;
  
  static ExtPrequalifyFileCallback *prequalifyFileCB;
  static void *prequalifyFileCB_udata;
  SbBool prequalifyFileFlag;
  
  static void readTextureFile(SoExtTexture2 *tex); 
  
  SoDither *m_dither;
  
  // These keep the filename field in sync.
  void filename_HasChanged(void);
  void wrap_HasChanged(void);
  void maxAnisotropy_HasChanged(void);

  // Load callbacks attributes
  SoExtTexture2CB *m_loadStartCB;
  SoExtTexture2CB *m_loadFinishCB;
  SoExtTexture2CB *m_unloadCB;

  void *m_loadStartCBData;
  void *m_loadFinishCBData;
  void *m_unloadCBData;

  static GLint maxTexSize;  // depends on the video board
   
  // Current memory used by all texture objects
  static long m_globalMemoryUsed;
  
  // Memory used by the node
  long m_memoryUsed;
  
  // List of all SoExtTexture2 nodes
  static SbPList m_nodeList;
  
  // Maximum memory space allocated for the texture objects
  static long memorySpace;
  
  static int m_numNodes;
  static int m_numTexObjs;
  static int m_numNodeMax;
  
  // Use of texture lut ?
  static SbBool m_useTextureLUT;
  
  static void manageNodeListAlloc(SoExtTexture2 *node);

  SbRasterImage* m_rasterImage;

  // store a stack of directory to use for finding the file
  SbStringList currentDirStack;

  int m_numRenderCaches;
};

#ifdef _MSC_VER
#pragma warning( pop )
#endif

#endif /* _SO_EXTTEXTURE_2_ */

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/