ClampableNode 2.43 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
1 2 3 4 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 37 38 39 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
/* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
 * Copyright 2008-2011 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 OSGEARTH_CLAMPABLE_NODE_H
#define OSGEARTH_CLAMPABLE_NODE_H 1

#include <osgEarth/Common>
#include <osgEarth/DepthOffset>
#include <osgEarth/OverlayNode>
#include <osg/Group>

namespace osgEarth
{
    class MapNode;

    /**
     * Node graph that can be "clamped" on the MapNode terrain
     * using the overlay decorator.
     *
     * Usage: Create this node and put it anywhere in the scene graph. The
     * subgraph of this node will be draped on the MapNode's terrain.
     */
    class OSGEARTH_EXPORT ClampableNode : public OverlayNode, public DepthOffsetInterface
    {
    public:
        /**
         * Constructs a new clampable node.
         */
        ClampableNode( MapNode* mapNode, bool clamped =true );


    public: // DepthOffsetInterface

        /** Sets the depth offsetting options. See DepthOffset */
        void setDepthOffsetOptions( const DepthOffsetOptions& options );

        /** Gets the depth offsetting options. See DepthOffset */
        const DepthOffsetOptions& getDepthOffsetOptions() const;

    public: // osg::Node

        virtual osg::BoundingSphere computeBound() const;

        virtual void traverse(osg::NodeVisitor& nv);

    public: // backwards-compatibility

        /** @deprecated */
        void setClamped( bool value ) { setActive(value); }
        /** @deprecated */
        bool getClamped() const { return getActive(); }

    protected:
        void setUniforms();
        void dirty();
        void scheduleUpdate();

        DepthOffsetAdapter _adapter;
        bool               _updatePending;

        virtual ~ClampableNode() { }
    };

} // namespace osgEarth

#endif // OSGEARTH_CLAMPABLE_NODE_H