SoMemoryObject.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      : David BEILLOIN (Mar 2007)
**=======================================================================*/
 
 
#ifndef SO_MEMORY_OBJECT_H
#define SO_MEMORY_OBJECT_H
 
#include <Inventor/misc/SoRefCounter.h>
#include <Inventor/STL/map>
#include <Inventor/SbDataType.h>
#include <Inventor/threads/SbThreadMutex.h>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class SoBufferObject;
 
//
//  Class: SoMemoryObject
//
//  Class used to encapsulate a memory buffer pointer potentially shared
//  by multiple objects.
//  A reference counter is associated with this object to avoid deletion
//  until reference exists.
//
 
class  SoMemoryObject : public SoRefCounter
{
public:
 
  enum CopyPolicy
  {
    COPY = 0,
    NO_COPY,
    NO_COPY_AND_DELETE,
    NO_COPY_AND_FREE
  };
 
  SoMemoryObject();
 
  SoMemoryObject(void* buf, size_t byteSize, bool owner=true);
 
  SoMemoryObject(void* buf, size_t byteSize, SbDataType type, CopyPolicy policy);
 
 
  SoMemoryObject(SoBufferObject* bufObj, SbDataType type=SbDataType::UNSIGNED_BYTE, bool owner=true);
 
  virtual ~SoMemoryObject();
 
  void* get() const;
 
  size_t length() const;
 
  inline SbDataType getType() const;
 
private:
 
  void setOwner(bool f) { m_policy = f ? NO_COPY_AND_FREE:NO_COPY; }
 
  // setup a user allocated buffer
  void setBuffer(void *buf, size_t byteSize);
 
  // just change the m_size value without reallocation
  void forceSize(size_t byteSize);
 
  static SoMemoryObject* getMemoryObject(uint32_t id);
  uint32_t getId() { return m_index; }
  void setId( uint32_t id );
 
  inline SoBufferObject* getBufferObject() const;
 
private:
  void registerMemObj();
 
  void releaseValues();
 
  template <typename T> void deleteValues(void *buffer);
 
  template <typename T> void allocValues(void*& buffer, size_t byteSize);
 
 
  bool m_userPointer;
  SoBufferObject * m_bufferObj;
 
  uint32_t m_index;
  static uint32_t index;
 
  typedef std::map< uint32_t, SoMemoryObject*> SoMemObjMap;
  typedef SoMemObjMap::value_type SoMemObjValue;
  static SoMemObjMap s_memObjMap;
  static SbThreadMutex s_accessMutex;
 
  SbDataType m_type;
  CopyPolicy m_policy;
};
 
/*******************************************************************************/
SbDataType
SoMemoryObject::getType() const
{
  return m_type;
}
 
SoBufferObject* 
SoMemoryObject::getBufferObject() const
{
  return m_bufferObj;
}
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
#endif // SO_MEMORY_OBJECT_H