source: trunk/packages/vizservers/geovis/geovis_protocol.txt @ 4333

Last change on this file since 4333 was 4333, checked in by ldelgass, 10 years ago

update doc

File size: 6.8 KB
3Protocol for geovis render server. 
5Commands take the general form of command and arguments using Tcl syntax and are
6terminated by a newline.  Some command arguments expect a Tcl list which can be
7sent by enclosing the list in curly braces to prevent the interpreter from
8splitting the list into multiple arguments.  Likewise, strings with spaces
9should be quoted or enclosed in curly braces.  In the documentation below,
10arguments are indicated by angle brackets and optional arguments are surrounded
11by question marks -- the brackets and question marks are not part of the
12protocol and should not be included in argument strings.  The arguments shown
13in angle brackets should be replaced with a string (where there are fixed
14choices this document indicates valid values by separating them with pipe
15symbols), a list in Tcl syntax, or a numeric value.  Boolean arguments can take
16the form of 0|1, true|false, or yes|no.  Since the protocol commands are
17executed in a Tcl interpreter, Tcl code such as math expressions in expr
18commands enclosed in square brackets are also allowed.  Since the interpreter
19is a "safe" interpreter, some Tcl commands that could cause security issues may
20not be available for use.
22When binary data is to be sent, it should follow the newline after a command
23that indicates incoming data including a byte count argument.
29== General dataset, scene and renderer commands ==
31camera delete <name>
32       Delete named viewpoint
33camera dist <distance>
34       Set camera distance from focal point
35camera get
36       Request camera parameters
37camera go <x> <y> <?zoomFactor?> <?duration?>
38       Move camera to new focal point.
39       <x>,<y> = Screen/mouse coordinates
40       <zoomFactor> = Zoom distance multiplier, 1.0=no zoom
41       <duration> = Duration of viewpoint move animation in seconds
42camera orient <quatW> <quatX> <quatY> <quatZ>
43       Set scene orientation using a quaternion
44camera pan <x> <y>
45       <x,y> viewport coordinates (window center at 0,0).  Positive x pan
46       means pan object to right (camera to left).  Positive y pan means
47       pan object down (camera up).  For example a pan of 0.5, 0.5 would
48       move the object center to the lower right corner of the window
49camera reset <?all?>
50       Option all resets orientation/rotation as well as pan/zoom/clip range
51camera restore <name> <?duration?>
52       Set viewpoint to a named viewpoint, with optional animation duration in seconds
53camera rotate <x> <y>
54       Specify relative rotation in viewport coordinates
55camera save <name>
56       Save current viewpoint to a named viewpoint
57camera set <x> <y> <z> <heading> <pitch> <distance> <?duration?> <?srs?> <?vertDatum?>
58       Explicitly set camera parameters, with optional animation duration in seconds
59       <x>, <y> = Map coordinates of focal point
60       <z> = Altitude of focal point (see vertDatum)
61       <heading> = Azimuth in degrees
62       <pitch> = Elevation in degrees
63       <distance> = Distance of camera from focal point in map units(?)
64       <srs> = coordinate system, defaults to map coordinate system
65       <vertDatum> = vertical datum for interpreting z coordinate
66camera zoom <y>
67       Specify zoom by viewport coordinates (i.e. normalized y mouse coords)
69clientinfo <list>
71key press <key>
72key release <key>
74mouse click <button> <x> <y>
75mouse dblclick <button> <x> <y>
76mouse drag <button> <x> <y>
77mouse motion <x> <y>
78mouse release <button> <x> <y>
79mouse scroll <direction>
81renderer render
82         Force a new image to be rendered
84screen bgcolor <r> <g> <b>
85screen size <width> <height>
87map coords <x> <y>
88    Translate screen/mouse coordinates into map coordinates
90General form:
91map layer add <type> <driver> <url> ... <layerName>
92    <type> = image|elevation|line|point|polygon|text
93    <driver> = gdal|wms|tms
95Specific layer types:
96map layer add image gdal <url> <layerName>
97    Add a GDAL image layer from a file or URL
98map layer add image wms <url> <layers> <format> <transparent> <layerName>
99    Add a WMS image layer from a URL + layer string
100    <url> = URL of WMS service
101    <layers> = layers string for WMS server
102    <format> = Image format to return (e.g. 'png')
103    <transparent> = bool
104map layer add image tms <url> <layerName>
105    Add a TMS image layer from a URL
106    <url> = URL of TMS service
107map layer add elevation <driver> <url> <layerName>
108    Add an elevation image layer from a file or URL
109    <driver> = gdal|tms|wms
110map layer add point <url> <layerName>
111    Add a point feature layer from a file or URL
112map layer add polygon <url> <layerName>
113    Add a polygon feature layer from a file or URL
114map layer add line <url> <layerName>
115    Add a line feature layer from a file or URL
116map layer add text <url> <layerName>
117    Add a text symbol layer from a file or URL
119map layer delete <layerName>
120map layer opacity <opacity> <layerName>
121map layer move <pos> <layerName>
122map layer visible <bool> <layerName>
123map load data follows <nbytes>
124    Send an .earth file over the wire
125map load file <path>
126    Load an .earth file from a filesystem mounted on the server
127map load url <url>
128    Load an .earth file from a network address
129map reset <type> <?profile?> <?xmin?> <?ymin?> <?xmax?> <?ymax?>
130    Clear the scene and rebuild a new map from scratch.  When resetting the
131    map to geocentric, a profile and extents should be omitted.  When the map
132    type is projected, the profile is required and extents are optional.
133    type = geocentric|projected
134    profile = Well known profile string, e.g. 'global-geodetic',
135    'global-mercator'.  If specifying bounds (i.e. not global), use 'geodetic'
136    or 'spherical-mercator' or an SRS init string (such as an EPSG code)
137    xmin,ymin,xmax,ymax = map bounds (in profile projection/units)
142nv>image -type image -bytes <nbytes>
143  <binary RGB data>
144nv>dataset coords <x> <y> <z>
145nv>ok -token <seqnum>
146   Reply indicated commands through <seqnum> (numbered beginning at 1) have been
147   processed, but no new image was rendered
149Error Replies:
151nv>viserror -bytes <nbytes>
152   <multi-line error string of nbytes>
Note: See TracBrowser for help on using the repository browser.