Symbol for PathObjects where the enclosed area is filled with a solid color and / or with one or more patterns. More...

#include <area_symbol.h>

Inheritance diagram for OpenOrienteering::AreaSymbol:

Collaboration diagram for OpenOrienteering::AreaSymbol:

[legend]

Classes
struct	FillPattern
	Describes a fill pattern. More...

Public Member Functions
	AreaSymbol () noexcept

	~AreaSymbol () override

void	createRenderables (const Object *object, const VirtualCoordVector &coords, ObjectRenderables &output, Symbol::RenderableOptions options) const override
	Creates renderables for a generic object. More...

void	createRenderables (const PathObject *object, const PathPartVector &path_parts, ObjectRenderables &output, Symbol::RenderableOptions options) const override
	Creates renderables for a path object. More...

void	createRenderablesNormal (const PathObject *object, const PathPartVector &path_parts, ObjectRenderables &output) const

void	createHatchingRenderables (const PathObject object, const PathPartVector &path_parts, ObjectRenderables &output, const MapColor color) const
	Creates area hatching renderables for a path object. More...

void	colorDeletedEvent (const MapColor *color) override
	Called when a color is removed from the map. More...

bool	containsColor (const MapColor *color) const override
	Returns if the given color is used by this symbol. More...

const MapColor *	guessDominantColor () const override
	Returns the dominant color of this symbol. More...

void	replaceColors (const MapColorMap &color_map) override
	Replaces colors used by this symbol. More...

void	scale (double factor) override
	Scales the symbol. More...

qreal	dimensionForIcon () const override
	Returns the dimension which shall considered when scaling the icon. More...

const MapColor *	getColor () const

void	setColor (const MapColor *color)

int	getMinimumArea () const

int	getNumFillPatterns () const

void	setNumFillPatterns (int count)

FillPattern &	getFillPattern (int i)

const FillPattern &	getFillPattern (int i) const

bool	hasRotatableFillPattern () const

SymbolPropertiesWidget *	createPropertiesWidget (SymbolSettingDialog *dialog) override
	Creates a properties widget for the symbol. More...

Public Member Functions inherited from OpenOrienteering::Symbol
	Symbol (Type type) noexcept

virtual	~Symbol ()

Symbol &	operator= (const Symbol &)=delete

Symbol &	operator= (Symbol &&)=delete

virtual bool	validate () const

bool	equals (const Symbol *other, Qt::CaseSensitivity case_sensitivity=Qt::CaseSensitive) const
	Checks for equality to the other symbol. More...

bool	stateEquals (const Symbol *other) const
	Checks protected/hidden state for equality to the other symbol. More...

Type	getType () const
	Returns the type of the symbol. More...

const PointSymbol *	asPoint () const
	Case to PointSymbol with type checking. More...

PointSymbol *	asPoint ()
	Case to PointSymbol with type checking. More...

const LineSymbol *	asLine () const
	Case to LineSymbol with type checking. More...

LineSymbol *	asLine ()
	Case to LineSymbol with type checking. More...

const AreaSymbol *	asArea () const
	Case to AreaSymbol with type checking. More...

AreaSymbol *	asArea ()
	Case to AreaSymbol with type checking. More...

const TextSymbol *	asText () const
	Case to TextSymbol with type checking. More...

TextSymbol *	asText ()
	Case to TextSymbol with type checking. More...

const CombinedSymbol *	asCombined () const
	Case to CombinedSymbol with type checking. More...

CombinedSymbol *	asCombined ()
	Case to CombinedSymbol with type checking. More...

virtual TypeCombination	getContainedTypes () const
	Returns the combined bitmask of all symbol types this symbol contains. More...

bool	isTypeCompatibleTo (const Object *object) const
	Checks if the symbol can be applied to the given object. More...

bool	numberEquals (const Symbol *other) const
	Returns if the symbol numbers are exactly equal. More...

bool	numberEqualsRelaxed (const Symbol *other) const
	Returns if the symbol numbers are equal, ignoring trailing zeros. More...

void	save (QXmlStreamWriter &xml, const Map &map) const
	Saves the symbol in xml format. More...

virtual bool	loadingFinishedEvent (Map *map)
	Called when loading the map is finished. More...

