Provided by: grass-doc_7.0.3-1build1_all bug

NAME

       m.nviz.script  - Creates fly-through script to run in NVIZ.

KEYWORDS

       miscellaneous, graphics, raster, raster3d, vector, visualization

SYNOPSIS

       m.nviz.script
       m.nviz.script --help
       m.nviz.script         [-fckoe]         input=name        output=name         [name=string]
       [route=east,north[,east,north,...]]  dist=float ht=float  frames=integer   [start=integer]
       [--overwrite]  [--help]  [--verbose]  [--quiet]  [--ui]

   Flags:
       -f
           Full render -- Save images

       -c
           Fly at constant elevation (ht)

       -k
           Include command in the script to output a KeyFrame file

       -o
           Render images off-screen

       -e
           Enable vector and sites drawing

       --overwrite
           Allow output files to overwrite existing files

       --help
           Print usage summary

       --verbose
           Verbose module output

       --quiet
           Quiet module output

       --ui
           Force launching GUI dialog

   Parameters:
       input=name [required]
           Name of input raster map

       output=name [required]
           Name of output script

       name=string
           Prefix of output images (default = NVIZ)

       route=east,north[,east,north,...]
           Route coordinates (east,north)

       dist=float [required]
           Camera layback distance (in map units)

       ht=float [required]
           Camera height above terrain

       frames=integer [required]
           Number of frames

       start=integer
           Start frame number (default=0)

DESCRIPTION

       The  m.nviz.script  program  allows  the user to easily create a script that can be run in
       NVIZ to fly through a terrain.  The NVIZ flight path can be chosen interactively from  the
       GRASS  monitor  (-i)  or  supplied on the command line as comma separated coordinates. The
       program optionally allows a KeyFrame file to created  (after  running  the  script).  This
       KeyFrame file can be loaded into the Keyframe Animation panel for fine tuning or editing.

       The  script  generated  by  m.nviz.script  can  be  run  from  the NVIZ command line (nviz
       script=script_name) or after NVIZ is started by selecting Scripting->Play Script.

OPTIONS

   Flags:
       -i
           Intercative mode
           The user selects the camera path from the GRASS monitor by  clicking  the  left  mouse
           button along the route. Click the right mouse button to finish.

       -f
           Full render
           The script will draw all loaded NVIZ data and save scene to PPM image.

       -c
           Flay at constant elevation
           With  this flag the camera will be set to an elevation given by the ht= parameter. The
           default is to fly at ht= above the topography (i.e. camera height = elevation + ht)

       -k
           Output KeyFrame file
           Generate a KeyFrame file that can be loaded from the NVIZ  Keyframe  Animation  panel.
           The  KeyFrame  file  is  automatically  assigned  the  script  name  with a .kanimator
           extension.

       -o
           Render the animation in an off-screen context

       -e
           Enable vector and sites drawing

   Parameters:
       input
           The name of the GRASS raster map with elevation data.
           This should be the same file that will be loaded in NVIZ.

       output
           The name of the NVIZ script to create.

       name
           The prefix for output images if running in full render mode (-f).
           The defulat preifix is NVIZ (eg. NVIZ0000.ppm).

       dist
           The distance of the camera behind the center of view.

       ht
           The height of the camera above the center of view.
           If the the -c flag is set, the height represents the actual camera height.

       frames
           The number of frames in the animation.

       start
           The starting frame number (default = 0).
           This option may be useful in full render mode when creating an animation in  sections.
           For example the user may wish to start at frame number 2000.

       route
           The comma separated geographic coordinates for keyframe locations.
           The interactive flag (-i) overrides this option.

EXAMPLE

       To  interactively  create  an NVIZ animation from raster elev.rast with 500 frames and the
       camera set to 50 meters above and 250 meters behind the scene, run the following:
       g.region raster=elevation.dem
       d.rast elevation.dem
       m.nviz.script -ik input=elevation.dem output=nviz.script dist=2400 ht=1220 frames=1000
       In the above the example the user is prompted to select the route from the GRASS  monitor.
       The output script, ’nviz.script.nvscr’, can then be run in NVIZ:
       nviz elevation=elevation.dem script=nviz.script.nvscr

NOTES / HINTS

       The  user  must  select  at  least four key-frame locations (points) otherwise an error is
       generated.

       If the GRASS region is changed the m.nviz.script command must be re-run.

       The current GRASS region and the user supplied parameters are included as a comment at the
       top of the output script. This information can be used to easily re-create the animation.

       The  camera position is calculated backwards from the supplied position(s). It is possible
       that the camera position will lie outside the current window, in which  case  a  non-fatal
       error  is  generated  (Error: selected point is outside region).  This error can result in
       jerky movements during the animation.  To correct this problem reduce the dist=  parameter
       or increase the current region.

   Loading the script into NVIZ
       The  user  can  run  the  script  at  arbitrary resolution. To re-run it at higher spatial
       resolution or  different  settings,  the  user  first  loads  the  surface  and  sets  the
       resolution,  lighting,  etc. Then internally the script generated by m.nviz.script is run.
       Alternatively, the user can run nviz with a previuosly saved state and  the  m.nviz.script
       generated script:
       nviz state=saved.state script=nviz.script.nvscr

   Keyframe animator script
       Running  the  script  generated  by  m.nviz.script within NVIZ, a new script for kanimator
       (keyframe animator) is created. The kanimator panel offers fine tuning of the speed (frame
       rate)  as  well  as  editing individual frames or inserting new frames. This new kanimator
       script has to be loaded from the Kanimator panel in NVIZ. In the Kanimator panel there are
       Save  and  Load  button  which allow the user to save and re-load a kanimator script. Once
       loaded, the key frames will appear in the GUI and can then be edited there.

SEE ALSO

       wxGUI 3D viewer (NVIZ)

AUTHOR

       Bob Covill

       Last changed: $Date: 2014-12-19 22:55:37 +0100 (Fri, 19 Dec 2014) $

       Main index | Misc index | Topics index | Keywords index | Full index

       © 2003-2016 GRASS Development Team, GRASS GIS 7.0.3 Reference Manual