gem::MapViewPathCollection Class Reference

PathCollection object. More...

Inheritance diagram for gem::MapViewPathCollection:

Collaboration diagram for gem::MapViewPathCollection:

Public Member Functions
int	size () const noexcept
	Get the number of paths in this collection.
const PathRef	getPathAt (int index) const noexcept
	Get the path specified by index.
const PathRef	getPathByName (const String &name) const noexcept
	Get the path specified by name.
Rgba	getBorderColorAt (int index) const noexcept
	Get the border color for the path specified by index.
Rgba	getFillColorAt (int index) const noexcept
	Get the inner color for the path specified by index.
double	getBorderSizeAt (int index) const noexcept
	Get the border size for the path specified by index.
double	getInnerSizeAt (int index) const noexcept
	Get the inner size for the path specified by index.
MapViewPathCollection &	add (Path const &path, Rgba colorBorder=Rgba(), Rgba colorInner=Rgba(), double szBorder=-1., double szInner=-1.) noexcept
	Add a path to the collection.
MapViewPathCollection &	remove (Path const &path) noexcept
	Remove the path from the collection.
MapViewPathCollection &	removeAt (int index) noexcept
	Remove the path specified by index.
MapViewPathCollection &	clear () noexcept
	Remove all paths from the collection.
PathMatchList	hitTest (const RectangleGeographicArea &area) const
	Hit test in path collection.

Detailed Description

PathCollection object.

Implements share-read / write Api object over IPathCollection.

Member Function Documentation

add()

MapViewPathCollection & gem::MapViewPathCollection::add ( Path const & path, Rgba colorBorder = Rgba(), Rgba colorInner = Rgba(), double szBorder = -1., double szInner = -1. )

inlinenoexcept

Add a path to the collection.

Parameters

[in]	path	The path to be added.
[in]	colorBorder	The color of the path border. By default the one from the current map view style is used.
[in]	colorInner	The color of the path inner. By default the one from the current map view style is used.
[in]	szBorder	The size of the path border in mm. If < 0 the one from the current map view style is used.
[in]	szInner	The size of the path inner in mm. If < 0 the one from the current map view style is used.

Returns

A reference to this object

clear()

MapViewPathCollection & gem::MapViewPathCollection::clear ( )

inlinenoexcept

Remove all paths from the collection.

Returns

A reference to this object

getBorderColorAt()

Rgba gem::MapViewPathCollection::getBorderColorAt ( int index ) const

inlinenoexcept

Get the border color for the path specified by index.

Parameters

[in]

index

The path index

Returns

The border color

getBorderSizeAt()

double gem::MapViewPathCollection::getBorderSizeAt ( int index ) const

inlinenoexcept

Get the border size for the path specified by index.

Parameters

[in]

index

The path index

Returns

The border size

getFillColorAt()

Rgba gem::MapViewPathCollection::getFillColorAt ( int index ) const

inlinenoexcept

Get the inner color for the path specified by index.

Parameters

[in]

index

The path index

Returns

The inner color

getInnerSizeAt()

double gem::MapViewPathCollection::getInnerSizeAt ( int index ) const

inlinenoexcept

Get the inner size for the path specified by index.

Parameters

[in]

index

The path index

Returns

The inner size

getPathAt()

const PathRef gem::MapViewPathCollection::getPathAt ( int index ) const

inlinenoexcept

Get the path specified by index.

Parameters

[in]

index

The path index

Returns

The path at the given index if index is valid, otherwise an empty object ( i.e. bool(returned path) == false )

getPathByName()

const PathRef gem::MapViewPathCollection::getPathByName ( const String & name ) const

inlinenoexcept

Get the path specified by name.

Parameters

[in]

name

The path name

Returns

The path with the given name if name exists, otherwise an empty object ( i.e. bool(returned path) == false )

hitTest()

PathMatchList gem::MapViewPathCollection::hitTest ( const RectangleGeographicArea & area ) const

inline

Hit test in path collection.

Parameters

[in]

area

The area to hit test

Returns

The list of matched paths

remove()

MapViewPathCollection & gem::MapViewPathCollection::remove ( Path const & path )

inlinenoexcept

Remove the path from the collection.

Parameters

[in]

path

The path to be removed

Returns

A reference to this object

removeAt()

MapViewPathCollection & gem::MapViewPathCollection::removeAt ( int index )

inlinenoexcept

Remove the path specified by index.

Parameters

[in]

index

The path index

Returns

A reference to this object

size()

int gem::MapViewPathCollection::size ( ) const

inlinenoexcept

Get the number of paths in this collection.

Returns

The number of paths