libosmscout  0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
osmscout::MapPainter Class Referenceabstract

Abstract base class of all renders (though you can always write your own renderer without inheriting from this class) It implements the general rendering algorithm. More...

#include <MapPainter.h>

+ Inheritance diagram for osmscout::MapPainter:

Classes

struct  AreaData
 Data structure for holding temporary data about areas. More...
 
struct  ContourSymbolData
 
struct  RouteLabelData
 Data structure for holding temporary data route labels. More...
 
class  WayData
 Data structure for holding temporary data about ways. More...
 
struct  WayPathData
 Data structure for holding temporary data about way paths (a way may consist of multiple paths/lines rendered) More...
 

Public Types

using WayPathDataIt = std::list< WayPathData >::iterator
 

Public Member Functions

bool Draw (const Projection &projection, const MapParameter &parameter, const MapData &data)
 
bool Draw (const Projection &projection, const MapParameter &parameter, const MapData &data, RenderSteps startStep, RenderSteps endStep)
 
 MapPainter (const StyleConfigRef &styleConfig)
 
virtual ~MapPainter ()
 

Protected Member Functions

virtual void AfterDrawing (const StyleConfig &styleConfig, const Projection &projection, const MapParameter &parameter, const MapData &data)
 
virtual void AfterPreprocessing (const StyleConfig &styleConfig, const Projection &projection, const MapParameter &parameter, const MapData &data)
 Low level drawing routines that have to be implemented by the concrete drawing engine. More...
 
virtual void BeforeDrawing (const StyleConfig &styleConfig, const Projection &projection, const MapParameter &parameter, const MapData &data)
 
virtual void DrawArea (const Projection &projection, const MapParameter &parameter, const AreaData &area)=0
 Draw the given area using the given FillStyle for the area outline. More...
 
virtual void DrawContourLines (const Projection &projection, const MapParameter &parameter, const MapData &data)
 
virtual void DrawContourSymbol (const Projection &projection, const MapParameter &parameter, const Symbol &symbol, const ContourSymbolData &data)=0
 Draw the given Symbol on top of the contour of the given path. More...
 
virtual void DrawGround (const Projection &projection, const MapParameter &parameter, const FillStyle &style)=0
 (Optionally) fills the area with the given default color for ground. More...
 
virtual void DrawHillShading (const Projection &projection, const MapParameter &parameter, const MapData &data)
 
virtual void DrawIcon (const IconStyle *style, const Vertex2D &centerPos, double width, double height)=0
 Draw the Icon as defined by the IconStyle at the given pixel coordinate (icon center). More...
 
virtual void DrawLabels (const Projection &projection, const MapParameter &parameter, const MapData &data)=0
 
virtual void DrawPath (const Projection &projection, const MapParameter &parameter, const Color &color, double width, const std::vector< double > &dash, LineStyle::CapStyle startCap, LineStyle::CapStyle endCap, const CoordBufferRange &coordRange)=0
 Draw simple line with the given style,the given color, the given width and the given untransformed nodes. More...
 
virtual void DrawSymbol (const Projection &projection, const MapParameter &parameter, const Symbol &symbol, const Vertex2D &screenPos, double scaleFactor=1.0)=0
 Draw the Symbol as defined by the SymbolStyle at the given pixel coordinate (symbol center). More...
 
virtual void DrawWay (const StyleConfig &styleConfig, const Projection &projection, const MapParameter &parameter, const WayData &data)
 
const std::list< AreaData > & GetAreaData () const
 
virtual double GetFontHeight (const Projection &projection, const MapParameter &parameter, double fontSize)=0
 Returns the height of the font. More...
 
double GetProjectedWidth (const Projection &projection, double minPixel, double width) const
 
double GetProjectedWidth (const Projection &projection, double width) const
 
virtual double GetProposedLabelWidth (const MapParameter &parameter, double averageCharWidth, double objectWidth, size_t stringLength)
 Compute suggested label width for given parameters. More...
 
const std::list< WayData > & GetWayData () const
 
virtual bool HasIcon (const StyleConfig &styleConfig, const Projection &projection, const MapParameter &parameter, IconStyle &style)=0
 Return true, if the icon in the IconStyle is available and can be drawn. More...
 
bool IsVisibleArea (const Projection &projection, const GeoBox &boundingBox, double pixelOffset) const
 Useful global helper functions. More...
 
bool IsVisibleWay (const Projection &projection, const GeoBox &boundingBox, double pixelOffset) const
 
std::vector< OffsetRelParseLaneTurns (const LanesFeatureValue &feature) const
 
virtual void RegisterContourLabel (const Projection &projection, const MapParameter &parameter, const ObjectFileRef &ref, const PathLabelData &label, const LabelPath &labelPath)=0
 Register contour label. More...
 
