Juggler Suite of Tools—Documentation

This page provides links to all documentation related to the Juggler Suite of Tools. In many cases, the documentation comes in both HTML and PDF form. The documentation provided here is for all released versions of VR Juggler and associated modules. It is grouped by module and by release. We also include course notes and slides from VR Juggler tutorials.

• On-Site Documentation
  • Juggler Module Documentation
  • Juggler Tutorial Material
• Off-Site Documentation
  • VR Juggler Configuration Guide (by Infiscape Corporation)
  • GMTL documentation (from SourceForge)
  • Boost C++ Libraries documentation (by the Boost project)
  • C++ Standard Template Library Programmer's Guide (by SGI)

VR Juggler

2.0.x Getting Started Guide [PDF | HTML] The Getting Started Guide is a short document to explain some of the basic concepts in VR Juggler as well as introduce you to using existing VR Juggler applications. Programmer's Guide [PDF | HTML] The Programmer's Guide is a verbose narative to help the beginning VR Juggler application developer write effective virtual reality applications in C++. C++ Programmer Reference [HTML (no JavaScript)] The C++ Programmer Reference presents the VR Juggler API documentation in HTML form. It is generated from the comments in the source code using Doxygen. Java Programmer Reference The Java Programmer Reference presents the VRJConfig API documentation in HTML form. It is generated from the comments in the source code using javadoc. 2.0 Alpha 4 Getting Started Guide [PDF | HTML] The Getting Started Guide is a short document to explain some of the basic concepts in VR Juggler as well as introduce you to using existing VR Juggler applications. Programmer's Guide [PDF | HTML] The Programmer's Guide is a verbose narative to help the beginning VR Juggler application developer write effective virtual reality applications in C++. Programmer Reference [HTML (no JavaScript) | PDF] The C++ Programmer Reference presents the VR Juggler API documentation in HTML form. It is generated from the comments in the source code using Doxygen. 1.0 Getting Started Guide [PDF | HTML] The Getting Started Guide is a short document to explain some of the basic concepts in VR Juggler as well as introduce you to using existing VR Juggler applications. Configuration Guide [PDF | HTML] The Configuration Guide provides users of VR Juggler with examples of how to configure each of the parameterized elements of VR Juggler. It covers everything from simulator input to large-screen projection displays. Programmer's Guide [PDF | HTML] The Programmer's Guide is a verbose narative to help the beginning VR Juggler application developer write effective virtual reality applications in C++. Technical Overview [PDF | HTML] An overview of the technical details of VR Juggler. VjControl Guide [PDF | HTML] The VjControl Guide explains config chunks and how to use VjControl, the VR Juggler configuration tool. Performance Measurement Guide [PDF | HTML] Information for using VR Juggler's built-in performance monitoring capabilities. Programmer Reference The programmer reference presents the VR Juggler API documentation in HTML form. It is generated from the comments in the source code.

VPR

1.0.x Programmer's Guide [PDF | HTML] The Programmer's Guide is a description of the various cross-platform interfaces provided by VPR. It provides a prose description of the classes and is intended to act as a supplement to the programmer reference. Programmer Reference [HTML (no JavaScript)] The programmer reference presents the VPR API documentation in HTML form. It is generated from the comments in the source code using Doxygen. 0.35 Programmer's Guide [PDF | HTML] The Programmer's Guide is a description of the various cross-platform interfaces provided by VPR. It provides a prose description of the classes and is intended to act as a supplement to the programmer reference. Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the VPR API documentation in HTML form. It is generated from the comments in the source code using Doxygen.

Gadgeteer

