Contents 1 What to expect 2 Getting started 3 Tutorial examples 3.1 Introductory 3.2 Geometry 3.3 Appearances 3.4 Transformations 3.5 Input / Output 3.6 Tools 3.7 Lights and cameras 3.8 Audio 3.9 Viewers 3.10 Graphical user interface 3.11 Other topics 3.12 Sample projects

What to expect

This tutorial is designed to help you learn how to write Java applications using the jReality package. You should already know how to program in Java. If you work through the examples shown here, you'll be able to create your own hierarchical scene graphs and populate them with a wide variety of geometry, appearances and transformations. You'll learn how to set camera and lights. You'll also learn how to write your own interactive tools and insert them into the scene graph. Finally you'll learn helpful tips for optimizing your performance and avoiding some common pitfalls.

Most of the tutorials demonstrate how to do a certain thing in jreality, based on a short code example.

Bold tutorial links contain documentation or detailed background information.

Suggestions and corrections to gunn at math.tu-berlin.de.

Getting started

You can check out the current jReality source tree using the Subversion source control utility. Use the server

http://fs.math.tu-berlin.de:8000/svn/jreality

For anonymous access login as user guest with empty password.

The trunk contains an eclipse project, see the Eclipse set-up tutorial on how to get everything running in eclipse.

For command line usage, consult this document, which also gives directions for installing JOGL, a java package which jReality uses to obtain hardware accelerated rendering.

As you work through this tutorial, you may wish to consult the following documents which describe more conceptually how jReality works:

• an overview of jReality features, and
• a more detailed look at the jReality scene graph.
• JavaDoc browser for the jReality package.

Tutorial examples

Each of the following tutorial examples is structured as follows:

• A link to the full source code of the Java class in the de.jreality.tutorial directory,
• Optional links to the JavaDoc of the jReality classes featured in the tutorial class,
• A link to run the tutorial example as a Java webstart,
• Commentary on selected parts of the source code, and
• A screenshot showing the intended result of running the tutorial example (not always present).

The Java classes which are contained in this tutorial can also be found in the jReality source tree under the folder src-tutorial if you wish to work with them directly. They can all be run as standalone Java applications.

Introductory

• Introduction to jReality programming. The following sequence of tutorial examples is designed to teach you the basics of jReality programming. It is generally modeled on the User Tutorial. Here, you will learn how to program the capabilities that you there learned how to activate interactively. (Old version here.)
  • Run the JRViewer application
  • Loading and Displaying a geometry
  • Set material properties with appearances
  • Set material properties with shader interfaces and add a tool
  • Set the camera
  • Construct a geometry
  • Apply a texture
  • Use a transformation

Geometry

• Use geometry factories
  • Use a point set factory
  • Use an indexed line set factory
  • Use an indexed face set factory
    • Attach face colors using a factory
    • Unwrap a geometry using a factory
  • Use a quad mesh factory
  • Use a parametric surface factory
  • Use a tube factory
  • Use a ball and stick factory
  • Use a thickened surface factory
  • Use a geometry merge factory
• Use a clipping plane
  • Use a slice box
• Display 3D text

Appearances

For an introduction to the use of appearances in jReality, see the introductory tutorial (this section and this section). The following examples assume you have mastered the fundamentals presented there.

• Use a geometry shader
• The default shaders
  • Use the default point shader
  • Use the default line shader
  • Use the default polygon shader
• Use a non-default shader
• Use a 2d texture
• Use an animated 2d texture
• Use a skybox and reflection map
• Use an OpenGL Shading Language shader
• Use vertex arrays in JOGL backend
• Use shaded lines in JOGL backend
• Use the root appearance
• Use vertex colors an a point set
• Set simple Background
• Inheritance appearance

Transformations

• Introduction To Transformations
• Use the MatrixBuilder class
• Use a transformation listener

Input / Output

• How to use a reader
• How to write and register a custom reader

Tools

• Most developers will be content to write specific tools.
  • Tools introduction
  • Add a ready-made tool
  • Use the DragEventTool
  • Write a simple tool
  • Write a texture dragging tool
  • Write a 3D paint tool
  • Use the mouse-over input slot
  • Write an animation tool
  • Write a model tool
  • Write an add points tool
  • Write an input segments tool
  • Write an map navigation tool
• Developers who want to add new devices need to learn about the tool system.
  • Toolsystem introduction
  • Install a simple Gamepad
  • How to use a Spacenavigator

Lights and cameras

• Use a point light
• Use a spotlight
• Use a camera path
• Use a camera listener

Audio

• The jReality audio rendering pipeline
• Writing applications with audio
• Writing audio sources
• Odds and ends
• Open Sound Control

Viewers

• Create a simple JRViewer (the most recommended one)
• Add VR functionality
• Extract viewer from JRViewer
• Create a standalone viewer
• Use selection capabilities
• Mix JOGL graphics with 2D Java graphics
• Use accelerated 2d textures with JOGL backend

Graphical user interface

JReality provides a plugin-based system to create user interfaces.

• Adding panels for user interaction to JRViewer
  • Add a slider for some parameter
  • Add an inspector for a factory
• Use the full power of jReality's plugin system
  • Plugins getting started
  • The JRViewer plug-in set
  • Persistence of Plugins
  • Change/Override content tools
  • Internal frame-size test
  • Adding a shrink panel widget
  • Menu bar and tool bar items
  • Adding a preference page
  • Adding a help page

Other topics

• Explore noneuclidean geometry
• Use JLink to read from Mathematica
• Use jReality with jruby
• Use jReality with jython
• Use jReality with groovy

Sample projects

• Polygon Editor
• Darboux transform
• Discrete K-surfaces tutorial

Previous: Main Page Developer Tutorial: Contents Next: [[]]