Carleton University 3D Viewer Logo

CUViewer User Manual:

Atar File Format
Licensing
  1. Installation
  2. Usage
  3. Mouse Commands
  4. Keyboard Commands

The CU Viewer program displays *.gl.#.SS and *.cuv output from Atar simulations. The following sections describe the installation procedure and program usage for Unix and windows environments.

1. Installation

Requires latest OpenGL/video card drivers (goto video card website, look for downloads/drivers). Download the correct source or binary files from cuviewer.sourceforge.com for the correct system (Linux/Unix, Windows)

I. Binary Installation:

UNIX/LINUX:
1. download binary distribution and unzip  (tar -zxvf  cuviewer-version.tar.gz, extracts into folder called cuviewer)
2. log in as administrator (root)
3. run script:
./installcuviewer
i.e.
#copies binaries:
cp -fr cuviewer cuviewertc /usr/bin/
#copies online documentation
cp -fr cuviewhtml /usr/share/doc/cuviewer/

Uninstallation:
run script:
./removecuviewer

Provides:
/usr/bin/cuviewer
/usr/bin/cuviewertc
documentation:
/usr/share/doc/cuviewer/cuviewhtml

WINDOWS (Versions Win95,98,ME,XP,2000):
Run setup program. That's it.
*.cuv, *.gl, and *.SS files are automatically registered to run cuviewer.

II. Instructions to compile cuviewer from source:


Source Installation Requires:

2. Usage

CUViewer is simple program with a nice user interface for displaying data in a 3D window The viewer can save images to many file formats, print, and display the view in serveral ways. Some features are for general displaying purposes like lighting, fog, transparency, etc. Bin Paletting (shortcut p, P, [, and ]) creates equally spaced contours (ie. blue to red, that is minimum to maximum temperature resp.) and displays the contours on a temperature scale. The Show Scenes Dialog (keyboard shortcut e) control scenes and multi-scene animation.

Using the command prompt:

example:    cuviewer [OPTIONS] file1 file2 ...

on low color video cards:
cuviewertc [OPTIONS] file1 file2 ...

X Windows options

-bg or -background color (X11 only)
-fg or -foreground color (X11 only)
   sets the default foreground color
-geometry WIDTHxHEIGHT (X11 only)
   sets the client geometry of the main window, example:

    -geometry 800x600

-visual TrueColor
    make use of all the colors from the underlying window system.
image export
-e filename  Export image to file, and uses the default image format that is specified in ~/.cuviewer/cuviewrc
viewsettings script
-s filename.script  execute script on first file

Instructions on how to use script file:
  • open cuviewer, open a file.
  • make any adjustments to viewing angle or viewer settings.
  • click file->save to script file
  • close and run the program with the "-s filename.script" specified and specify a cuviewer file to open.
movie script
-m filename.script  execute movie script on first file

 Instructions on how to use a movie script file:
  • open cuviewer, open a file.
  • click file->create movie script 
  • save script to a file
  • set movie properties (frames per second, time limit, etc...), click ok to start recording.
  • exit program anytime to stop recording.
  • run the program with the "-m filename.script" specified at command prompt and specify a cuviewer file to open.
  • frames will be saved to disk as images in the default image format specified under global preferences.

Miscellaneous

-v  version
-h  help



3. Mouse Mappings

L: Left button, M: Middle, R: Right

Mouse Button L M R
Spin object about it's center x    
Zooms in/out with mouse
 
x
 
Change the camera's aim
 
 
x
Rotate object about it's center
x
x
 
Rotate object about the point where the camera aims at.
x
 
x
Translate camera vertically and horizontally  
x
x

4. Keyboard Shortcuts


File Operations

CTRL+O
CTRL+M
CTRL+R
CTRL+L
CTRL+S
CTRL+C
CTRL+W
CTRL+P
CTRL+A
CTRL+X
CTRL+Q
F1
Shift+F1
open file
merge another file into current scene
reload file
load script
save script
close file
close window
print file
autoexport image
export image at a specified resolution
exit program
Help
Show Version

Viewing

0-9
a
Ctrl+b
c
d
e
Ctrl+E
b
g
i
l
o
p
Shift+P
[
]
r
s
t
v
f
q
x
z
w

up,down,
right,left
Keypadkeys:
/,*,-,+
PgUp,
PgDown
Home,End

reset camera to a predefined viewpoint
anti-aliasing (produces a higher quality image at the cost of slower rendering performance).
toggle bounding box always
redraw document (opengl refresh)
diffuse light (i.e.. brightness of the total image)
show scenes dialog (toggles entities)
toggle edit mode
toggle bounding box
gamma lighting filter
export image to file
lighting
outlines
bin window paletting (maps 100% red to 100% blue colours into equally spaced bins)
toggle paletting colours (changes the bin colours)
increase number of bins
decrease number of bins  
show viewer settings panel
toggle between flat and smooth shading
two sided polygons
change between perspective and orthogonal views
fog
opaque wireframes
transparency
zero clipping plane of view
wireframe/line mode

orbit camera around object


Slide view left,right,up,down resp.
Rotate camera counterclockwise,
Rotate camera clockwise
Zoom camera in,out