VolumeViz/nodes/SoVolumeData.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : P. ESTRADE (Feb 2000)
**=======================================================================*/
#ifndef  _SO_VOLUME_DATA_
#define  _SO_VOLUME_DATA_

#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif

#include <Inventor/STL/map>
#include <Inventor/STL/vector>

#include <Inventor/SbBox.h>
#include <Inventor/SbPList.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFMemObj.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFUShort.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFArray3D.h>

#include <LDM/SoLDMDataAccess.h>
#include <LDM/SoLDMMediator.h>
#include <LDM/SoLDMTileID.h>
#include <LDM/nodes/SoDataSet.h>
#include <LDM/nodes/SoTransferFunction.h>
#include <LDM/readers/SoVolumeReader.h>

#include <VolumeViz/nodes/SoVolumeRendering.h>

class SoGLRenderAction;
class SoCallbackAction;
class SoWriteAction;
class SoVolumeReader;
class SoCache;
class SoNodeDependencies;
class SoState;
class SoGLVolCacheList;
class SoVolumeHistogram;
class SoDataCompositor;
class SoVolumeShader;

// LDM
class SoLDMTileManager;
class SoLDMTileVisitor;
class SoLDMNodeFrontManager;
class SoLDMTextureManager;
class SoLDMGeometry;
class SoLDMResourceManager;

// Algorithms
class SoDataExtract;
class LDMDefaultSliceAccessor;
class SoVolumeData;

class  SoVolumeData : public SoDataSet, public SoVolumeRendering
{
  SO_NODE_HEADER( SoVolumeData );

public:
  using SoDataSet::getTexData;

  //compatibility issues:
  typedef SoLDMDataAccess        LDMDataAccess;
  typedef SoLDMMediator::LDMManagerAccess     LDMManagerAccess;
  typedef ::LDMResourceParameter LDMResourceParameter;

  SoVolumeData();

  SoSFBool   usePalettedTexture;


  SoSFBool   useSharedPalettedTexture;

  SoSFBool   useExtendedData;

  SoSFArray3D data;

  SoSFBool dataRGBA;

  virtual SbBool getMinMax( int64_t &min, int64_t &max);

  virtual SbBool getMinMax( double &min, double &max);

  //LDM
  // This method must be used for LDM files and can also be used for other file formats.

  SbBool getHistogram( int &length, int64_t* &histogram);

  void updateRegions(const SbBox3i32 *region, int num_regions);

  void updateTilesInTextureMemory(SoLDMTileID* tiles, int numTiles);

  virtual SbVec3f voxelToXYZ(const SbVec3f &dataPosition) const;

  virtual SbBox3f voxelToXYZ(const SbBox3f& box) const;

  virtual SbVec3f XYZToVoxel(const SbVec3f &dataPosition);

  virtual SbBox3f XYZToVoxel(const SbBox3f &xyzBox);

  void setRGBAData(const bool flag);


#if 1             SoDEPRECATED
  SoVolumeData* subSetting( const SbBox3s& region );
SoDEPRECATED
  void updateRegions( const SbBox3s *region, int num_regions );
SoDEPRECATED
  void loadRegions( const SbBox3s *region, int num_regions, SoState* state, SoTransferFunction* transFunc );
SoDEPRECATED
  void setSubSamplingLevel(const SbVec3s& ROISampling, const SbVec3s& secondarySampling);
SoDEPRECATED
  void getSubSamplingLevel(SbVec3s &ROISampling, SbVec3s &secondarySampling);
SoDEPRECATED
  void setPageSize(SbVec3s& size);
SoDEPRECATED
  void setVolumeData( const SbVec3s &dimension, void *data,
                                   SoDataSet::DataType type=UNSIGNED_BYTE,
                                   int numSignificantBits = 0 );

#endif 
#if 1             
#ifndef HIDDEN_FROM_DOC

