For documentation on the current version, please check Knowledge Base.
Class orbit.webclient.PanoramaViewer
Class Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
orbit.webclient.PanoramaViewer(viewerId, flash)Class PanoramaViewer models a single panorama viewer. |
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
addEventListener(eventType, handler)Add an event listener. |
|
getFOV()Get the FOV of the panorama. |
|
getPan()Get the pan angle of the panorama. |
|
getPhoto()Get the current photo. |
|
getSnapshot()Get the last panorama snapshot. |
|
getTilt()Get the tilt angle of the panorama. |
|
getViewerId()Get the identifier of this viewer. |
|
loadPhoto(photo, options)Load a photo. |
|
loadPhotoAtLatLon(lat, lon, options)Load a photo close to a specified coordinate. |
|
loadPhotoAtXY(x, y, crs, options)Load a photo close to a specified coordinate. |
|
loadPhotoById(photo, options)Load a photo. |
|
lookAtXY(coordinate, crs, crs)Look at a specific spatial position. |
|
lookAtXYZ(coordinate, crs, z, crs)Look at a specific spatial position. |
|
removeEventListener(eventType, handler)Remove an event listener. |
|
setFOV(value)Set the FOV of the panorama. |
|
setPan(value)Set the pan angle of the panorama. |
|
setTilt(value)Set the tilt angle of the panorama. |
|
updateSnapshot()Update the panorama snapshot. |
Class Detail
orbit.webclient.PanoramaViewer(viewerId, flash)
Class PanoramaViewer models a single panorama viewer.
Parameters
{String} viewerId | The viewer identifier. |
{goog.ui.media.FlashObject} flash | The parent flash object. |
Method Detail
addEventListener
Add an event listener.
Parameters
{String} eventType | The event type to listen to. |
{Function} handler | The function to call when the event occurs. |
getFOV
Get the FOV of the panorama.
Returns
{Float} Returns the FOV (horizontal fov, degrees).
getPan
Get the pan angle of the panorama.
Returns
{Float} Returns the pan angle.
getPhoto
Get the current photo.
getSnapshot
Get the last panorama snapshot.
Returns
returns a base64 encoded jpeg image.
getTilt
Get the tilt angle of the panorama.
Returns
{Float} Returns the tilt angle.
getViewerId
Get the identifier of this viewer.
Returns
{String} Returns the identifier.
loadPhoto
loadPhotoAtLatLon
Load a photo close to a specified coordinate.
Parameters
| lat | The coordinate latitude. |
| lon | The coordinate longitude. |
| options | The set of load-photo options. |
loadPhotoAtXY
Load a photo close to a specified coordinate.
Parameters
| x | The x coordinate ordinal. |
| y | The y coordinate ordinal. |
| crs | The crs of the coordinate. |
| options | The set of load-photo options. |
loadPhotoById
lookAtXY
Look at a specific spatial position.
Parameters
| coordinate | the coordinate to look at. |
| crs | CRS of the specified coordinate. |
| crs |
lookAtXYZ
Look at a specific spatial position.
Parameters
| coordinate | the coordinate to look at. |
| crs | CRS of the specified coordinate. |
| z | |
| crs |
removeEventListener
Remove an event listener.
Parameters
{String} eventType | The type of the event. |
{Function} handler | The handler function. |
setFOV
Set the FOV of the panorama.
Parameters
{Float} value | The new FOV. |
setPan
Set the pan angle of the panorama.
Parameters
{Float} value | The new pan angle. |
setTilt
Set the tilt angle of the panorama.
Parameters
{Float} value | The new tilt angle. |
updateSnapshot
Update the panorama snapshot. After this method is called, a snapshot is generated asynchronously. Wait for the SNAPSHOT_UPDATED event and then use getSnapshot() to retrieve the actual snapshot.