libmapnik-dev 2.2.0+ds1-6build2 / usr / include / mapnik / text_symbolizer.hpp

/*****************************************************************************
 *
 * This file is part of Mapnik (c++ mapping toolkit)
 *
 * Copyright (C) 2011 Artem Pavlenko
 *
 * This library 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.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *****************************************************************************/

#ifndef MAPNIK_TEXT_SYMBOLIZER_HPP
#define MAPNIK_TEXT_SYMBOLIZER_HPP

// mapnik
#include <mapnik/color.hpp>
#include <mapnik/font_set.hpp>
#include <mapnik/symbolizer.hpp>
#include <mapnik/text_placements/base.hpp>
#include <mapnik/text_placements/dummy.hpp>

// boost
#include <boost/shared_ptr.hpp>
#include <boost/make_shared.hpp>

// stl
#include <string>

#if (!defined(NO_DEPRECATION_WARNINGS) && __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
#define func_deprecated __attribute__ ((deprecated))
#else
#define func_deprecated
#endif

namespace mapnik
{

enum halo_rasterizer_enum
{
    HALO_RASTERIZER_FULL,
    HALO_RASTERIZER_FAST,
    halo_rasterizer_enum_MAX
};

DEFINE_ENUM(halo_rasterizer_e, halo_rasterizer_enum);

struct MAPNIK_DECL text_symbolizer : public symbolizer_base
{
    // Note - we do not use boost::make_shared below as VC2008 and VC2010 are
    // not able to compile make_shared used within a constructor
    text_symbolizer(text_placements_ptr placements = text_placements_ptr(new text_placements_dummy));
    text_symbolizer(expression_ptr name, std::string const& face_name,
                    float size, color const& fill,
                    text_placements_ptr placements = text_placements_ptr(new text_placements_dummy)
        );
    text_symbolizer(expression_ptr name, float size, color const& fill,
                    text_placements_ptr placements = text_placements_ptr(new text_placements_dummy)
        );
    text_symbolizer(text_symbolizer const& rhs);
    text_symbolizer& operator=(text_symbolizer const& rhs);
    expression_ptr get_name() const func_deprecated;
    void set_name(expression_ptr expr);

    expression_ptr get_orientation() const func_deprecated; // orienation (rotation angle atm)
    void set_orientation(expression_ptr expr);

    double get_text_ratio() const func_deprecated; // target ratio for text bounding box in pixels
    void set_text_ratio(double ratio);
    double get_wrap_width() const func_deprecated; // width to wrap text at, or trigger ratio
    void set_wrap_width(double width);
    unsigned char get_wrap_char() const func_deprecated; // character used to wrap lines
    std::string get_wrap_char_string() const func_deprecated; // character used to wrap lines as std::string
    void set_wrap_char(unsigned char character);
    void set_wrap_char_from_string(std::string const& character);
    text_transform_e get_text_transform() const func_deprecated; // text conversion on strings before display
    void set_text_transform(text_transform_e convert);
    double get_line_spacing() const func_deprecated; // spacing between lines of text
    void set_line_spacing(double spacing);
    double get_character_spacing() const func_deprecated; // spacing between characters in text
    void set_character_spacing(double spacing);
    double get_label_spacing() const func_deprecated; // spacing between repeated labels on lines
    void set_label_spacing(double spacing);
    unsigned get_label_position_tolerance() const func_deprecated; //distance the label can be moved on the line to fit, if 0 the default is used
    void set_label_position_tolerance(unsigned tolerance);
    bool get_force_odd_labels() const func_deprecated; // try render an odd amount of labels
    void set_force_odd_labels(bool force);
    double get_max_char_angle_delta() const func_deprecated; // maximum change in angle between adjacent characters
    void set_max_char_angle_delta(double angle);
    double get_text_size() const func_deprecated;
    void set_text_size(double size);
    std::string const& get_face_name() const func_deprecated;
    void set_face_name(std::string face_name);
    boost::optional<font_set> const& get_fontset() const func_deprecated;
    void set_fontset(font_set const& fset);
    color const& get_fill() const func_deprecated;
    void set_fill(color const& fill);
    void set_halo_fill(color const& fill);
    color const& get_halo_fill() const func_deprecated;
    void set_halo_radius(double radius);
    double get_halo_radius() const func_deprecated;
    void set_halo_rasterizer(halo_rasterizer_e rasterizer_p);
    halo_rasterizer_e get_halo_rasterizer() const;
    void set_label_placement(label_placement_e label_p);
    label_placement_e get_label_placement() const func_deprecated;
    void set_vertical_alignment(vertical_alignment_e valign);
    vertical_alignment_e get_vertical_alignment() const func_deprecated;
    void set_displacement(double x, double y);
    void set_displacement(position const& p);
    position const& get_displacement() const func_deprecated;
    void set_avoid_edges(bool avoid);
    bool get_avoid_edges() const func_deprecated;
    void set_minimum_distance(double distance);
    double get_minimum_distance() const func_deprecated;
    void set_minimum_padding(double distance);
    double get_minimum_padding() const func_deprecated;
    void set_minimum_path_length(double size);
    double get_minimum_path_length() const;
    void set_allow_overlap(bool overlap);
    bool get_allow_overlap() const func_deprecated;
    void set_text_opacity(double opacity);
    double get_text_opacity() const func_deprecated;
    void set_wrap_before(bool wrap_before);
    bool get_wrap_before() const func_deprecated; // wrap text at wrap_char immediately before current work
    void set_horizontal_alignment(horizontal_alignment_e valign);
    horizontal_alignment_e get_horizontal_alignment() const func_deprecated;
    void set_justify_alignment(justify_alignment_e valign);
    justify_alignment_e get_justify_alignment() const func_deprecated;
    text_placements_ptr get_placement_options() const;
    void set_placement_options(text_placements_ptr placement_options);
    void set_largest_bbox_only(bool val);
    bool largest_bbox_only() const;
private:
    text_placements_ptr placement_options_;
    halo_rasterizer_e halo_rasterizer_;
};
}

#endif // MAPNIK_TEXT_SYMBOLIZER_HPP