Looks a pattern image up in the pattern image directories of a render parameter and classifies the outcome, so that every map backend can report a pattern fill it cannot serve in the same way. More...

#include <PatternLookup.h>

Public Types
enum class	Status : uint8_t { Found , NotFound , NoSourceConfigured }
	Outcome of searching the configured pattern image directories for a pattern. More...

Public Member Functions
	PatternLookup ()=delete

Static Public Member Functions
static std::string	Describe (const std::list< std::string > &patternPaths, const std::string &patternName, const std::string &extension, Status status)
	Report for a lookup that did not resolve the pattern: names the pattern and either says that no pattern image source is configured or lists the directories that were searched.
static Status	Resolve (const std::list< std::string > &patternPaths, const std::string &patternName, const std::string &extension, std::string &filename)
	Search the given directories for an image of the pattern.

Detailed Description

Looks a pattern image up in the pattern image directories of a render parameter and classifies the outcome, so that every map backend can report a pattern fill it cannot serve in the same way.

The lookup only answers where an image is and what should be reported if there is none; loading the image stays with the backend, because every backend keeps its images in its own type.

Member Enumeration Documentation

◆ Status

enum class osmscout::PatternLookup::Status : uint8_t

strong

Outcome of searching the configured pattern image directories for a pattern.

Enumerator
Found	An image for the pattern was found in one of the configured directories.
NotFound	The configured directories hold no image for the pattern.
NoSourceConfigured	No pattern image directory is configured at all.

Constructor & Destructor Documentation

◆ PatternLookup()

osmscout::PatternLookup::PatternLookup ( )

delete

References Describe(), and Resolve().

Member Function Documentation

◆ Describe()

std::string osmscout::PatternLookup::Describe	(	const std::list< std::string > &	patternPaths,
		const std::string &	patternName,
		const std::string &	extension,
		Status	status )

static

Report for a lookup that did not resolve the pattern: names the pattern and either says that no pattern image source is configured or lists the directories that were searched.

Parameters

patternPaths	directories the lookup searched
patternName	pattern name as the style sheet uses it, without an extension
extension	image file extension including the dot (for example ".png")
status	outcome of the lookup

Returns: the report, empty for Status::Found

References Found, NoSourceConfigured, and NotFound.

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

◆ Resolve()

PatternLookup::Status osmscout::PatternLookup::Resolve	(	const std::list< std::string > &	patternPaths,
		const std::string &	patternName,
		const std::string &	extension,
		std::string &	filename )

static

Search the given directories for an image of the pattern.

The directories are searched in their given order, so the first directory that holds the image wins.