#include <LabelLayouter.h>

Classes
struct	LayoutJob
	Layout job initializes separate canvases for icons/symbols, labels and overlay labels. More...

Public Types
using	ContourLabelType = ContourLabel< NativeGlyph >

using	LabelInstanceType = LabelInstance< NativeGlyph, NativeLabel >

using	LabelPtr = std::shared_ptr< LabelType >

using	LabelType = Label< NativeGlyph, NativeLabel >

Public Member Functions
const std::vector< ContourLabelType > &	ContourLabels () const

template<class Painter >
void	DrawLabels (const Projection &projection, const MapParameter &parameter, Painter *p)

template<class Painter >
void	DrawTextLabels (const Projection &, const MapParameter &, Painter *) const

	LabelLayouter (TextLayouter *textLayouter)

const std::vector< LabelInstanceType > &	Labels () const

void	Layout (const Projection &projection, const MapParameter &parameter)

void	ProcessLabel (const Projection &projection, const MapParameter &parameter, const Vertex2D &point, LabelInstanceType &instance, double &offset, const LabelData &data, double objectWidth)

void	RegisterContourLabel (const Projection &projection, const MapParameter &parameter, const ObjectFileRef &ref, const PathLabelData &labelData, const LabelPath &labelPath)

void	RegisterLabel (const Projection &projection, const MapParameter &parameter, const ObjectFileRef &ref, const Vertex2D &point, const LabelData &data, double objectWidth=10.0)

void	RegisterLabel (const Projection &projection, const MapParameter &parameter, const ObjectFileRef &ref, const Vertex2D &point, const std::vector< LabelData > &data, double objectWidth=10.0)

void	Reset ()

void	SetLayoutOverlap (uint32_t overlap)

void	SetViewport (const ScreenVectorRectangle &v)

Static Public Member Functions
static bool	IsOverlay (const LabelData &labelData)

Detailed Description

template<class NativeGlyph, class NativeLabel, class TextLayouter>
class osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >

Template Parameters

NativeGlyph
NativeLabel
TextLayouter	- class providing low level text layouting required methods:

// glyph bounding box relative to its base point DoubleScreenRectangle GlyphBoundingBox(const NativeGlyph &) const

// layout text for label std::shared_ptr<Label<NativeGlyph, NativeLabel>> Layout( const Projection& projection, const MapParameter& parameter, const std::string& text, double fontSize, double objectWidth, bool enableWrapping = false, bool contourLabel = false);

Member Typedef Documentation

◆ ContourLabelType

template<class NativeGlyph , class NativeLabel , class TextLayouter >

using osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::ContourLabelType = ContourLabel<NativeGlyph>

◆ LabelInstanceType

template<class NativeGlyph , class NativeLabel , class TextLayouter >

using osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LabelInstanceType = LabelInstance<NativeGlyph, NativeLabel>

◆ LabelPtr

template<class NativeGlyph , class NativeLabel , class TextLayouter >

using osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LabelPtr = std::shared_ptr<LabelType>

◆ LabelType

template<class NativeGlyph , class NativeLabel , class TextLayouter >

using osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LabelType = Label<NativeGlyph, NativeLabel>

Constructor & Destructor Documentation

◆ LabelLayouter()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LabelLayouter ( TextLayouter * textLayouter )

inlineexplicit

Member Function Documentation

◆ ContourLabels()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

const std::vector< ContourLabelType > & osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::ContourLabels ( ) const

inline

Referenced by osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::DrawLabels().

◆ DrawLabels()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

template<class Painter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::DrawLabels	(	const Projection &	projection,
		const MapParameter &	parameter,
		Painter *	p
	)

inline

Template Parameters

Painter

required methods:

void DrawSymbol(const Projection& projection,
                const MapParameter& parameter,
                onst Symbol& symbol,
                double x, double y) override;

void DrawIcon(const IconStyle* style,
              double centerX, double centerY,
              double width, double height) override;

void DrawLabel(const Projection& projection,
               const MapParameter& parameter,
               const DoubleScreenRectangle& labelRectangle,
               const LabelData& label,
               const std::shared_ptr<NativeLabel>& layout);

void DrawGlyphs(const Projection &projection,
                const MapParameter &parameter,
                const osmscout::PathTextStyleRef style,
                const std::vector<Glyph<NativeGlyph>> &glyphs);

Parameters

