YMKMapWindow

class YMKMapWindow : NSObject

Handles the MapWindow element.

SummarySummary

Instance methodsInstance methods

func width() -> Int Window width in physical pixels

func height() -> Int Window height in physical pixels

func worldToScreen(withWorldPoint worldPoint: YMKPoint) -> YMKScreenPoint? Transforms the position from world coordinates to screen coordinates

func screenToWorld(with screenPoint: YMKScreenPoint) -> YMKPoint? Transforms coordinates from screen space to world space

func addSizeChangedListener(with sizeChangedListener: YMKMapSizeChangedListener) Adds a SizeChangedListener

func removeSizeChangedListener(with sizeChangedListener: YMKMapSizeChangedListener) Removes a SizeChangedListener

PropertiesProperties

var map: YMKMap { get } Gets the map interface

var focusRect: YMKScreenRect? { get set } When using controls that overlay the map view, calculating the proper camera position can be tricky

var focusPoint: YMKScreenPoint? { get set } The point on the screen that corresponds to camera position

var gestureFocusPoint: YMKScreenPoint? { get set } Defines the focus point of gestures

var gestureFocusPointMode: YMKGestureFocusPointMode { get set } Specifies the way provided gesture focus point affects gestures

var pointOfView: YMKPointOfView { get set } Defines the position of the point of view

var focusRegion: YMKVisibleRegion { get } Gets the focused region

var isValid: Bool { get } Tells if this object is valid or no

Instance methodsInstance methods

width()width()

func width() -> Int

Window width in physical pixels

height()height()

func height() -> Int

Window height in physical pixels

worldToScreen(withWorldPoint:)worldToScreen(withWorldPoint:)

func worldToScreen(withWorldPoint worldPoint: YMKPoint) -> YMKScreenPoint?

Transforms the position from world coordinates to screen coordinates.

Parameters
worldPoint	Latitude and longitude information.

Returns

The point in screen space corresponding to worldPoint; returns none if the point is behind the camera.

screenToWorld(with:)screenToWorld(with:)

func screenToWorld(with screenPoint: YMKScreenPoint) -> YMKPoint?

Transforms coordinates from screen space to world space.

Parameters
screenPoint	The point in screen coordinates relative to the top left of the map. These coordinates are in physical pixels and not in device independent (virtual) pixels.

Returns

Latitude and longitude information.

addSizeChangedListener(with:)addSizeChangedListener(with:)

func addSizeChangedListener(with sizeChangedListener: YMKMapSizeChangedListener)

Adds a SizeChangedListener.

The class does not retain the object in the 'sizeChangedListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

removeSizeChangedListener(with:)removeSizeChangedListener(with:)

func removeSizeChangedListener(with sizeChangedListener: YMKMapSizeChangedListener)

Removes a SizeChangedListener.

PropertiesProperties

mapmap

var map: YMKMap { get }

Gets the map interface.

focusRectfocusRect

var focusRect: YMKScreenRect? { get set }

When using controls that overlay the map view, calculating the proper camera position can be tricky. This property simplifies the task by defining the area of interest (the focus rectangle) inside the view. Map methods that calculate the camera position based on a world bounding box ensure that this bounding box will fit into the focusRect.

For example, when using a semi-transparent control that overlays the top half of the map view, define the focus rectangle as the lower half of the view to ensure that object of interest appear in the lower half of map view. In addition, if focusPoint is null all camera movements will have the center of the lower half as their target.

If focusRect is null, the whole map view is used instead.

On iOS, if you change the focus rectangle in the viewDidLayoutSubviews callback, it's recommended to call MapView.layoutIfNeeded just before that action.

Optional property, can be nil.

focusPointfocusPoint

var focusPoint: YMKScreenPoint? { get set }

The point on the screen that corresponds to camera position. Changing camera position or focusPoint makes the new camera target appear exactly at the focusPoint on screen.

If focusPoint is null, the center of focusRect is used instead.

Optional property, can be nil.

gestureFocusPointgestureFocusPoint

var gestureFocusPoint: YMKScreenPoint? { get set }

Defines the focus point of gestures. Actual behaviour depends on gestureFocusPointMode. If the point is not set, the source point of the gesture will be used as the focus point. Default: none.

Optional property, can be nil.

gestureFocusPointModegestureFocusPointMode

var gestureFocusPointMode: YMKGestureFocusPointMode { get set }

Specifies the way provided gesture focus point affects gestures. Default: TapGestures.

pointOfViewpointOfView

var pointOfView: YMKPointOfView { get set }

Defines the position of the point of view. Cameras use perspective projection, which causes perspective deformations. Perspective projection has an axis, and points on this axis are not affected by perspective deformations. This axis is a line parallel to the view's direction, so its projection to the screen is a point - the "point of view". By default, this point is at the center of the screen, but some applications might want to set it to the center of focusRect. Use this flag to do so. Default: ScreenCenter

focusRegionfocusRegion

var focusRegion: YMKVisibleRegion { get }

Gets the focused region.

Returns

A region that corresponds to the current focusRect or the visible region if focusRect is not set. Region IS bounded by latitude limits [-90, 90] and IS NOT bounded by longitude limits [-180, 180]. If longitude exceeds its limits, we see the world's edge and another instance of the world beyond this edge.

isValidisValid

var isValid: Bool { get }

Tells if this object is valid or no. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.