Skip to content
Snippets Groups Projects
partiview.sgml 85.1 KiB
Newer Older
teuben's avatar
teuben committed
<!doctype linuxdoc system>

<!-- 
     Changelog:
     2000-09-25   created the changelog after a week of initial editing    PJT
     2000-10-10   made consistent with VERSION 0.1 release                 PJT
teuben's avatar
teuben committed
     2000-11-07   election night changes                                   PJT
teuben's avatar
teuben committed
     2000-11-20   document some CVS and new configure stuff for 0.3        PJT
     2000-12-28   document new movie features for the new CVS version      
                  and lotsa more commands described now                    PJT
slevy's avatar
slevy committed
     2001-07-19   Even more commands described.  Separate kira section.   slevy
     2001-08-30   better introduction and library descriptions, 
                  added some command descriptions, removed redundancies,
                  added examples to make animated gifs                     pjt
pteuben's avatar
pteuben committed


     2002-01-22   pjt
     Note that linuxdoc should be converted to the DocBook format, which supersedes
     linuxdoc and has a lot more features. Conversion can be done with ld2db.sh
     and some perl scripts. clean_ld2db.pl cleans up the dirty conversion, after
     which manually a few small things will need to be cleaned up.
     See the C-C++ Beautifier for details.

     2002-01-03   some more installation notes
pteuben's avatar
pteuben committed
     2002-05-07   some notes on virdir vs. partiview
     2002-06-19   describe stereo, waveobj, detach                       slevy
     2002-06-20   document windows build process                         slevy
     2002-06-25   some doc for colormaps, selected-sets, only=           slevy
pteuben's avatar
pteuben committed
     2005-02-15   example how to compile and run on Fedora Core 3        pjt
  Revision 1.25  2010/04/27 23:44:49  slevy
  Assorted updates, including warp command.

pteuben's avatar
pteuben committed
  Revision 1.24  2005/02/16 13:52:36  pteuben
  added some FC3 comments

  Revision 1.23  2004/10/19 02:10:58  slevy
  Add blurbs describing .obj (Wavefront) and .pb (simple binary particle) formats.

  Revision 1.22  2002/06/27 04:23:12  slevy
  Describe Windows build process (for both partiview and starlab).
  Update FLTK.  Avoid mentioning fltk 2.0 since it probably doesn't work.
  Try using <verb> around code blocks; with sgml2latex, <code> places
  ugly horizontal rules around the blocks and misplaces them so that they
  crop some of the text.

  Describe "detach" command and new cross-eyed stereo feature.
  Describe thresh, only=/only-/only+, see and sel commands.
  But really need a separate section about how selection sets should work.
  (Maybe writing the section will make it clear how they *should* work.)
  Add "thresh" example.  Look at stellar distribution by B-V - the Orion
  spur really does show up in blue!

  Describe transform syntax including "tfm camera", making multiplication
  order explicit.

  Describe colormap file syntax in new section.  Document "cment" & "vcmap" cmds.

teuben's avatar
teuben committed
 -->

<article>

<!-- Title information -->

<title> Partiview (PC-VirDir)
<author> Peter Teuben, Stuart Levy
<date> 27 April 2010
teuben's avatar
teuben committed
<abstract>

partiview is a program that enables you to visualize and animate
particle data. partiview runs on relatively simple desktops and
laptops, but is mostly compatible with its big brother VirDir.
teuben's avatar
teuben committed
This document helps you installing and running the development version 
teuben's avatar
teuben committed
of partiview.
teuben's avatar
teuben committed
</abstract>

<!-- Table of contents -->
<toc>

<!-- Begin the document -->

<!--------------------------------------------------------------------------- -->

teuben's avatar
teuben committed
<sect> Installation
<p>

This release has been tried on Linux (Fedora, Ubuntu, etc.), Mac OS X, Irix and Windows.
partiview needs two libraries to compile: OpenGL (or MESA) for the 
drawing operations, and FLTK for the graphical user interface.
These libraries are known to work on MS-Windows as well as many Unix flavors.
teuben's avatar
teuben committed

<sect1> OpenGL (possibly via Mesa)
teuben's avatar
teuben committed
<p>
Most platforms will have it installed already, whether as libMesaGL or libGL.
Our <tt/configure/ script (see below) 
should take care of the two possible options.
teuben's avatar
teuben committed
<p>
	Homepage: <htmlurl url="http://mesa3d.sourceforge.net/"
			  name="http://mesa3d.sourceforge.net/">

teuben's avatar
teuben committed
<p>
	Redhat packages: (part of powertools I believe)
teuben's avatar
teuben committed