1.0.x Device Driver Authoring Guide [PDF | HTML] The Device Driver Authoring Guide provides a thorough discussion of how to write device drivers for Gadgeteer. It includes information explaining how to write drivers that can be loaded at runtime as dynamically loadable libraries. Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the Gadgeteer API documentation in HTML form. It is generated from the comments in the source code using Doxygen. 0.15 Cluster Juggler [PDF | HTML] The ClusterJuggler Guide presents background information about clustering techniques and how they are implemented in VR Juggler. The guide also walks the reader through a simple cluster configuration example. Device Driver Authoring Guide [PDF | HTML] The Device Driver Authoring Guide provides a thorough discussion of how to write device drivers for Gadgeteer. It includes information explaining how to write drivers that can be loaded at runtime as dynamically loadable libraries. Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the Gadgeteer API documentation in HTML form. It is generated from the comments in the source code using Doxygen.

Tweek

All Introductory Brochure This one-page brochure offers an introduction to what Tweek is and how it may be used within virtual reality applications. It is neither too technical nor too high-level. 1.0.x Programmer's Guide [PDF | HTML] The programmer's guide is an introduction to programming with Tweek. It explains the C++, Java, and CORBA aspects. C++ Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the Tweek C++ API documentation in HTML form. It is generated from the comments in the source code using Doxygen. Java Programmer Reference The programmer reference presents the Tweek Java API documentation in HTML form. It is generated from the comments in the source code using JavaDoc. 0.16 Programmer's Guide [PDF | HTML] The programmer's guide is an introduction to programming with Tweek. It explains the C++, Java, and CORBA aspects. C++ Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the Tweek C++ API documentation in HTML form. It is generated from the comments in the source code using Doxygen. Java Programmer Reference The programmer reference presents the Tweek Java API documentation in HTML form. It is generated from the comments in the source code using JavaDoc.

JCCL

1.0.x C++ Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the JCCL C++ API documentation in HTML form. It is generated from the comments in the source code using Doxygen. Java Programmer Reference The programmer reference presents the JCCL Java API documentation in HTML form. It is generated from the comments in the source code using JavaDoc. 0.17 C++ Programmer Reference [HTML (no JavaScript) | PDF] The programmer reference presents the JCCL C++ API documentation in HTML form. It is generated from the comments in the source code using Doxygen.

Sonix

1.0.x Programmer's Reference [HTML (no JavaScript) | PDF] This guide is a reference manual for the Sonix C++ API. It shows the C++ interfaces for all classes in Sonix generated using Doxygen. 0.4 Programmer's Guide [PDF | HTML] This guide is a short document to explain some of the basic concepts in Sonix. This is written for the beginning Sonix application developer. It explains how to write effective C++ applications using sound in 3D and virtual reality environments. Programmer's Reference [HTML (no JavaScript) | PDF] This guide is a reference manual for the Sonix C++ API. It shows the C++ interfaces for all classes in Sonix generated using Doxygen.

PyJuggler

1.0.x Getting Started Guide [PDF | HTML] This guide explains how to get started with PyJuggler as a mechanism for writing VR Juggler application objects in Python. It lists the dependencies needed for typical PyJuggler usage and what environment variables need to be set. PyJuggler Programmer Reference The programmer reference presents the PyJuggler API documentation in HTML form. It is generated from Python docstrings in the source code using pydoc. PyGMTL Programmer Reference The programmer reference presents the PyJuggler API documentation in HTML form. It is generated from Python docstrings in the source code using pydoc.

Developers

Developers Juggler Team Guide [PDF | HTML] The Juggler Team Guide is the document for current developers and future developers. It covers everything relevant to developing and contributing to the Juggler Project including building the modules from source, patch submission, and the coding standard. Build System Guide [PDF | HTML] The Build System Guide describes the philosophy and design of the Juggler Project build system. Those developers who need to maintain and extend the global build and the build systems of individual modules must read this book. Note that it is not Doozer++ documentation, and it does not cover general usage.

