/home/cube/sources/osgearth/src/osgEarthSymbology/StencilVolumeNode

Go to the documentation of this file.

/* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
 * Copyright 2008-2010 Pelican Mapping
 * http://osgearth.org
 *
 * osgEarth 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 */
#ifndef OSGEARTHSYMBOLOGY_STENCIL_VOLUME_NODE_H
#define OSGEARTHSYMBOLOGY_STENCIL_VOLUME_NODE_H 1

#include <osgEarthSymbology/Common>
#include <osgEarthSymbology/Geometry>
#include <osgEarth/MaskNode>
#include <osgEarth/ThreadingUtils>
#include <osg/Group>
#include <osg/Vec4>
#include <queue>

namespace osgEarth { namespace Symbology 
{
    class OSGEARTHSYMBOLOGY_EXPORT StencilVolumeNode : public osgEarth::MaskNode
    {
    public:
        StencilVolumeNode(
            bool preRenderChildrenToDepthBuffer =false,
            bool inverted =false );

        StencilVolumeNode( const StencilVolumeNode& rhs, const osg::CopyOp& op =osg::CopyOp::DEEP_COPY_ALL );

        META_Node(osgEarth::Symbology,StencilVolumeNode);
        
        //override
        virtual void traverse( osg::NodeVisitor& nv );

    public: // props

        // sets the render bins and returns the next available bin.
        int setBaseRenderBin( int bin );

        // adds stenciling volume geometry (safely during the next update traversal, if necessary)
        void addVolumes( osg::Node* node, bool onNextUpdate =true );
   
    public: // utilties

        static osg::Node* createFullScreenQuad( const osg::Vec4f& color );


    public: //osg::Group overrides

        virtual bool addChild( Node *child );
        virtual bool insertChild( unsigned int index, Node *child );
        virtual bool removeChildren(unsigned int pos,unsigned int numChildrenToRemove);
        virtual bool replaceChild( Node *origChild, Node* newChild );
        virtual bool setChild( unsigned  int i, Node* node );
        virtual osg::BoundingSphere computeBound() const;

    protected:
        void init();

        osg::ref_ptr<osg::Group> _root;
        osg::Group* _stencilGroup1;
        osg::Group* _stencilGroup2;
        osg::Group* _depthPass;
        osg::Group* _renderPass;
        bool _inverted;
        bool _preRenderChildrenToDepthBuffer;

        Threading::Mutex _addVolumesMutex;
        std::queue< osg::ref_ptr<osg::Node> > _volumesToAdd;
        void addQueuedVolumes();
    };


} } // namespace osgEarth::Symbology

#endif // OSGEARTHSYMBOLOGY_STENCIL_VOLUME_NODE_H