teuben's avatar
teuben committed
<sect1> FLTK
<p>
Also make sure <tt/FLTK/ is installed, from fltk.org.
FLTK versions 1.1.x (e.g. 1.1.7, 1.1.9, ...) work.  
FLTK 2 will not work with partiview.
teuben's avatar
teuben committed

If you're not sure whether you already have it, try
teuben's avatar
teuben committed
<tscreen><code>
       % locate libfltk.a 
       % locate Fl_Slider.h

if they fail, then

       % cd &lt;where-ever&gt;/fltk-1.1.9
teuben's avatar
teuben committed
       % make install
teuben's avatar
teuben committed
</code></tscreen>

       (you only need it if you want to recompile partiview at some point,
        not if you just want to run it, since FLTK is built-in to partiview binaries.)
teuben's avatar
teuben committed
<p>
	Homepage: <htmlurl url="http://www.fltk.org/"
			  name="http://www.fltk.org/">
<p>
	Find rpms: <htmlurl url="http://rpmfind.net"
			   name="http://rpmfind.net">

<P>     FLTK is under continuous development.   Versions from 1.1.1 through
1.1.9 have been successfully tested with partiview. Some problems
with other versions exist, but 1.1.4 is also known to work.
pteuben's avatar
pteuben committed

teuben's avatar
teuben committed

<sect1> partiview
<p>
You can decide to use a branded version, usually available as a tar or zip file,
or use the CVS (see below).
Extract the tarball, and install the program from within the 
<tt/src/ directory:
teuben's avatar
teuben committed

<tscreen><code>
       % tar zxf partiview-0.6.tar.gz
teuben's avatar
teuben committed

       % cd partiview-0.6/src
teuben's avatar
teuben committed
       % make clean                (if you really must compile a new executable)
teuben's avatar
teuben committed
       % ./configure               (GNU autoconf toolset to ease installation)
       % make depend               (might need to make new local dependancies)
       % make partiview	           (should not have to edit Makefile anymore)
teuben's avatar
teuben committed
</code></tscreen>

If you encounter difficulties of locating either the FLTK or MESA/OpenGL
libraries, configure script options can specify them:
<tt/--with-fltk=/<it/dirname/ names the directory which contains the
<tt/lib/ and <tt/FL/ subdirectories, <tt/--with-mesa=/<it/dirname/
can specify the Mesa installation directory [??], and
<tt/--with-kira=/<it/dirname/ names the Starlab directory, whose default
value is taken from environment variable STARLAB_PATH if that is set.
teuben's avatar
teuben committed
<sect1> CVS
<p>
The current source code of <tt/partiview/ is always available from CVS,
with public anonymous read-only access.  Occasionally we stamp out a
packaged release, too, but looking to CVS is best.

(Partiview developers can request a non-anonymous CVS account
from Peter Teuben -- <tt/teuben@astro.umd.edu/.)

Currently the CVS repository machine is <tt/cvs.astro.umd.edu/.
Here's a sample session with some commonly used CVS commands:
teuben's avatar
teuben committed

<tscreen><code>
pteuben's avatar
pteuben committed
 setenv CVSROOT   :pserver:anonymous@cvs.astro.umd.edu:/home/cvsroot
teuben's avatar
teuben committed
 setenv CVSEDITOR emacs

 cvs login                      (only needed once, and only for pserver type access)

teuben's avatar
teuben committed
 cvs checkout partiview              # get a new local sandbox to work in, or
 cd partiview                        # goto the root directory of partiview
 cvs -n -q update                    # check if others had made any changes
 cvs update                          # if so, update your sandbox and/or resolve conflicts
 cd partiview/src                    # goto the 'src' directory of partiview
 ./configure --with-fltk=/some/where/fltk-1.1.something/ ...

 emacs partibrains.c                 # edit some files
teuben's avatar
teuben committed
 make all                            # compile the program
 ./partiview                         # test the program
 emacs kira_parti.cc                 # edit another file
teuben's avatar
teuben committed
 make all                            # check if it still compiles
teuben's avatar
teuben committed
 cvs -n -q update                    # check if anybody else made changes
 cvs update                          # if so, update your sandbox again, resolve conflicts

teuben's avatar
teuben committed
 cvs commit                          # and commit your changes

</code></tscreen>
teuben's avatar
teuben committed

<sect1> Compiling under Windows
<p>
Partiview can be compiled from the command line on Windows using either the
Microsoft Visual C tools (<tt/cl, nmake,/ etc.) or using <tt>gcc/g++</tt> with
<tt/MinGW32, MSYS and w32api/.  The MinGW route is currently the only way
to compile with kira/Starlab support.  There's no provision for building
partiview within the MS Visual Studio GUI.

