Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::MapViewPreferencesV2 Class Reference

MapViewPreferencesV2 object. More...

Inheritance diagram for gem::MapViewPreferencesV2:
Collaboration diagram for gem::MapViewPreferencesV2:

Public Member Functions

const FollowPositionPreferencesV2Ref followPositionPreferences () const noexcept
 Follow position preferences(read-only).
FollowPositionPreferencesV2Ref followPositionPreferences () noexcept
 Follow position preferences.
MapViewPreferencessetMapViewPerspective (EMapViewPerspective perspective, Animation animation=Animation()) noexcept
 Set the map view perspective.
EMapViewPerspective getMapViewPerspective () const noexcept
 Get the map view perspective.
double getViewAngle () const noexcept
 Get the viewing angle.
double getMinViewAngle () const noexcept
 Get the minimum viewing angle.
double getMaxViewAngle () const noexcept
 Get the maximum viewing angle.
MapViewPreferencessetViewAngle (double value, bool animated=false) noexcept
 Set the viewing angle.
MapViewPreferencessetTiltAngle (double angleDegrees) noexcept
 Set tilt angle in degrees.
double getTiltAngle () const noexcept
 Get tilt angle in degrees.
double getRotationAngle () const noexcept
 Get map rotation angle in degrees relative to north-south axis.
MapViewPreferencessetRotationAngle (double angle) noexcept
 Get map rotation angle in degrees relative to north-south axis.
LandmarkStoreCollectionRef lmks () noexcept
 Get access to the visibility settings for the landmark stores.
MapViewRoutesCollectionRef routes () noexcept
 Get access to the collection of visible routes.
PathCollectionRef paths () noexcept
 Get access to the collection of visible paths.
MapViewOverlayCollectionRef overlays () noexcept
 Get access to the collection of visible overlays.
MapViewMarkerCollectionsRef markers () noexcept
 Get access to the collections of visible markers.
bool getTrafficVisibility () const noexcept
 Get traffic visibility.
int setTrafficVisibility (bool value) noexcept
 Set traffic visibility.
MapViewPreferencesenableCursor (bool value) noexcept
 Enable/Disable the cursor mode When the cursor is enabled map selection can be activated by calling setCursorScreenPosition The cursor is automatically disabled by MapView::startFollowingPosition.
bool isCursorEnabled () const noexcept
 Test if cursor is enabled.
MapViewPreferencesenableCursorRender (bool value) noexcept
 Enable/Disable the cursor rendering.
bool isCursorRenderEnabled () const noexcept
 Test if cursor is enabled.
bool getNorthFixedFlag () const noexcept
 Get the value of the NorthFixed flag.
MapViewPreferencessetNorthFixedFlag (bool value) noexcept
 Set the value of the NorthFixed flag.
MapViewPreferencessetMapStyleByPath (const String &path, bool smoothTransition=false) noexcept
 Set map view details by content path.
MapViewPreferencessetMapStyle (const DataBuffer &content, bool smoothTransition=false) noexcept
 Set map view details by content.
MapViewPreferencessetMapStyle (const ContentStoreItem &style, bool smoothTransition=false) noexcept
 Set map view details by ContentStoreItem.
MapViewPreferencessetMapStyleById (LargeInteger id, bool smoothTransition=false) noexcept
 Set map view details by content id.
const StringRef getMapStylePath () const noexcept
 Get the current view style content path See ContentStoreItem::getFileName().
LargeInteger getMapStyleId () const noexcept
 Get the current view style content id See ContentStoreItem::getId().
MapViewPreferencessetBuildingsVisibility (EBuildingsVisibility option) noexcept
 Set buildings visibility to specified option.
EBuildingsVisibility getBuildingsVisibility () const noexcept
 Get buildings visibility option.
MapViewPreferencesupdateCurrentStyleFromJson (const DataBuffer &data)
 Update current style from json ( studio style editor use case ).
bool isMapSceneObjectVisible (const MapSceneObject &obj) const noexcept
 Get the given map scene object visibility in current view.
