FGX Globe API Documentation

FGX Globe API Documentation

FGX Globe provides a manipulable 3D visual display of FGX CrossFeed near real-time data of current on-line FlightGear sessions.

The visual display is accessed using URLs with session parameters specified in the query string.

This document provides

• The parameters that can be used
• Examples of the URLs

For a brief introduction to RESTful web services please visit the sites listed below:
http://www.infoq.com/articles/rest-introduction
http://en.wikipedia.org/wiki/REST

Parameters

The current set of API parameters are as follows.

Parameter	Use	Default
lat	Sets camera position latitude	45
lon	Sets camera position longitude	-20
rad	Sets radius distance from the center of the Globe which has a radius of 50	100
ps	Sets the scale of the planes	10
as	Sets the scale of the altitude exaggeration	10
dd	Sets the rate of movement of the screen display	0.2
rr	Sets the refresh rate of calls to FGX CrossFeed in seconds	10
gi	Sets the image to display on the globes. Other choices: '../textures/world.jpg' and '../textures/earth_atmos_2048.jpg'	'../textures/GLOBALeb3colshade.jpg'

Examples

The following are some URLs with query strings that you may try out:

Default - no query string http://jaanga/github.com/data-globes/fgx-globe-r2-dev/index.html

Zoom close into SFO, rapid refresh, slow down that mouse
http://jaanga/github.com/fgx-globe-r2-dev/index.html?lat=37.5&lon=-122.2&rad=58&ps=0.5&dd=1&rr=3

Zoom closer into Western Europe
http://jaanga/github.com/fgx-globe-r2-dev/index.html?lat=48&lon=7&rad=75&ps=0.5&dd=1&rr=8

Zoom a bit into Japan
http://jaanga/github.com/fgx-globe-r2-dev/index.html?lat=35.6&lon=139.7&rad=85&ps=5&dd=0.5&rr=8

Zoom a bit into OZ/NZ
http://jaanga/github.com/fgx-globe-r2-dev/index.html?lat=-33.8&lon=153&rad=85&ps=5&dd=0.5&rr=8

Zoom out and see almost all of South America
http://jaanga/github.com/fgx-globe-r2-dev/index.html?lat=-20&lon=-60&rad=120&ps=8&dd=0.2&rr=8