To compile with Microsoft C:
<p>
<enum>
<item> Install FLTK using MS Visual C++ as described in its documentation.
<item> Unpack the <tt/partiview/ distribution from its tarball or via CVS.
<item> Edit the file <tt>partiview/src/partiview.mak</tt>,
changing <tt/FLTK_DIR/ as appropriate.
<item> Run the <tt/vcvars32.bat/ script from the Developer Studio <tt/Bin/
	directory; this will set the MSVCDIR environment variable,
	add the <tt/Bin/ directory to PATH, etc.
<item> In the <tt>partiview/src</tt> directory, compile with
<tscreen><verb>
       nmake -f partiview.mak
</verb></tscreen>
Dependencies are <it/not/ properly maintained by this Makefile, so
use <tt/nmake -f partiview.mak   clean/ if you change anything.
</enum>


To compile with MinGW and company, you'll need to:
<enum>
<item> Install <tt/MinGW/ (gcc, etc.), its associated <tt/w32api/
	libraries and header files, and the <tt/MSYS/ suite of
	UNIX-like tools.  All three packages are available at:
    <htmlurl url="http://www.sourceforge.net/projects/mingw/"
        name="http://www.sourceforge.net/projects/mingw/">
  Unpack the .zip or .tar archives of MinGW and w32api;
  both packages are intended to live in the same directory.
  The MSYS package comes as a self-extracting archive and
  can be extracted into a different directory as desired.
  (But don't attempt to merge the MSYS <tt/bin/ directory contents
  into <tt>mingw/bin</tt>.)
<item> Add both the MSYS <tt/bin/ subdirectory and MinGW <tt/bin/
  subdirectory to the Windows PATH environment variable,
  with the MSYS directory coming earlier, e.g. in a command window
<tscreen><verb>
    set path=%path%;C:\util\msys\1.0\bin;C:\util\mingw\bin
</verb></tscreen>
or the analogous setting of PATH using (on WinNT/2000 at least)
<tt/My Computer -> Control Panel -> System -> Environment/
to make a permanent change to PATH.

<item> Use MinGW to build FLTK.   (FLTK 1.1.x, e.g. 1.1.9, works with partiview.  FLTK 2.0 won't work.
Not sure about versions in between.)   Unpack the FLTK source distribution and say
<tscreen><verb>
    sh configure
    make
</verb></tscreen>

<item> Build the Starlab libraries, if desired:
  <enum>
    <item>You may need to install CVS for Windows.  Binary packages
	are available; follow the Win32 link on
	   <htmlurl url="http://www.cvshome.org/downloads.html"
		   name="http://www.cvshome.org/downloads.html">.
	Put the resulting cvs.exe file into the PATH somewhere.

    <item>Use CVS to checkout the Starlab sources into some directory:
<tscreen><verb>
    cd C:\some\where
    set CVSROOT=:pserver:anonymous@cvs.astro.umd.edu:/home/cvsroot
    cvs login
    cvs checkout starlab
    cd starlab
</verb></tscreen>

    <item>Copy <tt>templates\starlab_setup.bat</tt> to
	<tt>local\starlab_setup.bat</tt>, and edit it.
	Change the first two <tt/set/ commands: set <tt/STARLAB_PATH/
	to the installation directory -- in the above example,
	<tt>set STARLAB_PATH=C:\some\where\starlab</tt>.
	Also optionally update (or remove) <tt/set PATH=.../
	to add MSYS and MinGW <tt/bin/ directories to it.
    <item>From a Windows command window, type

<tscreen><verb>
     local\starlab_setup
     make libs  
</verb></tscreen>

    <item>If successful, you should find in the <tt/lib/ directory
	the files <tt/libdstar.a  libdyn.a  libnode.a  librdc.a  libsstar.a  libstd.a  libtdyn.a/
   </enum>
  <p>
  <item>
    Now, back in the <tt>partiview/src</tt> directory,
    use <tt/configure/ and <tt/make/ as under Unix.
    The MSYS package imposes its own UNIX-like syntax for Windows pathnames,
    which you'll need to use as arguments to configure and friends,
    with forward- instead of backslashes and a /<it/drive-letter/ prefix.
    Also, if typing to a Windows command-window, shell scripts like
    <tt>configure</tt> must be explicitly fed to <tt>sh</tt>.
    Thus for example if FLTK is installed in <tt>C:\util\fltk-1.1.9</tt>
    and Starlab is in <tt>F:\src\starlab</tt>, then you might build
    partiview by typing
<tscreen><verb>
	sh configure --with-fltk=/c/util/fltk-1.1.9  --with-kira=/f/src/starlab
	make
</verb></tscreen>
    Note there's no need to specify the location of the OpenGL or other
    libraries; the configure script and MinGW tools already know
    where to find those.  Omit the "--with-kira=..." if you're not using Starlab.