  SoSFInt32 volumeDataId;
#else
SoDEPRECATED
  SoSFInt32 volumeDataId;
#endif
SoDEPRECATED
  void setVolumeSize( const SbBox3f &size );
SoDEPRECATED
  const SbBox3f& getVolumeSize();
SoDEPRECATED
  void setVolumeData( const SbVec3i32 &dimension, SoMemoryObject* data, SoDataSet::DataType type=UNSIGNED_BYTE, int numSignificantBits = 0 );
SoDEPRECATED
  void setVolumeData( const SbVec3i32 &dimension, void *data, SoDataSet::DataType type=UNSIGNED_BYTE, int numSignificantBits = 0 );
SoDEPRECATED
  SbBool getVolumeData( SbVec3i32 &dimension, void *&data, SoDataSet::DataType &type, int *numSignificantBits = NULL );
SoDEPRECATED
  SbBool getMinMax( int &min, int &max);

SoDEPRECATED
  SbBool getVolumeData( SbVec3s &dimension, void *&data,
                                     SoDataSet::DataType &type, int *numSignificantBits = NULL );
SoDEPRECATED
  SbBool getHistogram ( int &length, int* &histogram);
SoDEPRECATED
  static int getMaxNumVolumes() ;

#endif 
#if 1             SoDEPRECATED
  void setPaging(SbBool);
SoDEPRECATED
  SbVec3i32 getDimension() { return SoDataSet::getDimension(); }

#endif 
#if 1             SoDEPRECATED
  SoSFEnum   storageHint;
SoDEPRECATED enum
  StorageHint {
    AUTO,
    TEX2D_MULTI,
    TEX2D = TEX2D_MULTI,
    TEX3D,
    MEMORY,
#ifndef HIDDEN_FROM_DOC

    VOLUMEPRO,
    TEX2D_SINGLE
#endif // HIDDEN_FROM_DOC
  };

#endif 
#if 1             SoDEPRECATED
  SbVec3i32 getPageSize();
SoDEPRECATED enum
  SubMethod {
    NEAREST,
    MAX,
    AVERAGE
  };
SoDEPRECATED enum
  OverMethod {
    NONE,
    CONSTANT,
    LINEAR,
    CUBIC
  };
SoDEPRECATED
  void enableSubSampling(SbBool enable);
SoDEPRECATED
  SbBool isSubSamplingEnabled(){ return FALSE; }
SoDEPRECATED
  void enableAutoSubSampling(SbBool enable);
SoDEPRECATED
  SbBool isAutoSubSamplingEnabled(){ return FALSE; }
SoDEPRECATED
  void enableAutoUnSampling(SbBool enable);
SoDEPRECATED
  SbBool isAutoUnSamplingEnabled(){ return FALSE; }
SoDEPRECATED
  void unSample();
SoDEPRECATED
  void setSubSamplingMethod(SubMethod method);
SoDEPRECATED
  void setSubSamplingLevel(const SbVec3i32& ROISampling, const SbVec3i32& secondarySampling);
SoDEPRECATED
  void getSubSamplingLevel(SbVec3i32 &ROISampling, SbVec3i32 &secondarySampling);
SoDEPRECATED
  SoVolumeData *reSampling( const SbVec3i32 &dimension, SoVolumeData::SubMethod subMethod, SoVolumeData::OverMethod = NONE);
SoDEPRECATED
  SoVolumeData *subSetting( const SbBox3i32 &region );
SoDEPRECATED
  void setTexMemorySize(int size);
SoDEPRECATED
  int getTexMemorySize();
SoDEPRECATED
  void setPageSize(int size);
SoDEPRECATED
  void setPageSize(SbVec3i32& size);
SoDEPRECATED
  void loadRegions(const SbBox3i32 * region, int num_regions,SoState* state,SoTransferFunction* transFunc);
SoDEPRECATED
  SbBool isPaging();

#endif 
private:

  SbVec3d getVoxelSize() const;

  virtual void updateTile( const SbBox3i32 &region, const SoLDMTileID& tileId );
  virtual void drawTilesInMainMemory(SoState *state);

  enum Cmd{
    CREATE_NODE,
    UPDATE_REGIONS,
    SET_LDM,
    SET_PAGING
  };

  virtual void notify(SoNotList *list);

  int64_t getValue (SbVec3i32 &pos, SbBool real = FALSE);
  double  getValueD(const SbVec3i32 &pos, SbBool real = FALSE);
  int64_t loadDataValue(void* value, const SbVec3i32 &pos, void*& data, SoBufferObject *dataBufferObject, SbBool real);

  static void initClass();
  static void exitClass();

  virtual void     updateColorTable(SoState *, SoTransferFunction *);
  void             loadData(SoAction* action, SbBool& texLoadedOrReloaded);

  SoTransferFunction::GLColorMapType installColorMap(SoState*, int alphaUse=0);
  SoTransferFunction::GLColorMapType getColorMapType(SoState*);
  SbVec3i32&       getDimensionPowerOf2();
  SbVec3f&         getTexRatio();

  // CPU lighting
  void             setLighting(SoState* state, SbBool);
  void             setLightDirection(SoState* state,const SbVec3f&);
  void             setLightIntensity(SoState* state,float);

  virtual bool     isPalettedTexture(SoState* state);
  int              isSharedPalettedTexture();

