libosmscout  0.1
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
Public Member Functions | Public Attributes | List of all members
osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob Struct Reference

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

#include <LabelLayouter.h>

Public Member Functions

ScreenMask * GetCanvas (LabelData data)
 
double GetLabelPadding (const LabelData &labelData) const
 
 LayoutJob (const LayoutJob &)=delete
 
 LayoutJob (const ScreenVectorRectangle &layoutViewport, const Projection &projection, const MapParameter &parameter)
 
 LayoutJob (LayoutJob &&)=delete
 
LayoutJob & operator= (const LayoutJob &)=delete
 
LayoutJob & operator= (LayoutJob &&)=delete
 
void ProcessLabelContourLabel (const ContourLabelType &currentContourLabel, std::vector< ContourLabelType > &contourLabelInstances)
 
void ProcessLabelInstance (const LabelInstanceType &currentLabel, std::vector< LabelInstanceType > &labelInstances)
 
void ProcessLabels (std::vector< LabelInstanceType > &labelInstances, std::vector< ContourLabelType > &contourLabelInstances)
 
void SortLabels ()
 
void Swap (std::vector< LabelInstanceType > &labelInstances, std::vector< ContourLabelType > &contourLabelInstances)
 
 ~LayoutJob ()=default
 

Public Attributes

std::vector< ContourLabelType > allSortedContourLabels
 
std::vector< LabelInstanceType > allSortedLabels
 
double contourLabelPadding
 
ScreenMask iconCanvas
 
double iconPadding
 
ScreenMask labelCanvas
 
double labelPadding
 
ScreenVectorRectangle layoutViewport
 
ScreenMask overlayCanvas
 
double overlayLabelPadding
 
double shieldLabelPadding
 

Detailed Description

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

Layout job initializes separate canvases for icons/symbols, labels and overlay labels.

Then takes all registered labels and contour labels and sort them by priority. Note that labels includes standard labels, icons/symbols and overlay labels. As final step process labels and contour labels (from highest priority) and check its visual rectangle in corresponding canvas. When pixels are not occupied yet, it is added and pixels on canvas mark.

Constructor & Destructor Documentation

◆ LayoutJob() [1/3]

template<class NativeGlyph , class NativeLabel , class TextLayouter >
osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::LayoutJob ( const ScreenVectorRectangle &  layoutViewport,
const Projection &  projection,
const MapParameter &  parameter 
)
inline

◆ LayoutJob() [2/3]

template<class NativeGlyph , class NativeLabel , class TextLayouter >
osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::LayoutJob ( const LayoutJob &  )
delete

◆ LayoutJob() [3/3]

template<class NativeGlyph , class NativeLabel , class TextLayouter >
osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::LayoutJob ( LayoutJob &&  )
delete

◆ ~LayoutJob()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::~LayoutJob ( )
default

Member Function Documentation

◆ GetCanvas()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
ScreenMask* osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::GetCanvas ( LabelData  data)
inline

References osmscout::LabelData::Icon, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::iconCanvas, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::IsOverlay(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::labelCanvas, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::overlayCanvas, osmscout::LabelData::Symbol, and osmscout::LabelData::type.

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

◆ GetLabelPadding()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
double osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::GetLabelPadding ( const LabelData &  labelData) const
inline

References osmscout::LabelData::Icon, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::iconPadding, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::IsOverlay(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::labelPadding, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::overlayLabelPadding, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::shieldLabelPadding, osmscout::LabelData::style, osmscout::LabelData::Symbol, and osmscout::LabelData::type.

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

◆ operator=() [1/2]

template<class NativeGlyph , class NativeLabel , class TextLayouter >
LayoutJob& osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::operator= ( const LayoutJob &  )
delete

◆ operator=() [2/2]

template<class NativeGlyph , class NativeLabel , class TextLayouter >
LayoutJob& osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::operator= ( LayoutJob &&  )
delete

◆ ProcessLabelContourLabel()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabelContourLabel ( const ContourLabelType &  currentContourLabel,
std::vector< ContourLabelType > &  contourLabelInstances 
)
inline

References osmscout::ScreenMask::AddMask(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::contourLabelPadding, osmscout::debugLabelLayouter, osmscout::ContourLabel< NativeGlyph >::glyphs, osmscout::ScreenMask::HasCollision(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::labelCanvas, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::layoutViewport, osmscout::ContourLabel< NativeGlyph >::priority, osmscout::ScreenVectorRectangle::width, osmscout::ScreenVectorRectangle::x, and osmscout::ScreenVectorRectangle::y.

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

◆ ProcessLabelInstance()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabelInstance ( const LabelInstanceType &  currentLabel,
std::vector< LabelInstanceType > &  labelInstances 
)
inline

References osmscout::debugLabelLayouter, osmscout::LabelInstance< NativeGlyph, NativeLabel >::elements, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::GetCanvas(), osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::GetLabelPadding(), osmscout::ScreenMask::HasCollision(), osmscout::LabelData::Icon, osmscout::LabelData::iconHeight, osmscout::LabelData::iconStyle, osmscout::LabelData::iconWidth, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::IsOverlay(), osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::label, osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::labelData, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::layoutViewport, osmscout::LabelInstance< NativeGlyph, NativeLabel >::priority, osmscout::LabelInstance< NativeGlyph, NativeLabel >::ref, osmscout::LabelData::Symbol, osmscout::LabelData::text, osmscout::LabelData::type, osmscout::ScreenPixelRectangle::width, osmscout::ScreenVectorRectangle::width, osmscout::ScreenVectorRectangle::x, osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::x, osmscout::ScreenVectorRectangle::y, and osmscout::LabelInstance< NativeGlyph, NativeLabel >::Element::y.

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

◆ ProcessLabels()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabels ( std::vector< LabelInstanceType > &  labelInstances,
std::vector< ContourLabelType > &  contourLabelInstances 
)
inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedContourLabels, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedLabels, osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabelContourLabel(), and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::ProcessLabelInstance().

◆ SortLabels()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::SortLabels ( )
inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedContourLabels, and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedLabels.

◆ Swap()

template<class NativeGlyph , class NativeLabel , class TextLayouter >
void osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::Swap ( std::vector< LabelInstanceType > &  labelInstances,
std::vector< ContourLabelType > &  contourLabelInstances 
)
inline

References osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedContourLabels, and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedLabels.

Member Data Documentation

◆ allSortedContourLabels

template<class NativeGlyph , class NativeLabel , class TextLayouter >
std::vector<ContourLabelType> osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedContourLabels

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

◆ allSortedLabels

template<class NativeGlyph , class NativeLabel , class TextLayouter >
std::vector<LabelInstanceType> osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::allSortedLabels

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

◆ contourLabelPadding

template<class NativeGlyph , class NativeLabel , class TextLayouter >
double osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::contourLabelPadding

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

◆ iconCanvas

template<class NativeGlyph , class NativeLabel , class TextLayouter >
ScreenMask osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::iconCanvas

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

◆ iconPadding

template<class NativeGlyph , class NativeLabel , class TextLayouter >
double osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::iconPadding

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

◆ labelCanvas

template<class NativeGlyph , class NativeLabel , class TextLayouter >
ScreenMask osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::labelCanvas

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

◆ labelPadding

template<class NativeGlyph , class NativeLabel , class TextLayouter >
double osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::labelPadding

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

◆ layoutViewport

template<class NativeGlyph , class NativeLabel , class TextLayouter >
ScreenVectorRectangle osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::layoutViewport

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

◆ overlayCanvas

template<class NativeGlyph , class NativeLabel , class TextLayouter >
ScreenMask osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::overlayCanvas

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

◆ overlayLabelPadding

template<class NativeGlyph , class NativeLabel , class TextLayouter >
double osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::overlayLabelPadding

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

◆ shieldLabelPadding

template<class NativeGlyph , class NativeLabel , class TextLayouter >
double osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LayoutJob::shieldLabelPadding

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

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