Changeset 4350


Ignore:
Timestamp:
Apr 26, 2014 9:12:47 AM (10 years ago)
Author:
ldelgass
Message:

Doc updates

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/packages/vizservers/geovis/geovis_protocol.txt

    r4346 r4350  
    33Protocol for geovis render server. 
    44
    5 Commands take the general form of command and arguments using Tcl syntax and are 
     5Commands take the general form of command and arguments using Tcl syntax and are
    66terminated by a newline.  Some command arguments expect a Tcl list which can be
    77sent by enclosing the list in curly braces to prevent the interpreter from
     
    2727================================================================================
    2828
    29 == General dataset, scene and renderer commands ==
     29== General scene and renderer commands ==
    3030
    3131camera delete <name>
     
    5050       Option all resets orientation/rotation as well as pan/zoom/clip range
    5151camera restore <name> <?duration?>
    52        Set viewpoint to a named viewpoint, with optional animation duration in seconds
     52       Set viewpoint to a named viewpoint, with optional animation duration in
     53       seconds
    5354camera rotate <x> <y>
    5455       Specify relative rotation in viewport coordinates
     
    5657       Save current viewpoint to a named viewpoint
    5758camera set <x> <y> <z> <heading> <pitch> <distance> <?duration?> <?srs?> <?vertDatum?>
    58        Explicitly set camera parameters, with optional animation duration in seconds
     59       Explicitly set camera parameters, with optional animation duration in
     60       seconds
    5961       <x>, <y> = Map coordinates of focal point
    6062       <z> = Altitude of focal point (see vertDatum)
     
    6466       <srs> = coordinate system, defaults to map coordinate system
    6567       <vertDatum> = vertical datum for interpreting z coordinate
     68camera throw <bool>
     69       Enable/disable throw inertia for panning/rotating when using mouse events
     70       through protocol
    6671camera zoom <y>
    6772       Specify zoom by viewport coordinates (i.e. normalized y mouse coords)
    6873
    6974clientinfo <list>
     75
     76colormap add <colorMapName> <colorMap> <opacityMap>
     77         (Re-)define a colormap.  If colorMapName doesn't exist, it is created,
     78         otherwise the colormap is redefined and all users will be updated.
     79         colorMap = Tcl list of {value r g b} control points
     80         opacityMap = Tcl list of {value alpha} control points
     81colormap define <colorMapName> <colorMap> <opacityMap>
     82         (Re-)define a colormap (same as 'add')
     83colormap delete <?colorMapName?>
     84colormap res <numberOfTableEntries>
     85         Set the "resolution" or number of lookup table entries in the colormap
     86         <numberOfTableEntries> = integer or "default"
     87
     88renderer render
     89         Force a new image to be rendered
     90
     91screen bgcolor <r> <g> <b>
     92screen size <width> <height>
     93
     94== Mouse and Keyboard Events ==
    7095
    7196key press <key>
     
    79104mouse scroll <direction>
    80105
    81 renderer render
    82          Force a new image to be rendered
    83 
    84 screen bgcolor <r> <g> <b>
    85 screen size <width> <height>
     106== Map Commands ==
    86107
    87108map coords <x> <y>
    88109    Translate screen/mouse coordinates into map coordinates
     110
     111map grid <bool> <?type?>
     112    Toggle graticule and set type
     113    <type> = geodetic|utm|mgrs
    89114
    90115General form:
    91116map layer add <type> <driver> <url> ... <layerName>
    92117    <type> = image|elevation|line|point|polygon|text
    93     <driver> = gdal|wms|tms|xyz
    94 
    95 Specific layer types:
     118    <driver> = gdal|tms|wms|xyz
     119
     120Specific image layer types:
    96121map layer add image gdal <url> <layerName>
    97122    Add a GDAL image layer from a file or URL
     
    105130    Add a TMS image layer from a URL
    106131    <url> = URL of TMS service
     132map layer add image xyz <urlPattern> <layerName>
     133    Add an image layer from a web map using a template URL
     134
     135Elevation layers:
    107136map layer add elevation <driver> <url> <layerName>
    108137    Add an elevation image layer from a file or URL
    109138    <driver> = gdal|tms|wms
     139
     140Feature/model layers:
    110141map layer add point <url> <layerName>
    111142    Add a point feature layer from a file or URL
     
    121152map layer move <pos> <layerName>
    122153map layer visible <bool> <layerName>
     154
    123155map load data follows <nbytes>
    124156    Send an .earth file over the wire
     
    127159map load url <url>
    128160    Load an .earth file from a network address
     161
     162map posdisp <bool> <?format?> <?precision?>
     163    Toggle coordinate/position display, set format and precision
     164    <format> = latlong_decimal_degrees|latlong_degrees_decimal_minutes|
     165               latlong_degrees_minutes_seconds|mgrs
     166    <precision> = integer number of digits to display
     167
    129168map reset <type> <?profile?> <?xmin?> <?ymin?> <?xmax?> <?ymax?>
    130169    Clear the scene and rebuild a new map from scratch.  When resetting the
     
    137176    xmin,ymin,xmax,ymax = map bounds (in profile projection/units)
    138177
     178map scalebar <bool> <?units?>
     179    Toggle scale label/bar
     180    <units> = meters|feet|us_survey_feet|nautical_miles
     181map setpos <x> <y>
     182    Set the coordinate/position display based on mouse coordinates
     183map terrain edges <bool>
     184    *Not currently implemented*
     185map terrain lighting <bool>
     186map terrain linecolor <r> <g> <b>
     187    *Not currently implemented*
     188map terrain vertscale <val>
     189    Set scale factor for terrain height
     190map terrain wireframe <bool>
     191
    139192================================================================================
    140193Replies:
     
    142195nv>image -type image -bytes <nbytes>
    143196  <binary RGB data>
    144 nv>dataset coords <x> <y> <z>
     197nv>map coords <x> <y> <z> <?mouseX?> <?mouseY?>
     198   Reply to query of map coordinates.  If reply is to a request with mouse
     199   coordinates, the mouse coordinates are included.
     200nv>map coords invalid <mouseX> <mouseY>
     201   Reply indicating an off-map click/query
    145202nv>ok -token <seqnum>
    146203   Reply indicated commands through <seqnum> (numbered beginning at 1) have been
Note: See TracChangeset for help on using the changeset viewer.