/home/cube/sources/osgearth/src/osgEarth/MaskLayer

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 OSGEARTH_MASK_LAYER_H
#define OSGEARTH_MASK_LAYER_H 1

#include <osgEarth/Common>
#include <osgEarth/Layer>
#include <osgEarth/Config>
#include <osgEarth/MaskSource>
#include <osg/Node>

namespace osgEarth
{
    class Map;

    class OSGEARTH_EXPORT MaskLayerOptions : public ConfigOptions
    {
    public:        
        MaskLayerOptions( const ConfigOptions& options =ConfigOptions() );

        MaskLayerOptions( const std::string& name, const MaskSourceOptions& driverOptions =MaskSourceOptions() );

        optional<std::string>& name() { return _name; }
        const optional<std::string>& name() const { return _name; }

        optional<MaskSourceOptions>& driver() { return _driver; }
        const optional<MaskSourceOptions>& driver() const { return _driver; }

    public:
        virtual Config getConfig() const;
        virtual void mergeConfig( const Config& conf );

    private:
        void fromConfig( const Config& conf );
        void setDefaults();

        optional<std::string> _name;
        optional<MaskSourceOptions> _driver;
    };

    class OSGEARTH_EXPORT MaskLayer : public Layer
    {
    public:
        MaskLayer( const MaskLayerOptions& options =MaskLayerOptions() );

        MaskLayer( const std::string& name, const MaskSourceOptions& options );
        
        MaskLayer(const MaskLayerOptions& options, MaskSource* source );

        MaskSource* getMaskSource() const { return _maskSource.get(); }

    public:
        osg::Vec3dArray* getOrCreateBoundary( float heightScale = 1.0, const SpatialReference* srs = NULL, ProgressCallback* progress =0L );

    public:

        void initialize( const std::string& referenceURI, const Map* map );

    private:
        std::string _referenceURI;
        MaskLayerOptions _initOptions, _runtimeOptions;
        osg::ref_ptr<MaskSource> _maskSource;
        Revision _maskSourceRev;
        osg::ref_ptr<osg::Vec3dArray> _boundary;

        void copyOptions();
    };

    typedef std::vector< osg::ref_ptr<MaskLayer> > MaskLayerVector;
}

#endif // OSGEARTH_MASK_LAYER_H