SoDepthBufferElement.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (Apr 2009)
**=======================================================================*/
 
#ifndef _SO_DEPTH_BUFFER_ELEMENT_
#define _SO_DEPTH_BUFFER_ELEMENT_
 
#include <Inventor/SbBasic.h>
#include <Inventor/SbVec.h>
#include <Inventor/elements/SoSubElement.h>
#include <Inventor/SbEnums.h>
 
class SoDepthBuffer;
 
class  SoDepthBufferElement : public SoElement
{
  SO_ELEMENT_HEADER(SoDepthBufferElement);
 
public:
  enum DepthWriteFunction {
    NEVER = SbEnums::COMP_FUNC_NEVER,
    LESS = SbEnums::COMP_FUNC_LESS,
    EQUAL = SbEnums::COMP_FUNC_EQUAL,
    LEQUAL = SbEnums::COMP_FUNC_LESS_EQUAL,
    GREATER = SbEnums::COMP_FUNC_GREATER,
    NOTEQUAL = SbEnums::COMP_FUNC_NOT_EQUAL,
    GEQUAL = SbEnums::COMP_FUNC_GREATER_EQUAL,
    ALWAYS = SbEnums::COMP_FUNC_ALWAYS
  };
 
  static void set(SoState* state, const SbBool test, const SbBool write, const DepthWriteFunction function, const SbVec2f range);
 
  static void set(SoState* state, SoDepthBuffer* depthBuffer,  const SbBool test, const SbBool write, const DepthWriteFunction function, const SbVec2f range);
 
  static void get(SoState* state, SbBool& test, SbBool& write, DepthWriteFunction& function, SbVec2f& range);
 
  virtual void print(FILE *fp) const;
 
  virtual void push(SoState *state);
 
  virtual void pop(SoState *state, const SoElement *prevTopElement);
 
private:
 
  virtual void init(SoState *state);
 
  virtual SbBool matches(const SoElement* elt) const;
 
  virtual SoElement* copyMatchInfo() const;
 
 
private:
 
  static void initClass();
 
  static void exitClass();
 
  static SbBool getWriteMask(SoState * state);
 
  static void setWriteMask(SoState* state, const SbBool writeMask);
 
  static DepthWriteFunction getFunction(SoState * state);
 
  static void setFunction( SoState* state, const DepthWriteFunction function );
 
  static SbBool getTest( SoState * state );
 
  static void setTest( SoState* state, const SbBool test );
 
  static SbVec2f getRange(SoState * state);
 
  static SoDepthBuffer* getDepthBuffer(SoState * state);
 
  static DepthWriteFunction getDefaultFunction();
 
  static bool depthTest(DepthWriteFunction func, double currentDepth, double newDepth);
 
  static bool depthTest(SoState* state, double currentDepth, double newDepth);
 
private:
 
  virtual ~SoDepthBufferElement();
 
  virtual void setElt(SoDepthBuffer* depthBuffer, const SbBool enable, const SbBool write, const DepthWriteFunction function, const SbVec2f range);
 
private:
  SbBool test;
  SbBool write;
  DepthWriteFunction function;
  SbVec2f range;
 
  SoDepthBuffer* m_depthBuffer;
};
 
#endif /* _SO_DEPTH_BUFFER_ELEMENT_ */