libosgearth-dev 2.9.0+dfsg-1 / usr / include / osgEarth / MapFrame

/* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
 * Copyright 2016 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_MAP_FRAME_H
#define OSGEARTH_MAP_FRAME_H 1

#include <osgEarth/Common>
#include <osgEarth/Containers>
#include <osgEarth/MapInfo>
#include <osgEarth/Revisioning>
#include <osgEarth/Layer>
#include <osgEarth/ElevationLayer>

namespace osgEarth
{
    class Profile;
    class Map;
    class MapOptions;
    class TileKey;
    class ElevationPool;
    class ProgressCallback;

    /**
     * A "snapshot in time" of a Map model revision. Use this class to get a safe "copy" of
     * the map model lists that you can use without worrying about the model changing underneath
     * you from another thread.
     */
    class OSGEARTH_EXPORT MapFrame
    {
    public:
        /**
         * Constructs a new empty map frame that's not connected to any map.
         */
        MapFrame();

        MapFrame(const MapFrame& rhs);

        MapFrame(const Map* map);

        bool isValid() const;

        /** dtor */
        virtual ~MapFrame() { }

        /**
         * Sets the map to which this frame is connected.
         */
        void setMap(const Map* map);

        /**
         * Synchronizes this frame to the last-synced map. Returns true if changes occurred.
         */
        bool sync();

        /**
         * True is a sync() would acquire new data.
         */
        bool needsSync() const;

        /** Releases any references held by this frame. Call sync() to restablish */
        void release();

        /** The source map's UID */
        UID getUID() const;

        /** Accesses the profile/rendering info about the source map. */
        const MapInfo& getMapInfo() const { return _mapInfo; }

        /** Convenience method to access the map's profile */
        const Profile* getProfile() const { return _mapInfo.getProfile(); }

        const LayerVector& layers() const { return _layers; }
        
        template<typename T>
        unsigned getLayers(std::vector<osg::ref_ptr<T> >& output) const {
            for (LayerVector::const_iterator i = _layers.begin(); i != _layers.end(); ++i) {
                T* t = dynamic_cast<T*>(i->get());
                if (t) output.push_back(t);
            }
            return output.size();
        }

        template<typename T>
        unsigned getLayers(osg::MixinVector< osg::ref_ptr<T> >& output) const {
            for (LayerVector::const_iterator i = _layers.begin(); i != _layers.end(); ++i) {
                T* obj = dynamic_cast<T*>(i->get());
                if (obj) output.push_back(obj);
            }
            return output.size();
        }

        /** Whether the frame contains a layer with the matching UID */
        bool containsLayer(UID uid) const;

        template<typename T>
        T* getLayerByName(const std::string& name) {
            for (LayerVector::const_iterator i = _layers.begin(); i != _layers.end(); ++i) {
                if (i->get()->getName() == name)
                    return dynamic_cast<T*>(i->get());
            }
            return 0L;
        }

        /** The elevation layer stack snapshot */
        const ElevationLayerVector& elevationLayers() const { return _elevationLayers; }

        /** Gets the map data model revision with which this frame is currently sync'd */
        Revision getRevision() const { return _mapDataModelRevision; }

        /** Checks whether all the data for the specified key is cached. */
        bool isCached( const TileKey& key ) const;

        /** Access to the map's options */
        const MapOptions& getMapOptions() const;

        /** The highest set minLevel() amongst all image and elevation layers */
        unsigned getHighestMinLevel() const { return _highestMinLevel; }

        /**
         * Equivalent to the Map::populateHeightField() method, but operates on the
         * elevation stack snapshot in this MapFrame.
         */
        bool populateHeightField(
            osg::ref_ptr<osg::HeightField>& hf,
            const TileKey&                  key,
            bool                            expressHeightsAsHAE,
            ProgressCallback*               progress) const;

        bool populateHeightFieldAndNormalMap(
            osg::ref_ptr<osg::HeightField>& hf,
            osg::ref_ptr<NormalMap>&        normalMap,
            const TileKey&                  key,
            bool                            expressHeightsAsHAE,
            ProgressCallback*               progress) const;

        /**
         * Gets the map's elevation pool.
         * This returns a ref_ptr because the Map itself is held with an observer_ptr.
         */
        ElevationPool* getElevationPool() const;

    private:
        bool _initialized;
        osg::observer_ptr<const Map> _map;
        std::string _name;
        MapInfo _mapInfo;
        Revision _mapDataModelRevision;
        LayerVector _layers;
        ElevationLayerVector _elevationLayers;
        unsigned _highestMinLevel;
        osg::ref_ptr<osg::Referenced> _pool;

        friend class Map;

        void refreshComputedValues();
    };

}

#endif // OSGEARTH_MAP_FRAME_H