SoBlendElement.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#ifndef _SO_BLEND_ELEMENT_H
#define _SO_BLEND_ELEMENT_H
 
#include <Inventor/SbColorRGBA.h>
#include <Inventor/elements/SoElement.h>
#include <Inventor/elements/SoSubElement.h>
#include <Inventor/SbEnums.h>

class  SoBlendElement : public SoElement
{
  SO_ELEMENT_HEADER( SoBlendElement );
 
public:
  enum BlendFactor
  {
    ZERO = SbEnums::BLEND_ZERO,
    ONE = SbEnums::BLEND_ONE,
    SRC_COLOR = SbEnums::BLEND_SRC_COLOR,
    ONE_MINUS_SRC_COLOR = SbEnums::BLEND_ONE_MINUS_SRC_COLOR,
    DST_COLOR = SbEnums::BLEND_DST_COLOR,
    ONE_MINUS_DST_COLOR = SbEnums::BLEND_ONE_MINUS_DST_COLOR,
    SRC_ALPHA = SbEnums::BLEND_SRC_ALPHA,
    ONE_MINUS_SRC_ALPHA = SbEnums::BLEND_ONE_MINUS_SRC_ALPHA,
    DST_ALPHA = SbEnums::BLEND_DST_ALPHA,
    ONE_MINUS_DST_ALPHA = SbEnums::BLEND_ONE_MINUS_DST_ALPHA,
    CONSTANT_COLOR = SbEnums::BLEND_CONSTANT_COLOR,
    ONE_MINUS_CONSTANT_COLOR = SbEnums::BLEND_ONE_MINUS_CONSTANT_COLOR,
    CONSTANT_ALPHA = SbEnums::BLEND_CONSTANT_ALPHA,
    ONE_MINUS_CONSTANT_ALPHA = SbEnums::BLEND_ONE_MINUS_CONSTANT_ALPHA,
    SRC_ALPHA_SATURATE = SbEnums::BLEND_SRC_ALPHA_SATURATE,
    SRC1_COLOR = SbEnums::BLEND_SRC1_COLOR,
    ONE_MINUS_SRC1_COLOR = SbEnums::BLEND_ONE_MINUS_SRC1_COLOR,
    SRC1_ALPHA = SbEnums::BLEND_SRC1_ALPHA,
    ONE_MINUS_SRC1_ALPHA = SbEnums::BLEND_ONE_MINUS_SRC1_ALPHA
  };

  enum BlendEquation
  {
    FUNC_ADD = SbEnums::BLEND_FUNC_ADD,
    FUNC_SUBTRACT = SbEnums::BLEND_FUNC_SUBTRACT,
    FUNC_REVERSE_SUBTRACT = SbEnums::BLEND_FUNC_REVERSE_SUBTRACT,
    MIN = SbEnums::BLEND_FUNC_MIN,
    MAX = SbEnums::BLEND_FUNC_MAX
  };

  struct  BlendElementParameters {
    BlendElementParameters()
      : enabled(false)
      , sourceRGBFactor( SoBlendElement::ONE )
      , destinationRGBFactor( SoBlendElement::ZERO )
      , sourceAlphaFactor( SoBlendElement::ONE )
      , destinationAlphaFactor( SoBlendElement::ZERO )
      , equation( SoBlendElement::FUNC_ADD )
      , color( SbColorRGBA( 0, 0, 0, 0 ) )
    {
    }
 
    bool operator == (const BlendElementParameters& other) const;
    bool operator != (const BlendElementParameters& other) const;
 
    bool enabled;
    BlendFactor sourceRGBFactor;
    BlendFactor destinationRGBFactor;
    BlendFactor sourceAlphaFactor;
    BlendFactor destinationAlphaFactor;
    BlendEquation equation;
    SbColorRGBA color;
  };

  static void set( SoState* state, const BlendElementParameters& parameters );

  static void setBlending( SoState* state, bool enabled );

  static void setFunction( SoState* state, const BlendFactor source, const BlendFactor destination );

  static void get( SoState* state, BlendElementParameters& parameter );

  virtual void print( FILE* fp ) const;

  virtual void push( SoState* state );

  virtual void pop( SoState* state, const SoElement* prevTopElement );
 
private:
  virtual ~SoBlendElement();

  virtual void init( SoState* state );

  virtual void setElt( const BlendElementParameters& parameter );

  virtual SbBool matches( const SoElement* element ) const;

  virtual SoElement* copyMatchInfo() const;
 
private:

  static void initClass();

  static void exitClass();
 
private:
  BlendElementParameters m_parameters;
};
 
#endif // _SO_BLEND_ELEMENT_H