/home/cube/sources/osgearth/src/osgEarthSymbology/TextSymbol

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

#include <osgEarthSymbology/Symbol>
#include <osgEarthSymbology/Expression>
#include <osg/Referenced>
#include <vector>

namespace osgEarth { namespace Symbology
{
    class OSGEARTHSYMBOLOGY_EXPORT TextSymbol : public Symbol
    {
    public:
        enum SizeMode {
            SIZEMODE_SCREEN,
            SIZEMODE_OBJECT
        };

        enum LineOrientation {
            LINEORIENTATION_PARALLEL,
            LINEORIENTATION_PERPENDICULAR,
            LINEORIENTATION_HORIZONTAL
        };

        enum LinePlacement {
            LINEPLACEMENT_ALONG_LINE,
            LINEPLACEMENT_CENTROID
        };

        TextSymbol( const Config& conf =Config() );

        optional<Fill>& fill() { return _fill; }
        const optional<Fill>& fill() const { return _fill; }

        optional<Stroke>& halo() { return _halo; }
        const optional<Stroke>& halo() const { return _halo; }

        optional<std::string>& font() { return _font; }
        const optional<std::string>& font() const { return _font; }

        optional<StringExpression>& content() { return _content; }
        const optional<StringExpression>& content() const { return _content; }

        optional<NumericExpression>& priority() { return _priority; }
        const optional<NumericExpression>& priority() const { return _priority; }

        optional<float>& size() { return _size; }
        const optional<float>& size() const { return _size; }

        optional<bool>& rotateToScreen() { return _rotateToScreen; }
        const optional<bool>& rotateToScreen() const { return _rotateToScreen; }

        optional<osg::Vec2s>& pixelOffset() { return _pixelOffset; }
        const optional<osg::Vec2s>& pixelOffset() const { return _pixelOffset; }

        optional<bool>& removeDuplicateLabels() { return _removeDuplicateLabels; }
        const optional<bool>& removeDuplicateLabels() const { return _removeDuplicateLabels; }

        optional<SizeMode>& sizeMode() { return _sizeMode; }
        const optional<SizeMode>& sizeMode() const { return _sizeMode; }

        optional<LineOrientation>& lineOrientation() { return _lineOrientation; }
        const optional<LineOrientation>& lineOrientation() const { return _lineOrientation; }

        optional<LinePlacement>& linePlacement() { return _linePlacement; }
        const optional<LinePlacement>& linePlacement() const { return _linePlacement; }

        optional<std::string>& provider() { return _provider; }
        const optional<std::string>& provider() const { return _provider; }

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

    protected:
        optional<Fill>              _fill;
        optional<Stroke>            _halo;
        optional<std::string>       _font;
        optional<float>             _size;
        optional<StringExpression>  _content;
        optional<NumericExpression> _priority;
        optional<bool>              _rotateToScreen;
        optional<bool>              _removeDuplicateLabels;
        optional<SizeMode>          _sizeMode;
        optional<LineOrientation>   _lineOrientation;
        optional<LinePlacement>     _linePlacement;
        optional<std::string>       _theme;
        optional<osg::Vec2s>        _pixelOffset;
        optional<std::string>       _provider;
    };

} } // namespace osgEarth::Symbology

#endif // OSGEARTHSYMBOLOGY_TEXT_SYMBOL_H