projection
parameter
p	- painter pointer

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::ContourLabels(), osmscout::LabelData::Icon, osmscout::ScreenVectorRectangle::Intersects(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::IsOverlay(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::Labels(), osmscout::ScreenVectorRectangle::Set(), osmscout::LabelData::Symbol, and osmscout::LabelData::Text.

Referenced by osmscout::MapPainterAgg::DrawLabels(), osmscout::MapPainterCairo::DrawLabels(), osmscout::MapPainterQt::DrawLabels(), and osmscout::MapPainterSVG::DrawLabels().

◆ DrawTextLabels()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

template<class Painter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::DrawTextLabels	(	const Projection &	,
		const MapParameter &	,
		Painter *
	)		const

inline

◆ IsOverlay()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

static bool osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::IsOverlay ( const LabelData & labelData )

inlinestatic

References osmscout::LabelData::alpha.

Referenced by osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::DrawLabels(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::GetCanvas(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::GetLabelPadding(), and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabelInstance().

◆ Labels()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

const std::vector< LabelInstanceType > & osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::Labels ( ) const

inline

Referenced by osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::DrawLabels().

◆ Layout()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::Layout	(	const Projection &	projection,
		const MapParameter &	parameter
	)

inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabels(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::SortLabels(), and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::Swap().

Referenced by osmscout::MapPainterAgg::DrawLabels(), osmscout::MapPainterCairo::DrawLabels(), osmscout::MapPainterQt::DrawLabels(), and osmscout::MapPainterSVG::DrawLabels().

◆ ProcessLabel()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::ProcessLabel	(	const Projection &	projection,
		const MapParameter &	parameter,
		const Vertex2D &	point,
		LabelInstanceType &	instance,
		double &	offset,
		const LabelData &	data,
		double	objectWidth
	)

inline

References osmscout::LabelData::fontSize, osmscout::Vertex2D::GetX(), osmscout::Vertex2D::GetY(), osmscout::LabelData::Icon, osmscout::LabelData::iconHeight, osmscout::LabelData::iconWidth, osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::label, osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::labelData, osmscout::LabelData::priority, osmscout::LabelData::Symbol, osmscout::LabelData::text, osmscout::LabelData::type, osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::x, and osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::y.

Referenced by osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::RegisterLabel(), and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::RegisterLabel().

◆ RegisterContourLabel()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::RegisterContourLabel	(	const Projection &	projection,
		const MapParameter &	parameter,
		const ObjectFileRef &	ref,
		const PathLabelData &	labelData,
		const LabelPath &	labelPath
	)

inline

References osmscout::Glyph< NativeGlyph >::angle, osmscout::LabelPath::AngleAtLength(), osmscout::LabelPath::AngleAtLengthDeg(), osmscout::ContourLabelPositioner::calculatePositions(), osmscout::debugLabelLayouter, osmscout::LabelPath::GetLength(), osmscout::Vertex2D::GetX(), osmscout::Vertex2D::GetY(), osmscout::PathLabelData::height, osmscout::ScreenVectorRectangle::height, osmscout::ScreenVectorRectangle::Intersects(), osmscout::ContourLabelPositioner::Position::labelCount, osmscout::ContourLabelPositioner::Position::labelSpace, osmscout::ContourLabelPositioner::Position::offset, osmscout::LabelPath::PointAtLength(), osmscout::Glyph< NativeGlyph >::position, osmscout::PathLabelData::priority, osmscout::PathLabelData::style, osmscout::LabelPath::TestAngleVariance(), osmscout::PathLabelData::text, osmscout::Glyph< NativeGlyph >::trHeight, osmscout::Glyph< NativeGlyph >::trPosition, osmscout::Glyph< NativeGlyph >::trWidth, osmscout::ScreenVectorRectangle::width, osmscout::ScreenVectorRectangle::x, and osmscout::ScreenVectorRectangle::y.

Referenced by osmscout::MapPainterAgg::RegisterContourLabel(), osmscout::MapPainterCairo::RegisterContourLabel(), osmscout::MapPainterQt::RegisterContourLabel(), and osmscout::MapPainterSVG::RegisterContourLabel().

◆ RegisterLabel() [1/2]

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::RegisterLabel	(	const Projection &	projection,
		const MapParameter &	parameter,
		const ObjectFileRef &	ref,
		const Vertex2D &	point,
		const LabelData &	data,
		double	objectWidth = `10.0`
	)

inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::ProcessLabel().

Referenced by osmscout::MapPainterAgg::RegisterRegularLabel(), osmscout::MapPainterCairo::RegisterRegularLabel(), osmscout::MapPainterQt::RegisterRegularLabel(), and osmscout::MapPainterSVG::RegisterRegularLabel().

◆ RegisterLabel() [2/2]

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::RegisterLabel	(	const Projection &	projection,
		const MapParameter &	parameter,
		const ObjectFileRef &	ref,
		const Vertex2D &	point,
		const std::vector< LabelData > &	data,
		double	objectWidth = `10.0`
	)

inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::ProcessLabel().

◆ Reset()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::Reset ( )

inline

Referenced by osmscout::MapPainterAgg::DrawLabels(), osmscout::MapPainterCairo::DrawLabels(), osmscout::MapPainterQt::DrawLabels(), and osmscout::MapPainterSVG::DrawLabels().

◆ SetLayoutOverlap()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::SetLayoutOverlap ( uint32_t overlap )

inline

References osmscout::ScreenVectorRectangle::height, osmscout::ScreenVectorRectangle::width, osmscout::ScreenVectorRectangle::x, and osmscout::ScreenVectorRectangle::y.

Referenced by osmscout::MapPainterAgg::BeforeDrawing(), osmscout::MapPainterCairo::BeforeDrawing(), osmscout::MapPainterQt::BeforeDrawing(), osmscout::MapPainterSVG::BeforeDrawing(), and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::SetViewport().

◆ SetViewport()

template<class NativeGlyph , class NativeLabel , class TextLayouter >

void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::SetViewport ( const ScreenVectorRectangle & v )

inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::SetLayoutOverlap().

Referenced by osmscout::MapPainterAgg::BeforeDrawing(), osmscout::MapPainterCairo::BeforeDrawing(), osmscout::MapPainterQt::BeforeDrawing(), and osmscout::MapPainterSVG::BeforeDrawing().

The documentation for this class was generated from the following file:

LabelLayouter.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ContourLabelType

◆ LabelInstanceType

◆ LabelPtr

◆ LabelType

Constructor & Destructor Documentation

◆ LabelLayouter()

Member Function Documentation

◆ ContourLabels()

◆ DrawLabels()

◆ DrawTextLabels()

◆ IsOverlay()

◆ Labels()

◆ Layout()

◆ ProcessLabel()

◆ RegisterContourLabel()

◆ RegisterLabel() [1/2]

◆ RegisterLabel() [2/2]

◆ Reset()

◆ SetLayoutOverlap()

◆ SetViewport()