YMKPanoramaDescription

class YMKPanoramaDescription : NSObject

Undocumented

SummarySummary

Class methodsClass methods

init(panoramaId: String,         position: YMKPanoramaPosition?,      angularBBox: YMKPanoramaAngularBoundingBox,         tileSize: YMKPanoramaImageSize,       tileLevels: [YMKPanoramaTileLevel],      iconMarkers: [YMKPanoramaIconMarker],      textMarkers: [YMKPanoramaTextMarker],   companyMarkers: [YMKPanoramaCompanyMarker],  iconConnections: [YMKPanoramaIconConnection],  arrowConnections: [YMKPanoramaArrowConnection],        direction: YMKDirection,             span: YMKSpan,      attribution: YMKAttribution?)

PropertiesProperties

var panoramaId: String { get } panoramaId is passed as a parameter to the TileImageFactory or to the TileUrlProvider

var position: YMKPanoramaPosition? { get } Geo position

var angularBBox: YMKPanoramaAngularBoundingBox { get } The angularBBox field sets how the tile tilelevels oriented in space

var tileSize: YMKPanoramaImageSize { get } Any tile level imageSize width must be multiple of the tileSize width

var tileLevels: [YMKPanoramaTileLevel] { get } The tileLevels is a set of the TileLevel structs

var iconMarkers: [YMKPanoramaIconMarker] { get } Add marker icons to the panorama

var textMarkers: [YMKPanoramaTextMarker] { get } Add marker text to the panorama

var companyMarkers: [YMKPanoramaCompanyMarker] { get } Add company icons and labels to the panorama

var iconConnections: [YMKPanoramaIconConnection] { get } Add icons with interaction

var arrowConnections: [YMKPanoramaArrowConnection] { get } Add standard player arrow connections

var direction: YMKDirection { get } Suggest where to look at once panorama is opened

var span: YMKSpan { get } Suggest view area span

var attribution: YMKAttribution? { get } Panorama author information

Class methodsClass methods

init(panoramaId:position:angularBBox:tileSize:tileLevels:iconMarkers:textMarkers:companyMarkers:iconConnections:arrowConnections:direction:span:attribution:)init(panoramaId:position:angularBBox:tileSize:tileLevels:iconMarkers:textMarkers:companyMarkers:iconConnections:arrowConnections:direction:span:attribution:)

init(panoramaId: String,         position: YMKPanoramaPosition?,      angularBBox: YMKPanoramaAngularBoundingBox,         tileSize: YMKPanoramaImageSize,       tileLevels: [YMKPanoramaTileLevel],      iconMarkers: [YMKPanoramaIconMarker],      textMarkers: [YMKPanoramaTextMarker],   companyMarkers: [YMKPanoramaCompanyMarker],  iconConnections: [YMKPanoramaIconConnection],  arrowConnections: [YMKPanoramaArrowConnection],        direction: YMKDirection,             span: YMKSpan,      attribution: YMKAttribution?)

PropertiesProperties

panoramaIdpanoramaId

var panoramaId: String { get }

panoramaId is passed as a parameter to the TileImageFactory or to the TileUrlProvider

positionposition

var position: YMKPanoramaPosition? { get }

Geo position.

Optional field, can be nil.

angularBBoxangularBBox

var angularBBox: YMKPanoramaAngularBoundingBox { get }

The angularBBox field sets how the tile tilelevels oriented in space. Direction + span will be limited between top and bottom The recommendation for initializing angular bbox: (right - left) == 360. Non 360 degrees panoramas are not supported yet. (top - bottom) <= 180 The angular aspect ratio must be the same as any tileLevel aspect ratio. (right - left)/(top - bottom) == tileLevel[i].width/tileLevel[i].height

tileSizetileSize

var tileSize: YMKPanoramaImageSize { get }

Any tile level imageSize width must be multiple of the tileSize width. Only 256x256 and 512x512 tiles are supported.

tileLevelstileLevels

var tileLevels: [YMKPanoramaTileLevel] { get }

The tileLevels is a set of the TileLevel structs. Tile levels can be added in any order. It's recommended to have at least 2 tile levels: - low quality zoom. For example 512x200 - high quality zoom. For axample 20480x8000

It can be useful to have several tile levels for huge images to save network traffic and reduce memory and power consumption. So the final tile levels list may look like that: level, width, height 0, 512, 200 1, 2048, 800 2, 5120, 2000 6, 10240, 4000 9, 20480, 8000

Player takes into account the view area size and available tile levels and downloads the most suitable level.

The tileLevels[i] aspect ratio must be the same. At first low quality zoom is loaded. Once it's done, the panorama player notifies that the panorama is opened and starts loading high quality zoom tiles.

iconMarkersiconMarkers

var iconMarkers: [YMKPanoramaIconMarker] { get }

Add marker icons to the panorama

textMarkerstextMarkers

var textMarkers: [YMKPanoramaTextMarker] { get }

Add marker text to the panorama

companyMarkerscompanyMarkers

var companyMarkers: [YMKPanoramaCompanyMarker] { get }

Add company icons and labels to the panorama

iconConnectionsiconConnections

var iconConnections: [YMKPanoramaIconConnection] { get }

Add icons with interaction

arrowConnectionsarrowConnections

var arrowConnections: [YMKPanoramaArrowConnection] { get }

Add standard player arrow connections

directiondirection

var direction: YMKDirection { get }

Suggest where to look at once panorama is opened. It's just a recommendation because it depends on angularBBox and span.

spanspan

var span: YMKSpan { get }

Suggest view area span. It's just a recommendation because it depends on angularBBox and direction.

attributionattribution

var attribution: YMKAttribution? { get }

Panorama author information.

Optional field, can be nil.