MapViewPreferencessetMapSceneObjectVisibility (const MapSceneObject &obj, bool visible) noexcept
 Set the given map scene object visibility in current view.
MapViewPreferencessetMapSceneObjectScaleFactor (const MapSceneObject &obj, float scaleFactor) noexcept
 Set the given map scene object scale factor in current view.
bool GetMapSceneObjectScaleFactor (const MapSceneObject &obj) const noexcept
 Get the given map scene object scale factor in current view.
MapViewPreferencessetDrawFPS (bool bEnable, const Xy &pos) noexcept
 Enable/disable frames per second draw.
bool getDrawFPS () const noexcept
 Get frames per second draw state.
int getMapDetailsQualityLevel () const noexcept
 Get map details quality level.
MapViewPreferencessetMapDetailsQualityLevel (int level) noexcept
 Set map details quality level.
bool isFastBrowsingEnabled () const noexcept
 Get fast browsing status.
MapViewPreferencesenableFastBrowsingMode (bool enable) noexcept
 Set fast browsing status.
MapViewPreferencesenableTouchGestures (int gestures, bool enable) noexcept
 Enable / disable touch gestures.
bool isTouchGestureEnabled (ETouchGestures gesture) const noexcept
 Check if touch gesture is enabled.
int getTouchGesturesStates () const noexcept
 Get enabled touch gestures packed.
MapViewPreferencessetTouchGesturesStates (int enabledTouchGesturesBitfield) noexcept
 Set enabled touch gestures packed.
Rect getFocusViewport () const noexcept
 Get the map view focus viewport.
MapViewPreferencessetFocusViewport (const Rect &view) noexcept
 Set the map view focus viewport.
bool getMapLabelsFading () const noexcept
 Get the map labels fading state.
MapViewPreferencessetMapLabelsFading (bool enable) noexcept
 Set the map labels continuous rendering.
bool getMapLabelsContinuousRendering () const noexcept
 Get the map labels continuous rendering state.
MapViewPreferencessetMapLabelsContinuousRendering (bool enable) noexcept
 Set the map labels fading.
bool disableFastLoading () const noexcept
 Get the fast data loading disable state.
MapViewPreferencessetDisableFastLoading (bool disable) noexcept
 Disable the fast data loading when moving camera.
MapViewPreferencesshowMapScale (bool enable) noexcept
 Enables or disables the map scale.
bool isMapScaleShown () const noexcept
 Check if map scale is shown.
MapViewPreferencessetMapScalePosition (Rect rcPosition) noexcept
 Sets the map position.
Rect getMapScalePosition () const noexcept
 Gets the map position.
MapViewPreferencessetElevationAlphaFactor (float alphaFactor) noexcept
 Sets the elevation alpha factor.
float getElevationAlphaFactor () const noexcept
 Gets the elevation alpha factor.

Detailed Description

MapViewPreferencesV2 object.

Implements share-read / write Api object over IMapViewPreferences.

Member Function Documentation

◆ disableFastLoading()

bool gem::MapViewPreferences::disableFastLoading ( ) const
inlinenoexceptinherited

Get the fast data loading disable state.

Returns
true if fast data loading is disabled

◆ enableCursor()

MapViewPreferences & gem::MapViewPreferences::enableCursor ( bool value)
inlinenoexceptinherited

Enable/Disable the cursor mode When the cursor is enabled map selection can be activated by calling setCursorScreenPosition The cursor is automatically disabled by MapView::startFollowingPosition.

Parameters
[in]valueTrue to enable the cursor
Returns
MapViewPreferences reference

◆ enableCursorRender()

MapViewPreferences & gem::MapViewPreferences::enableCursorRender ( bool value)
inlinenoexceptinherited

Enable/Disable the cursor rendering.

Parameters
[in]valueTrue to enable the cursor rendering
Returns
MapViewPreferences reference

◆ enableFastBrowsingMode()

MapViewPreferences & gem::MapViewPreferences::enableFastBrowsingMode ( bool enable)
inlinenoexceptinherited

Set fast browsing status.

