SoShadowGroup.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      : R.ALBOU (Sep 2001)
**=======================================================================*/
#ifndef  _SO_SHADOW_GROUP_
#define  _SO_SHADOW_GROUP_
 
 
#include <Inventor/nodes/SoGroup.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/SbMatrix.h>
#include <Inventor/SbPImpl.h>
 
class SoGLShadowMapping ;
class SoCache ;
class SoGLTexture;
 
SO_PIMPL_PUBLIC_DECLARATION(SoShadowGroup)
 

class  SoShadowGroup : public SoGroup
{
  SO_NODE_HEADER(SoShadowGroup);
  SO_PIMPL_PUBLIC_HEADER(SoShadowGroup)
 
public:
  enum VisibilityFlag {
    ABSOLUTE_RADIUS,

    LONGEST_BBOX_EDGE_FACTOR
  } ;

  enum ShadowingMethod {
    VARIANCE_SHADOW_MAP,
    #ifndef HIDDEN_FROM_DOC
    LAST_METHOD
    #endif
  };

  SoShadowGroup();

  SoShadowGroup(int nChildren);

  SoSFBool        isActive ;

  SoSFFloat   intensity ;

  SoSFFloat   precision ;

  SoSFFloat   quality ;

  SoSFBool    shadowCachingEnabled ;

  SoSFFloat   visibilityRadius ;

  SoSFEnum    visibilityFlag ;
 

  SoSFInt32 smoothFactor;

  SoSFFloat minVariance;

  SoSFFloat lightBleedingReduction;

  SoSFEnum method;

  static SbBool isSupported(SoShadowGroup::ShadowingMethod method = SoShadowGroup::VARIANCE_SHADOW_MAP) ;
 
 
private:
  virtual void GLRender(SoGLRenderAction *action);
 
  /*----------------------------------------------------------------------------*/
 
private:
  typedef std::vector<int> StackIndexVector;
 
  static void initClass() ;
  static void exitClass() ;
 
  const std::vector<SbMatrix>& getLightViewMatrices() const;
 
  const std::vector<SbMatrix>& getLightViewProjectionMatrices() const;
 
  const std::vector<SbVec2f>& getLightsNearFar() const;
 
  const std::vector<SbVec2i32>& getLightMatricesOffsetsAndNums() const;
 
  const std::vector<float>& getLightShadowIntensities() const;
 
  int getLightMatrixIndex() const;

  static int getShadowMapTextureUnit(SoGLRenderAction* action);

  void invalidateLightCaches();

  bool isCacheValid(SoState* state, SoCache* &cache, const StackIndexVector& elemsToCheck);
 

  bool isShadowActive(SoState* state) const;

  float getQuality(SoState* state) const;

  virtual void notify(SoNotList *list);

  SbVec2i32 getShadowMapSize() const;
 
private:
  virtual ~SoShadowGroup();

  void destroy() override;
 
private:
 
#if 1             SoDEPRECATED
  SoSFBool        isShapesBefore;
#endif  

  void addElementsToCache(SoState* state, SoCache* cache) const;

  void chooseShadowingMethod();

  inventor::impl::SoShadowGroupImpl* createImplementation() const;
 
  void commonInit();

  static int s_defaultTextureUnit;
};
/*----------------------------------------------------------------------------*/
#endif // _SO_SHADOW_GROUP_