SoVolumeRenderingQuality.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      : Benjamin GRANGE (Aug 2005)
**=======================================================================*/
 
 
#ifndef _SO_VOLUME_QUALITY_H_
#define _SO_VOLUME_QUALITY_H_
 
 
#include <Inventor/SbBasic.h>
#include <Inventor/fields/SoMFNode.h>
#include <Inventor/fields/SoSFBitMask.h>
#include <Inventor/fields/SoSFColor.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/nodes/SoGroup.h>
#include <VolumeViz/nodes/SoVolumeShader.h>
 
/*----------------------------------------------------------------------------*/
class SoFragmentShader;
class SoVertexShader;
class SoTransferFunction;
class SoVolumeShader;
class SoNodeDependencies;

class  SoVolumeRenderingQuality : public SoVolumeShader {
 
  SO_NODE_HEADER(SoVolumeRenderingQuality);
 
public:
  enum GradientQuality
  {
    LOW = 0,

    MEDIUM,

    HIGH,
#ifndef HIDDEN_FROM_DOC
    LAST_GRADIENT_QUALITY
#endif
  };

  enum EdgeDetect2DMethod {
    LUMINANCE = 1,

    DEPTH = 1 << 1,

    GRADIENT = 1 << 2
  };

  SoVolumeRenderingQuality();

  SoSFBool lighting;

  SoSFBool preIntegrated;

  SoSFBool jittering;

  SoSFFloat gradientThreshold;

  SoSFBool edgeColoring;

  SoSFColor edgeColor;

  SoSFFloat edgeThreshold;

  SoSFBool boundaryOpacity;

  SoSFFloat boundaryOpacityIntensity;

  SoSFFloat boundaryOpacityThreshold;

  SoSFBool edgeDetect2D;

  SoSFFloat edgeDetect2DInnerThreshold;

  SoSFFloat edgeDetect2DOuterThreshold;

  SoSFBitMask edgeDetect2DMethod;

  SoSFEnum gradientQuality;

  SoSFBool colorInterpolation;

  SoSFFloat surfaceScalarExponent;

  SoSFFloat unnormalizedGradientExponent;

  SoSFBool segmentedInterpolation;

  SoSFFloat segmentedInterpolationThreshold;

  SoSFBool voxelizedRendering;

  SoSFBool voxelOutline;

  SoSFFloat voxelOutlineThreshold;

  SoSFFloat voxelOutlineWidth;

  SoSFColor voxelOutlineColor;

  SoSFBool ambientOcclusion;

  SoSFBool deferredLighting;
 
#if 1             
SoDEPRECATED
  SoSFBool cubicInterpolation;
 
#endif 
 
#if 1             

   /** @deprecated @DEPRECATED_SINCE_OIV 10000 @BR No longer used. OPENGL mode is always used. */SoDEPRECATED enum LightingModel
  {
    OIV6,
    OPENGL
  };
SoDEPRECATED
  SoSFEnum lightingModel;
 
#endif 
 
#ifndef HIDDEN_FROM_DOC
  private:

  enum ShadowingMethod
  {
    SHADOW_MAP,

    RAYCASTING,
  };

  SoSFEnum shadowingMethod;

  SoSFFloat AORadius;
  SoSFFloat AONumSample;
  SoSFFloat AOKernelSize;
  SoSFBool AOUseNormal;
  SoSFBool AOShowAO;
  SoSFBool AOShowNormal;
 
  void GLRender(SoGLRenderAction *action);
  virtual void doAction(SoAction *action);
  virtual void notify(SoNotList* list);
 
  // Initializes the classes.
  static void initClass();
  static void exitClass();

  GradientQuality getGradientMethod(SoState* state) const;

  SbBool hasEdgeDetect2d(SoState* state) const;

  SbBool hasAmbientOcclusion(SoState* state) const;

  SbBool hasDeferredLighting(SoState* state) const;

  SbBool hasCubicInterpolation(SoState* state) const;

  SbBool hasBoundaryOpacity(SoState* state) const;

  virtual void installTextures(SoGLRenderAction* action);
  
  virtual SbBool isRaycastingEnabled(SoState* state) const;

  virtual void allocateTextureUnit(SoGLRenderAction *action) const;

  SbBool isVoxelizedRenderingEnabled(SoState* state) const;

  virtual bool isInterpolationActive(SoGLRenderAction* action);

  virtual bool isColorInterpolationEnabled(SoState* state);

  bool isPreintegratedEnabled(SoState* state) const;

  void setRemovePhysicalQuality( bool removePhysicalQuality );

  void setRenderMode( SoVolumeRender::RenderMode renderMode ) { m_renderMode = renderMode; }
private:
 
  virtual ~SoVolumeRenderingQuality();
 
#endif
 
private:
 
  static const float DEFAULT_INNER_EDGE_THRESHOLD;
  static const float DEFAULT_OUTTER_EDGE_THRESHOLD;

  void checkAndUpdateEdge2DSupport(SoGLRenderAction* action);

  SbBool hasEdgeColoring(SoState* state) const;

  void clampEdgeDetect2dFields();
 
  SoNodeDependencies* m_transferFunctionCache;

  SoRef<SoGroup> m_preIntegratedScene;
  SoGroup* m_preIntegratedTexPlaceHolder;
  SoTextureUnit* m_preIntegratedTexUnit;

  bool m_removePhysicalQuality;

  SoVolumeRender::RenderMode m_renderMode;
};
/*----------------------------------------------------------------------------*/
 
#endif /*_SO_VOLUME_QUALITY_H_*/