StreetViewPanoramaOptions

  • StreetViewPanoramaOptions configures the initial settings for a StreetViewPanorama within your Android application.

  • You can use this class when programmatically adding a panorama to a StreetViewPanoramaFragment or StreetViewPanoramaView.

  • Options include setting the initial position, camera angle, and user interaction controls.

  • The initial position can be specified using a panorama ID, LatLng coordinates, a search radius, or a combination of these.

  • You can control user interactions, such as panning, zooming, and navigation between panoramas.
public final class StreetViewPanoramaOptions extends AbstractSafeParcelable
implements ReflectedParcelable

Defines configuration PanoramaOptions for a StreetViewPanorama. These options can be used when adding a panorama to your application programmatically. If you are using a StreetViewPanoramaFragment, you can pass these options in using the static factory method StreetViewPanoramaFragment.newInstance(StreetViewPanoramaOptions). If you are using a StreetViewPanoramaView, you can pass these options in using the constructor StreetViewPanoramaView.StreetViewPanoramaView(Context, StreetViewPanoramaOptions).

Inherited Constant Summary

Public Constructor Summary

StreetViewPanoramaOptions()
Creates a new StreetViewPanoramaOptions object.

Public Method Summary

Boolean
getPanningGesturesEnabled()
Returns true if users are initially able to pan via gestures on Street View panoramas.
String
getPanoramaId()
Returns the initial panorama ID for the Street View panorama, or null if unspecified.
LatLng
getPosition()
Returns the initial position for the Street View panorama, or null if unspecified.
Integer
getRadius()
Returns the initial radius used to search for a Street View panorama, or null if unspecified.
StreetViewSource
getSource()
Returns the source filter used to search for a Street View panorama, or StreetViewSource.DEFAULT if unspecified.
Boolean
getStreetNamesEnabled()
Returns true if users are initially able to see street names on Street View panoramas.
StreetViewPanoramaCamera
getStreetViewPanoramaCamera()
Returns the initial camera for the Street View panorama, or null if unspecified.
Boolean
getUseViewLifecycleInFragment()
Returns the useViewLifecycleInFragment option, or null if unspecified.
Boolean
getUserNavigationEnabled()
Returns true if users are initially able to move to different Street View panoramas.
Boolean
getZoomGesturesEnabled()
Returns true if users are initially able to zoom via gestures on Street View panoramas.
StreetViewPanoramaOptions
panningGesturesEnabled(boolean enabled)
Toggles the ability for users to use pan around on panoramas using gestures.
StreetViewPanoramaOptions
panoramaCamera(StreetViewPanoramaCamera camera)
Specifies the initial camera for the Street View panorama.
StreetViewPanoramaOptions
panoramaId(String panoId)
Specifies the initial position for the Street View panorama based on a panorama id.
StreetViewPanoramaOptions
position(LatLng position)
Specifies the initial position for the Street View panorama based upon location.
StreetViewPanoramaOptions
position(LatLng position, Integer radius, StreetViewSource source)
Specifies the initial position for the Street View panorama based upon location, radius and source.
StreetViewPanoramaOptions
position(LatLng position, Integer radius)
Specifies the initial position for the Street View panorama based upon location and radius.
StreetViewPanoramaOptions
position(LatLng position, StreetViewSource source)
Specifies the initial position for the Street View panorama based upon location and source.
StreetViewPanoramaOptions
streetNamesEnabled(boolean enabled)
Toggles the ability for users to see street names on panoramas.
String
toString()
StreetViewPanoramaOptions
useViewLifecycleInFragment(boolean useViewLifecycleInFragment)
When using a StreetViewPanoramaFragment, this flag specifies whether the lifecycle of the Street View panorama should be tied to the fragment's view or the fragment itself.
StreetViewPanoramaOptions
userNavigationEnabled(boolean enabled)
Toggles the ability for users to move between panoramas.
void
writeToParcel(Parcel out, int flags)
StreetViewPanoramaOptions
zoomGesturesEnabled(boolean enabled)
Toggles the ability for users to zoom on panoramas using gestures.

Inherited Method Summary

Public Constructors

public StreetViewPanoramaOptions ()

Creates a new StreetViewPanoramaOptions object.

Public Methods

public Boolean getPanningGesturesEnabled ()

Returns true if users are initially able to pan via gestures on Street View panoramas.

