SbImageDataVoxel.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Julien Sallanne (Feb 2014)
**=======================================================================*/
 
#ifndef _SB_IMAGEDATAVOXEL_H_
#define _SB_IMAGEDATAVOXEL_H_
 
#include <ImageViz/SoImageViz.h>
#include <ImageViz/SbImageDataType.h>
#include <Inventor/devices/SoCpuBufferObject.h>
 
#include <Inventor/errors/SbException.h>
class SoDEPRECATED  SbImageDataVoxel
{
public:
  SbImageDataVoxel(const SbImageDataType& channelType, SoBufferObject* buffer, size_t offset);
 
  ~SbImageDataVoxel();
 
  SbImageDataVoxel(const SbImageDataVoxel&);
 
  const SbImageDataVoxel& operator=(const SbImageDataVoxel& right);
 
  inline const SbImageDataType& getImageDataType() const { return m_imageDataType; }
 
  template <typename TypeOut> TypeOut castValue(size_t channelIndex) const;
 
  template <typename TypeOut> TypeOut& getValue(size_t channelIndex);
 
  template <typename TypeOut> const TypeOut& getValue(size_t channelIndex) const;
 
private:
 
  void* getDataPtr() const;
 
private:
 
  SbImageDataType m_imageDataType;
  // Used to keep constructor buffer. It is mapped in SbImageDataVoxel constructor and
  // unmapped in destructor.
  SoRef<SoBufferObject> m_buffer;
  // Offset use to map m_buffer to m_cpuBuffer.
  size_t m_offset;
  // CPU buffer containing data. It is mapped in SbImageDataVoxel constructor and
  // unmapped in destructor. Basically, m_cpuBuffer = m_buffer->map() + offset;
  SoRef<SoCpuBufferObject> m_cpuBuffer;
  // Pointer to channels. Basically, m_ptr = m_cpuBuffer->map();
  void* m_ptr;
};
 
 
//-----------------------------------------------------------------------------
template <typename TypeOut>
TypeOut
SbImageDataVoxel::castValue(size_t i) const
{
  if ( i >= getImageDataType().getNumChannel() )
    throw SbException("out of range");
 
  TypeOut dataValue;
 
  switch ( m_imageDataType.getDataType() )
  {
  case SbDataType::UNSIGNED_BYTE : dataValue = TypeOut(((unsigned char*) m_ptr)[i]);  break;
  case SbDataType::UNSIGNED_SHORT: dataValue = TypeOut(((unsigned short*) m_ptr)[i]); break;
  case SbDataType::UNSIGNED_INT32: dataValue = TypeOut(((unsigned int*) m_ptr)[i]);   break;
  case SbDataType::SIGNED_BYTE   : dataValue = TypeOut(((signed char*) m_ptr)[i]);    break;
  case SbDataType::SIGNED_SHORT  : dataValue = TypeOut(((signed short*) m_ptr)[i]);   break;
  case SbDataType::SIGNED_INT32  : dataValue = TypeOut(((signed int*) m_ptr)[i]);     break;
  case SbDataType::FLOAT         : dataValue = TypeOut(((float*) m_ptr)[i]);          break;
  case SbDataType::DOUBLE        : dataValue = TypeOut(((double*) m_ptr)[i]);         break;
  default : SoDebugError::postWarning("SbImageDataVoxel::castValue()", "Unknown data type %s", m_imageDataType.getDataType().getString().toLatin1()); dataValue = 0; break;
  }
  return dataValue;
}
 
//-----------------------------------------------------------------------------
template <typename TypeOut>
const TypeOut&
SbImageDataVoxel::getValue(size_t i) const
{
  if ( i >= getImageDataType().getNumChannel() )
    throw SbException("out of range");
 
  TypeOut returnValue;
  const SbDataType dataTypeOut = SbDataType::getTemplateType(returnValue);
 
  if ( dataTypeOut != getImageDataType().getDataType() )
    throw SbException("inconsistent dataType");
 
  return ((TypeOut*) m_ptr)[i];
}
 
//-----------------------------------------------------------------------------
template <typename TypeOut>
TypeOut&
SbImageDataVoxel::getValue(size_t i)
{
  if ( i >= getImageDataType().getNumChannel() )
    throw SbException("out of range");
 
  TypeOut returnValue;
  const SbDataType dataTypeOut = SbDataType::getTemplateType(returnValue);
 
  if ( dataTypeOut != getImageDataType().getDataType() )
    throw SbException("inconsistent dataType");
 
  return ((TypeOut*) m_ptr)[i];
}
 
#endif // _SB_IMAGEDATAVOXEL_H_