osmscout::MapParameter Class Reference

Collection of Parameter that parametrize and influence drawing of the map. More...

#include <MapParameter.h>

Public Types
enum class	IconMode { FixedSizePixmap , ScaledPixmap , OriginalPixmap , Scalable }
enum class	PatternMode { OriginalPixmap , Scalable }

Public Member Functions
double	GetAreaMinDimensionMM () const
double	GetContourLabelOffset () const
double	GetContourLabelPadding () const
double	GetContourLabelSpace () const
bool	GetDrawFadings () const
bool	GetDrawWaysWithFixedWidth () const
FillStyleProcessorRef	GetFillStyleProcessor (size_t typeIndex) const
std::string	GetFontName () const
	The font name this parameter was configured with, as it was configured: a font family or the path of a font file (see SetFontName).
double	GetFontSize () const
IconMode	GetIconMode () const
double	GetIconPadding () const
const std::list< std::string > &	GetIconPaths () const
double	GetIconPixelSize () const
double	GetIconSize () const
double	GetLabelLayouterOverlap () const
bool	GetLabelLineFitToArea () const
double	GetLabelLineFitToWidth () const
size_t	GetLabelLineMaxCharCount () const
size_t	GetLabelLineMinCharCount () const
double	GetLabelPadding () const
double	GetLineMinWidthPixel () const
Locale	GetLocale () const
Locale &	GetLocaleRef ()
TransPolygon::OptimizeMethod	GetOptimizeAreaNodes () const
double	GetOptimizeErrorToleranceMm () const
TransPolygon::OptimizeMethod	GetOptimizeWayNodes () const
double	GetOverlayLabelPadding () const
PatternMode	GetPatternMode () const
const std::list< std::string > &	GetPatternPaths () const
double	GetPatternSize () const
double	GetPlateLabelPadding () const
bool	GetPreferSymbolIcons () const
bool	GetRenderBackground () const
bool	GetRenderContourLines () const
bool	GetRenderHillShading () const
bool	GetRenderSeaLand () const
bool	GetRenderUnknowns () const
std::string	GetRouteLabelSeparator () const
bool	GetShowAltLanguage () const
double	GetSidecarDistance () const
double	GetSidecarMaxDistanceMM () const
double	GetSidecarMinDistanceMM () const
size_t	GetWarningCoordCountLimit () const
size_t	GetWarningObjectCountLimit () const
bool	IsAborted () const
bool	IsDebugData () const
bool	IsDebugPerformance () const
	MapParameter ()
void	RegisterFillStyleProcessor (size_t typeIndex, const FillStyleProcessorRef &processor)
void	SetAreaMinDimensionMM (double areaMinDimensionMM)
void	SetBreaker (const BreakerRef &breaker)
void	SetContourLabelOffset (double contourLabelOffset)
void	SetContourLabelPadding (double padding)
void	SetContourLabelSpace (double contourLabelSpace)
void	SetDebugData (bool debug)
void	SetDebugPerformance (bool debug)
void	SetDrawFadings (bool drawFadings)
void	SetDrawWaysWithFixedWidth (bool drawWaysWithFixedWidth)
void	SetFontName (const std::string &fontName)
	Font to draw and measure labels with.
void	SetFontSize (double fontSize)
void	SetIconMode (const IconMode &mode)
void	SetIconPadding (double padding)
void	SetIconPaths (const std::list< std::string > &paths)
void	SetIconPixelSize (double size)
void	SetIconSize (double size)
void	SetLabelLayouterOverlap (double labelLayouterOverlap)
void	SetLabelLineFitToArea (bool labelLineFitToArea)
void	SetLabelLineFitToWidth (double labelLineFitToWidth)
void	SetLabelLineMaxCharCount (size_t labelLineMaxCharCount)
void	SetLabelLineMinCharCount (size_t labelLineMinCharCount)
void	SetLabelPadding (double labelPadding)
void	SetLineMinWidthPixel (double lineMinWidthPixel)
void	SetLocale (const Locale &locale)
void	SetOptimizeAreaNodes (TransPolygon::OptimizeMethod optimize)
void	SetOptimizeErrorToleranceMm (double errorToleranceMm)
void	SetOptimizeWayNodes (TransPolygon::OptimizeMethod optimize)
void	SetOverlayLabelPadding (double padding)
void	SetPatternMode (const PatternMode &mode)
void	SetPatternPaths (const std::list< std::string > &paths)
void	SetPatternSize (double size)
void	SetPlateLabelPadding (double plateLabelPadding)
void	SetPreferSymbolIcons (bool preferSymbolIcons)
void	SetRenderBackground (bool render)
void	SetRenderContourLines (bool render)
void	SetRenderHillShading (bool render)
void	SetRenderSeaLand (bool render)
void	SetRenderUnknowns (bool render)
void	SetRouteLabelSeparator (const std::string &separator)
void	SetShowAltLanguage (bool showAltLanguage)
void	SetSidecarDistance ()
void	SetSidecarMaxDistanceMM ()
void	SetSidecarMinDistanceMM ()
void	SetWarningCoordCountLimit (size_t limit)
void	SetWarningObjectCountLimit (size_t limit)

