Class PanoramaDescription

Warning

This feature is available in the Full MapKit SDK version

Package world.mappable.mapkit.places.panorama

java.lang.Object
    ↳ world.mappable.mapkit.places.panorama.PanoramaDescription

class PanoramaDescription implements Serializable

Summary

Constructors

Signature and Description

PanoramaDescription()
Use constructor with parameters in your code.

PanoramaDescription(@NonNull java.lang.String panoramaId,
                    @Nullable Position position,
                    @NonNull AngularBoundingBox angularBBox,
                    @NonNull ImageSize tileSize,
                    @NonNull java.util.List<TileLevel> tileLevels,
                    @NonNull java.util.List<IconMarker> iconMarkers,
                    @NonNull java.util.List<TextMarker> textMarkers,
                    @NonNull java.util.List<CompanyMarker> companyMarkers,
                    @NonNull java.util.List<IconConnection> iconConnections,
                    @NonNull java.util.List<ArrowConnection> arrowConnections,
                    @NonNull Direction direction,
                    @NonNull Span span,
                    @Nullable Attribution attribution)

Methods

Type and modifiers

Method and Description

synchronized java.lang.String

getPanoramaId()
panoramaId is passed as a parameter to the TileImageFactory or to the TileUrlProvider

synchronized Position

getPosition()
Geo position.

synchronized AngularBoundingBox

getAngularBBox()
The angularBBox field sets how the tile tilelevels oriented in space.

synchronized ImageSize

getTileSize()
Any tile level imageSize width must be multiple of the tileSize width.

synchronized java.util.List<TileLevel>

getTileLevels()
The tileLevels is a set of the TileLevel structs.

synchronized java.util.List<IconMarker>

getIconMarkers()
Add marker icons to the panorama

synchronized java.util.List<TextMarker>

getTextMarkers()
Add marker text to the panorama

synchronized java.util.List<CompanyMarker>

getCompanyMarkers()
Add company icons and labels to the panorama

synchronized java.util.List<IconConnection>

getIconConnections()
Add icons with interaction

synchronized java.util.List<ArrowConnection>

getArrowConnections()
Add standard player arrow connections

synchronized Direction

getDirection()
Suggest where to look at once panorama is opened.

synchronized Span

getSpan()
Suggest view area span.

synchronized Attribution

getAttribution()
Panorama author information.

void

serialize(world.mappable.runtime.bindings.Archive archive)

static java.lang.String

getNativeName()

Constuctors

PanoramaDescription

PanoramaDescription()

Use constructor with parameters in your code.

This one is for serialization only!


PanoramaDescription

PanoramaDescription(@NonNull java.lang.String panoramaId,
                    @Nullable Position position,
                    @NonNull AngularBoundingBox angularBBox,
                    @NonNull ImageSize tileSize,
                    @NonNull java.util.List<TileLevel> tileLevels,
                    @NonNull java.util.List<IconMarker> iconMarkers,
                    @NonNull java.util.List<TextMarker> textMarkers,
                    @NonNull java.util.List<CompanyMarker> companyMarkers,
                    @NonNull java.util.List<IconConnection> iconConnections,
                    @NonNull java.util.List<ArrowConnection> arrowConnections,
                    @NonNull Direction direction,
                    @NonNull Span span,
                    @Nullable Attribution attribution)

Methods

getPanoramaId

@NonNull
java.lang.String getPanoramaId()

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


getPosition

@Nullable
Position getPosition()

Geo position.

Optional field, can be null.


getAngularBBox

@NonNull
AngularBoundingBox getAngularBBox()

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


getTileSize

@NonNull
ImageSize getTileSize()

Any tile level imageSize width must be multiple of the tileSize width.

Only 256x256 and 512x512 tiles are supported.


getTileLevels

@NonNull
java.util.List<TileLevel> getTileLevels()

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.


getIconMarkers

@NonNull
java.util.List<IconMarker> getIconMarkers()

Add marker icons to the panorama


getTextMarkers

@NonNull
java.util.List<TextMarker> getTextMarkers()

Add marker text to the panorama


getCompanyMarkers

@NonNull
java.util.List<CompanyMarker> getCompanyMarkers()

Add company icons and labels to the panorama


getIconConnections

@NonNull
java.util.List<IconConnection> getIconConnections()

Add icons with interaction


getArrowConnections

@NonNull
java.util.List<ArrowConnection> getArrowConnections()

Add standard player arrow connections


getDirection

@NonNull
Direction getDirection()

Suggest where to look at once panorama is opened.

It's just a recommendation because it depends on angularBBox and span.


getSpan

@NonNull
Span getSpan()

Suggest view area span.

It's just a recommendation because it depends on angularBBox and direction.


getAttribution

@Nullable
Attribution getAttribution()

Panorama author information.

Optional field, can be null.


serialize

@Override
void serialize(world.mappable.runtime.bindings.Archive archive)

getNativeName

java.lang.String getNativeName()

Previous
PanoramaChangeListener
Next
PanoramaLayer