SoVRVoxFileReader.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : M. Heck (Jul 2003)
**=======================================================================*/
#ifndef  _SO_VR_VOX_FILE_READER_
#define  _SO_VR_VOX_FILE_READER_
 
#include <LDM/readers/SoVolumeReader.h>
#include <VolumeViz/nodes/SoVolumeData.h>
 
 
class  SoVRVoxFileReader : public SoVolumeReader 
{
  SO_FIELDCONTAINER_HEADER(SoVRVoxFileReader);
 
 public:
  SoVRVoxFileReader();
 
  virtual int setFilename( const SbString& filename );
 
  virtual ReadError getDataChar( SbBox3f &size, SoDataSet::DataType &type,  SbVec3i32 &dim ) override;
 
  virtual void getSubSlice( const SbBox2i32& subSlice, int sliceNumber, void * data );
 
  virtual int getNumSignificantBits() 
  { return m_numSigBits; }
 
  virtual SoVolumeReader::ReaderType getReaderType ()
  {return VOX;};
 
 private:
 
  void convertFromTo(void* inBuffer, void* outBuffer, size_t numElements, SoDataSet::DataType inDataType, SoDataSet::DataType outDataType, char inEndianness);
 
  template<typename FROM_TYPE>
  void convertFromTo(FROM_TYPE* inBuffer, void* outBuffer, size_t numElements, SoDataSet::DataType outDataType, char inEndianness);
 
  template<typename FROM_TYPE, typename TO_TYPE>
  void convertFromTo(FROM_TYPE* inBuffer, TO_TYPE* outBuffer, size_t numElements, char inEndianness);
 
  SbBox3f   m_size;
  SbVec3i32 m_dim;
 
  // File may store data as int8 but this volume may be seen as int16.
  // For. when file is uint8 but offset is -2000, actual data may be in [-2000, 0] so have
  // to be encode in signed 16 bits.
  SoDataSet::DataType m_fileDataType;
  SoDataSet::DataType m_volumeDataType;
 
  int m_offsetToData;
 
  // Specific data from vox file
  SbString  m_volumeTitle;
  SbString  m_volumeCopyright;
  int       m_volumeCount;
  SbVec3f   m_volumeScale;
  SbVec3f   m_volumePosition;
  char      m_endian;
  SbMatrix  m_volumeMatrix;
 
  // Scale and offset to rescale data:
  // outData = scale * inData + offset.
  double m_voxelScale;
  double m_voxelOffset;
 
  int       m_numSigBits;
 
  SbString m_userFilename;
 
  // If true, apply scale and offset to data in the getSubSlice. Linked to LDM_VOX_READER_APPLY_SCALE_OFFSET.
  static bool s_applyScaleOffset;
};
 
#endif // _SO_VR_VOX_FILE_READER_