Parameters
[in]enabletrue to enable, false to disable
Returns
MapViewPreferences reference

◆ enableTouchGestures()

MapViewPreferences & gem::MapViewPreferences::enableTouchGestures ( int gestures,
bool enable )
inlinenoexceptinherited

Enable / disable touch gestures.

Parameters
[in]gesturesPacked ETouchGestures
[in]enableTrue to enable, false to disable
Returns
MapViewPreferences reference

◆ followPositionPreferences() [1/2]

const FollowPositionPreferencesV2Ref gem::MapViewPreferencesV2::followPositionPreferences ( ) const
inlinenoexcept

Follow position preferences(read-only).

Returns
Follow position preferences reference.

◆ followPositionPreferences() [2/2]

FollowPositionPreferencesV2Ref gem::MapViewPreferencesV2::followPositionPreferences ( )
inlinenoexcept

Follow position preferences.

Returns
Follow position preferences reference.

◆ getBuildingsVisibility()

EBuildingsVisibility gem::MapViewPreferences::getBuildingsVisibility ( ) const
inlinenoexceptinherited

Get buildings visibility option.

Returns
The buildings visibility option

◆ getDrawFPS()

bool gem::MapViewPreferences::getDrawFPS ( ) const
inlinenoexceptinherited

Get frames per second draw state.

Returns
True if frames per second draw is enabled

◆ getElevationAlphaFactor()

float gem::MapViewPreferences::getElevationAlphaFactor ( ) const
inlinenoexceptinherited

Gets the elevation alpha factor.

Returns
the elevation alpha factor between 0-1

◆ getFocusViewport()

Rect gem::MapViewPreferences::getFocusViewport ( ) const
inlinenoexceptinherited

Get the map view focus viewport.

The focus viewport is the view screen part containing the maximum map details. The coordinates are relative to view parent screen

The default value is the view whole viewport.

Returns
The focus viewport

◆ getMapDetailsQualityLevel()

int gem::MapViewPreferences::getMapDetailsQualityLevel ( ) const
inlinenoexceptinherited

Get map details quality level.

Returns
The map details quality level

◆ getMapLabelsContinuousRendering()

bool gem::MapViewPreferences::getMapLabelsContinuousRendering ( ) const
inlinenoexceptinherited

Get the map labels continuous rendering state.

Returns
true if map labels are in continuous rendering state

◆ getMapLabelsFading()

bool gem::MapViewPreferences::getMapLabelsFading ( ) const
inlinenoexceptinherited

Get the map labels fading state.

Returns
true if map labels are in fading state

◆ getMapScalePosition()

Rect gem::MapViewPreferences::getMapScalePosition ( ) const
inlinenoexceptinherited

Gets the map position.

Returns
position

◆ GetMapSceneObjectScaleFactor()

bool gem::MapViewPreferences::GetMapSceneObjectScaleFactor ( const MapSceneObject & obj) const
inlinenoexceptinherited

Get the given map scene object scale factor in current view.

Parameters
[in]objThe map scene object
Returns
obj scale factor

◆ getMapStyleId()

LargeInteger gem::MapViewPreferences::getMapStyleId ( ) const
inlinenoexceptinherited

Get the current view style content id See ContentStoreItem::getId().

If no style is set the function returns 0

Returns
The current view style content id

◆ getMapStylePath()

const StringRef gem::MapViewPreferences::getMapStylePath ( ) const
inlinenoexceptinherited

Get the current view style content path See ContentStoreItem::getFileName().

Returns
The current view style content path

◆ getMapViewPerspective()

EMapViewPerspective gem::MapViewPreferences::getMapViewPerspective ( ) const
inlinenoexceptinherited

Get the map view perspective.

Returns
The map perspective

◆ getMaxViewAngle()

double gem::MapViewPreferences::getMaxViewAngle ( ) const
inlinenoexceptinherited

Get the maximum viewing angle.

Maximum view angle is when the camera is looking directly toward the horizon

Returns
The maximum view angle

◆ getMinViewAngle()