Detailed Description

Collection of Parameter that parametrize and influence drawing of the map.

Member Enumeration Documentation

IconMode

enum class osmscout::MapParameter::IconMode

strong

Enumerator
FixedSizePixmap
ScaledPixmap
OriginalPixmap
Scalable

PatternMode

enum class osmscout::MapParameter::PatternMode

strong

Enumerator
OriginalPixmap
Scalable

Constructor & Destructor Documentation

MapParameter()

osmscout::MapParameter::MapParameter

(

)

Member Function Documentation

GetAreaMinDimensionMM()

double osmscout::MapParameter::GetAreaMinDimensionMM ( ) const

inline

GetContourLabelOffset()

double osmscout::MapParameter::GetContourLabelOffset ( ) const

inline

GetContourLabelPadding()

double osmscout::MapParameter::GetContourLabelPadding ( ) const

inline

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

GetContourLabelSpace()

double osmscout::MapParameter::GetContourLabelSpace ( ) const

inline

GetDrawFadings()

bool osmscout::MapParameter::GetDrawFadings ( ) const

inline

GetDrawWaysWithFixedWidth()

bool osmscout::MapParameter::GetDrawWaysWithFixedWidth ( ) const

inline

GetFillStyleProcessor()

FillStyleProcessorRef osmscout::MapParameter::GetFillStyleProcessor

(

size_t

typeIndex

)

const

GetFontName()

std::string osmscout::MapParameter::GetFontName ( ) const

inline

The font name this parameter was configured with, as it was configured: a font family or the path of a font file (see SetFontName).

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

GetFontSize()

double osmscout::MapParameter::GetFontSize ( ) const

inline

Referenced by osmscout::MapPainterAgg::DrawMap(), osmscout::MapPainterQt::DrawMap(), osmscout::MapPainterSVG::DrawMap(), osmscout::MapPainterSVG::GetFontHeight(), and osmscout::LabelLayouter< NativeGlyph, NativeLabel, TextLayouter >::LabelReach().

GetIconMode()

IconMode osmscout::MapParameter::GetIconMode ( ) const

inline

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

GetIconPadding()

double osmscout::MapParameter::GetIconPadding ( ) const

inline

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

GetIconPaths()

const std::list< std::string > & osmscout::MapParameter::GetIconPaths ( ) const

inline

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

GetIconPixelSize()

double osmscout::MapParameter::GetIconPixelSize ( ) const

inline

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

GetIconSize()

double osmscout::MapParameter::GetIconSize ( ) const

inline

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

GetLabelLayouterOverlap()

double osmscout::MapParameter::GetLabelLayouterOverlap ( ) const

inline

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

GetLabelLineFitToArea()

bool osmscout::MapParameter::GetLabelLineFitToArea ( ) const

inline

Referenced by osmscout::MapPainter::GetProposedLabelWidth().

GetLabelLineFitToWidth()

double osmscout::MapParameter::GetLabelLineFitToWidth ( ) const

inline

Referenced by osmscout::MapPainter::GetProposedLabelWidth().

GetLabelLineMaxCharCount()

size_t osmscout::MapParameter::GetLabelLineMaxCharCount ( ) const

inline

Referenced by osmscout::MapPainter::GetProposedLabelWidth().

GetLabelLineMinCharCount()

size_t osmscout::MapParameter::GetLabelLineMinCharCount ( ) const

inline

Referenced by osmscout::MapPainter::GetProposedLabelWidth().

GetLabelPadding()

double osmscout::MapParameter::GetLabelPadding ( ) const

inline

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

GetLineMinWidthPixel()

double osmscout::MapParameter::GetLineMinWidthPixel ( ) const

inline

Referenced by osmscout::MapPainterCairo::DrawMap().

GetLocale()

Locale osmscout::MapParameter::GetLocale ( ) const

inline

Referenced by osmscout::DynamicFeatureLabelReader::GetLabel().

GetLocaleRef()

Locale & osmscout::MapParameter::GetLocaleRef ( )

inline

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

GetOptimizeAreaNodes()

TransPolygon::OptimizeMethod osmscout::MapParameter::GetOptimizeAreaNodes ( ) const

inline

GetOptimizeErrorToleranceMm()

double osmscout::MapParameter::GetOptimizeErrorToleranceMm ( ) const

inline

GetOptimizeWayNodes()

TransPolygon::OptimizeMethod osmscout::MapParameter::GetOptimizeWayNodes ( ) const

