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 program is free software; you can redistribute it and/or
14 // modify it under the terms of the GNU General Public License as
15 // published by the Free Software Foundation; either version 2 of the
16 // License, or (at your option) any later version.
18 // This program is distributed in the hope that it will be useful, but
19 // WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 // General Public License for more details.
23 // You should have received a copy of the GNU General Public License
24 // along with this program; if not, write to the Free Software
25 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
33 #include <osg/Texture2D>
34 #include <osg/AlphaFunc>
35 #include <osg/BlendFunc>
38 #include <osg/NodeVisitor>
40 #include <osg/PolygonMode>
41 #include <osg/ShadeModel>
42 #include <osg/StateSet>
43 #include <osg/FrameBufferObject> // for GL_DEPTH_STENCIL_EXT on Windows
45 #include <osgDB/FileNameUtils>
47 #include <simgear/scene/material/EffectGeode.hxx>
48 #include <simgear/scene/util/RenderConstants.hxx>
50 #include <Main/globals.hxx>
51 #include <Viewer/renderer.hxx>
52 #include <Scenery/scenery.hxx>
53 #include "od_gauge.hxx"
57 //------------------------------------------------------------------------------
58 FGODGauge::FGODGauge():
63 _use_image_coords( false ),
64 _use_stencil( false ),
65 _use_mipmapping( false ),
66 _coverage_samples( 0 ),
72 //------------------------------------------------------------------------------
73 FGODGauge::~FGODGauge()
76 globals->get_renderer()->removeCamera(camera.get());
79 //------------------------------------------------------------------------------
80 void FGODGauge::setSize(int size_x, int size_y)
83 _size_y = size_y < 0 ? size_x : size_y;
86 texture->setTextureSize(_size_x, _size_x);
89 //----------------------------------------------------------------------------
90 void FGODGauge::setViewSize(int width, int height)
93 _view_height = height < 0 ? width : height;
96 updateCoordinateFrame();
99 //------------------------------------------------------------------------------
100 void FGODGauge::useImageCoords(bool use)
102 if( use == _use_image_coords )
105 _use_image_coords = use;
108 updateCoordinateFrame();
111 //------------------------------------------------------------------------------
112 void FGODGauge::useStencil(bool use)
114 if( use == _use_stencil )
123 //------------------------------------------------------------------------------
124 void FGODGauge::setSampling( bool mipmapping,
125 int coverage_samples,
128 if( _use_mipmapping == mipmapping
129 && _coverage_samples == coverage_samples
130 && _color_samples == color_samples )
133 _use_mipmapping = mipmapping;
135 if( color_samples > coverage_samples )
141 "FGODGauge::setSampling: color_samples > coverage_samples not allowed!"
143 color_samples = coverage_samples;
146 _coverage_samples = coverage_samples;
147 _color_samples = color_samples;
152 //------------------------------------------------------------------------------
153 bool FGODGauge::serviceable(void)
158 //------------------------------------------------------------------------------
159 void FGODGauge::allocRT(osg::NodeCallback* camera_cull_callback)
161 camera = new osg::Camera;
162 camera->setDataVariance(osg::Object::DYNAMIC);
163 // Only the far camera should trigger this texture to be rendered.
164 camera->setNodeMask(simgear::BACKGROUND_BIT);
165 camera->setReferenceFrame(osg::Transform::ABSOLUTE_RF);
166 camera->setRenderOrder(osg::Camera::PRE_RENDER);
167 camera->setClearColor(osg::Vec4(0.0f, 0.0f, 0.0f , 0.0f));
168 camera->setClearStencil(0);
169 camera->setRenderTargetImplementation( osg::Camera::FRAME_BUFFER_OBJECT,
170 osg::Camera::FRAME_BUFFER );
172 if( camera_cull_callback )
173 camera->setCullCallback(camera_cull_callback);
175 updateCoordinateFrame();
178 osg::StateSet* stateSet = camera->getOrCreateStateSet();
179 stateSet->setMode(GL_LIGHTING, osg::StateAttribute::OFF);
180 stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::OFF);
181 stateSet->setMode(GL_FOG, osg::StateAttribute::OFF);
182 stateSet->setMode(GL_DEPTH_TEST, osg::StateAttribute::OFF);
183 stateSet->setAttributeAndModes(new osg::PolygonMode(osg::PolygonMode::FRONT_AND_BACK,
184 osg::PolygonMode::FILL),
185 osg::StateAttribute::ON);
186 stateSet->setAttributeAndModes(new osg::AlphaFunc(osg::AlphaFunc::GREATER,
188 osg::StateAttribute::ON);
189 stateSet->setAttribute(new osg::ShadeModel(osg::ShadeModel::FLAT));
190 stateSet->setAttributeAndModes(new osg::BlendFunc(osg::BlendFunc::SRC_ALPHA,
191 osg::BlendFunc::ONE_MINUS_SRC_ALPHA),
192 osg::StateAttribute::ON);
195 texture = new osg::Texture2D;
196 texture->setTextureSize(_size_x, _size_y);
197 texture->setInternalFormat(GL_RGBA);
202 globals->get_renderer()->addCamera(camera.get(), false);
206 //------------------------------------------------------------------------------
207 void FGODGauge::updateCoordinateFrame()
211 if( _view_width < 0 )
212 _view_width = _size_x;
213 if( _view_height < 0 )
214 _view_height = _size_y;
216 camera->setViewport(0, 0, _size_x, _size_y);
218 if( _use_image_coords )
219 camera->setProjectionMatrix(
220 osg::Matrix::ortho2D(0, _view_width, _view_height, 0)
223 camera->setProjectionMatrix(
224 osg::Matrix::ortho2D( -_view_width/2., _view_width/2.,
225 -_view_height/2., _view_height/2. )
229 //------------------------------------------------------------------------------
230 void FGODGauge::updateStencil()
234 GLbitfield mask = GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT;
238 camera->attach( osg::Camera::PACKED_DEPTH_STENCIL_BUFFER,
239 GL_DEPTH_STENCIL_EXT );
240 mask |= GL_STENCIL_BUFFER_BIT;
244 camera->detach(osg::Camera::PACKED_DEPTH_STENCIL_BUFFER);
247 camera->setClearMask(mask);
250 //------------------------------------------------------------------------------
251 void FGODGauge::updateSampling()
257 osg::Texture2D::MIN_FILTER,
258 _use_mipmapping ? osg::Texture2D::LINEAR_MIPMAP_NEAREST
259 : osg::Texture2D::LINEAR
262 osg::Camera::COLOR_BUFFER,
272 * Replace a texture in the airplane model with the gauge texture.
274 class ReplaceStaticTextureVisitor:
275 public osg::NodeVisitor
279 ReplaceStaticTextureVisitor( const char* name,
280 osg::Texture2D* new_texture ):
281 osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN),
282 _tex_name( osgDB::getSimpleFileName(name) ),
283 _new_texture(new_texture)
286 ReplaceStaticTextureVisitor( const SGPropertyNode* placement,
287 osg::Texture2D* new_texture,
288 osg::NodeCallback* cull_callback = 0 ):
289 osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN),
290 _tex_name( osgDB::getSimpleFileName(
291 placement->getStringValue("texture"))
293 _node_name( placement->getStringValue("node") ),
294 _parent_name( placement->getStringValue("parent") ),
295 _new_texture(new_texture),
296 _cull_callback(cull_callback)
298 if( _tex_name.empty()
299 && _node_name.empty()
300 && _parent_name.empty() )
305 "No filter criterion for replacing texture. "
306 " Every texture will be replaced!"
311 * Get a list of groups which have been inserted into the scene graph to
312 * replace the given texture
314 Placements& getPlacements()
319 virtual void apply(osg::Geode& node)
321 simgear::EffectGeode* eg = dynamic_cast<simgear::EffectGeode*>(&node);
325 osg::StateSet* ss = eg->getEffect()->getDefaultStateSet();
329 osg::Group *parent = node.getParent(0);
330 if( !_node_name.empty() && parent->getName() != _node_name )
333 if( !_parent_name.empty() )
335 // Traverse nodes upwards starting at the parent node (skip current
337 const osg::NodePath& np = getNodePath();
339 for( int i = static_cast<int>(np.size()) - 2; i >= 0; --i )
341 const osg::Node* path_segment = np[i];
342 const osg::Node* path_parent = path_segment->getParent(0);
344 // A node without a name is always the parent of the root node of
345 // the model just containing the file name
346 if( path_parent && path_parent->getName().empty() )
349 if( path_segment->getName() == _parent_name )
360 for( size_t unit = 0; unit < ss->getNumTextureAttributeLists(); ++unit )
362 osg::Texture2D* tex = dynamic_cast<osg::Texture2D*>
364 ss->getTextureAttribute(unit, osg::StateAttribute::TEXTURE)
367 if( !tex || !tex->getImage() || tex == _new_texture )
370 if( !_tex_name.empty() )
372 std::string tex_name = tex->getImage()->getFileName();
373 std::string tex_name_simple = osgDB::getSimpleFileName(tex_name);
374 if( !osgDB::equalCaseInsensitive(_tex_name, tex_name_simple) )
378 // insert a new group between the geode an it's parent which overrides
380 osg::ref_ptr<osg::Group> group = new osg::Group;
381 group->setName("canvas texture group");
383 parent->removeChild(eg);
384 parent->addChild(group);
387 group->setCullCallback(_cull_callback);
389 _placements.push_back(group);
391 osg::StateSet* stateSet = group->getOrCreateStateSet();
392 stateSet->setTextureAttribute( unit, _new_texture,
393 osg::StateAttribute::OVERRIDE );
394 stateSet->setTextureMode( unit, GL_TEXTURE_2D,
395 osg::StateAttribute::ON );
401 "Replaced texture '" << _tex_name << "'"
402 << " for object '" << parent->getName() << "'"
403 << (!_parent_name.empty() ? " with parent '" + _parent_name + "'"
414 std::string _tex_name, ///<! Name of texture to be replaced
415 _node_name, ///<! Only replace if node name matches
416 _parent_name; ///<! Only replace if any parent node matches
417 /// given name (all the tree upwards)
418 osg::Texture2D *_new_texture;
419 osg::NodeCallback *_cull_callback;
421 Placements _placements;
424 //------------------------------------------------------------------------------
425 Placements FGODGauge::set_texture(const char* name, osg::Texture2D* new_texture)
427 osg::Group* root = globals->get_scenery()->get_aircraft_branch();
428 ReplaceStaticTextureVisitor visitor(name, new_texture);
429 root->accept(visitor);
430 return visitor.getPlacements();
433 //------------------------------------------------------------------------------
434 Placements FGODGauge::set_texture( const SGPropertyNode* placement,
435 osg::Texture2D* new_texture,
436 osg::NodeCallback* cull_callback )
438 osg::Group* root = globals->get_scenery()->get_aircraft_branch();
439 ReplaceStaticTextureVisitor visitor(placement, new_texture, cull_callback);
440 root->accept(visitor);
441 return visitor.getPlacements();