  //for sceneGraphChange
  static void sceneGraphChangeCB(void* , SoSensor*);


#if 1             SoDEPRECATED
  void updateColorTable(SoState *, SoVolumeData::StorageHint textype,SoTransferFunction *);

#endif 
  private:

  virtual void doAction( SoAction *action );
  virtual void GLRender( SoGLRenderAction *action );
  virtual SoLDMTileManager::LDMSliceAccessor* getAppropriateSliceAccessor(const SoLDM::DataSetIdPair& p);
  virtual SoLDMReader* getAppropriateLDMReader( const SbString& pathname);
  virtual void useFakeData(SoLDMTileID tileID, SoBufferObject* bufferObject);

  // ScaleViz specific : force rendering on all oiru in depth compositing mode
  // As VolumeViz shape nodes are considered as transparent (alpha)
  virtual int32_t getRenderUnitID() const;

  private:
  virtual SoLDMGeomElement* getAppropriateElement(SoLDMGeometry* v);

  void getVolumeTexGen(SbVec4d texGen[3]) const;

  SbMatrix getVolumeTexGen() const;

  SbVec3f getVolumeTextureRatio() const;

  SbBox3f toTextureSpace(const SbBox3f& bbox) const;

private:

  virtual void readerChanged();

  virtual void setElement(SoState* state);

  virtual SoVolumeReader *getAppropriateReader();

  // Destructor
  virtual ~SoVolumeData();
  void     releaseMemory();

  virtual bool enableMultidata(SoState* state);

  //Set data characteristic size, extent...
  virtual void readChar();

  virtual void unload();

  virtual void updateFilename();

  virtual SbBool isRGBAData();

  virtual void buildTile(SoLDMTileID tileID, SoBufferObject* buffer);

private:
  void resetData();

  void forceStorageHint();

  void updateData3D();

  //enum StorageHint m_storage;

  static SoDataExtract* s_dataExtractAlgorithms;

  void     releaseTextures(SoState* state);
  void     setDimension(const SbVec3i32 &);
  void     setDimensionPowerOf2();

  SbBool   initData(SoState*);
  SbBool   initReader();
private:

  void drawOctree(SoGLRenderAction* pGLRA);

  //Return -1 when lighting is on, 0 in RGBA texture mode
  virtual int getTexPrec(SoState*state);

private:

  //useful to draw the tiles if we have either only volumeRender or only slice
  SbBool m_tilesInRAMalreadyDrawn;


  SoDataCompositor* m_dataCompositor;

  void     extendData(int, void*);
  void     extendData1(int, int, void*);

  void     computeStatData(SbBool flag = FALSE);
  int      fswGetDataChar(SbBox3f &, DataType &, SbVec3i32 &);
  void     fswAbort();
  void     fswSkipSlice(int);
  void*    fswGetNextSlice(int);
  void     fswEnd();

  void     *m_fswSliceData;
  SoCache  *m_texElementDependency;
  SoNodeDependencies* m_dataRangeElementDependency;
  SbVec3i32 m_dimensionPowerOf2;
  SbVec3f   m_texRatio;
  SbBool    m_lighting;
  int       m_lightDir[3];
  int       m_lightInt;
  int       m_ambCol[3];
  int       m_specCol[3];
  int       m_shininess;

  SoGLVolCacheList* m_VRTexList;

  //
  // #grouped getVolumeSize()
  // #grouped getVolumeData(SbVec3i32 & dimension, data , DataType & type)
  // #grouped getReader()
  //
   friend class SoLDMMediator::LDMManagerAccess;

  std::map<const SoVolumeShader *, bool> m_rectilinearCoordinatesUpdated; 
#if 1             SoDEPRECATED
  int64_t  subSample(SoDataSet::DataType,int,SbVec3i32&,void*,int,int,int,int,SoVolumeData::SubMethod);
SoDEPRECATED
  double   subSampleD(SoDataSet::DataType,int,SbVec3i32&,void*,int,int,int,int,SoVolumeData::SubMethod);

#endif 
private:
  virtual void getDataOneObliqueSlice( const SbVec3i32& tileSize, SoBufferObject* tileData, int Zaxis, const SbPlane& plane, SoBufferObject* slicedata, int interp );
  virtual SoBufferObject* getDataOneSlice( const SbVec3i32& tileSize, SoBufferObject* tileData, int Zaxis, int slice);

  virtual void  computeLighting( const SbVec3i32 & tileSize, SoBufferObject* rgbaBuffer );
  SbBox3f getLDMOutliningBox();

