SoSFImage.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_SF_IMAGE_
#define  _SO_SF_IMAGE_
 
#include <Inventor/SbDataType.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbPList.h>
#include <Inventor/fields/SoSubField.h>
#include <Inventor/sys/SoGLType.h>
#include <Inventor/devices/SoBufferObject.h>
#include <Inventor/devices/SoCpuBufferObject.h>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class SbRasterImage;

//
//  SoSFImage subclass of SoSField.
//

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

  SoSFImage( const SoSFImage& obj );
 
#ifdef FLOAT
#undef FLOAT
#endif
  enum DataType {
    UNSIGNED_BYTE = SbDataType::UNSIGNED_BYTE,
    UNSIGNED_SHORT = SbDataType::UNSIGNED_SHORT,
    UNSIGNED_INT32 = SbDataType::UNSIGNED_INT32,
    SIGNED_BYTE = SbDataType::SIGNED_BYTE,
    SIGNED_SHORT = SbDataType::SIGNED_SHORT,
    SIGNED_INT32 = SbDataType::SIGNED_INT32,
    FLOAT = SbDataType::FLOAT
  };
 

  enum CopyPolicy {
    COPY = 0,
        NO_COPY = 1,
    NO_COPY_AND_DELETE = 2,
    NO_COPY_AND_FREE = 3
  };
 
  // getValue returns the size, number of components and a constant
  // pointer to the image.

  const void* getValue(SbVec2s &size, int &nc, DataType &dataType) const;
  const void* getValue(SbVec2i32 &size, int &nc, DataType &dataType) const;

  const unsigned char *getValue(SbVec2s &size, int &nc) const;
  const unsigned char *getValue(SbVec2i32 &size, int &nc) const;
 
 
 
  // setValue copies the image given to it into internal storage.
  // See startEditing() for a way of avoiding the copy if you are
  // doing a getValue() followed immediately by a setValue(). Set
  // 'copy' to NO_COPY or NO_COPY_AND_DELETE to pass directly the
  // pointer on the images. Otherwise, the buffer 'bytes' will be
  // copied. If copy is set to COPY or NO_COPY_AND_DELETE or
  // NO_COPY_AND_FREE, this object will delete the buffer when
  // required. If a NULL pointer is passed, a new bloc is allocated
  // according to the size and the number of components.

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

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

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

  void setSubValue(const SbVec2s &subSize,
                   const SbVec2s &offset,
                   void *data);
  void setSubValue (const SbVec2i32 &subSize,
                    const SbVec2i32 &offset,
                    void *data);
 

  void setSubValue(const SbVec2s &subSize,
                   const SbVec2s &offset,
                   unsigned char *bytes);
  void setSubValue(const SbVec2i32 &subSize,
                   const SbVec2i32 &offset,
                   unsigned char *bytes);
 

  void setSubValues(const SbVec2s *subSizes,
                    const SbVec2s *offsets,
                    int num, void **data);
  void setSubValues (const SbVec2i32 *subSizes,
                     const SbVec2i32 *offsets,
                     int num, void **data);
 

  void setSubValues(const SbVec2s *subSizes,
    const SbVec2s *offsets,
    int num, unsigned char **subBytes);

  void setSubValues(const SbVec2i32 *subSizes,
    const SbVec2i32 *offsets,
    int num, unsigned char **subBytes);
 

  int operator ==(const SoSFImage &f) const;

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

  void* startEditing(SbVec2s &size, int &nc, DataType &dataType);
  void* startEditing(SbVec2i32 &size, int &nc, DataType &dataType);

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

  void finishEditing();

  void* getSubTexture(int index, SbVec2s &size, SbVec2s &offset, DataType &dataType);

  void* getSubTexture(int index, SbVec2i32 &size, SbVec2i32 &offset, DataType &dataType);

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

  SbBool hasSubTextures(int &numSubTextures);

  void setNeverWrite(SbBool neverWrite);

  SbBool isNeverWrite()
  { return m_neverWrite ; }

  SbBool hasTransparency() const;

  SbRasterImage* toRasterImage(bool downSample = true) const;

  DataType getDataType() const
  {
    return m_dataType;
  }

  inline int getNumComponents() const
  {
    evaluate();
    return m_numComponents;
  }
 
private:
 
  static void initClass();
  static void exitClass();
  void resetSubTextures();
  static GLenum getGLType(SoSFImage::DataType dataType);
 
  SoBufferObject* getBufferObject() const;
 
  enum HasTransparency
  {
    ON,
    OFF,
    AUTO
  };

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

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

  SoRef<SoCpuBufferObject> m_cpuBufferObject;
 
  CopyPolicy m_copyPolicy;
 
  // list of [subSize, offset, bytes]
  SbPList m_subTexList;
  SbBool m_neverWrite;
 
  // -1 = don't know yet, 0 = no transp, 1 = has transp
  int m_hasTransparency;
 
  HasTransparency m_hasTransparencyState;
 
  DataType m_dataType;
 
  unsigned int getImageValueSize() const;
 
  // Reading and writing
  virtual SbBool readValue(SoInput *in);
  virtual void writeValue(SoOutput *out) const;
  void deleteBytesArray();
  void setValue (int32_t w, int32_t h, int nc, DataType dataType,
                     const void* data, CopyPolicy copy);
 
  void setValue (int32_t w, int32_t h, int nc, DataType dataType,
                     SoBufferObject* bufferObject, CopyPolicy copy);
 
  const void* getValue(int32_t &w, int32_t &h , int &nc, DataType &dataType) const;
  void* startEditing(int32_t &w, int32_t &h, int &nc, DataType &dataType);
 
 
};
 
inline SoBufferObject*
SoSFImage::getBufferObject() const
{
  return m_bufferObject.ptr();
}
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
#endif /* _SO_SF_IMAGE_ */