StreetViewPanorama

AI-generated Key Takeaways

StreetViewPanorama is the main class for the Street View feature in the Google Maps SDK for Android.
StreetViewPanorama objects cannot be directly instantiated but must be obtained from StreetViewPanoramaFragment or StreetViewPanoramaView using the getStreetViewPanoramaAsync() method.
Similar to a View object, StreetViewPanorama can only be read and modified from the main thread.
The class includes listeners for changes in camera position, panorama loading, and user taps or long presses.
Numerous public methods are available to control and retrieve information about the Street View panorama, including animation, getting location and camera details, and enabling/disabling user gestures and street names.

public class StreetViewPanorama extends Object

This is the main class of the Street View feature in the Google Maps SDK for Android and is the entry point for all methods related to Street View panoramas. You cannot instantiate a StreetViewPanorama object directly, rather, you must obtain one from the #getStreetViewPanoramaAsync() method on a StreetViewPanoramaFragment or StreetViewPanoramaView that you have added to your application.

Note: Similar to a View object, a StreetViewPanorama can only be read and modified from the main thread. Calling StreetViewPanorama methods from another thread will result in an exception.

Developer Guide

To get started with the Google Maps SDK for Android, read the Google Maps SDK for Android developer guide.

Nested Class Summary

interface	StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener	A listener for when the StreetViewPanoramaCamera changes
interface	StreetViewPanorama.OnStreetViewPanoramaChangeListener	A listener for when the Street View panorama loads a new panorama
interface	StreetViewPanorama.OnStreetViewPanoramaClickListener	Callback interface for when the user taps on the panorama.
interface	StreetViewPanorama.OnStreetViewPanoramaLongClickListener	Callback interface for when the user long presses on the panorama.

Public Method Summary

void	animateTo(StreetViewPanoramaCamera camera, long duration) Changes the current camera position, orientation and zoom, to a given position over a specified duration
StreetViewPanoramaLocation	getLocation() Returns the current location of the user and information regarding the current panorama's adjacent panoramas
StreetViewPanoramaCamera	getPanoramaCamera() Returns the current orientation and zoom
boolean	isPanningGesturesEnabled() Returns whether or not the panning gestures are enabled for the user
boolean	isStreetNamesEnabled() Returns whether or not the street names appear on the panorama
boolean	isUserNavigationEnabled() Returns whether or not the navigation is enabled for the user.
boolean	isZoomGesturesEnabled() Returns whether or not the zoom gestures are enabled for the user
Point	orientationToPoint(StreetViewPanoramaOrientation orientation) Returns a screen location that corresponds to an orientation (`StreetViewPanoramaOrientation`).
StreetViewPanoramaOrientation	pointToOrientation(Point point) Returns the orientation that corresponds to a screen location.
final void	setOnStreetViewPanoramaCameraChangeListener(StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener listener) Sets a callback that's invoked when the camera changes
final void	setOnStreetViewPanoramaChangeListener(StreetViewPanorama.OnStreetViewPanoramaChangeListener listener) Sets a callback that's invoked when the panorama changes
final void	setOnStreetViewPanoramaClickListener(StreetViewPanorama.OnStreetViewPanoramaClickListener listener) Sets a callback that's invoked when the panorama is tapped.
final void	setOnStreetViewPanoramaLongClickListener(StreetViewPanorama.OnStreetViewPanoramaLongClickListener listener) Sets a callback that's invoked when the panorama is long-pressed.
void	setPanningGesturesEnabled(boolean enablePanning) Sets whether the user is able to use panning gestures
void	setPosition(LatLng position, StreetViewSource source) Sets the StreetViewPanorama to a given location
void	setPosition(LatLng position) Sets the StreetViewPanorama to a given location
void	setPosition(LatLng position, int radius) Sets the StreetViewPanorama to a given location
void	setPosition(LatLng position, int radius, StreetViewSource source) Sets the StreetViewPanorama to a given location
void	setPosition(String panoId) Sets the StreetViewPanorama to a given location
void	setStreetNamesEnabled(boolean enableStreetNames) Sets whether the user is able to see street names on panoramas
void	setUserNavigationEnabled(boolean enableUserNavigation) Sets whether the user is able to move to another panorama
void	setZoomGesturesEnabled(boolean enableZoom) Sets whether the user is able to use zoom gestures

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public void animateTo (StreetViewPanoramaCamera camera, long duration)

Changes the current camera position, orientation and zoom, to a given position over a specified duration

Parameters

camera	The camera position to animate to. Must not be `null`.
duration	The length of time, in milliseconds, it takes to transition from the current camera position to the given one

public StreetViewPanoramaLocation getLocation ()

Returns the current location of the user and information regarding the current panorama's adjacent panoramas

Returns

The current location of the user

public StreetViewPanoramaCamera getPanoramaCamera ()

Returns the current orientation and zoom

Returns

The current camera

public boolean isPanningGesturesEnabled ()

Returns whether or not the panning gestures are enabled for the user

Returns

true if panning gestures are enabled

public boolean isStreetNamesEnabled ()

Returns whether or not the street names appear on the panorama

Returns

true if street names are shown

public boolean isUserNavigationEnabled ()

Returns whether or not the navigation is enabled for the user. This includes double tapping as well as using the navigation links

Returns

true if navigation is enabled

public boolean isZoomGesturesEnabled ()

Returns whether or not the zoom gestures are enabled for the user

Returns

true if zoom gestures are enabled

public Point orientationToPoint (StreetViewPanoramaOrientation orientation)

Returns a screen location that corresponds to an orientation (StreetViewPanoramaOrientation). The screen location is in screen pixels (not display pixels) relative to the top left of the Street View panorama (not of the whole screen).

Parameters

orientation	A `StreetViewPanoramaOrientation` on the Street View panorama to convert to a screen location.

Returns

A Point representing the screen location in screen pixels. Returns null if the orientation is unable to be projected on the screen (e.g. behind the user's field of view)

public StreetViewPanoramaOrientation pointToOrientation (Point point)

Returns the orientation that corresponds to a screen location. The screen location is specified in screen pixels (not display pixels) relative to the top left of the Street View panorama (not the top left of the whole screen).

Parameters

point	A `Point` on the screen in screen pixels.

Returns

The StreetViewPanoramaOrientation corresponding to the point on the screen, or null if the Street View panorama has not been initialized or if the given point is not a valid point on the screen

public final void setOnStreetViewPanoramaCameraChangeListener (StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener listener)

Sets a callback that's invoked when the camera changes

Parameters

listener	The callback that's invoked when the camera changes. To unset the callback, use `null`.

public final void setOnStreetViewPanoramaChangeListener (StreetViewPanorama.OnStreetViewPanoramaChangeListener listener)

Sets a callback that's invoked when the panorama changes

Parameters

listener	The callback that's invoked when the panorama changes. To unset the callback, use `null`.

public final void setOnStreetViewPanoramaClickListener (StreetViewPanorama.OnStreetViewPanoramaClickListener listener)

Sets a callback that's invoked when the panorama is tapped.

Parameters

listener	The callback that's invoked when the panorama is tapped. To unset the callback, use `null`.

public final void setOnStreetViewPanoramaLongClickListener (StreetViewPanorama.OnStreetViewPanoramaLongClickListener listener)

Sets a callback that's invoked when the panorama is long-pressed.

Parameters

listener	The callback that's invoked when the panorama is long-pressed. To unset the callback, use `null`.

public void setPanningGesturesEnabled (boolean enablePanning)

Sets whether the user is able to use panning gestures