  virtual SoBufferObject* getTransformedTile(const SoLDMTileID& tile,
                                             const SoLDM::DataSetIdPair& p,
                                             SoState * state=NULL,
                                             const bool useExtendedData = false);

public:
  enum CoordinateType {
    COORDINATES_UNIFORM = SoVolumeReader::COORDINATES_UNIFORM,
    COORDINATES_RECTILINEAR = SoVolumeReader::COORDINATES_RECTILINEAR
  };

  CoordinateType getCoordinateType() const
  {
    return m_coordinateType;
  }

  enum Axis {
    X,
    Y,
    Z
  };

  const std::vector<float>& getRectilinearCoordinates(Axis axis) const;

  virtual SbBool startEditing(int &transactionId );

  virtual int editTile( const SoLDMTileID& tileId, SoBufferObject* userData );

  virtual int editSubVolume( const SbBox3i32& subVolume, SoBufferObject* userData );

  virtual int editTile( const SoLDMTileID& tileId, const double& value );

  virtual int editSubVolume( const SbBox3i32& subVolume, const double& value );

  virtual int editSurfaceShape( const SoNode* surfaceShape, const float& thickness, const double& newValue );

  virtual int editSolidShape( const SoNode* solidShape, const double& value );

  virtual int editBoxes(
    const std::vector<SbVec3i32>& boxCenters,
    const int& boxSize,
    const double& newValue
    );

  virtual SbBool finishEditing(int transactionId);

  virtual SbBool undoEditing( int transactionId );

  virtual SbBool redoEditing( int transactionId );

  virtual SbBool saveEditing(bool recomputeLowerResolution = TRUE, const std::vector<char*> convertionParameters = std::vector<char*>(), SaveEditingCB* callback = NULL );

private:

  SbBool saveEditing( SoVolumeWriter* writer, SaveEditingCB* callback = NULL );

  const std::vector<float>& getInvertedRectilinearCoordinates(Axis axis) const;

  virtual void drawXYZBox(SoState* state, BoxColor color, const SbBox3f& box);

  virtual void drawIJKBox(SoState* state, BoxColor color, const SbBox3f& box, const SoLDMTileID& tile,
                          bool subTile = false);
  virtual void drawIJKBox(SoState* state, BoxColor color, const SbBox3f& box, bool fullRes, bool subTile = false);
  virtual void drawIJKBox(SoState* state, BoxColor color, const SbBox3f& box, bool subTile = false);

  void setupRectilinearCoordinates(const SbVec3i32&);
  bool isRectilinearCoordinatesUpdated(const SoVolumeShader* s);
  void resetRectilinearCoordinatesUpdated(const SoVolumeShader* s);

  SbVec3f computeRectilinearCoordinate(const SbVec3f& vertex);
  SbBox3f computeRectilinearCoordinate(const SbBox3f& box);

  SbVec3f computeInvertedRectilinearCoordinate(const SbVec3f& vertex);
  SbBox3f computeInvertedRectilinearCoordinate(const SbBox3f& box);

  void setDefaultValue( const double defValue );
  double getDefaultValue() const;

  SbBox3f getXYZCoordinates(const SbBox3i32& box, const SbBox3i32& cropped);

  SbBox3f getSubtileXYZCoordinates(const SbBox3i32& fullTileBox,
                                   const SbBox3i32& subTileBox,
                                   const SbBox3i32& cropped);

private:

  virtual SbBool doSaveEditing( SoVolumeWriter* writer, std::vector<SbBox3i32>& savedRegion, SaveEditingCB callback = NULL );

private:
  void bindVolumeDataToDrawStyle(SoAction* action);

  template <typename T> void copySliceData(const SbVec3i32& pageSize,
                                           SoBufferObject *pageData, int Zaxis,
                                           const SbPlane& plane, SoBufferObject *slicedata, int interpVal);
  // rectilinear dataset support
  std::vector<float> m_invertedRectilinearCoordinates[3]; 
  std::vector<float> m_rectilinearCoordinates[3]; 
  CoordinateType m_coordinateType;

  void setVolumeDataCompatibily(const SbVec3i32 &dimension,
                                void* dataPtr,
                                SoDataSet::DataType type = UNSIGNED_BYTE,
                                int numSignificantBits = 0);

  static void drawPoint(SoLDMTileID &tileID,int level,float levelmax);

  int m_numRenderCaches;
  SbThreadMutex* m_threadMutex;

  // Define the default value of the volumedata
  double m_defaultValue;

  SbBool m_editingStackDirty;
};

#ifdef _MSC_VER
#pragma warning( pop )
#endif

#endif // _SO_VOLUME_DATA_

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/