gem::MapViewRoute Class Reference

MapViewRoute object. More...

Public Member Functions
	MapViewRoute (const Route &route=Route(), const RouteRenderSettings &settings=RouteRenderSettings()) noexcept
	Constructor.
	MapViewRoute (const MapViewRoute &mapview)=default
	Copy Constructor.
	MapViewRoute (MapViewRoute &&mapView)=default
	Move Constructor.
MapViewRoute &	operator= (const MapViewRoute &mapview)=default
	Copy operator.
MapViewRoute &	operator= (MapViewRoute &&mapview)=default
	Move operator.
bool	operator== (const MapViewRoute &r) const
	Equal operator.
bool	operator!= (const MapViewRoute &r) const
	Not equal operator.
const Route &	getRoute () const noexcept
	Get route object.
MapViewRoute &	setRoute (const Route &route) noexcept
	Set route object.
const String &	getLabelText () const noexcept
	Get route label text.
MapViewRoute &	setLabelText (const String &text) noexcept
	Set route label text.
const ImageList &	getLabelImages () const noexcept
	Get route label images.
MapViewRoute &	setLabelImages (const ImageList &images) noexcept
	Set route label images.
MapViewRoute &	hideLabel ()
	Hide route label.
const RouteRenderSettings &	getRenderSettings () const noexcept
	Get route render settings(readonly).
RouteRenderSettings &	getRenderSettings () noexcept
	Get route render settings.
MapViewRoute &	setRenderSettings (const RouteRenderSettings &settings) noexcept
	Set route render settings.

Friends
class	MapViewRouteCollection

Detailed Description

MapViewRoute object.

Implements a route that can be displayed in a Map View

Constructor & Destructor Documentation

MapViewRoute() [1/3]

gem::MapViewRoute::MapViewRoute ( const Route & route = Route(), const RouteRenderSettings & settings = RouteRenderSettings() )

inlinenoexcept

Constructor.

Parameters

route	The route to be displayed
settings	The settings for rendering the route

MapViewRoute() [2/3]

gem::MapViewRoute::MapViewRoute ( const MapViewRoute & mapview )

default

Copy Constructor.

Parameters

[in]

mapview

The MapViewRoute object to be copied.

MapViewRoute() [3/3]

gem::MapViewRoute::MapViewRoute ( MapViewRoute && mapView )

default

Move Constructor.

Parameters

[in]

mapView

The MapViewRoute object to be moved.

Member Function Documentation

getLabelImages()

const ImageList & gem::MapViewRoute::getLabelImages ( ) const

inlinenoexcept

Get route label images.

Returns

The label images.

getLabelText()

const String & gem::MapViewRoute::getLabelText ( ) const

inlinenoexcept

Get route label text.

Returns

The label text.

getRenderSettings() [1/2]

const RouteRenderSettings & gem::MapViewRoute::getRenderSettings ( ) const

inlinenoexcept

Get route render settings(readonly).

Returns

The render settings.

getRenderSettings() [2/2]

RouteRenderSettings & gem::MapViewRoute::getRenderSettings ( )

inlinenoexcept

Get route render settings.

Returns

The render settings.

getRoute()

const Route & gem::MapViewRoute::getRoute ( ) const

inlinenoexcept

Get route object.

Returns

The route object.

hideLabel()

MapViewRoute & gem::MapViewRoute::hideLabel ( )

inline

Hide route label.

Returns

The MapViewRoute object.

operator!=()

bool gem::MapViewRoute::operator!= ( const MapViewRoute & r ) const

inline

Not equal operator.

Parameters

[in]

r

The MapViewRoute object to be compared.

Returns

True if the two objects are not equal, false otherwise.

operator=() [1/2]

MapViewRoute & gem::MapViewRoute::operator= ( const MapViewRoute & mapview )

default

Copy operator.

Parameters

[in]

mapview

The MapViewRoute object to be copied.

Returns

The MapViewRoute object.

operator=() [2/2]

MapViewRoute & gem::MapViewRoute::operator= ( MapViewRoute && mapview )

default

Move operator.

Parameters

[in]

mapview

The MapViewRoute object to be moved.

Returns

The MapViewRoute object.

operator==()

bool gem::MapViewRoute::operator== ( const MapViewRoute & r ) const

inline

Equal operator.

Parameters

[in]

r

The MapViewRoute object to be compared.

Returns

True if the two objects are equal, false otherwise.

setLabelImages()

MapViewRoute & gem::MapViewRoute::setLabelImages ( const ImageList & images )

inlinenoexcept

Set route label images.

Parameters

[in]

images

The label images to be set.

Returns

The MapViewRoute object.

setLabelText()

MapViewRoute & gem::MapViewRoute::setLabelText ( const String & text )

inlinenoexcept

Set route label text.

Parameters

[in]

text

The label text to be set.

Returns

The MapViewRoute object.

setRenderSettings()

MapViewRoute & gem::MapViewRoute::setRenderSettings ( const RouteRenderSettings & settings )

inlinenoexcept

Set route render settings.

Parameters

[in]

settings

The render settings to be set.

Returns

The MapViewRoute object.

setRoute()

MapViewRoute & gem::MapViewRoute::setRoute ( const Route & route )

inlinenoexcept

Set route object.

Parameters

[in]

route

The route object to be set.

Returns

The MapViewRoute object.