public String getPanoramaId ()

Returns the initial panorama ID for the Street View panorama, or null if unspecified.

public LatLng getPosition ()

Returns the initial position for the Street View panorama, or null if unspecified.

public Integer getRadius ()

Returns the initial radius used to search for a Street View panorama, or null if unspecified.

public StreetViewSource getSource ()

Returns the source filter used to search for a Street View panorama, or StreetViewSource.DEFAULT if unspecified.

public Boolean getStreetNamesEnabled ()

Returns true if users are initially able to see street names on Street View panoramas.

public StreetViewPanoramaCamera getStreetViewPanoramaCamera ()

Returns the initial camera for the Street View panorama, or null if unspecified.

public Boolean getUseViewLifecycleInFragment ()

Returns the useViewLifecycleInFragment option, or null if unspecified.

public Boolean getUserNavigationEnabled ()

Returns true if users are initially able to move to different Street View panoramas.

public Boolean getZoomGesturesEnabled ()

Returns true if users are initially able to zoom via gestures on Street View panoramas.

public StreetViewPanoramaOptions panningGesturesEnabled (boolean enabled)

Toggles the ability for users to use pan around on panoramas using gestures. See StreetViewPanorama.setPanningGesturesEnabled(boolean) for more details. The default is true

Parameters
enabled

public StreetViewPanoramaOptions panoramaCamera (StreetViewPanoramaCamera camera)

Specifies the initial camera for the Street View panorama.

Parameters
camera

public StreetViewPanoramaOptions panoramaId (String panoId)

Specifies the initial position for the Street View panorama based on a panorama id. The position set by the panoramaID takes precedence over a position set by a LatLng

Parameters
panoId

public StreetViewPanoramaOptions position (LatLng position)

Specifies the initial position for the Street View panorama based upon location. The position set by the panoramaID, if set, takes precedence over a position set by a LatLng

Parameters
position

public StreetViewPanoramaOptions position (LatLng position, Integer radius, StreetViewSource source)

Specifies the initial position for the Street View panorama based upon location, radius and source. The position set by the panoramaID, if set, takes precedence over a position set by a LatLng

Parameters
position
radius
source

public StreetViewPanoramaOptions position (LatLng position, Integer radius)

Specifies the initial position for the Street View panorama based upon location and radius. The position set by the panoramaID, if set, takes precedence over a position set by a LatLng

Parameters
position
radius

public StreetViewPanoramaOptions position (LatLng position, StreetViewSource source)

Specifies the initial position for the Street View panorama based upon location and source. The position set by the panoramaID, if set, takes precedence over a position set by a LatLng

Parameters
position
source

public StreetViewPanoramaOptions streetNamesEnabled (boolean enabled)

Toggles the ability for users to see street names on panoramas. See StreetViewPanorama.setStreetNamesEnabled(boolean) for more details. The default is true

Parameters
enabled

public String toString ()

public StreetViewPanoramaOptions useViewLifecycleInFragment (boolean useViewLifecycleInFragment)

When using a StreetViewPanoramaFragment, this flag specifies whether the lifecycle of the Street View panorama should be tied to the fragment's view or the fragment itself. The default value is false, tying the lifecycle of the Street View panorama to the fragment.

Using the lifecycle of the fragment allows faster rendering of the Street View panorama when the fragment is detached and reattached, because the underlying GL context is preserved. This has the cost that detaching the fragment, but not destroying it, will not release memory used by the panorama.

Using the lifecycle of a fragment's view means that a Street View panorama is not reused when the fragment is detached and reattached. This will cause the map to re-render from scratch, which can take a few seconds. It also means that while a fragment is detached, and therefore has no view, all StreetViewPanorama methods will throw NullPointerException.

Parameters
useViewLifecycleInFragment

public StreetViewPanoramaOptions userNavigationEnabled (boolean enabled)

Toggles the ability for users to move between panoramas. See StreetViewPanorama.setUserNavigationEnabled(boolean) for more details. The default is true

Parameters
enabled

public void writeToParcel (Parcel out, int flags)

Parameters
out
flags

public StreetViewPanoramaOptions zoomGesturesEnabled (boolean enabled)

Toggles the ability for users to zoom on panoramas using gestures. See StreetViewPanorama.setZoomGesturesEnabled(boolean) for more details. The default is true

Parameters
enabled