SoSFArray.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : R. ALBOU (Jan 2005)
**=======================================================================*/
 
#ifndef  SO_SF_ARRAY_H
#define  SO_SF_ARRAY_H
 
#include <Inventor/fields/SoSubField.h>
#include <Inventor/fields/SoSFImage.h>
 
class SoMemoryObject;
class SoBufferObject;

class  SoSFArray : public SoSField
{
  SO_SFIELD_REQUIRED_HEADER(SoSFArray);
  SO_SFIELD_CONSTRUCTOR_HEADER(SoSFArray);
 
public:
  enum CopyPolicy {
    COPY = SoMemoryObject::COPY,
    NO_COPY = SoMemoryObject::NO_COPY,
    NO_COPY_AND_DELETE = SoMemoryObject::NO_COPY_AND_DELETE,
    NO_COPY_AND_FREE = SoMemoryObject::NO_COPY_AND_FREE
  } ;

  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
  } ;

  inline void* getValue() const ;

  DataType getDataType() const { return (DataType)m_dataType.getType(); }

  void finishEditing();

  virtual int operator ==(const SoSFArray &f) const;

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

  void setNeverWrite(SbBool neverWrite)
  { m_neverWrite = neverWrite ;}

  SbBool isNeverWrite()
  { return m_neverWrite ; }

  inline const SbVec3i32& getSize() const;

  void* startEditing(SbVec3i32 &size, SbDataType& dataType);

  inline virtual size_t getValueSize() const ;

  const void* getValue(SbVec3i32 &size, SbDataType &dataType) const ;

  void setValue(const SbVec3i32 &size, const SbDataType& dataType,
                const void* data, CopyPolicy copy=COPY);

  void setValue(const SbVec3i32 &size,SoMemoryObject* memObj,
                CopyPolicy copy);

  SbBool isEmpty() const;
 
private:
  static void initClass();
  static void exitClass();
 
  SoBufferObject *getBufferObject() const;
 
private:
  int m_dimension;

  SbVec3i32     m_size;

  virtual SbBool readValue(SoInput *in);

  virtual void   writeValue(SoOutput *out) const ;

  SoMemoryObject* m_values ;
 
private:
  static const int NO_DATA_FLAG;

  template <typename T> void allocValues(int numValues);

  template <typename T> SbBool readAsciiValue(SoInput* in, size_t pos);

  template <typename T> void writeAsciiValue(SoOutput* out, size_t pos) const;

  SbDataType m_dataType ;

  CopyPolicy  m_copyPolicy;

  SbBool      m_neverWrite;
};
 
/*----------------------------------------------------------------------------*/
void*
SoSFArray::getValue() const
{
  if (isEmpty())
    return NULL;
 
  return m_values?m_values->get():NULL;
}
 
/*----------------------------------------------------------------------------*/
const SbVec3i32&
SoSFArray::getSize() const
{
  return m_size;
}
 
/*----------------------------------------------------------------------------*/
size_t
SoSFArray::getValueSize() const
{
  return m_dataType.getSize();
}/*----------------------------------------------------------------------------*/
 
 
#endif /* _SO_SF_ARRAY_H */