Callback to be called on retrieval of screenshot.

This class represents a pinned UIView, that means an UIView at a fixed location on the map.

The pinned view will automatically be repositioned on the screen as the map moves. There is more performance overhead involved in positioning an view as compared to a map marker, so for use cases which only require static images, markers should be used.

The MapCamera to control the angle of view for the map

The gestures control object for setting up the capture of gestures.

Maximum render frame rate in frames per second. Setting to 0 disables automatic rendering for this view. Setting negative values has no effect. The default value is 60 frames per second.

Returns the viewport size in physical pixels.

The code of the desired primary map display language. If not set or if the desired language is not supported, then the language of the displayed region is used, which is the default behaviour. Applies to all instances of MapView. When changed, triggers redraw of any visible MapView.

The code of the desired secondary map display language. If the desired language is not supported, then the language of the displayed region is used. If not set, no secondary map language will be used which is the default behaviour. Applies to all instances of MapView. When changed, triggers redraw of any visible MapView. Note: This feature is in beta state and thus there can be bugs and unexpected behavior.

The shadow quality for all instances of MapView. The quality controls the size of the shadow maps and the cascade count. The default shadow quality is {@code ShadowQuality.medium}. MapViews can request to render shadows by feature. Enabling shadows has a performance impact and should be considered only for devices with sufficient performance. Note: This feature is in beta state and thus there can be bugs and unexpected behavior.

Pauses rendering of this instance of map view.

Normally the application doesn’t need to call this method since the required handling of foreground/background switch is done from inside the HERESDK. However, if this needs to be called for some special reasons on application side, the application must call this method inapplicationWillResignActive(_:) of the application delegate or sceneWillResignActive(_:) of the scene delegate. Otherwise, it may result in rendering glitches as the renderer is prohibited from issuing rendering commands when being in background.

Resumes rendering of this instance of map view.

Normally the application doesn’t need to call this method since the required handling of foreground/background switch is done from inside the HERESDK. However, if this needs to be called for some special reasons on application side, the application must call this method in applicationDidBecomeActive(_:) of the application delegate or sceneDidBecomeActive(_:) of the scene delegate.

Undocumented

Undocumented

Initializes and returns a newly allocated view object

Initializes and returns a newly allocated view object with the specified frame rectangle.

Initializes and returns a newly allocated view object with the specified frame rectangle and sdk engine.

Undocumented

Initializes and returns a newly allocated view object with specified frame rectangle, sdk engine and options.

Undocumented

Indicates whether this instance is valid. It will be made invalid when the corresponding SDKNativeEngine is destroyed.

Converts geographical coordinates to view coordinates (in pixels).

If specified, altitude of the input coordinates is interpreted as altitude above sea level. If not specified, the input coordinates are interpreted as being on ground elevation. The above distinction is only relevant when 3D terrain feature is enabled.

The resulting view coordinates might be outside of current viewport, i.e. result might contain values less than zero or greater than view’s dimensions.

If the render surface is not attached, it will return nil.

Converts view coordinates to geographical coordinates.

An optional altitude component of the resulting geographical coordinate is not set.

If the view coordinates specify a point above a horizon, then the result is geographical coordinates of the point on a horizon below the specified view coordinates.

The fog effect is ignored for the calculation, meaning that for the view point within the area covered by the fog, the result is geographical coordinates that would be displayed at the specified point if the fog effect was not applied.

If the render surface is not attached, it will return nil.

Returns all map content located inside the specified pick area. Content to be picked is specified by a pick content filter. The pick area is defined by a rectangle in map view coordinates in pixels, relative to the map view’s origin at (0, 0) which indicates the top-left corner of the map view.

Asynchronously retrieves a screenshot of current map view. Note that this does not work when the map view is currently not visible, for example, when an application is running in background - even if MapView.pause() was not called.

Adds a MapViewLifecycleDelegate to this map view. Adding the same object multiple times has no effect.

Removes a MapViewLifecycleDelegate from this map view. Trying to remove an object that was not added or was removed before has no effect.

Reinitializes the map renderer. Does nothing if isValid is true or SDKNativeEngine.sharedInstance is nil.

This can be used after MapView gets invalidated as a result of destroying the shared SDKNativeEngine and setting a new shared SDKNativeEngine.

After this call finishes successfully, isValid becomes true.

Map state is not preserved. The caller must load a scene, set camera, re-add all the delegates and all the map items, etc.

Any previously stored instances of MapView.camera, MapView.mapScene, MapView.mapContext, MapView.gestures and MapView.hereMap remain invalid.

Sets the position of the HERE logo watermark within the map view.

By default, the watermark is aligned to the bottom-right corner of the view: Anchor2D(1.0, 1.0) and Point2D(-watermarkSize.width / 2, -watermarkSize.height / 2). It is recommended to change the default position only if necessary to avoid overlapping UI elements. The watermark should always be fully visible within the view. The anchor point on the watermark is its center (width/2, height/2), around which it will be placed in the map view. For map views smaller than 250 dip in both width and height, the watermark will not be shown.

The pixel scale factor used by this MapView. It is used to support screen resolution and size independence. This value is a derivative of the device’s screen pixel density and is a direct analog of the native scale factor for the physical screen.

It can be used to translate between physical pixels and points according to formula: points = pixels / pixel_scale.

Pixel scale is 0.0 if the map view is not initialized.

In cases where the MapView moves in between screens (e.g. from main screen to a CarPlay screen), the most up-to-date pixel scale value can be obtained after a render target gets attached to the view. To get notified when a render target gets attached to the MapView, see MapViewLifecycleDelegate.onAttach.

Provides the size of the watermark in physical pixels.

Pins a UIView to the MapView and returns a proxy object that can be used to control the pinning. Trying to pin a view that was already pinned or a view that has a super view has no effect and returns nil.

The altitude component of the coordinates, if set, is interpreted as above sea level. When not set, the coordinates are interpreted as at ground level.

Please note, a pinned UIView will be confined to the bounds of MapView by default. If this is not desired, setting MapView‘s property clipsToBounds to false will allow pinned views to exceed MapView’s bounds.

Removes a ViewPin from the MapView by specifying the corresponding UIView. Trying to unpin a view that was not pinned or was unpinned before has no effect.

Gets a copy of the array of currently added view pins.

Handles low memory situation.

This method should be called from a view controller, when it receives a memory warning (UIViewController.didReceiveMemoryWarning())