<!--------------------------------------------------------------------------- -->
teuben's avatar
teuben committed
<sect> Directory structure
<p>

Here is the directory structure:
teuben's avatar
teuben committed

<p>
<tscreen><verb>
     partiview/             root directory
     partiview/src          source code
     partiview/data         sample datafiles (e.g. Hipparcos Bright Star Catalogue)
teuben's avatar
teuben committed
     partiview/doc          manual (sgml, and derived  html, txt, ps/dvi)
     partiview/scripts      various useful scripts (calculator, moviemaker, etc.)
teuben's avatar
teuben committed
     partiview/nemo         NEMO specific converters/code
     partiview/starlab      STARLAB specific converters/code
teuben's avatar
teuben committed
     partiview/tutor        examples of tutorial type code (added in 0.2)
teuben's avatar
teuben committed
     
</verb></tscreen>

<sect> Running the program
teuben's avatar
teuben committed
<p>
First we describe a simple example how to run <tt/partiview/ with a supplied sample
dataset. Then we describe the different windows that <tt/partiview/ is made up of, and
the different commands and keystrokes it listens to.
teuben's avatar
teuben committed

<sect1>  Example 1: Hipparcos Bright Star Catalogue 3-D viewing
teuben's avatar
teuben committed
<p>

Start the program using one of the sample  "speck" files in the
teuben's avatar
teuben committed
<tt/data/ directory:

<tscreen><code>
teuben's avatar
teuben committed
       % ./hipbright
teuben's avatar
teuben committed
       % partiview hipbright
teuben's avatar
teuben committed
</code></tscreen>

teuben's avatar
teuben committed
and this should come up with a display familiar to most of us who
watch the skies. You should probably enlarge the
teuben's avatar
teuben committed
window a bit. Mine comes up in roughly a 300 by 300 display window,
which may be a bit small (certainly on my screen :-)
(Hint: the <tt/.partiviewrc/ file may contain commands like
<tt/eval winsize 600 400/.)
teuben's avatar
teuben committed


Hit the TAB key to bring focus to the (one line) command window inbetween
teuben's avatar
teuben committed
the log screen (top) and viewing screen (bottom). Type the commands

<tscreen><code>
	fov 50				(field of view 50 degrees)
	jump 0 0 0 80 70 60		(put yourself in the origin
					and look at euler angles
teuben's avatar
teuben committed
					RxRyRz (80,70,60)
teuben's avatar
teuben committed

</code></tscreen>

pteuben's avatar
pteuben committed
and it should give another nice comfy view :-)  If you ever get lost, 
and this is not hard, use
the <tt/jump/ command to go back to a known position and/or viewing
teuben's avatar
teuben committed
angle.
teuben's avatar
teuben committed

<figure loc="tbp">
<img src="pv1.gif">
<caption>partiview view</caption>
</figure>