virtual void RegisterRegularLabel (const Projection &projection, const MapParameter &parameter, const ObjectFileRef &ref, const std::vector< LabelData > &labels, const Vertex2D &position, double objectWidth)=0
 Register regular label with given text at the given pixel coordinate in a style defined by the given LabelStyle. More...
 

Protected Attributes

AccessFeatureValueReader accessReader
 Value reader for the 'lanes' feature. More...
 
AddressFeatureValueReader addressReader
 Value reader for the 'address' feature. More...
 
FillStyle areaMarkStyle
 Marker fill style for internal debugging. More...
 
FeatureValueBuffer coastlineSegmentAttributes
 
ColorFeatureValueReader colorReader
 Value reader for the 'color' feature. More...
 
double contourLabelOffset
 Same value as in MapParameter but converted to pixel. More...
 
double contourLabelSpace
 Same value as in MapParameter but converted to pixel. More...
 
CoordBuffer coordBuffer
 Coordinate buffer. More...
 
TextStyleRef debugLabel
 
std::vector< double > emptyDash
 Presets, precalculations and similar. More...
 
FillStyleRef landFill
 Fallback styles in case they are missing for the style sheet. More...
 
LanesFeatureValueReader lanesReader
 Value reader for the 'lanes' feature. More...
 
LayerFeatureValueReader layerReader
 Value reader for the 'layer' feature. More...
 
NameAltFeatureValueReader nameAltReader
 Value reader for the 'alternative name' feature. More...
 
NameFeatureValueReader nameReader
 Attribute readers. More...
 
RefFeatureValueReader refReader
 Value reader for the 'ref' feature. More...
 
FillStyleRef seaFill
 
double shieldGridSizeHoriz
 Width of a cell for shield label placement. More...
 
double shieldGridSizeVert
 Height of a cell for shield label placement. More...
 
StyleConfigRef styleConfig
 Reference to the style configuration to be used. More...
 
TransBuffer transBuffer
 Internal coordinate transformation data structures. More...
 
std::vector< double > tunnelDash
 Dash array for drawing tunnel border. More...
 
WidthFeatureValueReader widthReader
 Value reader for the 'width' feature. More...
 

Detailed Description

Abstract base class of all renders (though you can always write your own renderer without inheriting from this class) It implements the general rendering algorithm.

Concrete renders are implemented by implementing the abstract methods defined by this class and used as callbacks to the concrete renderer.

Member Typedef Documentation

◆ WayPathDataIt

using osmscout::MapPainter::WayPathDataIt = std::list<WayPathData>::iterator

Constructor & Destructor Documentation

◆ MapPainter()

◆ ~MapPainter()

osmscout::MapPainter::~MapPainter ( )
virtual

Member Function Documentation

◆ AfterDrawing()

void osmscout::MapPainter::AfterDrawing ( const StyleConfig styleConfig,
const Projection projection,
const MapParameter parameter,
const MapData data 
)
protectedvirtual

Reimplemented in osmscout::MapPainterSVG.

◆ AfterPreprocessing()

void osmscout::MapPainter::AfterPreprocessing ( const StyleConfig styleConfig,
const Projection projection,
const MapParameter parameter,
const MapData data 
)
protectedvirtual

Low level drawing routines that have to be implemented by the concrete drawing engine.

Some optional callbacks between individual processing steps.

Reimplemented in osmscout::MapPainterSVG.

◆ BeforeDrawing()

void osmscout::MapPainter::BeforeDrawing ( const StyleConfig styleConfig,
const Projection projection,
const MapParameter parameter,
const MapData data 
)
protectedvirtual

◆ Draw() [1/2]

bool osmscout::MapPainter::Draw ( const Projection projection,
const MapParameter parameter,
const MapData data 
)

◆ Draw() [2/2]

◆ DrawArea()

virtual void osmscout::MapPainter::DrawArea ( const Projection projection,
const MapParameter parameter,
const AreaData area 
)
protectedpure virtual

Draw the given area using the given FillStyle for the area outline.

Implemented in osmscout::MapPainterSVG, osmscout::MapPainterQt, osmscout::MapPainterAgg, osmscout::MapPainterCairo, and osmscout::MapPainterNoOp.

Referenced by DrawContourLines(), and DrawHillShading().

◆ DrawContourLines()

void osmscout::MapPainter::DrawContourLines ( const Projection projection,
const MapParameter parameter,
const MapData data 
)
protectedvirtual

◆ DrawContourSymbol()

virtual void osmscout::MapPainter::DrawContourSymbol ( const Projection projection,
const MapParameter parameter,
const Symbol symbol,
const ContourSymbolData data 
)
protectedpure virtual

Draw the given Symbol on top of the contour of the given path.

Implemented in osmscout::MapPainterSVG, osmscout::MapPainterQt, osmscout::MapPainterAgg, osmscout::MapPainterCairo, and osmscout::MapPainterNoOp.

◆ DrawGround()

virtual void osmscout::MapPainter::DrawGround ( const Projection projection,
const MapParameter parameter,
const FillStyle style 
)
protectedpure virtual

(Optionally) fills the area with the given default color for ground.

In 2D backends this just fills the given area, 3D backends might draw a sphere or an infinite plane.

Implemented in osmscout::MapPainterSVG, osmscout::MapPainterQt, osmscout::MapPainterAgg, osmscout::MapPainterCairo, and osmscout::MapPainterNoOp.

◆ DrawHillShading()

◆ DrawIcon()

virtual void osmscout::MapPainter::DrawIcon ( const IconStyle style,
const Vertex2D centerPos,
double  width,
double  height 
)
protectedpure virtual

Draw the Icon as defined by the IconStyle at the given pixel coordinate (icon center).

Implemented in osmscout::MapPainterQt, osmscout::MapPainterSVG, osmscout::MapPainterCairo, osmscout::MapPainterAgg, and osmscout::MapPainterNoOp.

◆ DrawLabels()

virtual void osmscout::MapPainter::DrawLabels ( const Projection projection,
const MapParameter parameter,
const MapData data 
)
protectedpure virtual

◆ DrawPath()

virtual void osmscout::MapPainter::DrawPath ( const Projection projection,
const MapParameter parameter,
const Color color,
double  width,
const std::vector< double > &  dash,
LineStyle::CapStyle  startCap,
LineStyle::CapStyle  endCap,
const CoordBufferRange coordRange 
)
protectedpure virtual

Draw simple line with the given style,the given color, the given width and the given untransformed nodes.

Implemented in osmscout::MapPainterQt, osmscout::MapPainterSVG, osmscout::MapPainterCairo, osmscout::MapPainterAgg, and osmscout::MapPainterNoOp.

Referenced by DrawWay().

◆ DrawSymbol()

virtual void osmscout::MapPainter::DrawSymbol ( const Projection projection,
const MapParameter parameter,
const Symbol symbol,
const Vertex2D screenPos,
double  scaleFactor = 1.0 
)
protectedpure virtual

Draw the Symbol as defined by the SymbolStyle at the given pixel coordinate (symbol center).

Implemented in osmscout::MapPainterQt, osmscout::MapPainterCairo, osmscout::MapPainterAgg, osmscout::MapPainterNoOp, and osmscout::MapPainterSVG.

◆ DrawWay()

◆ GetAreaData()

const std::list<AreaData>& osmscout::MapPainter::GetAreaData ( ) const
inlineprotected

◆ GetFontHeight()

virtual double osmscout::MapPainter::GetFontHeight ( const Projection projection,
const MapParameter parameter,
double  fontSize 
)
protectedpure virtual

◆ GetProjectedWidth() [1/2]

double osmscout::MapPainter::GetProjectedWidth ( const Projection projection,
double  minPixel,
double  width 
) const
protected

◆ GetProjectedWidth() [2/2]

double osmscout::MapPainter::GetProjectedWidth ( const Projection projection,
double  width 
) const
inlineprotected

◆ GetProposedLabelWidth()

double osmscout::MapPainter::GetProposedLabelWidth ( const MapParameter parameter,
double  averageCharWidth,
double  objectWidth,
size_t  stringLength 
)
protectedvirtual

Compute suggested label width for given parameters.

It may be used by backend for layout labels with wrapping words.

References osmscout::MapParameter::GetLabelLineFitToArea(), osmscout::MapParameter::GetLabelLineFitToWidth(), osmscout::MapParameter::GetLabelLineMaxCharCount(), and osmscout::MapParameter::GetLabelLineMinCharCount().

◆ GetWayData()

const std::list<WayData>& osmscout::MapPainter::GetWayData ( ) const
inlineprotected

◆ HasIcon()

virtual bool osmscout::MapPainter::HasIcon ( const StyleConfig styleConfig,
const Projection projection,
const MapParameter parameter,
IconStyle style 
)
protectedpure virtual

Return true, if the icon in the IconStyle is available and can be drawn.

If this method returns false, possibly a fallback (using a Symbol) will be chosen.

Icon style dimensions and iconId may be setup for later usage.

Implemented in osmscout::MapPainterSVG, osmscout::MapPainterQt, osmscout::MapPainterAgg, osmscout::MapPainterCairo, and osmscout::MapPainterNoOp.

◆ IsVisibleArea()

bool osmscout::MapPainter::IsVisibleArea ( const Projection projection,
const GeoBox boundingBox,
double  pixelOffset 
) const
protected

◆ IsVisibleWay()

bool osmscout::MapPainter::IsVisibleWay ( const Projection projection,
const GeoBox boundingBox,
double  pixelOffset 
) const
protected

◆ ParseLaneTurns()

◆ RegisterContourLabel()

virtual void osmscout::MapPainter::RegisterContourLabel ( const Projection projection,
const MapParameter parameter,
const ObjectFileRef ref,
const PathLabelData label,
const LabelPath labelPath 
)
protectedpure virtual

◆ RegisterRegularLabel()

virtual void osmscout::MapPainter::RegisterRegularLabel ( const Projection projection,
const MapParameter parameter,
const ObjectFileRef ref,
const std::vector< LabelData > &  labels,
const Vertex2D position,
double  objectWidth 
)
protectedpure virtual

Register regular label with given text at the given pixel coordinate in a style defined by the given LabelStyle.

Implemented in osmscout::MapPainterQt, osmscout::MapPainterSVG, osmscout::MapPainterAgg, osmscout::MapPainterCairo, and osmscout::MapPainterNoOp.

Referenced by DrawHillShading().

Member Data Documentation

◆ accessReader

AccessFeatureValueReader osmscout::MapPainter::accessReader
protected

Value reader for the 'lanes' feature.

◆ addressReader

AddressFeatureValueReader osmscout::MapPainter::addressReader
protected

Value reader for the 'address' feature.

◆ areaMarkStyle

FillStyle osmscout::MapPainter::areaMarkStyle
protected

Marker fill style for internal debugging.

Referenced by MapPainter().

◆ coastlineSegmentAttributes

FeatureValueBuffer osmscout::MapPainter::coastlineSegmentAttributes
protected

◆ colorReader

ColorFeatureValueReader osmscout::MapPainter::colorReader
protected

Value reader for the 'color' feature.

◆ contourLabelOffset

double osmscout::MapPainter::contourLabelOffset
protected

Same value as in MapParameter but converted to pixel.

◆ contourLabelSpace

double osmscout::MapPainter::contourLabelSpace
protected

Same value as in MapParameter but converted to pixel.

◆ coordBuffer

◆ debugLabel

TextStyleRef osmscout::MapPainter::debugLabel
protected

Referenced by MapPainter().

◆ emptyDash

std::vector<double> osmscout::MapPainter::emptyDash
protected

Presets, precalculations and similar.

Empty dash array

Referenced by osmscout::MapPainterSVG::DrawWay(), and DrawWay().

◆ landFill

FillStyleRef osmscout::MapPainter::landFill
protected

Fallback styles in case they are missing for the style sheet.

Referenced by osmscout::MapPainterSVG::AfterPreprocessing(), and MapPainter().

◆ lanesReader

LanesFeatureValueReader osmscout::MapPainter::lanesReader
protected

Value reader for the 'lanes' feature.

◆ layerReader

LayerFeatureValueReader osmscout::MapPainter::layerReader
protected

Value reader for the 'layer' feature.

◆ nameAltReader

NameAltFeatureValueReader osmscout::MapPainter::nameAltReader
protected

Value reader for the 'alternative name' feature.

◆ nameReader

NameFeatureValueReader osmscout::MapPainter::nameReader
protected

Attribute readers.

Value reader for the 'name' feature

◆ refReader

RefFeatureValueReader osmscout::MapPainter::refReader
protected

Value reader for the 'ref' feature.

◆ seaFill

FillStyleRef osmscout::MapPainter::seaFill
protected

◆ shieldGridSizeHoriz

double osmscout::MapPainter::shieldGridSizeHoriz
protected

Width of a cell for shield label placement.

◆ shieldGridSizeVert

double osmscout::MapPainter::shieldGridSizeVert
protected

Height of a cell for shield label placement.

◆ styleConfig

StyleConfigRef osmscout::MapPainter::styleConfig
protected

Reference to the style configuration to be used.

Referenced by osmscout::MapPainterSVG::AfterPreprocessing(), DrawContourLines(), DrawHillShading(), and osmscout::MapPainterSVG::DrawMap().

◆ transBuffer

TransBuffer osmscout::MapPainter::transBuffer
protected

Internal coordinate transformation data structures.

Internal buffer for coordinate transformation from geo coordinates to display coordinates

Referenced by DrawContourLines(), and DrawHillShading().

◆ tunnelDash

std::vector<double> osmscout::MapPainter::tunnelDash
protected

Dash array for drawing tunnel border.

Referenced by MapPainter().

◆ widthReader

WidthFeatureValueReader osmscout::MapPainter::widthReader
protected

Value reader for the 'width' feature.


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