virtual void	createBaselineRenderables (const PathObject object, const PathPartVector &path_parts, ObjectRenderables &output, const MapColor color) const
	Creates baseline renderables for a path object. More...

virtual bool	symbolChangedEvent (const Symbol old_symbol, const Symbol new_symbol)
	Called when a symbol was changed, replaced, or removed. More...

virtual bool	containsSymbol (const Symbol *symbol) const
	Returns true if the given symbol is referenced by this symbol. More...

QImage	getCustomIcon () const
	Returns the custom symbol icon. More...

void	setCustomIcon (const QImage &image)
	Sets a custom symbol icon. More...

QImage	getIcon (const Map *map) const
	Returns the symbol's icon. More...

QImage	createIcon (const Map &map, int side_length, bool antialiasing=true, qreal zoom=0) const
	Creates a symbol icon with the given side length (pixels). More...

void	resetIcon ()
	Clear the symbol's cached icon. More...

virtual qreal	calculateLargestLineExtent () const
	Returns the largest extent of all primitive lines which are part of the symbol. More...

const QString &	getName () const
	Returns the symbol name. More...

QString	getPlainTextName () const
	Returns the symbol name with all HTML markup stripped. More...

void	setName (const QString &new_name)
	Sets the symbol name. More...

QString	getNumberAsString () const
	Returns the symbol number as string. More...

int	getNumberComponent (int i) const
	Returns the i-th component of the symbol number as int. More...

void	setNumberComponent (int i, int new_number)
	Sets the i-th component of the symbol number. More...

const QString &	getDescription () const
	Returns the symbol description. More...

void	setDescription (const QString &new_description)
	Sets the symbol description. More...

bool	isHelperSymbol () const
	Returns if this is a helper symbol (which is not printed in the final map). More...

void	setIsHelperSymbol (bool value)
	Sets if this is a helper symbol, see isHelperSymbol(). More...

bool	isHidden () const
	Returns if this symbol is hidden. More...

void	setHidden (bool value)
	Sets the hidden state of this symbol. More...

bool	isProtected () const
	Returns if this symbol is protected. More...

void	setProtected (bool value)
	Sets the protected state of this symbol. More...

bool	isRotatable () const
	Returns if objects with this symbol can be rotated in arbitrary directions. More...

Protected Member Functions
	AreaSymbol (const AreaSymbol &proto)

AreaSymbol *	duplicate () const override

void	saveImpl (QXmlStreamWriter &xml, const Map &map) const override
	Must be overridden to save type-specific symbol properties. More...

bool	loadImpl (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version) override
	Must be overridden to load type-specific symbol properties. More...

bool	equalsImpl (const Symbol *other, Qt::CaseSensitivity case_sensitivity) const override
	Compares AreaSymbol objects for equality. More...

Protected Member Functions inherited from OpenOrienteering::Symbol
	Symbol (const Symbol &proto)

void	setRotatable (bool value)
	Sets the rotatability state of the symbol. More...

Protected Attributes
std::vector< FillPattern >	patterns

const MapColor *	color

int	minimum_area

Friends
class	AreaSymbolSettings

class	PointSymbolEditorWidget

class	OCAD8FileImport

Additional Inherited Members
Public Types inherited from OpenOrienteering::Symbol
enum	Type { Point = 1, Line = 2, Area = 4, Text = 8, Combined = 16, NoSymbol = 0, AllSymbols = Point \| Line \| Area \| Text \| Combined }
	Enumeration of all possible symbol types. More...

enum	RenderableOption { RenderBaselines = 1 << 0, RenderAreasHatched = 1 << 1, RenderNormal = 0 }
	RenderableOptions denominate variations in painting symbols. More...

Static Public Member Functions inherited from OpenOrienteering::Symbol
template<class S >
static std::unique_ptr< S >	duplicate (const S &s)
	Duplicates a symbol. More...

static std::unique_ptr< Symbol >	load (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version)
	Load the symbol in xml format. More...

static std::unique_ptr< Symbol >	makeSymbolForType (Type type)
	Returns a newly created symbol of the given type. More...

static bool	areTypesCompatible (Type a, Type b)
	Returns if the symbol types can be applied to the same object types. More...

static TypeCombination	getCompatibleTypes (Type type)
	Returns a bitmask of all types which can be applied to the same objects as the given type. More...

