SoTexture.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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_TEXTURE_
#define  _SO_TEXTURE_
 
#include <Inventor/fields/SoSFVec4f.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFImage.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFColor.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/sys/SoGLType.h>
#include <Inventor/elements/SoTextureImageElement.h>
#include <SoDeprecationRules.h>
#include <Inventor/SbEnums.h>
#include <Inventor/renderer/RendererResourceMacro.h>
 
class SoFieldSensor;
class SoNodeSensor;
class SbRasterImage;
class SoGLTexture;
 
namespace inventor {
  namespace impl{
    class SoExtTexture2Impl;
    class SoIndexedTexture2Impl;
    class SoRenderToTexturePropertyImpl;
  };
  namespace renderer{
    class RendererContext;
  }
};
 
namespace inventor {
namespace renderer{
  template<typename T> struct Resource;
  class FixedPipelineShader;
};
};
#ifndef GL_COMBINE
#define GL_COMBINE 0x8570
#endif
#ifndef GL_CLAMP_TO_BORDER
#define GL_CLAMP_TO_BORDER 0x812D
#endif
#ifndef GL_CLAMP_TO_EDGE
#define GL_CLAMP_TO_EDGE 0x812F
#endif
#ifndef GL_MIRRORED_REPEAT
#define GL_MIRRORED_REPEAT 0x8370
#endif
 
SO_PIMPL_BASE_PUBLIC_DECLARATION(SoTexture)
 
 
//
//  Class: SoTexture
//
//  Texture node.
//
 
class  SoTexture : public SoNode {
 
  SO_NODE_ABSTRACT_HEADER(SoTexture);
 
  SO_PIMPL_BASE_PUBLIC_HEADER(SoTexture);
  RENDERER_RESOURCE(SoTexture);
public:
  enum InternalFormat {
    AUTO_INTERNAL_FORMAT,
    ALPHA_FORMAT,SoDEPRECATED ALPHA4, 
    ALPHA8,  
    ALPHA12,  
    ALPHA16,  
    LUMINANCE_FORMAT,  SoDEPRECATED LUMINANCE4,  
    LUMINANCE8,  
    LUMINANCE12,  
    LUMINANCE16,  
    LUMINANCE_ALPHA, 
    LUMINANCE4_ALPHA4,  
    LUMINANCE6_ALPHA2,  
    LUMINANCE8_ALPHA8,  
    LUMINANCE12_ALPHA4, 
    LUMINANCE12_ALPHA12, 
    LUMINANCE16_ALPHA16, 
    INTENSITY_FORMAT,  SoDEPRECATED INTENSITY4, 
    INTENSITY8, 
    INTENSITY12, 
    INTENSITY16,  
    R3_G3_B2,  
    RGB_FORMAT,  
    RGB4,  
    RGB5,  
    RG8,
    RGB8,  
    RGB10,  
    RGB12,  
    RGB16,  
    RGBA_FORMAT,  
    RGBA2,  
    RGBA4,  
    RGB5_ALPHA1,  
    RGBA8,  
    RGB10_ALPHA2,  
    RGBA12,  
    RGBA16, 
    RGBA_FLOAT32, 
    RGB_FLOAT32, 
    ALPHA_FLOAT32, 
    INTENSITY_FLOAT32, 
    LUMINANCE_FLOAT32, 
    LUMINANCE_ALPHA_FLOAT32, 
    RGBA_FLOAT16, 
    RGB_FLOAT16, 
    ALPHA_FLOAT16, 
    INTENSITY_FLOAT16, 
    LUMINANCE_FLOAT16, 
    LUMINANCE_ALPHA_FLOAT16, 
    COMPRESSED_ALPHA, 
    COMPRESSED_LUMINANCE,    
    COMPRESSED_LUMINANCE_ALPHA, 
    COMPRESSED_INTENSITY, 
    COMPRESSED_RGB, 
    COMPRESSED_RGBA,
    COMPRESSED_LUMINANCE_LATC1,
    COMPRESSED_SIGNED_LUMINANCE_LATC1,
    COMPRESSED_LUMINANCE_ALPHA_LATC2,
    COMPRESSED_SIGNED_LUMINANCE_ALPHA_LATC2,
    COMPRESSED_RED_RGTC1,
    COMPRESSED_SIGNED_RED_RGTC1,
    COMPRESSED_RED_GREEN_RGTC2,
    COMPRESSED_SIGNED_RED_GREEN_RGTC2,
    DEPTH_COMPONENT16,
    DEPTH_COMPONENT24,
    DEPTH24_STENCIL8,
    R8I,
    R8UI,
    R16I,
    R16UI,
    R32I,
    R32UI,
    RG8I,
    RG8UI,
    RG16I,
    RG16UI,
    RG32I,
    RG32UI,
    RGB8I,
    RGB8UI,
    RGB16I,
    RGB16UI,
    RGB32I,
    RGB32UI,
    RGBA8I,
    RGBA8UI,
    RGBA16I,
    RGBA16UI,
    RGBA32I,
    RGBA32UI,
#ifndef HIDDEN_FROM_DOC 
    LAST_FORMAT
#endif
  };
 