<p>
Note that spatial units for this dataset are
parsecs, though angular units are degrees for any data in partiview.
teuben's avatar
teuben committed
<p>
pteuben's avatar
pteuben committed
Now play with the display, use the 't', 'r', 'f' and 'o' keys 
(keys are case sensitive) in the viewing window and use the
teuben's avatar
teuben committed
left and mouse buttons down to (carefully) move around a bit, and make
yourself comfortable with moving around. Using the 't' button you get
some idea of the distance of the stars by moving back and forth a little
(the parallax trick). In fact, if you 't' around a little bit, you may
see a green line flashing through the display. This is one of the  RGB
teuben's avatar
teuben committed
(xyz) axes attached to the (0,0,0) [our sun] position.  You should see
teuben's avatar
teuben committed
Procyon and Sirius exhibit pretty large parallaxes, but Orion is pretty
teuben's avatar
teuben committed
steady since it is several hundred parsecs away.
If you move the right mouse button you will zoom in/out and 
teuben's avatar
teuben committed
should see our Sun flash by with the red-green-blue axes.
<p>
pteuben's avatar
pteuben committed
The RGB axes represent the XYZ axes in a (right-handed)
cartesian system. For the Hipparcos
data the X (red) axis points to RA=0h, Y (green) axis to RA=6h, both in the equatorial
plane, and the Z (blue) axis points to the equatorial north pole.
teuben's avatar
teuben committed
Try and use the middle mouse button (or the 'p' key)  to click on Sirius
or Procyon, and see if you can get it to view its properties.  Now use
the 'P' key to switch center to rotation to that star. Sirius is
probably a good choice. Move around a bit, and try and get the sun and orion
in the same view :-)
<p>
[NOTE: these Hipparcos data do not have reliably distance above
pteuben's avatar
pteuben committed
100-200 pc, so Orion's individual distances are probably uncertain to 30%]
teuben's avatar
teuben committed
<p>

A little bit on the types of motion, and what the mouse buttons do

<tscreen><code>

              |     left            middle          right
              |     Button-1        Button-2        Button-3         Shift Button-1
------------------------------------------------------------------------------------
teuben's avatar
teuben committed
f (fly)       |     fly             'pick'          zoom
o (orbit)     |     orbit           'pick'          zoom
r (rotate)    |     rotate X/Y      'pick'          rotate Z            translate
teuben's avatar
teuben committed
t (translate) |     translate       'pick'          zoom

</code></tscreen>

The point of origin for rotations can be changed with the 'P' button.
First you can try and pick ('p' or Button-2) a point, and if found,
teuben's avatar
teuben committed
hit 'P' to make this point the new rotation center default.



<tscreen><code>
red   = X axis
green = Y axis
blue  = Z axis
</code></tscreen>

pteuben's avatar
pteuben committed
To choose an arbitrary center of rotation, use the <tt/center/ command.

teuben's avatar
teuben committed
<sect1> Top Row
<p>
pteuben's avatar
pteuben committed
The top row contains some shortcuts to some frequently used commands.
From left to right, it should show the following buttons:
teuben's avatar
teuben committed
<p>
<descrip>

<tag> More </tag>
Offers some mode switches as toggles: <tt/inertia/
for continues spin or motion,
pteuben's avatar
pteuben committed
and an <tt/H-R Diagram/ to invoke a separate H-R diagram window
for datasets that support stellar evolution.
teuben's avatar
teuben committed

<tag> [g1] </tag>
Pulldown g1, g2, ... (or whichever group) 
is the currently selected group. See  <tt/object/ command
to make aliases which group is defined to what object. If multiple
groups are defined, the next row below this contains a list of all
the groups, and their aliases, so you can toggle them to be displayed.
teuben's avatar
teuben committed

<tag> [f]ly </tag>
Pulldown to select fly/orbit/rot/tran, which can also be activate
teuben's avatar
teuben committed
by pressing the f/o/r/t keys inside the viewing window.

<tag> point </tag>
Toggle to turn the points on/off. See also the <tt/points/ command.
teuben's avatar
teuben committed

<tag> poly </tag>
Toggle to turn polygons on/off. See also the <tt/polygon/ command.
teuben's avatar
teuben committed

<tag> lbl </tag>
Toggle to turn labels on/off. See also the <tt/label/ command.
teuben's avatar
teuben committed

<tag> tex </tag>
Toggle to turn textures on/off. See also the <tt/texture/ command.
teuben's avatar
teuben committed

<tag> box </tag>
Toggle to turn boxes on/off. See also the <tt/boxes/ command.
teuben's avatar
teuben committed

pteuben's avatar
pteuben committed
The current displayed value of the <tt/logslum lum/ slider (see next)
teuben's avatar
teuben committed
<tag> logslum lum </tag>
Slider controlling the logarithm of the <bf/datavar/ variable 
selected as luminosity (with the <tt/lum/ command).
<sect1> Group row (optional)
<p>
When more than one group has been activated (groups of particles or objects 
can have their own display properties, and be turned on and off at will),
a new Group Row will appear as the 2nd row.
<p>
Left-clicking (button 1) on a button toggles the display of that group;
right-clicking (button 3) enables display of the group,
and also selects it as the current group for GUI controls and
text commands.

<sect1> Time Animation rows (Optional)


For time-dependent data, the third and fourth row from
the top control the currently displayed data-time.
This time-control bar is only visible when the object
has a nonzero time range.
Shows the current time (or offset from the tripmeter).
The absolute time is the sum of the <bf/T/ and <bf/+/ fields.
Both are editable.
See also the <tt/step/ control command.
Press to mark a reference point in time.
The T field becomes zero, and the + field (below)
is set to current time.  As time passes, T shows the
offset from this reference time.
Press to return to reference time (sets T to 0).
<tag> + </tag>
Current last time where tripmeter was set. You can reset to
the first frame with the command <tt/step 0/

Drag to adjust the current time.  Sensitivity depends
on the speed setting; dragging by one dial-width
corresponds to 0.1 wall-clock second of animation,
i.e. 0.1 * <it/speed/ in data time units.
Step time backwards or forwards by 0.1 * <it/speed/ data time units.
See also the <tt/</ and <tt/>/ keyboard shortcuts.
<tag> >> </tag>  toggle movie move forwards in time
Toggle animating backwards or forwards in time, by 
1 * <it/speed/ data time units per real-time second.
See also the <tt/{/, <tt/~/, and <tt/}/ keyboard shortcuts.
(Logarithmic) value denoting <it/speed/ of animation.
See also the <tt/speed/ control command.
teuben's avatar
teuben committed

</descrip>


<sect1> Camera (path) Animation row
teuben's avatar
teuben committed
<p>
The fifth (or 4th or 3rd, depending if Group and/or Time rows are present)
row from the top controls loading and playing sequences of moving through space.
teuben's avatar
teuben committed
<p>
<descrip>

teuben's avatar
teuben committed
Brings up a filebrowser to load a <bf/.wf/ path file. This is a file with on each
line 7 numbers: xyz location, RxRyRz viewing direction, and FOV (field of view).
The <tt/rdata/ command loads such path files too.
teuben's avatar
teuben committed

<tag> Play </tag>
Play the viewpoint along the currently loaded path,
as the <tt/play/ command does.
Right-click for a menu of play-speed options.
teuben's avatar
teuben committed

<tag> << < [###] >>> </tag>
Step through camera-path frames.
See also <tt/frame/ control command.
teuben's avatar
teuben committed

<tag> slider </tag>
Slides through camera path, and displays current frame.
teuben's avatar
teuben committed

</descrip>

teuben's avatar
teuben committed
<sect1> Logfile window
teuben's avatar
teuben committed
<p>
The third window from the top contains a logfile of past commands
and responses to them, and can be resized by dragging the bar between
command window and viewing window.
The Logfile window also has a scroll bar on the left. You can
direct the mouse to any previous command, and it will show up in the
command window. Using the arrow keys this command can then be edited.
teuben's avatar
teuben committed
<p>

teuben's avatar
teuben committed
<sect1> Command window
<p>
The Command window is a single line entry window, in which Control
Commands can be given.  Their responses appear in the Logfile
window and on the originating console. (unlike Data Commands,
which show no feedback). You can still give Data Commands in
this window by prefixing them with the <tt/add/ command.
The Up- and Down-arrow keys (not those on the keypad) scroll through
previous commands, and can be edited using the arrow keys and a subset
of the emacs control characters.
teuben's avatar
teuben committed
<p>
teuben's avatar
teuben committed

teuben's avatar
teuben committed
<sect1> Viewing window
<p>
The (OpenGL) Viewing window is where all the action occurs.  Typically
this is where you give single keystroke commands and/or move the mouse
for an interactive view of the data.  It can be resized two ways:
either by resizing the master window, or by picking up the separator
between Viewing window and Command window above.
teuben's avatar
teuben committed

<sect1> Example 2: a (starlab) animation
<p>
Setting up a small animation in for example Starlab can be done quite simply as follows:
(see also the primbim16.mk makefile to create a standard one):
  % makeplummer -i -n 20 | makemass -l 0.5 -u 10.0 | scale -s | kira -d 2 -D x10 > run1
  % partiview run1.cf
  % cat run1.cf

  kira run1
  eval every
  eval lum mass 0 0.01
  eval psize 100
  eval cment 1  1 .7 .3
  eval color clump exact
Alternatively, if you had started up partiview without any arguments, the following
Control Command (see below) would have done the same

<tscreen><code>
</code></tscreen>
teuben's avatar
teuben committed

<sect1> Example 3: stereo viewing 
<p>
The 's' key within the viewing window toggles stereo viewing. By default each
object is split in a blue and a red part, that should be viewed with a pair
of red(left)/blue(right) glasses. Red/green glasses will probably work too.
Crosseyed viewing is also available if selected by <bf/stereo cross/.
See <bf/stereo/ and <bf/focallen/ in the View Commands section. 

<sect1> Example 4: subsetting
<p>
In the <tt/data/ directory, run
<verb>
  partiview hip.cf
</verb>
One of the data fields for these stars is the <it/B-V/ color, <tt/colorb_v/,
abbreviatable to just <tt/color/.  Look at just the bluest stars: try
<verb>
  thresh color &lt; -.1
</verb>
Back off to a large distance (drag with right mouse button,
and drag the <tt/logslum lum/ slider to brighten)
and look at the distribution of these blue stars.  The
Orion spiral-arm spur, extending generally along the +Y (green)
axis, has lots of them.  Now look at more reddish stars,
those with .5 &lt;= <it/B-V/ &lt;= 1.5, with:
<verb>
  thresh color  .5  1.5
</verb>
These are much more uniformly distributed in the galactic plane.
Return to seeing all stars, with:
<verb>
  see all
</verb>
or re-view the threshold-selected subset (reddish stars) with
<verb>
  see thresh
</verb>
or its complement with
<verb>
  see -thresh
</verb>

<p>
There are two types of commands in <tt/partiview/: 
Control Commands and Data Commands.
Probably the most visible difference between the two is that every Control
Command returns feedback to the user, whereas Data Commands
are interpreted without comment unless an error occurs.

Some situations, e.g. the command-entry text box, expect to receive
Control Commands; others, e.g. files (.cf, .speck, etc.) named on
the command line or specified by <tt/read/ or <tt/include/ commands,
are expected to contain Data Commands.

However, it is always possible to enter a Data Command
where a Control Command is expected,
using the <tt/add/ command prefix, e.g. you could type in the text box:
<tscreen><code>
  add 0 0 0 text The Origin
</code></tscreen>. Likewise, a Control Command
may be given where data is expected, as in a data or .cf file,
using the <tt/eval/ prefix:
<tscreen><code>
  1 0 0 text X=1
  eval bgcolor 0.3 0.2 0.1
</code></tscreen>

See also the previous <bf/starlab/ example.

<!-- 
	Before we explain the two types of Commands in
	more detail, a few other concepts are needed:
-->
teuben's avatar
teuben committed
<p>

(see partibrains.c::specks_parse_args)
<p>
Control Commands are accepted in the Command window, and in some other contexts.
Generally, <tt/partiview/ gives a response to every Control Command,
reporting the (possibly changed) status.
Typically, if parameters are omitted, the current state is reported.
<p>
Some commands apply to particles in the current group (see Object group commands);
others affect global things, such as time or display settings.
<p>
Data Commands can also be given, if prefixed with <tt/add/.
teuben's avatar
teuben committed


pteuben's avatar
pteuben committed
<sect1>I/O Control Commands
teuben's avatar
teuben committed

teuben's avatar
teuben committed
<tag>
teuben's avatar
teuben committed
</tag>
Read a file containing Data Commands (typical suffix <tt/.cf/ or <tt/.speck/).
teuben's avatar
teuben committed

NOTYET (would read a file containing control commands)
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>
slevy's avatar
slevy committed
Run an arbitrary unix command (invoked via /bin/sh) as a subprocess of <tt/partiview/.
Its standard output is interpreted as a stream of control commands.
Thus <tt/partiview/ can be driven externally, e.g. to record an animation
(using the <tt/snapshot/ command), or to provide additional GUI controls.
Several <tt/async/ commands can run concurrently. 
Examples are given later. Warning: you cannot interrupt a started command,
short of hitting ESC to exit partiview.
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>
Enter a Data Command where a Control Command is expected,
e.g. in the text input box.  For example,
<verb>
  add 10 15 -1 text blah
</verb>
adds a new label "blah" at 10 15 -1, or
<verb>
  add kira myrun.out
</verb>
loads a kira (starlab) output file.
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>
Processes that control command just as if the <tt/eval/ prefix weren't there.
Provided for symmetry: wherever either a control command or a data command
is expected, entering <tt/eval/ <it/control-command/ ensures that it's
taken as a control command.
teuben's avatar
teuben committed


<tag>
add filepath (data-command)
teuben's avatar
teuben committed
</tag>
Determines the list of directories where all data files, color maps, etc.
are sought.  See the <tt/filepath/ entry under
<!-- ref id="datacommands" name="Data Commands" --> Data Commands.
teuben's avatar
teuben committed

teuben's avatar
teuben committed

pteuben's avatar
pteuben committed
<sect1>Object Group Control Commands
<p>
<tt/Partiview/ can load multiple groups of particles,
each with independent display settings, colormaps, etc.
When more than one group is loaded, the Group Row appears on the GUI,
with one toggle-button for each group.  Toggling the button turns
slevy's avatar
slevy committed
display of that group on or off.  Right-clicking turns the group unconditionally on,
and selects that group as the current one for other GUI controls.
<p>
Many Control Commands apply to the <it/currently selected/ group.
Groups always have names of the form g<it/N/ for some small positive <it/N/;
each group may also have an alias.
teuben's avatar
teuben committed

teuben's avatar
teuben committed
<tag>
g<it/N/ </tag>
Select group g<it/N/.  Create a new group if it doesn't already exist.
teuben's avatar
teuben committed

<tag>
g<it/N/=<it/alias/ </tag>
Assign name <it/alias/ to group g<it/N/.
pteuben's avatar
pteuben committed
Note there must be no blanks around the <tt/=/ sign.
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>
Likewise, select object <it/objectname/, which may be either an alias name
slevy's avatar
slevy committed
or g<it/N/.  
teuben's avatar
teuben committed

<tag>
g<it/N/ <it/control-command/
teuben's avatar
teuben committed
</tag>

<tag>
object <it/objectname/ <it/control-command/
teuben's avatar
teuben committed
</tag>
Either form may be used as a <it/prefix/ to any control command
to act on the specified group, e.g. <tt/object fred poly on/
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>
Invoke the given <it/control-command/ in all groups.
For example, to turn display of group 3 on and all others off, use:
<tscreen><verb>
gall off
g3 on
</verb></tscreen>
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>

<tag>
teuben's avatar
teuben committed
</tag>
pteuben's avatar
pteuben committed
Either one will
enable the display of the currently selected group (as it is by default).
teuben's avatar
teuben committed

pteuben's avatar
pteuben committed
Either one will turn off the display of the current group.
pteuben's avatar
pteuben committed
<sect1>View Control commands
teuben's avatar
teuben committed
<p>
View commands affect the view; they aren't specific to data groups.
teuben's avatar
teuben committed

teuben's avatar
teuben committed
<tag>
teuben's avatar
teuben committed
</tag>
Angular field of view (in degrees) in Y-direction.
teuben's avatar
teuben committed

<tag>
cen[ter] <it/X Y Z/ [<it/RADIUS/]
teuben's avatar
teuben committed
</tag>
<!-- int[erest] <it/X Y Z/ [<it/RADIUS/] -->
Set point of interest.  This is the center of rotation in
<tt/[o]rbit/ and <tt/[r]otate/ modes.  Also, in <tt/[o]rbit/ mode,
translation speed is proportional to the viewer's distance from this point.
The optional <it/RADIUS/ (also set by <tt/censize/) determines the size
of the marker crosshair, initially 1 unit.
teuben's avatar
teuben committed

<tag>
cen[ter] [<it/X Y Z/ [<it/RADIUS/]]
int[erest] [<it/X Y Z/ [<it/RADIUS/]]
teuben's avatar
teuben committed
</tag>
Set point of interest.  This is the center of rotation in
<tt/[o]rbit/ and <tt/[r]otate/ modes.  And, in <tt/[o]rbit/ mode,
translation speed is proportional to the viewer's distance from this point.
The optional <it/RADIUS/ (also set by <tt/censize/) determines the size
of the marker crosshair, initially 1 unit.
****  why is center/interest commented out in the first example. Originally
this command was documented twice, the first one has /interest commented out.
teuben's avatar
teuben committed

<tag>
censize [<it/RADIUS/]
</tag>
Set size of point-of-interest marker.
teuben's avatar
teuben committed

<tag>
teuben's avatar
teuben committed
</tag>
Report the 3-D camera position and forward direction vector.
teuben's avatar
teuben committed

<tag>
Clipping distances.  The computer graphics setup always requires
drawing only objects in some finite range of distances in front of the
viewpoint.  Both values must be strictly positive, and their ratio
is limited; depending on the graphics system in use, distant objects
may appear to blink if the <it/FAR//<it/NEAR/ ratio exceeds 10000 or so.
teuben's avatar
teuben committed

To set the far clip range without changing the near, use a non-numeric
near clip value, e.g. <tt/clip - 1000/.

<!--
teuben's avatar
teuben committed
<tag>
ortho
</tag>
teuben's avatar
teuben committed
NOTYET
teuben's avatar
teuben committed

<tag>
jump [<it/X Y Z/] [<it/Rx Ry Rz/]
teuben's avatar
teuben committed
</tag>
Get or set the current position (XYZ) and/or viewing (RxRyRz) angle.

teuben's avatar
teuben committed
<tag>
readpath
</tag>
Read a Wavefront (<tt/.wf/) file describing a path through space.
teuben's avatar
teuben committed

<tag>
rdata
teuben's avatar
teuben committed
</tag>
Synonym for readpath.
teuben's avatar
teuben committed

<tag>
play <it/speed/[f]
teuben's avatar
teuben committed
</tag>
Play the currently loaded (from <tt/readpath//<tt/rdata/) camera animation
path, at <it/speed/ times normal speed,
skipping frames as needed to keep up with wall-clock time.
(Normal speed is 30 frames per second.)
With "f" suffix, displays every <it/speed/-th frame, without regard to real
time.
teuben's avatar
teuben committed

<tag>
frame [<it/frameno/]
teuben's avatar
teuben committed
</tag>
Get or set the current frame the <it/frameno/-th.

<tag>
update		
</tag>
Ensures the display is updated, as before taking a snapshot.
Probably only useful in a stream of control commands from an <tt/async/
subprocess.

<tag>
winsize [<it/XSIZE/ [<it/YSIZE/]]
</tag>

<tag>
winsize <it/XSIZE/x<it/YSIZE/+<it/XPOS/+<it/YPOS/
</tag>
Resize graphics window.  With no arguments, reports current size.
With one argument, resizes to given width, preserving aspect ratio.
With two arguments, reshapes window to that height and width.
With complete X geometry specification (no embedded spaces),
e.g. <tt/winsize 400x350+20-10/,
also sets position of graphics window, with +X and +Y measured from
left/top, -X and -Y measured from right/bottom of screen.