SoDepthOffsetElement.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-2018 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Dec 2008)
**=======================================================================*/
 
#ifndef  SO_DEPTH_OFFSET_ELEMENT_H
#define  SO_DEPTH_OFFSET_ELEMENT_H
 
#include <Inventor/elements/SoFloatElement.h>
 
SoEXTENDER_Documented class  SoDepthOffsetElement : public SoFloatElement
{
 
  SO_ELEMENT_HEADER(SoDepthOffsetElement);
  
public:
 
  static void set(SoState *state, float offset);
 
  static void set(SoState *state, SoNode *, float offset);
 
  static void set(SoState *state, float, float, float);
 
  static float get(SoState *state);
 
  static void setMaxOffset(SoState *state, float offset);
 
  static float getMaxOffset(SoState *state);
 
  virtual void push( SoState* );
 
  virtual void pop(SoState*, const SoElement*);
 
private:
 
  virtual void init(SoState *state);
 
private:
  // Initializes the class
  static void initClass();
    static void exitClass();
 
  static void setNormalizationFactor(SoState *state, float value);
 
  static float getNormalizationFactor(SoState *state);
 
  static void setNDCadjustment(SoState *state, float value);
 
  static float getNDCadjustment(SoState *state);
 
  static void evalGlobalFactors(float offset, float& NDCadjustment, float &normFactor);
 
  // Specify the version of depth offset used :
  // V1 : Depth offset modifies camera projection matrix
  // V2 : Depth offset modifies projection matrix only here
  //      To have the same behavior than V1, you have to add a DepthOffset node
  //      with an offset at 0 on the root of the scene graph.
  enum DepthOffsetVersion
  {
    NONE = -1,
    V1 = 1,
    V2
  };
 
  static DepthOffsetVersion getDepthOffsetVersion();
 
  static void copyDepthOffset( SoState* dstState, SoState* srcState );
 
private:
  virtual ~SoDepthOffsetElement();
 
  float maxOffset;
  float localdata;
  float normalizationFactor;
  float NDCadjustment;
 
private :
 
  static DepthOffsetVersion s_depthOffsetVersion;
};
 
#endif // SO_DEPTH_OFFSET_ELEMENT_H