Inventor/nodes/SoTexture.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      : 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/nodes/SoNode.h>
#include <Inventor/sys/SoGLType.h>
#include <Inventor/elements/SoTextureImageElement.h>
#include <SoDeprecationRules.h>

class SoFieldSensor;
class SoNodeSensor;
class SbRasterImage;
class SoGLTexture;

#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


//
//  Class: SoTexture
//
//  Texture node.
//

class  SoTexture : public SoNode {

  SO_NODE_ABSTRACT_HEADER(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,  
    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
  };

  enum Model {
    MODULATE = GL_MODULATE,

    DECAL = GL_DECAL,

    BLEND = GL_BLEND,

    REPLACE = GL_REPLACE,

    ADD = GL_ADD,

    COMBINE = GL_COMBINE

  };

  enum Wrap {
    REPEAT = GL_REPEAT,

    CLAMP = GL_CLAMP,

    CLAMP_TO_BORDER         = GL_CLAMP_TO_BORDER,

    CLAMP_TO_EDGE         = GL_CLAMP_TO_EDGE,

    MIRRORED_REPEAT         = GL_MIRRORED_REPEAT

  };

  enum Filter
  {
    AUTO  = 0,
    NEAREST = GL_NEAREST,
    LINEAR = GL_LINEAR,
    NEAREST_MIPMAP_NEAREST = GL_NEAREST_MIPMAP_NEAREST,
    NEAREST_MIPMAP_LINEAR = GL_NEAREST_MIPMAP_LINEAR,
    LINEAR_MIPMAP_NEAREST = GL_LINEAR_MIPMAP_NEAREST,
    LINEAR_MIPMAP_LINEAR = GL_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
  };

#if 1             SoDEPRECATED
  SoSFBool useAutoMipmap;

#endif 
  SoSFEnum internalFormat;

  SoSFBool enableCompressedTexture;

  SoSFEnum wrapS;

  SoSFEnum model;

  SoSFColor blendColor;

  SoSFBool enableBorder;

  SoSFVec4f borderColor;

  SoSFFloat maxAnisotropy;

  SoSFEnum minFilter;

  SoSFEnum magFilter;

  // Adding entry to this struct also means that we update 
  // SoImage and SoVrmlImageTexture.
  enum FileType
  {
    UNKNOWN,
    RGB,
    SGI,
    TIFF,
    GIF,
    JPEG,
    BMP,
    PNG,
    JPEG2000,
    PGX,
    PNM,
    RAS,
    DDS,
    HDRI,
    NUM_FILETYPES
  };

  void setBitmapFileType(FileType in_type);

  FileType getBitmapFileType(void) { return (m_filetype); }

  static SbBool isSupported(HW_Feature feature);

  inline virtual void setOverride(const SbBool state)
  { override.setValue(state); }

  inline virtual SbBool isOverride() const
  { return override.getValue(); }

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 void notify(SoNotList *list);

  virtual bool affectsPath() const;

  SoSFBool override;

  static SoTexture::InternalFormat getInternalFormatFromDataType(SoState* state, SoSFImage::DataType dataType, int nc, SbBool enableCompressedTexture = FALSE, const SbVec4f& borderColor = SbVec4f(0.0f,0.0f,0.0f,1.0f) );

  // This funtion describe the specified internal format.
  // If nc is not NULL it will receive the number of components for the returned format
  // If dataType is not NULL it will receive the type of the compenents for the returned format
  static GLenum describeInternalFormat(SoState*state, SoTexture::InternalFormat texInternalFormat, int* nc = NULL, SbDataType* componentType = NULL);

  static bool isClampToEdgeAvailable(SoState* state);

  static FileType checkFileType( const SbString& filename );

  static SbRasterImage* readTexture( const SbString& filename, FileType filetype = UNKNOWN );

  static std::vector< SbRasterImage* > readTextures( const std::vector< SbString >& filenames, bool splitCubeMaps, FileType filetype = UNKNOWN );

  static bool isTextureObjectSupported( SoState* state );

  static bool isTextureFloatSupported( SoState* state );

  static bool isTextureCompressionSupported( SoState* state);

  static bool isTextureDepthSupported( SoState* state);

  static bool isPalettedTextureSupported( SoState* state);

  static bool isSharedTexturePaletteSupported( SoState* state);

  static bool isTextureRectangleSupported( SoState* state);

  static bool isTextureRGSupported( SoState* state);

private:
  SoTexture();

  virtual ~SoTexture();

  int getReadStatus() { return m_readStatus; }
  void setReadStatus(int s) { m_readStatus = s; }

  SoFieldSensor *wrapSSensor;
  SoFieldSensor *maxAnisotropySensor;

  bool bFieldChanging;  // to protect from fieldHasChanged rentrance

  static SbString getFileTypeSuffix( FileType type );

  FileType m_filetype;
  SbBool m_userfileType;

  virtual GLenum getGLInternalFormat(SoSFImage& image, float quality = 1.0);
  

  static SbVec4i32 selectGCParams(InternalFormat intFmt);  

  static void convertHDRI_RGBE_TO_FLOAT32(SbRasterImage* rasterIn, float* floatOut, float exposureFactor);
  static void convertHDRI_FLOAT32_TO_UCHAR(float* fcol, unsigned char* outBuff, int width, int height);
  static void convertHDRI_FLOAT32_TO_UCHAR( SoSFImage* );

  virtual bool isTextureConfigurationValid(SoState* state, const SoTextureImageElement::SoTexImageData& config);

  SoGLTexture* m_texture;

private:

  static SbRasterImage* readTextureDataFromFile( const SbString& filename, FileType filetype );

  static std::vector< SbRasterImage* > splitRasterImage( SbRasterImage* sourceImage );

  static void readImageSection( unsigned char* input, int inputWidth, 
                      int xOffset, int yOffset, int width, int height, 
                      int elementSize, unsigned char* output, bool invertAndMirror);

  int m_readStatus;

  static SbBool m_featuresInitialized;
  static SbBool m_features[HW_LAST];
  static bool s_ivNoTextureObject;
  static int s_texture_object_extensionID;
  static int s_clamp_to_edge_EXT_extensionID;
  static int s_clamp_to_edge_SGIS_extensionID;
  static int s_texture_float_extensionID;
  static int s_texture_compression_extensionID;
  static int s_detph_texture_ARB_extensionID;
  static int s_paletted_texture_extensionID;
  static int s_shared_texture_palette_extensionID;
  static int s_texture_rectangle_extensionID;
  static int s_texture_rg_extensionID;

};

#endif /* _SO_TEXTURE_ */

---

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