static bool	lessByNumber (const Symbol s1, const Symbol s2)
	Compares two symbols by number. More...

static bool	lessByColorPriority (const Symbol s1, const Symbol s2)
	Compares two symbols by the dominant colors' priorities. More...

Static Public Attributes inherited from OpenOrienteering::Symbol
static constexpr auto	number_components = 3u
	Number of components of symbol numbers. More...

Detailed Description

Symbol for PathObjects where the enclosed area is filled with a solid color and / or with one or more patterns.

Constructor & Destructor Documentation

◆ AreaSymbol() [1/2]

OpenOrienteering::AreaSymbol::AreaSymbol ( )

noexcept

◆ ~AreaSymbol()

OpenOrienteering::AreaSymbol::~AreaSymbol ( )

override

◆ AreaSymbol() [2/2]

OpenOrienteering::AreaSymbol::AreaSymbol ( const AreaSymbol & proto )

explicitprotected

Member Function Documentation

◆ colorDeletedEvent()

void OpenOrienteering::AreaSymbol::colorDeletedEvent ( const MapColor * color )

overridevirtual

Called when a color is removed from the map.

Symbols need to remove all references to the given color when this event occurs.

Implements OpenOrienteering::Symbol.

◆ containsColor()

bool OpenOrienteering::AreaSymbol::containsColor ( const MapColor * color ) const

overridevirtual

Returns if the given color is used by this symbol.

Implements OpenOrienteering::Symbol.

◆ createHatchingRenderables()

void OpenOrienteering::AreaSymbol::createHatchingRenderables	(	const PathObject *	object,
		const PathPartVector &	path_parts,
		ObjectRenderables &	output,
		const MapColor *	color
	)		const

Creates area hatching renderables for a path object.

◆ createPropertiesWidget()

SymbolPropertiesWidget * OpenOrienteering::AreaSymbol::createPropertiesWidget ( SymbolSettingDialog * dialog )

overridevirtual

Creates a properties widget for the symbol.

Implements OpenOrienteering::Symbol.

◆ createRenderables() [1/2]

void OpenOrienteering::AreaSymbol::createRenderables	(	const Object *	object,
		const VirtualCoordVector &	coords,
		ObjectRenderables &	output,
		Symbol::RenderableOptions	options
	)		const

overridevirtual

Creates renderables for a generic object.

This will create the renderables according to the object's properties and the given coordinates.

Implementations must use the coordinates (coords) instead of the object's coordinates.

Implements OpenOrienteering::Symbol.

◆ createRenderables() [2/2]

void OpenOrienteering::AreaSymbol::createRenderables	(	const PathObject *	object,
		const PathPartVector &	path_parts,
		ObjectRenderables &	output,
		Symbol::RenderableOptions	options
	)		const

overridevirtual

Creates renderables for a path object.

This will create the renderables according to the object's properties and the coordinates given by the path_parts. This allows the immediate use of precalculated meta-information on paths.

See also: createRenderables()

Reimplemented from OpenOrienteering::Symbol.

◆ createRenderablesNormal()

void OpenOrienteering::AreaSymbol::createRenderablesNormal	(	const PathObject *	object,
		const PathPartVector &	path_parts,
		ObjectRenderables &	output
	)		const

◆ dimensionForIcon()

qreal OpenOrienteering::AreaSymbol::dimensionForIcon ( ) const

overridevirtual

Returns the dimension which shall considered when scaling the icon.

Reimplemented from OpenOrienteering::Symbol.

◆ duplicate()

AreaSymbol * OpenOrienteering::AreaSymbol::duplicate ( ) const

overrideprotectedvirtual

Implements OpenOrienteering::Symbol.

◆ equalsImpl()

bool OpenOrienteering::AreaSymbol::equalsImpl	(	const Symbol *	other,
		Qt::CaseSensitivity	case_sensitivity
	)		const

overrideprotectedvirtual

Compares AreaSymbol objects for equality.

Fill patterns are only compared in order.

Implements OpenOrienteering::Symbol.

◆ getColor()

const MapColor* OpenOrienteering::AreaSymbol::getColor ( ) const

inline

◆ getFillPattern() [1/2]

