Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

IPanorama

Interface for describing a panorama.

Constructor | Methods

Constructor

IPanorama()

Methods

NameReturnsDescription
getAngularBBox()

Number[]

Returns spherical coordinates that define the area covered by the image on the panoramic sphere. Coordinates are specified in the format [thetaTop, phiRight, thetaBottom, phiLeft] (the same as CSS).

getConnectionArrows()

IPanoramaConnectionArrow[]

Returns array of connection arrows on the panorama.

getConnectionMarkers()

IPanoramaConnectionMarker[]

Returns array of connection markers on the panorama.

getCoordSystem()

ICoordSystem

Returns the coordinate system that is used for defining positions of the panorama and all the associated markers and connections.

getDefaultDirection()

Number[]

Returns default direction of view. It will be used by the player when opening the panorama.

getDefaultSpan()

Number[]

Returns default size of the viewing area. It will be used by the player when opening the panorama.

getGraph()

IPanoramaGraph|null

Returns the graph of panoramas connected to the current panorama for making quick transitions.

getMarkers()

IPanoramaMarker[]

Returns array of markers on the panorama.

getName()

String

Returns the name of the panorama displayed by the player in the interface.

getPosition()

Number[]

Returns the location of the panorama in the coordinate system set in the options. Set in the format [lon, lat, height], [lat, lon, height] or [x, y, height] depending on the coordinate system and order. height – the height of the panorama in meters, relative to some level (not necessarily sea level).

getTileLevels()

IPanoramaTileLevel[]

Returns array of zoom levels for the panorama image.

getTileSize()

Number[]

Returns the size of tiles that the panorama image is divided into.

Methods details

getAngularBBox

{Number[]} getAngularBBox()

Returns spherical coordinates that define the area covered by the image on the panoramic sphere. Coordinates are specified in the format [thetaTop, phiRight, thetaBottom, phiLeft] (the same as CSS).

getConnectionArrows

{IPanoramaConnectionArrow[]} getConnectionArrows()

Returns array of connection arrows on the panorama.

getConnectionMarkers

{IPanoramaConnectionMarker[]} getConnectionMarkers()

Returns array of connection markers on the panorama.

getCoordSystem

{ICoordSystem} getCoordSystem()

Returns the coordinate system that is used for defining positions of the panorama and all the associated markers and connections.

getDefaultDirection

{Number[]} getDefaultDirection()

Returns default direction of view. It will be used by the player when opening the panorama.

getDefaultSpan

{Number[]} getDefaultSpan()

Returns default size of the viewing area. It will be used by the player when opening the panorama.

getGraph

{IPanoramaGraph|null} getGraph()

Returns the graph of panoramas connected to the current panorama for making quick transitions.

getMarkers

{IPanoramaMarker[]} getMarkers()

Returns array of markers on the panorama.

getName

{String} getName()

Returns the name of the panorama displayed by the player in the interface.

getPosition

{Number[]} getPosition()

Returns the location of the panorama in the coordinate system set in the options. Set in the format [lon, lat, height], [lat, lon, height] or [x, y, height] depending on the coordinate system and order. height – the height of the panorama in meters, relative to some level (not necessarily sea level).

getTileLevels

{IPanoramaTileLevel[]} getTileLevels()

Returns array of zoom levels for the panorama image.

getTileSize

{Number[]} getTileSize()

Returns the size of tiles that the panorama image is divided into.