VolumeViz/nodes/SoVolumeClippingGroup.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      : Benjamin GRANGE (Aug 2006)
** Modified    : David BEILLOIN (Mar 2011)
**=======================================================================*/
#ifndef  _SO_VOLUME_CLIPPING_GROUP_
#define  _SO_VOLUME_CLIPPING_GROUP_

#include <Inventor/nodes/SoGroup.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/SbBox.h>

class SoGLDepthPeeling;
class SoState;
class SoROI;
class SoVolumeData;
class SoShaderProgram;
class SoShapeHints;

class  SoVolumeClippingGroup : public SoGroup {
  SO_NODE_HEADER( SoVolumeClippingGroup );

 public:

  SoVolumeClippingGroup();

  SoSFInt32 numPasses;

  SoSFBool clipOutside;

  static SbBool isSupported(SoState* state=NULL) ;

  static unsigned int getMaxNumPasses(SoState* state=NULL);

  typedef void SoVolumeClippingGroupCB( SoVolumeClippingGroup *mgr, void *userData );

  void setNotEnoughPassCallback( SoVolumeClippingGroupCB *f, void *userData );

 private:
  virtual void GLRender(SoGLRenderAction *action);
  virtual void doAction(SoAction *action);
  virtual void getBoundingBox(SoGetBoundingBoxAction *action);

  virtual void rayPick(SoRayPickAction *action);

  virtual void notify(SoNotList *list);

 private:
  static void initClass() ;
  static void exitClass() ;

  //Set depth textures and activate shaders in SoVolumeRender
  void activeShaderAndBindTextures(SoGLRenderAction *action);

  //Get the texture unit number where the first depth layer is binded
  int getFistDepthTextureUnit(SoGLRenderAction *action) const;

  //Return the number of depth textures pairs
  int getNumPairs() const;

  //Return 1/DepthTexSize
  SbVec3f getTexScaleFactor() const;

  // Return TRUE if using 2D texture array
  SbBool isUsingTextureArray() const;

  //Return the real number of depth layer passes used
  int getNumPassUsed() const;

  //TRUE if box is not into the clipping volume
  SbBool isCulled(const SbBox3f &box);


  //Used by SoVolumeShader to update its uniforms
  SbBool needViewportSizeUpdate() const { return m_needViewportSizeUpdate; }
  SbBool needNumPassesUpdate() const { return m_needNumPassesUpdate; }
  SbBool needExclusiveModeUpdate() const { return m_needExclusiveModeUpdate; }

  void numPassesUpdated() { m_needNumPassesUpdate = FALSE; }
  void exclusiveModeUpdated() { m_needExclusiveModeUpdate = FALSE; }

  // This is used by SoVolumeGroupElement just to ensure that
  // the resources won't be allocated-computed-release for each path
  // collected by the SoVolumeGroup node.
  //
  // This method is called by SoVolumeClippingGroup itself. The SoVolumeGroupElement calls the unlock
  // in order to allow releaseResources to do the job.
  void lockResources();

  // Release previously locked resources.
  void unlockResources();

  // Indicates if the resources are locked or not.
  bool areResourcesLocked();

  // Release the depth peeling resources if they are not locked.
  // Most of the time it is called by SoVolumeClippingGroupElement, except when we do multi volume 
  // the release is done by SoVolumeGroupElement.
  void releaseResources(SoState* state);

  inline const SbXfBox3f& getWorldBbox() const { return m_worldBbox; }

private:
  virtual ~SoVolumeClippingGroup();

private:

  enum LayersState
  {
    NOT_COMPUTED,
    COMPUTED,
  };

  LayersState m_layersState;

  bool m_isLocked;

  // max pass when texture_array is not supported.
  static const int MAX_NUM_PASSES = 5;


  struct NotEnoughLayerCBData {
    NotEnoughLayerCBData() : m_notEnoughPassCB(NULL), m_notEnoughPassCBData(NULL), that(NULL) {}
    SoVolumeClippingGroupCB* m_notEnoughPassCB;
    void* m_notEnoughPassCBData;
    SoVolumeClippingGroup* that;
  };
  NotEnoughLayerCBData m_notEnoughLayerCBData;

  static void notEnoughLayerCB(void *userData, SoGLDepthPeeling *mgr);

  void commonInit() ;

  SbBool initDepthPeeling(SoGLRenderAction *action, const SbVec2s &vpSize);

  SbBool m_depthRendered;
  SoGLDepthPeeling *m_glDepthPeeling;

  SbVec2s m_previousViewportSize;

  SbBool m_needViewportSizeUpdate;
  SbBool m_needNumPassesUpdate;
  SbBool m_needExclusiveModeUpdate;

  // update bbox of the clipping volume
  void updateChildBBox(SoAction*);
  // get bbox of the clipping volume
  const SbXfBox3f& getBBox(SoAction*);

  SbBool m_applyTochild;
  SbXfBox3f m_bbox;
  bool m_bboxCacheClean;

  SbXfBox3f m_worldBbox;

  struct SoVolumeClippingInfos {
    SoVolumeClippingGroup *cg;
    SoGLRenderAction *ra;
  } m_clippingInfos;
  static void renderCB(void *userData, SoGLDepthPeeling *mgr);

  SbBool m_depthPeelingPass;

  SbBool m_releaseResources;

  SoShapeHints* m_shapeHintOverride;

  static bool s_debugVolumeClipping;
  SoShaderProgram* m_showDepthShader;
  void debugGLRender(SoGLRenderAction *action);
  void createDebugShader();

};
/*----------------------------------------------------------------------------*/
#endif

---

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