SoMFImage.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_MF_IMAGE_
#define  _SO_MF_IMAGE_
 
#include <Inventor/fields/SoSubField.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbPList.h>
 
//
//  SoMFImage subclass of SoMField.
//
 
class  SoMFImage : public SoMField {
 
  // Uses only some of the standard field stuff 
  // (because there is no SbImage type):
  SO_MFIELD_REQUIRED_HEADER(SoMFImage);
  SO__MFIELD_RW_HEADER(SoMFImage);
  SO_MFIELD_CONSTRUCTOR_HEADER(SoMFImage);
  
 public:
  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 unsigned char *getValue(SbVec2s &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,
                const unsigned char *bytes, 
                CopyPolicy copy = COPY);    
#ifdef NOTNOW
  void setSubValue(const SbVec2s &subSize, 
                   const SbVec2s &offset,
                   unsigned char *bytes);
 
  void setSubValues(const SbVec2s *subSizes, 
                    const SbVec2s *offsets,
                    int num, unsigned char **bytes);   
  int operator ==(const SoMFImage &f) const;
 
  int operator !=(const SoMFImage &f) const
  { return ! ((*this) == f); }
 
  unsigned char *startEditing(SbVec2s &size, int &nc);
 
  void finishEditing();
 
  unsigned char *getSubTexture(int index, SbVec2s &size, SbVec2s &offset);
 
  SbBool hasSubTextures(int &numSubTextures);
#endif
  void setNeverWrite(SbBool neverWrite);
 
  SbBool isNeverWrite() 
    { return neverWrite ; }
 
  SbBool hasTransparency() const;
 
 private:
 
  static void initClass();
 //
 void resetSubTextures();
  
 private:
 
  // Width and height of image
  SbVec2s size;
 
  // Number of components per pixel
  int numComponents;
 
  // Array of pixels
  unsigned char *bytes;
 
  CopyPolicy copyPolicy;
 
  // list of [subSize, offset, bytes]
 // SbPList subTexList;
  SbBool neverWrite;
 
  // -1 = don't know yet, 0 = no transp, 1 = has transp
  int m_hasTransparency;
  
  // Reading and writing
  virtual SbBool readValue(SoInput *in);
  virtual void writeValue(SoOutput *out) const;
};
 
#endif /* _SO_MF_IMAGE_ */