double gem::MapViewPreferences::getMinViewAngle ( ) const
inlinenoexceptinherited

Get the minimum viewing angle.

Minimum view angle is when the camera is looking directly downward at the map

Returns
The minimum view angle

◆ getNorthFixedFlag()

bool gem::MapViewPreferences::getNorthFixedFlag ( ) const
inlinenoexceptinherited

Get the value of the NorthFixed flag.

Returns
The NorthFixed flag value

◆ getRotationAngle()

double gem::MapViewPreferences::getRotationAngle ( ) const
inlinenoexceptinherited

Get map rotation angle in degrees relative to north-south axis.

The value of 0 corresponds to north-up alignment

Returns
The rotation angle

◆ getTiltAngle()

double gem::MapViewPreferences::getTiltAngle ( ) const
inlinenoexceptinherited

Get tilt angle in degrees.

Returns
The tilt angle in degrees.

The tilt angle is 90 - viewAngle

◆ getTouchGesturesStates()

int gem::MapViewPreferences::getTouchGesturesStates ( ) const
inlinenoexceptinherited

Get enabled touch gestures packed.

Returns
Packed ETouchGestures

Default is TG_All

◆ getTrafficVisibility()

bool gem::MapViewPreferences::getTrafficVisibility ( ) const
inlinenoexceptinherited

Get traffic visibility.

By default is true if current map style contains the traffic layer

Returns
True if traffic is visible

◆ getViewAngle()

double gem::MapViewPreferences::getViewAngle ( ) const
inlinenoexceptinherited

Get the viewing angle.

Returns
The view angle

◆ isCursorEnabled()

bool gem::MapViewPreferences::isCursorEnabled ( ) const
inlinenoexceptinherited

Test if cursor is enabled.

Note
Default is false.
Returns
True if the cursor is enabled

◆ isCursorRenderEnabled()

bool gem::MapViewPreferences::isCursorRenderEnabled ( ) const
inlinenoexceptinherited

Test if cursor is enabled.

Note
Default is false.
Returns
True if the cursor is enabled

◆ isFastBrowsingEnabled()

bool gem::MapViewPreferences::isFastBrowsingEnabled ( ) const
inlinenoexceptinherited

Get fast browsing status.

Returns
True if fast browsing is enabled

◆ isMapScaleShown()

bool gem::MapViewPreferences::isMapScaleShown ( ) const
inlinenoexceptinherited

Check if map scale is shown.

Returns
true if map scale is shown

◆ isMapSceneObjectVisible()

bool gem::MapViewPreferences::isMapSceneObjectVisible ( const MapSceneObject & obj) const
inlinenoexceptinherited

Get the given map scene object visibility in current view.

Parameters
[in]objThe map scene object
Returns
True if the object is visible

◆ isTouchGestureEnabled()

bool gem::MapViewPreferences::isTouchGestureEnabled ( ETouchGestures gesture) const
inlinenoexceptinherited

Check if touch gesture is enabled.

Parameters
[in]gestureThe touch gesture
Returns
True if the touch gesture is enabled

◆ lmks()

LandmarkStoreCollectionRef gem::MapViewPreferences::lmks ( )
inlinenoexceptinherited

Get access to the visibility settings for the landmark stores.

Returns
The landmark store collection reference

◆ markers()

MapViewMarkerCollectionsRef gem::MapViewPreferences::markers ( )
inlinenoexceptinherited

Get access to the collections of visible markers.

Returns
The marker collections reference

◆ overlays()

MapViewOverlayCollectionRef gem::MapViewPreferences::overlays ( )
inlinenoexceptinherited

Get access to the collection of visible overlays.

Returns
The overlay collection reference

◆ paths()

PathCollectionRef gem::MapViewPreferences::paths ( )
inlinenoexceptinherited

Get access to the collection of visible paths.

Returns
The path collection reference

◆ routes()

MapViewRoutesCollectionRef gem::MapViewPreferences::routes ( )
inlinenoexceptinherited

Get access to the collection of visible routes.

Returns
The route collection reference

◆ setBuildingsVisibility()

