StencilRefNode.hh 5.08 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
Jan Möbius's avatar
Jan Möbius committed
4
 *      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen      *
Jan Möbius's avatar
Jan Möbius committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
Jan Möbius's avatar
Jan Möbius committed
37 38 39
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
Jan Möbius's avatar
Jan Möbius committed
40 41
 *                                                                           *
\*===========================================================================*/
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95




//=============================================================================
//
//  CLASS StencilRefNode
//
//=============================================================================


#ifndef ACG_STENCILREF_NODE_HH
#define ACG_STENCILREF_NODE_HH


//== INCLUDES =================================================================


#include "BaseNode.hh"


//== NAMESPACES ===============================================================

namespace ACG {
namespace SceneGraph {


//== CLASS DEFINITION =========================================================


/** \class StencilRefNode StencilRefNode.hh <ACG/Scenegraph/StencilRefNode.hh>
    Sets the stencil buffer reference for its child nodes
**/

class ACGDLLEXPORT StencilRefNode : public BaseNode
{
public:

  /// Default constructor.
  StencilRefNode (BaseNode*           _parent = 0,
	          const std::string&  _name = "<StencilRefNode>");

  /// Put this node between _parent and _child
  StencilRefNode (BaseNode*           _parent,
                  BaseNode*           _child,
                  const std::string&  _name="<unknown>");

  /// set class name
  ACG_CLASSNAME(StencilRefNode);

  /// set stencil reference number
  void setReference (GLuint _ref);

  /// set stencil reference for all z-pass pixels
96
  void enter(GLState& _state, const DrawModes::DrawMode& _drawmode);
97 98

  /// restores original stencil behavior
99
  void leave(GLState& _state, const DrawModes::DrawMode& _drawmode);
100 101 102

  /** \brief Do nothing in picking
   */
103
  void enterPick(GLState& _state, PickTarget _target, const DrawModes::DrawMode& _drawMode );
104 105 106

  /** \brief Do nothing in picking
   */
107
  void leavePick(GLState& _state, PickTarget _target, const DrawModes::DrawMode& _drawMode );
108 109 110 111 112 113 114 115 116 117 118 119 120 121

private:

  GLuint reference_;
};


//=============================================================================
} // namespace SceneGraph
} // namespace ACG
//=============================================================================
#endif // ACG_ENVMAP_NODE_HH defined
//=============================================================================