SoVolumeGroup.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-2025 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>
 
#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,
  };

  virtual bool affectsPath() const;
 
  static void initClass();
  static void exitClass();
 
  void addVolume(SoState* state, const SoVolumeRender* vr, SoLDMVirtualTexture* vt, SbVec3f planeNormal, int vpScale, float sliceDensity);
  void addSlice(const SoVolumeRender* vr, int numVertices, SbVec3f* vertices);
  VGState getVGState() const { return m_vgState; };
 
  /* return edgeDetectfragDataId created by registerRTT */
  int getEdgeDetectFragDataId() const;
 
  float getSliceDensity(const SoVolumeRender* vr) const;
 
  SoVolumeRenderingQuality* getVRQ(const SoVolumeRender* vr) const;
 
  typedef std::pair< unsigned int, SoRef<SoShape> > IdShapePair;
 
  const std::vector<IdShapePair>& getInternalShapeListForThisVr(const SoVolumeRender* vr) const;
 
private:
  virtual void GLRenderBelowPath(SoGLRenderAction* action);
  virtual void GLRenderInPath(SoGLRenderAction* action);
 
 private:
  // Destructor
  virtual ~SoVolumeGroup();
 
 private:
 
  struct Slice {
    // 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;
    std::vector<SbVec3f> vertices;
    const SoVolumeRender* vr;
    Slice(float distance, int numVertices, SbVec3f* vertices, const SoVolumeRender* vr);
  };
 
 
  struct VRInfo {
    const SoVolumeRender* vr;
    SoPath* path;
    SoVolumeRenderingQuality* vrq;
    SoLDMVirtualTexture* texID;
    int vpScale;
    float sliceDensity;
    SbVec3f planeNormal;
    SbMatrix viewingMatrix;
 
    bool operator==(const SoVolumeRender* _vr) const
    {
      return this->vr == _vr;
    }
  };
 
  typedef std::vector<VRInfo> VRInfoList;
  typedef std::map< const SoVolumeRender*, std::vector< IdShapePair > > VRContinuousShapeMap;
 
  std::map < const SoVolumeRender*, SoRef<SoVolumeRenderingQuality> > m_vrVrqMap;
 
  VRContinuousShapeMap m_vrContinuousShapeMap;
 
  SoVolumeOffscreenImpl* m_volumeOffscreenImpl;

  SoVRImageSpaceEffects* m_imageSpaceEffects;

  SoRef<SoShape> buildShapeSlices(const SoVolumeRender* vr, unsigned int orderedShapeId, unsigned int id, const std::vector<SbVec3f>& vertices);
 
  VGState m_vgState;
  VRInfoList m_vrInfoList;

  std::vector<Slice*> m_slices;
 
  void sortSlices();
  void renderSlices(SoState *state);
  static bool compareSlice(const Slice*s1, const Slice*s2);

  bool preRender(SoGLRenderAction *action, int &numberOfVolume);
  void postRender(SoGLRenderAction *action, int numberOfVolume);

  void beginOffscreenRendering( SoGLRenderAction* action );

  void endOffscreenRendering( SoGLRenderAction* action );

  bool needRttEdgeDetect(SoState* state) const;

  int getEdgeDetect2DMethod(SoState* state) const;

  int getLowResolutionScale() 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_