inline

GetOverlayLabelPadding()

double osmscout::MapParameter::GetOverlayLabelPadding ( ) const

inline

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

GetPatternMode()

PatternMode osmscout::MapParameter::GetPatternMode ( ) const

inline

Referenced by osmscout::MapPainterQt::HasPattern().

GetPatternPaths()

const std::list< std::string > & osmscout::MapParameter::GetPatternPaths ( ) const

inline

Referenced by osmscout::MapPainterCairo::HasPattern(), and osmscout::MapPainterQt::HasPattern().

GetPatternSize()

double osmscout::MapParameter::GetPatternSize ( ) const

inline

Referenced by osmscout::MapPainterQt::HasPattern().

GetPlateLabelPadding()

double osmscout::MapParameter::GetPlateLabelPadding ( ) const

inline

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

GetPreferSymbolIcons()

bool osmscout::MapParameter::GetPreferSymbolIcons ( ) const

inline

GetRenderBackground()

bool osmscout::MapParameter::GetRenderBackground ( ) const

inline

GetRenderContourLines()

bool osmscout::MapParameter::GetRenderContourLines ( ) const

inline

Referenced by osmscout::MapPainter::DrawContourLines().

GetRenderHillShading()

bool osmscout::MapParameter::GetRenderHillShading ( ) const

inline

Referenced by osmscout::MapPainter::DrawHillShading().

GetRenderSeaLand()

bool osmscout::MapParameter::GetRenderSeaLand ( ) const

inline

Referenced by osmscout::DBRenderJob::Run().

GetRenderUnknowns()

bool osmscout::MapParameter::GetRenderUnknowns ( ) const

inline

GetRouteLabelSeparator()

std::string osmscout::MapParameter::GetRouteLabelSeparator ( ) const

inline

GetShowAltLanguage()

bool osmscout::MapParameter::GetShowAltLanguage ( ) const

inline

GetSidecarDistance()

double osmscout::MapParameter::GetSidecarDistance ( ) const

inline

GetSidecarMaxDistanceMM()

double osmscout::MapParameter::GetSidecarMaxDistanceMM ( ) const

inline

GetSidecarMinDistanceMM()

double osmscout::MapParameter::GetSidecarMinDistanceMM ( ) const

inline

GetWarningCoordCountLimit()

size_t osmscout::MapParameter::GetWarningCoordCountLimit ( ) const

inline

Referenced by osmscout::MapPainterStatistics::DumpMapPainterStatistics().

GetWarningObjectCountLimit()

size_t osmscout::MapParameter::GetWarningObjectCountLimit ( ) const

inline

Referenced by osmscout::MapPainterStatistics::DumpMapPainterStatistics().

IsAborted()

bool osmscout::MapParameter::IsAborted ( ) const

inline

Referenced by osmscout::MapPainter::Draw().

IsDebugData()

bool osmscout::MapParameter::IsDebugData ( ) const

inline

Referenced by osmscout::MapPainterStatistics::DumpMapPainterStatistics().

IsDebugPerformance()

bool osmscout::MapParameter::IsDebugPerformance ( ) const

inline

Referenced by osmscout::MapPainterStatistics::DumpMapPainterStatistics().

RegisterFillStyleProcessor()

void osmscout::MapParameter::RegisterFillStyleProcessor	(	size_t	typeIndex,
		const FillStyleProcessorRef &	processor
	)

SetAreaMinDimensionMM()

void osmscout::MapParameter::SetAreaMinDimensionMM

(

double

areaMinDimensionMM

)

SetBreaker()

void osmscout::MapParameter::SetBreaker

(

const BreakerRef &

breaker

)

SetContourLabelOffset()

void osmscout::MapParameter::SetContourLabelOffset

(

double

contourLabelOffset

)

SetContourLabelPadding()

void osmscout::MapParameter::SetContourLabelPadding

(

double

padding

)

SetContourLabelSpace()

void osmscout::MapParameter::SetContourLabelSpace

(

double

contourLabelSpace

)

SetDebugData()

void osmscout::MapParameter::SetDebugData

