SoVolumeData.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-2024 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 SoState;
class SoGLVolCacheList;
class SoVolumeHistogram;
class SoDataCompositor;
class SoVolumeShader;
class SoVolumeState;
 
// LDM
class SoLDMTileManager;
class SoLDMTileVisitor;
class SoLDMNodeFrontManager;
class SoLDMTextureManager;
class SoLDMGeometry;
class SoLDMResourceManager;
 
// Algorithms
class SoDataExtract;
class LDMDefaultSliceAccessor;
class SoVolumeData;
 
SO_PIMPL_PUBLIC_DECLARATION(SoVolumeData)
 
 
class  SoVolumeData : public SoDataSet, public SoVolumeRendering
{
  SO_NODE_HEADER( SoVolumeData );
 
  SO_PIMPL_PUBLIC_HEADER( SoVolumeData );
 
public:
  using SoDataSet::getTexData;
 
  //compatibility issues:
  typedef SoLDMDataAccess LDMDataAccess;
  typedef ::SoLDMResourceParameters SoLDMResourceParameters;
 
  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);
 
  SbBool getHistogram( int &length, int64_t* &histogram);
 
  void updateRegions(const SbBox3i32 *region, int num_regions);
 
  void updateTilesInTextureMemory(SoLDMTileID* tiles, int numTiles);
 
  void setRGBAData(const bool flag);
 
  enum CoordinateType {
    COORDINATES_UNIFORM = SoVolumeReader::COORDINATES_UNIFORM,
    COORDINATES_RECTILINEAR = SoVolumeReader::COORDINATES_RECTILINEAR
  };
 
  CoordinateType getCoordinateType() const;
 
  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 );
 
#if 1             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 enum
  SubMethod {
    NEAREST,
    MAX,
    AVERAGE
  };
SoDEPRECATED enum
  OverMethod {
    NONE,
    CONSTANT,
    LINEAR,
    CUBIC
  };
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();
 
#endif 
private:
 
  virtual void doAction( SoAction *action );
  virtual void GLRender( SoGLRenderAction *action );
  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:
 
  SbVec3d getVoxelSize() const;
 
  virtual void updateTile( const SbBox3i32 &region, const SoLDMTileID& tileId );
  virtual void drawTilesInMainMemory(SoGLRenderAction* action, const SoLDM::DataSetIdPair& idPair);
 
  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();
 
  void             loadData(SoAction* action, SbBool& texLoadedOrReloaded);
 
  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);
 
  void getVolumeTexGen(SbVec4d texGen[3]) const;
 
  SbMatrix getVolumeTexGen() const;
 
  SbVec3f getVolumeTextureRatio() const;
 
  SbBox3f toTextureSpace(const SbBox3f& bbox) const;
  
  void drawOctree(SoGLRenderAction* pGLRA);
 
  //Return -1 when lighting is on, 0 in RGBA texture mode
  virtual int getTexPrec(SoState*state);
 
  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);
 
  SbBox3f getLDMOutliningBox();
 
  virtual SoBufferObject *getTransformedTile(const SoLDMTileID& tile,
                                             const SoLDM::DataSetIdPair& p,
                                             SoState * state=NULL,
                                             const bool useExtendedData = false);
 
 
  SbBool saveEditing( SoVolumeWriter* writer, SaveEditingCB* callback = NULL );
 
  const std::vector<float>& getInvertedRectilinearCoordinates(Axis axis) const;
 
  virtual void drawXYZBox( SoGLRenderAction* action, BoxColor color, const SbBox3f& box );
 
  virtual void drawIJKBox( SoGLRenderAction* action, BoxColor color, const SbBox3f& box, const SoLDMTileID& tile, bool subTile = false );
  virtual void drawIJKBox( SoGLRenderAction* action, BoxColor color, const SbBox3f& box, bool fullRes, bool subTile = false );
  virtual void drawIJKBox( SoGLRenderAction* action, 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) const;
  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);
 
  virtual LDMSliceAccessor* getAppropriateSliceAccessor( const SoLDM::DataSetIdPair& p );
 
  virtual SoLDMReader* getAppropriateLDMReader( const SbString& pathname);
 
private:
 
  virtual void readerChanged();
 
  virtual void setElement(SoState* state);
 
  virtual SoVolumeReader *getAppropriateReader();
 
  // Destructor
  virtual ~SoVolumeData();
  void     releaseMemory();
 
  virtual bool enableMultidata(SoState* state);
 
  virtual void unload();
 
  virtual void updateFilename();
 
  virtual SbBool isRGBAData();
 
  virtual void buildTile(SoLDMTileID tileID, SoBufferObject* buffer);
 
  virtual void  computeLighting( const SbVec3i32 & tileSize, SoBufferObject* rgbaBuffer );
 
SoINTERNAL private:
 
  virtual SoLDMGeomElement* getAppropriateElement( SoLDMGeometry* v );
 
private:
 
  void commonConstructor();
SoDEPRECATED
  SoSFEnum   storageHint;
 
  // This field is deprecated but cannot be remove without creating a new iv file version formatSoDEPRECATED
  SoSFInt32 volumeDataId;
 
  friend class ::SoVolumeState;
};
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif // _SO_VOLUME_DATA_