Code Monkey home page Code Monkey logo

guidance-replay's Introduction

guidance-replay

An event source loop for visual guidance simulator. It turns timestamped GeoJSON into mock location events.

API

Emitter

Generate location events for timestamped GeoJSON along a given update interval.

Parameters

  • geojson Object Timestamped geojson of route.
  • updateInterval number Interval (milliseconds) at which to generate location events.

Emitter.all

Return all location events for a route. Useful for debugging.

Returns Array<Object> Location events with coordinates, bearing, and, if in speedmode, speed and speedchange.

Emitter.next

Return the next location event for a route. Useful for long and/or complex routes.

Returns Object Location events with coordinates, bearing, and, if in speedmode, speed and speedchange.

Route

Turn a Mapbox Directions API response into timestamped GeoJSON in the format of GeoJSON Coordinate Properties.

Parameters

  • directions Object Response from Mapbox Directions API.
  • options Object Optional spacing parameter, which can be constant or acceldecel. Default is constant.

Returns Object GeoJSON LineString with coordinateProperties.times timestamps in milliseconds for each coordinate in the input geometry, starting at 0 ms.

Locator

Generate the location of an event, in terms of step number or coordinates, given any time along the route in milliseconds.

Parameters

  • directions Object Response from Mapbox Directions API.

Locator.maneuvers

Get times (milliseconds) and coordinates for the maneuvers along the route.

Returns Object Object with times and coordinates arrays for maneuvers along route.

Locator.step

Find the current Mapbox Directions API step given a time along the route.

Parameters

  • time Number Time along the route in milliseconds.

Returns Number Step along the route.

Locator.coords

Find the current coordinates given a time along the route.

Parameters

  • time Number Time along the route in milliseconds.

Returns Object Point feature with at locaiton corresponding to time input.

Development

test

npm test

run simulator

npm start
# --> http://localhost:9966/

guidance-replay's People

Contributors

emilymdubois avatar yhahn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.