(

bool

debug

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetDebugPerformance()

void osmscout::MapParameter::SetDebugPerformance

(

bool

debug

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetDrawFadings()

void osmscout::MapParameter::SetDrawFadings

(

bool

drawFadings

)

SetDrawWaysWithFixedWidth()

void osmscout::MapParameter::SetDrawWaysWithFixedWidth

(

bool

drawWaysWithFixedWidth

)

SetFontName()

void osmscout::MapParameter::SetFontName

(

const std::string &

fontName

)

Font to draw and measure labels with.

The name is either a font family ("Liberation Sans") or the path of a font file. A backend that resolves a font by family serves the face the file holds, and a backend that loads a font file directly loads it, so both forms are valid for every backend. A name that is neither a readable font file nor a family the host can resolve is reported and drawn with a default face.

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetFontSize()

void osmscout::MapParameter::SetFontSize

(

double

fontSize

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetIconMode()

void osmscout::MapParameter::SetIconMode

(

const IconMode &

mode

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), osmscout::IconLookup::IconLookup(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetIconPadding()

void osmscout::MapParameter::SetIconPadding

(

double

padding

)

SetIconPaths()

void osmscout::MapParameter::SetIconPaths

(

const std::list< std::string > &

paths

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), osmscout::IconLookup::IconLookup(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetIconPixelSize()

void osmscout::MapParameter::SetIconPixelSize

(

double

size

)

SetIconSize()

void osmscout::MapParameter::SetIconSize

(

double

size

)

SetLabelLayouterOverlap()

void osmscout::MapParameter::SetLabelLayouterOverlap

(

double

labelLayouterOverlap

)

SetLabelLineFitToArea()

void osmscout::MapParameter::SetLabelLineFitToArea

(

bool

labelLineFitToArea

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetLabelLineFitToWidth()

void osmscout::MapParameter::SetLabelLineFitToWidth

(

double

labelLineFitToWidth

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetLabelLineMaxCharCount()

void osmscout::MapParameter::SetLabelLineMaxCharCount

(

size_t

labelLineMaxCharCount

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetLabelLineMinCharCount()

void osmscout::MapParameter::SetLabelLineMinCharCount

(

size_t

labelLineMinCharCount

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetLabelPadding()

void osmscout::MapParameter::SetLabelPadding

(

double

labelPadding

)

SetLineMinWidthPixel()

void osmscout::MapParameter::SetLineMinWidthPixel

(

double

lineMinWidthPixel

)

SetLocale()

void osmscout::MapParameter::SetLocale

(

const Locale &

locale

)

SetOptimizeAreaNodes()

void osmscout::MapParameter::SetOptimizeAreaNodes

(

TransPolygon::OptimizeMethod

optimize

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetOptimizeErrorToleranceMm()

void osmscout::MapParameter::SetOptimizeErrorToleranceMm

(

double

errorToleranceMm

)

SetOptimizeWayNodes()

void osmscout::MapParameter::SetOptimizeWayNodes

(

TransPolygon::OptimizeMethod

optimize

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetOverlayLabelPadding()

void osmscout::MapParameter::SetOverlayLabelPadding

(

double

padding

)

SetPatternMode()

void osmscout::MapParameter::SetPatternMode

(

const PatternMode &

mode

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), osmscout::IconLookup::IconLookup(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetPatternPaths()

void osmscout::MapParameter::SetPatternPaths

(

const std::list< std::string > &

paths

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), osmscout::IconLookup::IconLookup(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetPatternSize()

void osmscout::MapParameter::SetPatternSize

(

double

size

)

SetPlateLabelPadding()

void osmscout::MapParameter::SetPlateLabelPadding

(

double

plateLabelPadding

)

SetPreferSymbolIcons()

void osmscout::MapParameter::SetPreferSymbolIcons

(

bool

preferSymbolIcons

)

SetRenderBackground()

void osmscout::MapParameter::SetRenderBackground

(

bool

render

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetRenderContourLines()

void osmscout::MapParameter::SetRenderContourLines

(

bool

render

)

SetRenderHillShading()

void osmscout::MapParameter::SetRenderHillShading

(

bool

render

)

SetRenderSeaLand()

void osmscout::MapParameter::SetRenderSeaLand

(

bool

render

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetRenderUnknowns()

void osmscout::MapParameter::SetRenderUnknowns

(

bool

render

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetRouteLabelSeparator()

void osmscout::MapParameter::SetRouteLabelSeparator

(

const std::string &

separator

)

SetShowAltLanguage()

void osmscout::MapParameter::SetShowAltLanguage

(

bool

showAltLanguage

)

Referenced by osmscout::PlaneMapRenderer::DrawMap(), and osmscout::TiledMapRenderer::onLoadJobFinished().

SetSidecarDistance()

void osmscout::MapParameter::SetSidecarDistance

(

)

SetSidecarMaxDistanceMM()

void osmscout::MapParameter::SetSidecarMaxDistanceMM

(

)

SetSidecarMinDistanceMM()

void osmscout::MapParameter::SetSidecarMinDistanceMM

(

)

SetWarningCoordCountLimit()

void osmscout::MapParameter::SetWarningCoordCountLimit

(

size_t

limit

)

Referenced by osmscout::PlaneMapRenderer::DrawMap().

SetWarningObjectCountLimit()

void osmscout::MapParameter::SetWarningObjectCountLimit

(

size_t

limit

)

Referenced by osmscout::PlaneMapRenderer::DrawMap().

---

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

• MapParameter.h
• MapParameter.cpp