/home/cube/sources/osgearth/src/osgEarth/Progress

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_PROGRESS_H
#define OSGEARTH_PROGRESS_H 1

#include <osgEarth/Common>

namespace osgEarth
{
    class OSGEARTH_EXPORT ProgressCallback : public osg::Referenced
    {
    public:
        ProgressCallback();
        virtual ~ProgressCallback() { }

        virtual bool reportProgress(double current, double total, const std::string& msg = std::string());

        // called when the process starts
        virtual void onStarted() { }

        // called when the process completed 
        virtual void onCompleted() { }

        void cancel() { _canceled = true; }
        bool isCanceled() const { return _canceled; }

        std::string& message() { return _message; }

        bool needsRetry() const { return _needsRetry;}
        void setNeedsRetry( bool needsRetry ) { _needsRetry = needsRetry; }
        
    protected:
        volatile bool _canceled;
        std::string _message;
        volatile bool _needsRetry;
    };

    class OSGEARTH_EXPORT ConsoleProgressCallback : public ProgressCallback
    {
    public:
        ConsoleProgressCallback();
        virtual ~ConsoleProgressCallback() { }

        virtual bool reportProgress(double current, double total, const std::string& msg = std::string());
    };
}

#endif