MapViewPreferences & gem::MapViewPreferences::setBuildingsVisibility ( EBuildingsVisibility option)
inlinenoexceptinherited

Set buildings visibility to specified option.

Parameters
[in]optionThe buildings visibility option
Returns
MapViewPreferences reference

◆ setDisableFastLoading()

MapViewPreferences & gem::MapViewPreferences::setDisableFastLoading ( bool disable)
inlinenoexceptinherited

Disable the fast data loading when moving camera.

Parameters
[in]disableTrue to disable, false to enable
Returns
MapViewPreferences reference

◆ setDrawFPS()

MapViewPreferences & gem::MapViewPreferences::setDrawFPS ( bool bEnable,
const Xy & pos )
inlinenoexceptinherited

Enable/disable frames per second draw.

Parameters
[in]bEnableTrue to enable frames per second draw
[in]posThe position of the frames per second draw
Returns
MapViewPreferences reference

◆ setElevationAlphaFactor()

MapViewPreferences & gem::MapViewPreferences::setElevationAlphaFactor ( float alphaFactor)
inlinenoexceptinherited

Sets the elevation alpha factor.

Parameters
[in]alphaFactor- float value between 0 and 1 to set the elevation shadows opacity
Returns
MapViewPreferences reference

◆ setFocusViewport()

MapViewPreferences & gem::MapViewPreferences::setFocusViewport ( const Rect & view)
inlinenoexceptinherited

Set the map view focus viewport.

If view is an empty viewport the focus will be reset to whole view

Parameters
[in]viewThe focus viewport
Returns
MapViewPreferences reference

◆ setMapDetailsQualityLevel()

MapViewPreferences & gem::MapViewPreferences::setMapDetailsQualityLevel ( int level)
inlinenoexceptinherited

Set map details quality level.

Parameters
[in]levelMap details quality level, see EMapDetailsQualityLevel
Returns
MapViewPreferences reference

◆ setMapLabelsContinuousRendering()

MapViewPreferences & gem::MapViewPreferences::setMapLabelsContinuousRendering ( bool enable)
inlinenoexceptinherited

Set the map labels fading.

Parameters
[in]enableTrue to enable, false to disable
Returns
MapViewPreferences reference

◆ setMapLabelsFading()

MapViewPreferences & gem::MapViewPreferences::setMapLabelsFading ( bool enable)
inlinenoexceptinherited

Set the map labels continuous rendering.

Parameters
[in]enableTrue to enable, false to disable
Returns
MapViewPreferences reference

◆ setMapScalePosition()

MapViewPreferences & gem::MapViewPreferences::setMapScalePosition ( Rect rcPosition)
inlinenoexceptinherited

Sets the map position.

Parameters
[in]rcPositionRectangle position related to parent view
Returns
MapViewPreferences reference

◆ setMapSceneObjectScaleFactor()

MapViewPreferences & gem::MapViewPreferences::setMapSceneObjectScaleFactor ( const MapSceneObject & obj,
float scaleFactor )
inlinenoexceptinherited

Set the given map scene object scale factor in current view.

Parameters
[in]objThe map scene object
[in]scaleFactorshould be between 0.1f and 5.0f. If set to 0, the object scale factor will be used.
Returns
MapViewPreferences reference

◆ setMapSceneObjectVisibility()

MapViewPreferences & gem::MapViewPreferences::setMapSceneObjectVisibility ( const MapSceneObject & obj,
bool visible )
inlinenoexceptinherited

Set the given map scene object visibility in current view.

Parameters
[in]objThe map scene object
[in]visibleTrue to show the object
Returns
MapViewPreferences reference

◆ setMapStyle() [1/2]

MapViewPreferences & gem::MapViewPreferences::setMapStyle ( const ContentStoreItem & style,
bool smoothTransition = false )
inlinenoexceptinherited

Set map view details by ContentStoreItem.

Parameters
[in]styleStyle content
[in]smoothTransitionEnables a smooth transition between old and new style
Returns
MapViewPreferences reference

◆ setMapStyle() [2/2]

