SoSFImage3.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      : Patrick Vigneras (Nov 1999)
**=======================================================================*/
 
#ifndef  _SO_SF_IMAGE_3_
#define  _SO_SF_IMAGE_3_
 
#include <Inventor/fields/SoSubField.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbPList.h>
#include <Inventor/devices/SoBufferObject.h>
#include <Inventor/fields/SoSFImage.h>
 
class SoCpuBufferObject;

//
//  SoSFImage3 subclass of SoSField. This field handles 3 dimensional images,
// that is a set of same-type (number of components) and same-size images.
// It is basically useful for 3d texturing (see Inventor/nodes/SoTexture3.h).
// This field uses a lot of memory (a simple 256x256x256 image in
// grayscale already takes 16MB of memory). Therefore, as opposed to the
// other fields, this field provides a way to manage memory and avoid
// useless copies of data. This is essentially done through the CopyPolicy
// enumeration and the set/isNeverWrite methods. The CopyPolicy provides
// four types of memory management:
// COPY is the default and is consistent with all other fields: any buffer
// passed is copied and the memory management is done inside the field;
// NO_COPY only uses a pointer given by the application which remains
// responsible for the memory management;
// NO_COPY_AND_DELETE accepts pointers from the application (ie does not
// copy the buffer) but the field takes responsability for the memory
// management. Note that this case is only intended for buffers
// created with the operator 'new';
// NO_COPY_AND_FREE is essentially the same as above but applies the function
// 'free' on the pointer instead of the operator 'delete'.
// Furthermore, two methods, is/setNeverWrite allow to write or not write
// out the data stored in this field. By default, the 'never write' condition
// is TRUE.
//

class  SoSFImage3 : public SoSField {
 
  // Uses only some of the standard field stuff (because there is no
  // SbImage type):
  SO_SFIELD_REQUIRED_HEADER(SoSFImage3);
  SO_SFIELD_CONSTRUCTOR_HEADER(SoSFImage3);
  
public:

  enum CopyPolicy {
    COPY = 0,
      NO_COPY = 1,
    NO_COPY_AND_DELETE = 2,
    NO_COPY_AND_FREE = 3
  };

  const void* getValue( SbVec3i32& size, int& nc, SoSFImage::DataType& dataType ) const;

  const unsigned char* getValue( SbVec3s& size, int& nc ) const;

  SoBufferObject* getBufferObject( SbVec3i32& size, int& nc, SoSFImage::DataType& dataType ) const;

  SoBufferObject* getBufferObject( SbVec3s& size, int& nc ) const;

  void setValue( const SbVec3i32& size, int nc,
                 SoSFImage::DataType dataType,
                 const void* data,
                 CopyPolicy copy = COPY );

  void setValue( const SbVec3i32& size, int nc,
                 SoSFImage::DataType dataType,
                 SoBufferObject* bufferObject,
                 CopyPolicy copy = COPY );

  void setValue( const SbVec3s &size,
                 int nc,
                 unsigned char *bytes,
                 CopyPolicy copy = COPY );

  void setValue( const SbVec3s &size,
                 int nc,
                 SoBufferObject* bufferObject,
                 CopyPolicy copy = COPY );

  void setSubValue( const SbVec3i32& subSize,
                    const SbVec3i32& offset,
                    void* bytes,
                    CopyPolicy copy = COPY );

  void setSubValue( const SbVec3s& subSize,
                    const SbVec3s& offset,
                    unsigned char* bytes,
                    CopyPolicy copy = COPY );

  void setSubValues( const SbVec3i32* subSizes,
                     const SbVec3i32* offsets,
                     int num,
                     void** data,
                     CopyPolicy copy = COPY );

  void setSubValues( const SbVec3s* subSizes,
                     const SbVec3s* offsets,
                     int num,
                     unsigned char** bytes,
                     CopyPolicy copy = COPY );

  int operator==(const SoSFImage3 &f) const;
  int operator!=(const SoSFImage3 &f) const
  { return ! ((*this) == f); }

  void* startEditing( SbVec3i32& size, int& nc, SoSFImage::DataType& dataType );

  unsigned char* startEditing( SbVec3s& size, int& nc );

  void finishEditing();

  void* getSubTexture( int index, SbVec3i32& size, SbVec3i32& offset, SoSFImage::DataType& dataType );

  unsigned char* getSubTexture( int index, SbVec3s& size, SbVec3s& offset );

  SbBool hasSubTextures(int &numSubTextures);

  void setNeverWrite(SbBool neverWrite);
  SbBool isNeverWrite()
  { return m_neverWrite; }
 
 
  SoBufferObject* getBufferObject() const;

  int getNumComponents() const;
 
 private:
 
  static void initClass();
  static void exitClass();
  void resetSubTextures();
 
  void deleteBytesArray();

  SbBool hasTransparency() const;

  void setHasTransparency(SoSFImage::HasTransparency status)
  {
    m_hasTransparencyState = status;
  }
 
  const SbVec3i32& getSize() const
  {
    return m_size;
  }
 
private:
 
  // Width, height and depth of image
  SbVec3i32 m_size;
 
  // Number of components per pixel
  int m_numComponents;

  unsigned char* m_buffer;
 
  // Buffer object which contains the data.
  SoRef<SoBufferObject> m_bufferObject;

  SoRef<SoCpuBufferObject> m_cpuBufferObject;
 
  CopyPolicy m_copyPolicy;
 
  // list of [subSize,offset,bytes,copypolicy]
  SbPList m_subTextures;
 
  SbBool m_neverWrite;
  
  SoSFImage::DataType m_dataType;
 
  SoSFImage::HasTransparency m_hasTransparencyState;
 
  size_t getImageValueSize() const;
 
  // Reading and writing
  virtual SbBool readValue(SoInput *in);
  virtual void writeValue(SoOutput *out) const;
};
 
inline SoBufferObject* 
SoSFImage3::getBufferObject() const
{
  return m_bufferObject.ptr();
}
 
inline int 
SoSFImage3::getNumComponents() const
{
  return m_numComponents;
}
 
#endif /* _SO_SF_IMAGE_3_ */