Developer Documentation
StencilRefNode.cc
1 /*===========================================================================*\
2  * *
3  * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40 \*===========================================================================*/
41 
42 
43 
44 //=============================================================================
45 //
46 // CLASS StencilRefNode - IMPLEMENTATION
47 //
48 //=============================================================================
49 
50 
51 //== INCLUDES =================================================================
52 
53 
54 #include "StencilRefNode.hh"
55 
56 
57 //== NAMESPACES ===============================================================
58 
59 
60 namespace ACG {
61 namespace SceneGraph {
62 
63 
64 //== IMPLEMENTATION ==========================================================
65 
66 
68  const std::string& _name)
69  : BaseNode(_parent, _name),
70  reference_ (0)
71 {}
72 
73 //----------------------------------------------------------------------------
74 
76  BaseNode* _child,
77  const std::string& _name)
78  : BaseNode(_parent, _child, _name),
79  reference_ (0)
80 {}
81 
82 //----------------------------------------------------------------------------
83 
84 void StencilRefNode::enter(GLState& /*_state*/, const DrawModes::DrawMode& /*_drawmode*/)
85 {
86  if(visible()) {
87  glPushAttrib (GL_STENCIL_BUFFER_BIT);
88  glStencilFunc (GL_ALWAYS, reference_, ~0);
89  glStencilOp (GL_KEEP, GL_KEEP, GL_REPLACE);
90  }
91 }
92 
93 //----------------------------------------------------------------------------
94 
95 void StencilRefNode::leave(GLState& /*_state*/, const DrawModes::DrawMode& /*_drawmode*/)
96 {
97  if(visible()) {
98  glPopAttrib ();
99  }
100 }
101 
102 //----------------------------------------------------------------------------
103 
104 void StencilRefNode::enterPick(GLState& /*_state*/ , PickTarget /*_target*/, const DrawModes::DrawMode& /*_drawMode*/ ) {
105 
106 }
107 
108 //----------------------------------------------------------------------------
109 
110 void StencilRefNode::leavePick(GLState& /*_state*/, PickTarget /*_target*/, const DrawModes::DrawMode& /*_drawMode*/ ) {
111 }
112 
114 {
115  reference_ = _ref;
116 }
117 
118 //=============================================================================
119 } // namespace SceneGraph
120 } // namespace ACG
121 //=============================================================================
122 
void enter(GLState &_state, const DrawModes::DrawMode &_drawmode) override
set stencil reference for all z-pass pixels
Namespace providing different geometric functions concerning angles.
void leavePick(GLState &_state, PickTarget _target, const DrawModes::DrawMode &_drawMode) override
Do nothing in picking.
void enterPick(GLState &_state, PickTarget _target, const DrawModes::DrawMode &_drawMode) override
Do nothing in picking.
PickTarget
What target to use for picking.
Definition: PickTarget.hh:73
void leave(GLState &_state, const DrawModes::DrawMode &_drawmode) override
restores original stencil behavior
bool visible()
Is node visible (status == Active)?
void setReference(GLuint _ref)
set stencil reference number
StencilRefNode(BaseNode *_parent=0, const std::string &_name="<StencilRefNode>")
Default constructor.