Class: StreetviewSequence

StreetviewSequence

new StreetviewSequence(container, options) → {jQuery.Deferred.Promise}

Create a StreetviewSequence object.
Parameters:
Name Type Description
container string | jQuery The container to which the animation canvas will be appended.
options Object
Properties
Name Type Argument Default Description
domain string <optional>
 Scheme + host which to pass the query parameters. Useful when using a proxy to generate signed URLs for high resolution imagery.
duration number <optional>
 1 Duration of the animation.
easeHeading Ease <optional>
 Power0.easeIn Greensock easing method used for heading skew.
easePitch Ease <optional>
 Power0.easeIn Greensock easing method used for pitch skew.
easeRoute Ease <optional>
 Power0.easeIn Greensock easing method used for route waypoint selection.
headingSkewEnd number <optional>
 options.headingSkewStart Heading at which to end the animation (horizontal).
headingSkewStart number <optional>
 0 Heading at which to start the animation (horizontal).
height number <optional>
 150 (Intrinsic) height of the animation canvas in pixels.
key string <optional>
 Google API key.
location google.maps.LatLng <optional>
 Location at which to place the stationary panorama.
loop boolean <optional>
 false Whether or not the animation should loop.
pitchSkewEnd number <optional>
 options.pitchSkewStart Pitch at which to end the animation (vertical).
pitchSkewStart number <optional>
 0 Pitch at which to start the animation (vertical).
route google.maps.google.maps.DirectionsResult <optional>
 Maps directions result for route stepping.
sensor boolean <optional>
 false Indicates whether or not the request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request. This value must be either true or false.
totalFrames number <optional>
 75 Total number of frames to be used for animation.
width number <optional>
 300 (Intrinsic) height of the animation canvas in pixels.
Source:
Returns:
Type
jQuery.Deferred.Promise

Methods

<inner> calcScalar(p, ease, start, end) → {number}

Calculate the current value of an ease based on it's progress given a start and end point.
Parameters:
Name Type Description
p number Raw linear progress of ease
ease Ease Ease function used for completion ratio calculation
start number Starting eased value
end number Ending eased value
Source:
Returns:
Type
number

<inner> draw()

Draw the current frame onto the animation canvas. Current frame is derived from the animation progress and the total amount of frames.
Source:

<inner> ended()

If options.loop is set to false, trigger an ended event. If true, the animation is then reversed, and thus, loops.
Source:

<inner> getLat(latLng) → {number}

As of Google Maps Javascript API V3 3.16, a literal lat/lng object and a google.maps.LatLng object are accepted as location points. This facade makes this easier to manage.
Parameters:
Name Type Description
latLng Object | google.maps.LatLng google.maps.LatLng object or a literal lat/lng object.
Source:
See:
Returns:
Type
number

<inner> getLng(latLng) → {number}

As of Google Maps Javascript API V3 3.16, a literal lat/lng object and a google.maps.LatLng object are accepted as location points. This facade makes this easier to manage.
Parameters:
Name Type Description
latLng Object | google.maps.LatLng google.maps.LatLng object or a literal lat/lng object.
Source:
See:
Returns:
Type
number

<inner> getPanoramaData() → {jQuery.Deferred.Promise}

For the given options.location, retrieve the necessary information to build a Street View Image URL. Note that the only information used from the API request is a heading that faces the street.
Source:
Returns:
Promise of a deferred object which eventually resolves with the necessary information to generate a Street View Image API URL.
Type
jQuery.Deferred.Promise

<inner> getRouteData(p) → {jQuery.Deferred.Promise}

Retrieve the Street View Panorama information for a given point on the route based on the given progress, p. From the Street View Panorama API response, we are given the original panorama location, the proper heading (facing down the street), and the proper pitch (vertically centered).
Parameters:
Name Type Description
p number Progress through the list of street view images.
Source:
Returns:
Promise of a deferred object which eventually resolves with the necessary information to generate a Street View Image API URL.
Type
jQuery.Deferred.Promise

<inner> getStreetHeading(location) → {jQuery.Deferred.Promise}

Get a street-facing heading for a given location accompanied with whether or not the location is indoors.
Parameters:
Name Type Description
location google.maps.LatLng
Source:
Returns:
Promise of a deferred object which eventually resolves with a heading and a boolean value indicated whether or not the location is indoor.
Type
jQuery.Deferred.Promise

<inner> getStreetViewImageURL(options) → {string}

Build a Street View Image API URL.
Parameters:
Name Type Description
options object
Properties
Name Type Argument Default Description
domain string <optional>
 window.location.protocol + '//maps.googleapis.com' Scheme + host which to pass the query parameters. Useful when using a proxy to generate signed URLs for high resolution imagery.
height number Image height in pixels.
key string <optional>
 Google Maps Javascript V3 API key.
sensor boolean Indicates whether or not the request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request. This value must be either true or false.
width number Image width in pixels.
Source:
Returns:
Street View Image API URL
Type
string

<inner> imageOnLoad()

Increment the total count of loaded images, and notify the returned deferred object of the total load progress. If the total loaded count is equal to the total number of frames, the deferred object is resolved. Every image used in the animation has its onload event bound to this function.
Source:

<inner> loadImages()

Build the array of images used for animation.
Source:

<inner> pause()

Pause the animation.
Source:

<inner> play()

Play the animation.
Source: