/home/cube/sources/osgearth/src/osgEarthUtil/OceanSurfaceNode

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 OSGEARTHUTIL_OCEANSURFACENODE
#define OSGEARTHUTIL_OCEANSURFACENODE

#include <osgEarthUtil/Common>
#include <osgEarth/ImageLayer>
#include <osg/Group>
#include <osg/observer_ptr>
#include <osg/CoordinateSystemNode>
#include <osg/Program>
#include <osg/Texture3D>

namespace osgEarth { namespace Util 
{
    using namespace osgEarth;

    class OSGEARTHUTIL_EXPORT OceanSurfaceNode : public osg::Group
    {
    public:
        OceanSurfaceNode();

        void setOceanMaskImageLayer( const ImageLayer* layer );

        const ImageLayer* getOceanMaskImageLayer() const { return _maskLayer.get(); }

        float getWaveHeight() const;

        void setWaveHeight(float waveHeight);

        float getMaxRange() const;

        void setMaxRange(float maxRange);

        float getPeriod() const;

        void setPeriod(float period);

        bool getEnabled() const;

        void setEnabled(bool enabled);

        bool getInvertMask() const;
        
        void setInvertMask(bool invertMask);

        void setModulationColor( const osg::Vec4f& color );

        osg::Vec4f getModulationColor() const;

        float getOceanAnimationPeriod() const;

        void setOceanAnimationPeriod(float oceanAnimationPeriod);

        osg::Image* getOceanSurfaceImage() const;
        
        void setOceanSurfaceImage( osg::Image* image);

        float getOceanSurfaceImageSizeRadians() const;

        void setOceanSurfaceImageSizeRadians( float size );

                void setAdjustToMSL( bool adjustToMSL);
                
                bool getAdjustToMSL() const;

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

    private:
        void rebuildShaders();

        void shadersDirty(bool value);
        bool _shadersDirty;

        float _maxRange;
        UID _oceanMaskLayerUID;
        int _oceanSurfaceTextureUnit;
        bool _oceanSurfaceTextureApplied;
        float _waveHeight;
        float _period;
        bool _enabled;
        bool _invertMask;
                bool _adjustToMSL;
        osg::observer_ptr<osg::CoordinateSystemNode> _csn;
        optional<osg::Vec4f> _oceanColor;
        float _oceanAnimationPeriod;
        float _oceanSurfaceImageSizeRadians;
        osg::ref_ptr< osg::Image > _oceanSurfaceImage;
        osg::ref_ptr< osg::Texture3D > _oceanSurfaceTexture;
        osg::observer_ptr< const ImageLayer > _maskLayer;
    };

} } // namespace osgEarth::Util

#endif //OSGEARTHUTIL_OCEANSURFACENODE