MapViewPreferences & gem::MapViewPreferences::setMapStyle ( const DataBuffer & content,
bool smoothTransition = false )
inlinenoexceptinherited

Set map view details by content.

Parameters
[in]contentStyle content
[in]smoothTransitionEnables a smooth transition between old and new style
Returns
MapViewPreferences reference

◆ setMapStyleById()

MapViewPreferences & gem::MapViewPreferences::setMapStyleById ( LargeInteger id,
bool smoothTransition = false )
inlinenoexceptinherited

Set map view details by content id.

Parameters
[in]idContent id See ContentStoreItem::getId() obtained from content store styles list
[in]smoothTransitionEnables a smooth transition between old and new style
Returns
MapViewPreferences reference

◆ setMapStyleByPath()

MapViewPreferences & gem::MapViewPreferences::setMapStyleByPath ( const String & path,
bool smoothTransition = false )
inlinenoexceptinherited

Set map view details by content path.

Parameters
[in]pathContent path See ContentStoreItem::getFileName() obtained from content store styles list
[in]smoothTransitionEnables a smooth transition between old and new style
Returns
MapViewPreferences reference

◆ setMapViewPerspective()

MapViewPreferences & gem::MapViewPreferences::setMapViewPerspective ( EMapViewPerspective perspective,
Animation animation = Animation() )
inlinenoexceptinherited

Set the map view perspective.

Parameters
[in]perspectiveThe map perspective.
[in]animationThe operation animation type. Default is none
Returns
MapViewPreferences reference

◆ setNorthFixedFlag()

MapViewPreferences & gem::MapViewPreferences::setNorthFixedFlag ( bool value)
inlinenoexceptinherited

Set the value of the NorthFixed flag.

Parameters
[in]valueThe NorthFixed flag value
Returns
MapViewPreferences reference

◆ setRotationAngle()

MapViewPreferences & gem::MapViewPreferences::setRotationAngle ( double angle)
inlinenoexceptinherited

Get map rotation angle in degrees relative to north-south axis.

The value of 0 corresponds to north-up alignment

Parameters
[in]angleThe rotation angle
Returns
MapViewPreferences reference

◆ setTiltAngle()

MapViewPreferences & gem::MapViewPreferences::setTiltAngle ( double angleDegrees)
inlinenoexceptinherited

Set tilt angle in degrees.

Parameters
[in]angleDegreesThe tilt angle in degrees.

The tilt angle is 90 - viewAngle

Returns
MapViewPreferences reference

◆ setTouchGesturesStates()

MapViewPreferences & gem::MapViewPreferences::setTouchGesturesStates ( int enabledTouchGesturesBitfield)
inlinenoexceptinherited

Set enabled touch gestures packed.

Parameters
[in]enabledTouchGesturesBitfieldPacked ETouchGestures
Returns
MapViewPreferences reference

◆ setTrafficVisibility()

int gem::MapViewPreferences::setTrafficVisibility ( bool value)
inlinenoexceptinherited

Set traffic visibility.

Will return error::KNotFound if current map style doesn't contain the traffic layer

Parameters
[in]valueTrue to show traffic
Returns
KNoError Success

◆ setViewAngle()

MapViewPreferences & gem::MapViewPreferences::setViewAngle ( double value,
bool animated = false )
inlinenoexceptinherited

Set the viewing angle.

Parameters
[in]valueThe view angle
[in]animatedThe animation flag
Returns
MapViewPreferences reference

◆ showMapScale()

MapViewPreferences & gem::MapViewPreferences::showMapScale ( bool enable)
inlinenoexceptinherited

Enables or disables the map scale.

Parameters
[in]enableTrue if enable, false if disable
Returns
MapViewPreferences reference

◆ updateCurrentStyleFromJson()

MapViewPreferences & gem::MapViewPreferences::updateCurrentStyleFromJson ( const DataBuffer & data)
inlineinherited

Update current style from json ( studio style editor use case ).

Parameters
[in]dataThe json data buffer
Returns
MapViewPreferences reference