  enum Model {
    MODULATE = SbEnums::TEX_MODEL_MODULATE,
 
    DECAL = SbEnums::TEX_MODEL_DECAL,
 
    BLEND = SbEnums::TEX_MODEL_BLEND,
 
    REPLACE = SbEnums::TEX_MODEL_REPLACE,
 
    ADD = SbEnums::TEX_MODEL_ADD,
 
    COMBINE = SbEnums::TEX_MODEL_COMBINE
 
  };
 
  enum Wrap {
    REPEAT = SbEnums::TEX_ADDRESS_REPEAT,
 
    CLAMP = SbEnums::TEX_ADDRESS_CLAMP,
 
    CLAMP_TO_BORDER         = SbEnums::TEX_ADDRESS_CLAMP_BORDER,
 
    CLAMP_TO_EDGE         = SbEnums::TEX_ADDRESS_CLAMP_TO_EDGE,
 
    MIRRORED_REPEAT         = SbEnums::TEX_ADDRESS_MIRROR_REPEAT
 
  };
 
  enum Filter
  {
    AUTO = SbEnums::TEX_FILTER_AUTO,
    NEAREST = SbEnums::TEX_FILTER_NEAREST,
    LINEAR = SbEnums::TEX_FILTER_LINEAR,
    NEAREST_MIPMAP_NEAREST = SbEnums::TEX_FILTER_NEAREST_MIPMAP_NEAREST,
    NEAREST_MIPMAP_LINEAR = SbEnums::TEX_FILTER_NEAREST_MIPMAP_LINEAR,
    LINEAR_MIPMAP_NEAREST = SbEnums::TEX_FILTER_LINEAR_MIPMAP_NEAREST,
    LINEAR_MIPMAP_LINEAR = SbEnums::TEX_FILTER_LINEAR_MIPMAP_LINEAR
  } ;
  
  enum HW_Feature {  
    HW_NPOT = 0,
 
    HW_FLOATFORMAT,
 
    HW_DEPTHFORMAT,
 
    HW_AUTOMIPMAP,
 
    HW_BORDER_CLAMP,
 
    HW_EDGE_CLAMP,
 
    HW_MIRRORED_REPEAT,
 
    HW_COMPRESSION_S3TC,
 
    HW_COMPRESSION_LATC,
 
   HW_COMPRESSION_RGTC,
 
#ifndef HIDDEN_FROM_DOC 
    HW_LAST
#endif
  };
 
  SoSFEnum internalFormat;
 
  SoSFBool enableCompressedTexture;
 
  SoSFEnum wrapS;
 
  SoSFEnum model;
 
  SoSFColor blendColor;
 
  SoSFBool enableBorder;
 
  SoSFVec4f borderColor;
 
  SoSFFloat maxAnisotropy;
 
  SoSFEnum minFilter;
 
  SoSFEnum magFilter;
 
  enum FileType
  {
    UNKNOWN,
    RGB,
    SGI,
    TIFF,
    GIF,
    JPEG,
    BMP,
    PNG,
    JPEG2000,
    DDS,
    HDRI,
    NUM_FILETYPES
  };
 
  void setBitmapFileType(FileType in_type);
 
  FileType getBitmapFileType(void);
 
  static SbBool isSupported(HW_Feature feature);
 
  inline virtual void setOverride(const SbBool state)
  { override.setValue(state); }
 
  inline virtual SbBool isOverride() const
  { return override.getValue(); }
 
  static SbRasterImage* readTexture( const SbString& filename, FileType filetype = UNKNOWN );
 
private:
  virtual void        doAction(SoAction *action)=0;
  virtual void        GLRender(SoGLRenderAction *action)=0;
  virtual void        callback(SoCallbackAction *action);
 
private:
  static void initClass();
  static void exitClass();
 
  virtual bool affectsPath() const;
 
  SoSFBool override;
 
  SoSFBool forInternalShader;
 
  enum NumSamplesSpecialValues
  {
    INHERIT_FROM_CURRENT_TARGET = -2,
  };
 
  SoSFInt32 numSamples;
 
  int getNumSamples();
 
  static int getNumSamples(SoState* state);
 
  void updateFromState(SoState* state);
 
  enum SubImageCopyPolicy
  {
    SUBIMAGE_NO_COPY,
    SUBIMAGE_COPY,
    SUBIMAGE_NO_COPY_AND_DELETE,
  };
 
  void subImage(const std::vector<SoTextureImageElementBase::TextureDataConfiguration>& subTextures,
                SubImageCopyPolicy copyPolicy = SUBIMAGE_COPY);
 
private:
  SoTexture();
 
  virtual ~SoTexture();
 
private:
 
#if 1             SoDEPRECATED
  SoSFBool useAutoMipmap;
#endif 
  void commonConstructor();
 
  friend class inventor::impl::SoExtTexture2Impl;
  friend class inventor::impl::SoIndexedTexture2Impl;
  friend class inventor::impl::SoRenderToTexturePropertyImpl;
  friend struct inventor::renderer::Resource<SoTexture>;
  friend class inventor::renderer::FixedPipelineShader;
  friend class inventor::renderer::RendererContext;
};
 
#endif /* _SO_TEXTURE_ */