libosgearth-dev 2.9.0+dfsg-1 / usr / include / osgEarthSymbology / TextSymbol

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

#include <osgText/Text>
#include <osgEarthSymbology/Symbol>
#include <osgEarthSymbology/Expression>
#include <osgEarthSymbology/Fill>
#include <osgEarthSymbology/Stroke>

namespace osgEarth { namespace Symbology
{
    /**
     * Symbol that describes how to render text labels.
     */
    class OSGEARTHSYMBOLOGY_EXPORT TextSymbol : public Symbol
    {
    public:
        enum Encoding {
            ENCODING_ASCII,
            ENCODING_UTF8,
            ENCODING_UTF16,
            ENCODING_UTF32
        };

        // note: these are identical to the values in osgText::Text::AlignmentType
        enum Alignment {
            ALIGN_LEFT_TOP,
            ALIGN_LEFT_CENTER,
            ALIGN_LEFT_BOTTOM,

            ALIGN_CENTER_TOP,
            ALIGN_CENTER_CENTER,
            ALIGN_CENTER_BOTTOM,

            ALIGN_RIGHT_TOP,
            ALIGN_RIGHT_CENTER,
            ALIGN_RIGHT_BOTTOM,

            ALIGN_LEFT_BASE_LINE,
            ALIGN_CENTER_BASE_LINE,
            ALIGN_RIGHT_BASE_LINE,

            ALIGN_LEFT_BOTTOM_BASE_LINE,
            ALIGN_CENTER_BOTTOM_BASE_LINE,
            ALIGN_RIGHT_BOTTOM_BASE_LINE,

            ALIGN_BASE_LINE = ALIGN_LEFT_BASE_LINE /// default.
        };

        enum Layout {
            LAYOUT_LEFT_TO_RIGHT,
            LAYOUT_RIGHT_TO_LEFT,
            LAYOUT_VERTICAL
        };

        META_Object(osgEarthSymbology, TextSymbol);

        TextSymbol(const TextSymbol& rhs,const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY);
        TextSymbol( const Config& conf =Config() );

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

        /** Text fill color. */
        optional<Fill>& fill() { return _fill; }
        const optional<Fill>& fill() const { return _fill; }

        /** Text outline color. */
        optional<Stroke>& halo() { return _halo; }
        const optional<Stroke>& halo() const { return _halo; }

        /** Text outline offset */
        optional<float>& haloOffset() { return _haloOffset; }
        const optional<float>& haloOffset() const { return _haloOffset; }

        /** Halo backdrop type */
        optional<osgText::Text::BackdropType>& haloBackdropType() { return _haloBackdropType; }
        const optional<osgText::Text::BackdropType>& haloBackdropType() const { return _haloBackdropType; }

        /** Halo backdrop implementation */
        optional<osgText::Text::BackdropImplementation>& haloImplementation() { return _haloImplementation; }
        const optional<osgText::Text::BackdropImplementation>& haloImplementation() const { return _haloImplementation; }

        /** Name of text font. */
        optional<std::string>& font() { return _font; }
        const optional<std::string>& font() const { return _font; }

        /** Actual text to render (if applicable) */
        optional<StringExpression>& content() { return _content; }
        const optional<StringExpression>& content() const { return _content; }

        /** Priority of the label (applicable when the renderer sorts labels) */
        optional<NumericExpression>& priority() { return _priority; }
        const optional<NumericExpression>& priority() const { return _priority; }

        /** Font size. */
        optional<NumericExpression>& size() { return _size; }
        const optional<NumericExpression>& size() const { return _size; }

        /** Pixel offset from the center point. */
        optional<osg::Vec2s>& pixelOffset() { return _pixelOffset; }
        const optional<osg::Vec2s>& pixelOffset() const { return _pixelOffset; }

        /** On screen rotation **/
        optional<NumericExpression>& onScreenRotation() { return _onScreenRotation; }
        const optional<NumericExpression>& onScreenRotation() const { return _onScreenRotation; }

        /** Label orientation for following a fixed course on the map. */
        optional<NumericExpression>& geographicCourse() { return _geographicCourse; }
        const optional<NumericExpression>& geographicCourse() const { return _geographicCourse; }

        /** Alignment of the label relative to (0,0) pixels */
        optional<Alignment>& alignment() { return _alignment; }
        const optional<Alignment>& alignment() const { return _alignment; }

        /** Layout of the label*/
        optional<Layout>& layout() { return _layout; }
        const optional<Layout>& layout() const { return _layout; }

        /** Whether to enable decluttering on the text, if applicable */
        optional<bool>& declutter() { return _declutter; }
        const optional<bool>& declutter() const { return _declutter; }

        /** Whether to enable occlusion culling on the text */
        optional<bool>& occlusionCull() { return _occlusionCull; }
        const optional<bool>& occlusionCull() const { return _occlusionCull; }

        /** The viewer altitude at which to start occlusion culling the text */
        optional<double>& occlusionCullAltitude() { return _occlusionCullAltitude; }
        const optional<double>& occlusionCullAltitude() const { return _occlusionCullAltitude; }

        /** Label generation provider to use */
        optional<std::string>& provider() { return _provider; }
        const optional<std::string>& provider() const { return _provider; }

        /** text encoding */
        optional<Encoding>& encoding() { return _encoding; }
        const optional<Encoding>& encoding() const { return _encoding; }

    public:
        virtual Config getConfig() const;
        virtual void mergeConfig( const Config& conf );
        static void parseSLD(const Config& c, class Style& style);

    protected:
        optional<Fill>              _fill;
        optional<Stroke>            _halo;
        optional<float>             _haloOffset;
        optional<osgText::Text::BackdropType> _haloBackdropType;
        optional<osgText::Text::BackdropImplementation> _haloImplementation;
        optional<std::string>       _font;
        optional<NumericExpression> _size;
        optional<StringExpression>  _content;
        optional<NumericExpression> _priority;
        optional<osg::Vec2s>        _pixelOffset;
        optional<NumericExpression> _onScreenRotation;
        optional<NumericExpression> _geographicCourse;
        optional<std::string>       _provider;
        optional<Encoding>          _encoding;
        optional<Alignment>         _alignment;
        optional<Layout>            _layout;
        optional<bool>              _declutter;
        optional<bool>              _occlusionCull;
        optional<double>            _occlusionCullAltitude;
    };

} } // namespace osgEarth::Symbology

#endif // OSGEARTHSYMBOLOGY_TEXT_SYMBOL_H