1 // Owner Drawn Gauge helper class
3 // Written by Harald JOHNSEN, started May 2005.
5 // Copyright (C) 2005 Harald JOHNSEN
7 // Ported to OSG by Tim Moore - Jun 2007
9 // Heavily modified to be usable for the 2d Canvas by Thomas Geymayer - April 2012
10 // Supports now multisampling/mipmapping, usage of the stencil buffer and placing
11 // the texture in the scene by certain filter criteria
13 // This library is free software; you can redistribute it and/or
14 // modify it under the terms of the GNU Library General Public
15 // License as published by the Free Software Foundation; either
16 // version 2 of the License, or (at your option) any later version.
18 // This library is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 // Library General Public License for more details.
23 // You should have received a copy of the GNU Library General Public
24 // License along with this library; if not, write to the Free Software
25 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
28 # include <simgear_config.h>
31 #include "ODGauge.hxx"
32 #include "CanvasSystemAdapter.hxx"
34 #include <simgear/debug/logstream.hxx>
35 #include <simgear/scene/util/RenderConstants.hxx>
37 #include <osg/Texture2D>
38 #include <osg/AlphaFunc>
39 #include <osg/BlendFunc>
42 #include <osg/PolygonMode>
43 #include <osg/ShadeModel>
44 #include <osg/StateSet>
45 #include <osg/FrameBufferObject> // for GL_DEPTH_STENCIL_EXT on Windows
54 //----------------------------------------------------------------------------
61 _coverage_samples( 0 ),
67 //----------------------------------------------------------------------------
73 //----------------------------------------------------------------------------
74 void ODGauge::setSystemAdapter(const SystemAdapterPtr& system_adapter)
76 _system_adapter = system_adapter;
79 //----------------------------------------------------------------------------
80 void ODGauge::setSize(int size_x, int size_y)
83 _size_y = size_y < 0 ? size_x : size_y;
88 texture->setTextureSize(_size_x, _size_y);
91 //----------------------------------------------------------------------------
92 void ODGauge::setViewSize(int width, int height)
95 _view_height = height < 0 ? width : height;
98 updateCoordinateFrame();
101 //----------------------------------------------------------------------------
102 void ODGauge::useImageCoords(bool use)
104 if( updateFlag(USE_IMAGE_COORDS, use) && texture )
105 updateCoordinateFrame();
108 //----------------------------------------------------------------------------
109 void ODGauge::useStencil(bool use)
111 if( updateFlag(USE_STENCIL, use) && texture )
115 //----------------------------------------------------------------------------
116 void ODGauge::useAdditiveBlend(bool use)
118 if( updateFlag(USE_ADDITIVE_BLEND, use) && camera )
122 //----------------------------------------------------------------------------
123 void ODGauge::setSampling( bool mipmapping,
124 int coverage_samples,
127 if( !updateFlag(USE_MIPMAPPING, mipmapping)
128 && _coverage_samples == coverage_samples
129 && _color_samples == color_samples )
132 if( color_samples > coverage_samples )
138 "ODGauge::setSampling: color_samples > coverage_samples not allowed!"
140 color_samples = coverage_samples;
143 _coverage_samples = coverage_samples;
144 _color_samples = color_samples;
149 //----------------------------------------------------------------------------
150 void ODGauge::setRender(bool render)
152 // Only the far camera should trigger this texture to be rendered.
153 camera->setNodeMask(render ? simgear::BACKGROUND_BIT : 0);
156 //----------------------------------------------------------------------------
157 bool ODGauge::serviceable(void)
159 return _flags & AVAILABLE;
162 //----------------------------------------------------------------------------
163 void ODGauge::allocRT(osg::NodeCallback* camera_cull_callback)
165 camera = new osg::Camera;
166 camera->setDataVariance(osg::Object::DYNAMIC);
167 camera->setReferenceFrame(osg::Transform::ABSOLUTE_RF);
168 camera->setRenderOrder(osg::Camera::PRE_RENDER);
169 camera->setClearColor(osg::Vec4(0.0f, 0.0f, 0.0f , 0.0f));
170 camera->setClearStencil(0);
171 camera->setRenderTargetImplementation( osg::Camera::FRAME_BUFFER_OBJECT,
172 osg::Camera::FRAME_BUFFER );
174 if( camera_cull_callback )
175 camera->setCullCallback(camera_cull_callback);
178 updateCoordinateFrame();
181 osg::StateSet* stateSet = camera->getOrCreateStateSet();
182 stateSet->setMode(GL_LIGHTING, osg::StateAttribute::OFF);
183 stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::OFF);
184 stateSet->setMode(GL_FOG, osg::StateAttribute::OFF);
185 stateSet->setMode(GL_DEPTH_TEST, osg::StateAttribute::OFF);
186 stateSet->setAttributeAndModes(
187 new osg::PolygonMode( osg::PolygonMode::FRONT_AND_BACK,
188 osg::PolygonMode::FILL ),
189 osg::StateAttribute::ON );
190 stateSet->setAttributeAndModes(
191 new osg::AlphaFunc(osg::AlphaFunc::GREATER, 0.001f),
192 osg::StateAttribute::ON );
193 stateSet->setAttribute(new osg::ShadeModel(osg::ShadeModel::FLAT));
197 texture = new osg::Texture2D;
198 texture->setTextureSize(_size_x, _size_y);
199 texture->setInternalFormat(GL_RGBA);
205 if( _system_adapter )
206 _system_adapter->addCamera(camera.get());
211 //----------------------------------------------------------------------------
212 void ODGauge::reinit()
214 osg::NodeCallback* cull_callback = camera ? camera->getCullCallback() : 0;
216 allocRT(cull_callback);
219 //----------------------------------------------------------------------------
220 void ODGauge::clear()
222 if( camera.valid() && _system_adapter )
223 _system_adapter->removeCamera(camera.get());
227 _flags &= ~AVAILABLE;
230 //----------------------------------------------------------------------------
231 bool ODGauge::updateFlag(Flags flag, bool enable)
233 if( bool(_flags & flag) == enable )
240 //----------------------------------------------------------------------------
241 void ODGauge::updateCoordinateFrame()
245 if( _view_width < 0 )
246 _view_width = _size_x;
247 if( _view_height < 0 )
248 _view_height = _size_y;
250 camera->setViewport(0, 0, _size_x, _size_y);
252 if( _flags & USE_IMAGE_COORDS )
253 camera->setProjectionMatrix(
254 osg::Matrix::ortho2D(0, _view_width, _view_height, 0)
257 camera->setProjectionMatrix(
258 osg::Matrix::ortho2D( -_view_width/2., _view_width/2.,
259 -_view_height/2., _view_height/2. )
263 //----------------------------------------------------------------------------
264 void ODGauge::updateStencil()
268 GLbitfield mask = GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT;
270 if( _flags & USE_STENCIL )
272 camera->attach( osg::Camera::PACKED_DEPTH_STENCIL_BUFFER,
273 GL_DEPTH_STENCIL_EXT );
274 mask |= GL_STENCIL_BUFFER_BIT;
278 camera->detach(osg::Camera::PACKED_DEPTH_STENCIL_BUFFER);
281 camera->setClearMask(mask);
284 //----------------------------------------------------------------------------
285 void ODGauge::updateSampling()
291 osg::Texture2D::MIN_FILTER,
292 (_flags & USE_MIPMAPPING) ? osg::Texture2D::LINEAR_MIPMAP_LINEAR
293 : osg::Texture2D::LINEAR
296 osg::Camera::COLOR_BUFFER,
299 _flags & USE_MIPMAPPING,
305 //----------------------------------------------------------------------------
306 void ODGauge::updateBlendMode()
310 camera->getOrCreateStateSet()
311 ->setAttributeAndModes
313 (_flags & USE_ADDITIVE_BLEND)
314 ? new osg::BlendFunc( osg::BlendFunc::SRC_ALPHA,
315 osg::BlendFunc::ONE_MINUS_SRC_ALPHA,
317 osg::BlendFunc::ONE )
318 : new osg::BlendFunc( osg::BlendFunc::SRC_ALPHA,
319 osg::BlendFunc::ONE_MINUS_SRC_ALPHA )
323 } // namespace canvas
324 } // namespace simgear