SoVolumeGroup.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      : T. DUFOUR (Nov 2002)
** Modified by : J. SALLANNE (Aug 2012)
**=======================================================================*/
#ifndef  _SO_VOLUME_GROUP_
#define  _SO_VOLUME_GROUP_
 
#include <VolumeViz/nodes/SoVolumeRender.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoFaceSet.h>
 
#if defined(_WIN32)
#pragma warning(push)
#pragma warning(disable: 4251) // 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
#endif
 
class SoGLObjectCache;
class SoLDMVirtualTexture;
class SoVolumeOffscreenImpl;
 
class  SoVolumeGroup : public SoSeparator {
 
  SO_NODE_HEADER( SoVolumeGroup );
 
 public:
  SoSFBool multiVolumes;
 
  SoVolumeGroup();
 
  //------------------------------------------------------------------------------
 
 private:
 
  enum VGState
  {
    REGISTERING_VR,
    COLLECTING_SLICE,
    RENDERING,
  };
 
  struct VGSlice {
    // slice distance from eye (affine component of slice plane), in view space.
    // Note: in view space Z axis goes FROM screen TO viewer. A slice is IN FRONT OF another if its distance is greater.
    float distance;
    SoLDMVirtualTexture* texID;
    int   numVertices;
    SbVec3f vertices[6];
    const SoVolumeRender* vr;
    SoRef<SoFaceSet> faceSet;
  };
 
  struct VRInfo {
    SoPath* path;
    SoVolumeRenderingQuality* vrq;
    /* Render at floor(1/vpScale of the viewport size). */
    int vpScale;
 
    float sliceDensity;
  };
 
  virtual bool affectsPath() const;
 
  static void initClass();
  static void exitClass();
 
  void addVolume( SoState* state, const SbVec3f& planeNormal, const float sliceSpacing, const SoPath* vrPath, const SoVolumeRender* vr, SoVolumeRenderingQuality* vrq, int vpScale, float sliceDensity );
  void addSlice( SoLDMVirtualTexture* vt, int numVertices, SbVec3f* vertices, const SoVolumeRender* vr );
  VGState getVGState() const { return m_vgState; };
 
  /* return edgeDetectfragDataId created by registerRTT */
  int getEdgeDetectFragDataId() const;
 
  const VRInfo* getVrInfo( const SoVolumeRender* vr );
  const VGSlice* getVgSlice( const size_t index );
  const VGSlice* getCurrentVgSlice();
 
private:
  virtual void GLRenderBelowPath(SoGLRenderAction *action);
  virtual void GLRenderInPath(SoGLRenderAction *action);
  
 private:
  // Destructor
  virtual ~SoVolumeGroup();
 
 private:
 
  typedef std::map<const SoVolumeRender*, VRInfo> VRInfoMap;
 
  SoVolumeOffscreenImpl* m_volumeOffscreenImpl;
 
  SoVRImageSpaceEffects* m_imageSpaceEffects;
 
  static void clearVRInfoStruct(const VRInfoMap::value_type& p);
 
  SoRef<SoFaceSet> buildFaceSet( const std::vector<int>& numVertices, const std::vector<SbVec3f>& vertices );
 
  VGState m_vgState;
  VRInfoMap m_vrInfoMap;
 
  std::vector<VGSlice*> m_slices;
  size_t m_currentSlice;
 
  int m_currentVolume;
 
  SbMatrix m_currentMatrix, m_currentMatrixInv;
  SbVec3f  m_currentPlane;
 
  SoRef<SoFaceSet> m_currentFaceSet;
  SoRef<SoVertexProperty> m_currentVp;
 
  void sortSlices();
  void renderSlices(SoState *state);
  static bool compareSlice(const VGSlice *s1, const VGSlice *s2);
 
  bool preRender(SoGLRenderAction *action, int &numberOfVolume);
  void postRender(SoGLRenderAction *action, int numberOfVolume);
 
  void setVGSlice(VGSlice* slice, float distance, SoLDMVirtualTexture* vt, int numVertices, SbVec3f vertices[], const SoVolumeRender* vr);
 
  void beginOffscreenRendering( SoGLRenderAction* action );
 
  void endOffscreenRendering( SoGLRenderAction* action );
 
  bool needRttColor(SoState* state) const;
 
  bool needRttEdgeDetect(SoState* state) const;
 
  int getEdgeDetect2DMethod(SoState* state) const;
 
  int getLowResolutionScale(SoState* state) const;
 
  void updateVRQ(int bitmask, std::vector<int>& bitMaskVector);
 
  void restoreVRQ(const std::vector<int>& bitMaskVector);
 
};
 
#if defined(_WIN32)
#pragma warning(pop)
#endif
 
#endif // _SO_VOLUME_GROUP_