Tutorials

	VRAC Lab Seminars
	"A GMTL Overview" Author: Justin Hare PowerPoint slides used for an hour-long presentation about how to use the Generic Math Template Library (GMTL). Virtual Reality Applications Center, October 2003
	"Learning VR Juggler" Author: Allen Bierbaum An introductory presentation on VR Juggler programming. Virtual Reality Applications Center, January 1999

	IEEE VR 2003 - Slides
	"VR Application Development Using VR JUggler" Author: Allen Bierbaum and Patrick Hartling A multi-part presentation including an introduction to VR Juggler 2.0, explanations of how to configure and run applications, and an overview of application programming using OpenGL and OpenSG®
	"Using VRJConfig" Author: Patrick Hartling An in-depth review of how to use VRJConfig
	"ClusterJuggler" Author: Allen Bierbaum A discussion of the design and use of ClusterJuggler
	"Using Tweek to Create Graphical User Interfaces in Virtual Reality" Author: Patrick Hartling An overview of Tweek and VRJ VNC and what they offer for adding GUIs to VR applications
	"Sonix: VR Juggler Sound Manager" Author: Allen Bierbaum An introduction to Sonix and a discussion of how to use it in VR Juggler applications
	"Avatars in VR Juggler Applications" Author: Patrick Hartling An explanation of skeletal animation, Cal3D, and the use of vjAvatar in VR Juggler applications

	IEEE VR 2003 - Course Notes
	"Scalable VR Application Authoring" Supplementary material to the tutorial slides. This includes information on how to download & install VR Juggler and on how to write VR Juggler applications using OpenGL, OpenSG®, & OpenGL Performer.

	IEEE VR 2002 - Slides
	"Getting Started with VR Juggler: Introduction and Configuration" Author: Christopher Just An introduction to using and configuring VR Juggler
	"VR Juggler 1.0 Application Programming" Author: Patrick Hartling An introduction to VR Juggler 1.0 application programming using OpenGL
	"VR Juggler Technical Overview" Author: Allen Bierbaum A complete description of VR Juggler internals
	"Collaborative VR: Fundamentals & Experiences" Author: Allen Bierbaum The basics of collaborative VR and lessons learned by the Juggler team
	"Cluster Juggler" Author: Christopher Just, Eric Olson An introduction to Cluster Juggler (which includes the Gadgeteer Remote Input Manager)
	"Travel in Virtual Environments" Author: Kevin Meinert An introduction to implementing travel/navigation in a virtual environment; The Travel Pattern; Travel system design
	"Graphical User Interfaces in Virtual Reality" Author: Patrick Hartling A review of GUIs in VR and an introduction to Tweek
	"Sonification in Virtual Environments" Author: Kevin Meinert An introduction to scientific sonification, methods, and tools

	IEEE VR 2002 - Course Notes
	"Scene Graph Rendering" Author: Dirk Reiners An overview of scene graph technology including OpenSG®
	"VR Juggler Clustering Solution: Net Juggler (and SoftGenLock)" Authors: Emmanuel Melin, Bruno Raffin How to use Net Juggler and SoftGenLock to run a VR Juggler application with active stereo on a PC cluster
	"Travel Systems for Virtual Environments" Author: Kevin Meinert An introduction to implementing travel/navigation in a virtual environment; The Travel Pattern; Introduction to Travel system design
	"Introduction to Sonification in Virtual Environments" Author: Kevin Meinert An introduction to scientific sonification, methods, and tools

	CAVE Workshop
	"Introduction to VR Juggler" Author: Allen Bierbaum, Carolina Cruz-Neira Presented at CAVE Workshop 2000
	"VR Juggler Application Programming" Author: Patrick Hartling, Allen Bierbaum, Carolina Cruz-Neira Introduction to application programming using VR Juggler 1.0 Presented at CAVE Programming Workshop in Stockholm, Sweden, October 2001
	"VR Application Development Using VR Juggler" Author: Allen Bierbaum, Patrick Hartling Introduction to application programming using VR Juggler 1.1 DR3 Presented at CAVE Programming Workshop in Aalborg, Denmark, October 2002