FillPattern& OpenOrienteering::AreaSymbol::getFillPattern ( int i )

inline

◆ getFillPattern() [2/2]

const FillPattern& OpenOrienteering::AreaSymbol::getFillPattern ( int i ) const

inline

◆ getMinimumArea()

int OpenOrienteering::AreaSymbol::getMinimumArea ( ) const

inline

◆ getNumFillPatterns()

int OpenOrienteering::AreaSymbol::getNumFillPatterns ( ) const

inline

◆ guessDominantColor()

const MapColor * OpenOrienteering::AreaSymbol::guessDominantColor ( ) const

overridevirtual

Returns the dominant color of this symbol.

If it is not possible to efficiently determine this color exactly, an appropriate heuristic should be used.

Implements OpenOrienteering::Symbol.

◆ hasRotatableFillPattern()

bool OpenOrienteering::AreaSymbol::hasRotatableFillPattern ( ) const

◆ loadImpl()

bool OpenOrienteering::AreaSymbol::loadImpl	(	QXmlStreamReader &	xml,
		const Map &	map,
		SymbolDictionary &	symbol_dict,
		int	version
	)

overrideprotectedvirtual

Must be overridden to load type-specific symbol properties.

See also: saveImpl()

Returns false if the current xml tag does not belong to the symbol and should be skipped, true if the element has been read completely.

Implements OpenOrienteering::Symbol.

◆ replaceColors()

void OpenOrienteering::AreaSymbol::replaceColors ( const MapColorMap & color_map )

overridevirtual

Replaces colors used by this symbol.

Implements OpenOrienteering::Symbol.

◆ saveImpl()

void OpenOrienteering::AreaSymbol::saveImpl	(	QXmlStreamWriter &	xml,
		const Map &	map
	)		const

overrideprotectedvirtual

Must be overridden to save type-specific symbol properties.

The map pointer can be used to get persistent indices to any pointers on map data.

Implements OpenOrienteering::Symbol.

◆ scale()

void OpenOrienteering::AreaSymbol::scale ( double factor )

overridevirtual

Scales the symbol.

Implements OpenOrienteering::Symbol.

◆ setColor()

void OpenOrienteering::AreaSymbol::setColor ( const MapColor * color )

inline

◆ setNumFillPatterns()

void OpenOrienteering::AreaSymbol::setNumFillPatterns ( int count )

inline

Friends And Related Function Documentation

◆ AreaSymbolSettings

friend class AreaSymbolSettings

friend

◆ OCAD8FileImport

friend class OCAD8FileImport

friend

◆ PointSymbolEditorWidget

friend class PointSymbolEditorWidget

friend

Member Data Documentation

◆ color

const MapColor* OpenOrienteering::AreaSymbol::color

protected

◆ minimum_area

int OpenOrienteering::AreaSymbol::minimum_area

protected

◆ patterns

std::vector<FillPattern> OpenOrienteering::AreaSymbol::patterns

protected

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

src/core/symbols/area_symbol.h (6261473 on 3 Oct 2019)
src/core/symbols/area_symbol.cpp (6261473 on 3 Oct 2019)
src/gui/symbols/area_symbol_settings.cpp (93d4c18 on 21 Jun 2019)

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AreaSymbol() [1/2]

◆ ~AreaSymbol()

◆ AreaSymbol() [2/2]

Member Function Documentation

◆ colorDeletedEvent()

◆ containsColor()

◆ createHatchingRenderables()

◆ createPropertiesWidget()

◆ createRenderables() [1/2]

◆ createRenderables() [2/2]

◆ createRenderablesNormal()

◆ dimensionForIcon()

◆ duplicate()

◆ equalsImpl()

◆ getColor()

◆ getFillPattern() [1/2]

◆ getFillPattern() [2/2]

◆ getMinimumArea()

◆ getNumFillPatterns()

◆ guessDominantColor()

◆ hasRotatableFillPattern()

◆ loadImpl()

◆ replaceColors()

◆ saveImpl()

◆ scale()

◆ setColor()

◆ setNumFillPatterns()

Friends And Related Function Documentation

◆ AreaSymbolSettings

◆ OCAD8FileImport

◆ PointSymbolEditorWidget

Member Data Documentation

◆ color

◆ minimum_area

◆ patterns