Vorlesung OpenGL mit Java von Prof. Dr. W. Kowalk / Übung bei Malte Mathiszig

Transkript

1 Vorlesung OpenGL mit Java von Prof. Dr. W. Kowalk / Übung bei Malte Mathiszig Semesteraufgabe von Jonas Jacobi und Dennis Heidsiek jonas.jacobi@web.de HeidsiekB@aol.com 9. August 2006 Inhaltsverzeichnis I LiesMich / Installationshinweise 2 1 Vorausgesetzte Software 2 2 Programmstart 2 3 Übersicht über die gegebene Packet-Struktur 3 4 Empfohlene Highlights 3 5 Verbesserungen seit der Präsentation im Hörsaal 3 II Aktueller Stand 4 6 ToDo s bis zur 1. Präsentation (Heisse Phase) Features mit hoher Priorität Features mit niedriger Priorität Erledigte Features III Entwurf vom (Aufgabe 19) 6 7 Einleitung 6 8 Grundsätzliches Grundliegende Ziele Daraus resultierende Designentscheidungen

2 9 Ausführlichere Beschreibung ausgewählter Highlights Active Rendering Das Packet jjdh.opengl.meshes Mehrstufige Rending - Pipeline Einlesen eines externen Grafikformates Grafische Effekte Gute Benutzbarbeit Deployment Teil I LiesMich / Installationshinweise 1 Vorausgesetzte Software 1. Sie benötigen Java (JRE oder SDK) in der Version 5.0 oder höher: 2. Unser Programm benötigt zwingend die neue JOGL-Version (JSR-Beta 5 oder höher): Das alte JOGL (Version oder älter) wird nicht mehr unterstützt! Die Beta 5 ist bereits in diesem Download mitgeliefert; die jeweils aktuellste JOGL-Version finden Sie hingegen auf der Website 3. Damit auch die Vertex Shader Effekte unseres Programmes funktionieren, müssen sie zudem noch vor dem eigentlichen Programstart das NVIDIA Cg Toolkit installieren: Dieser Schritt ist zwar nicht unbedingt notwendig, wird jedoch aus den oben genannten Gründen empfohlen. Wird das Cg Tookit nicht installiert, sind die Programme im Launcher mit der Endung withcg nicht lauffähig! 2 Programmstart Es gibt viele unterschiedliche Methoden, unser Programm zu starten: Am einfachsten ist die Variante über Java Webstart. In diesem Fall werden die benötigten Libaries und Natives automatisch ermittelt und heruntergeladen. Sie müssen lediglich die folgende Datei in ihrem Browser öffnen: Unser Program läuft auch lokal als ausführbare JAR - Datei. Diese Distribution finden sie in eclipse/out/bin. Sie müssen nur noch die entsprechenden Natives aus dem Ordner JOGL-Natives in diesen Ordner kopieren; anschliessend lässt sich das Programm einfach durch einen Doppelklick auf die Datei jjdh.jar bzw. durch den Kommandozeilen-Befehl 2

3 java -jar jjdh.jar starten. Diese Variante hat den Vorteil, dass sie auch ohne eine Integration unseres Projektes in Eclipse funktioniert. Alternativ könne sie unser Program auch in Eclipse importieren und das Program über den run_bin Befehl der ANT-Datei starten. Hierfür müssen sie jedoch noch einige Projektspezifische Einstellungen (Import der benötigten Libaries und Natives) in Eclipse vornehmen. Dies wird im folgenden Abschnitt (dritter Absatz) genauer beschrieben. 3 Übersicht über die gegebene Packet-Struktur Im Ordner abgegeben befinden sich die älteren Versionen unseres Programms, die wir jeweils im Rahmen der Übungsaufgaben an unseren Tutor abgegeben haben. Im Ordner dokumentation befinden sich die Sourcen für dieses Dokument sowie die während der Präsentation im Hörsaal verwendeten Folien als PowerPoint Datei. Im Ordner eclipse befindet sich die Developer Version unseres Programms. Diese entspricht den üblichen Konventionen eines Eclipse - Projektes, so dass unser Projekt direkt in eine gegebene Eclipse-Installion importiert werden kann. Die benötigten JAR-Libaries (4 Stück) befinden sich dabei in res/lib/jogl und res/lib/ogg-verbis. Zudem müssen u. U. noch die aktuellen JOGL-Natives für Ihr System eingebunden werden. Insbesondere sei hier auch auf unsere ausführliche, modulare und dokumentierte ANT-Datei verwiesen, die eine Vielzahl unterschiedlicher Aufgaben (Compilieren, Javadoc erzeugen, Webstart- Distribution erzeugen etc.) automatisiert. Die build.xml kann direkt aus Eclipse heraus geöffnet und gestartet werden. Alternativ kann sie auch mit einer Standallone-Version von ANT benutzt werden. Im Ordner JOGL-Natives befinden sich die aktuellen JOGL-Natives (in der Version JSR- Beta 5) für eine Vielzahl aktueller Betriebssysteme. 4 Empfohlene Highlights In jedem Programm wird durch einen Druck auf die k - Taste die aktuelle Tastaturbelegung (die von Programm zu Programm variieren kann) angezeigt. Empfehlenswert ist insbesondere das Programm FinalPresentationWithCG bzw. FinalPresentation (in diesem Fall ohne die Vertex-Shader Effekte). Hier finden sie die meisten Hightlights unseres Programmes in kompakter Form. Des weiteren möchten wir auch auf unser Javadoc (befindet sich im Ordner eclipse/doc hinweisen, welches einen groben Eindruck über unser Programm vermittelt. 5 Verbesserungen seit der Präsentation im Hörsaal Hier finden sich diverse Verbesserungen, die wir aus Zeitgründen bei der Präsentation im Hörsaal lediglich erwähnt, aber nicht präsentiert und jetzt ins Programm integriert haben: 1. In der FinalPresentation findet sich jetzt ein Beispiel für das Rendern beliebiger Swing- Komponenten in JOGL (zwischen dem MountKowalk und dem Flaggeneffekt). 3

4 2. Über der Kirch gibt es einen weiteren TriggerPoint, welcher das Rendering einer Real- World - HTML Datei aus dem Internet demonstriert. Zudem wird gleichzeitig eine längere OGG-Datei abgespielt, wobei alle periodisch zwischen laut und leise gewechselt wird. 3. Beim MD2-Trigger Point erscheinen jetzt gleich drei animierte MD2s gleichzeitig (Saurai, TeleTubby, BobbaFett). Witzigerweise machen diese sogar mehr oder weniger synkrone Bewegungen, da alle Dateien usprünglich aus Quake-Skins stammen. 4. Mit der e Taste kann jetzt in einen Skelett - Modus umgeschaltet werden. Dies ist insbesondere beim Mount Kowalk interessant, da so die Tesselation der verwendeten TrueType Schrift direkt gesehen werden kann. 5. In der Webstart Distribution wurden die Resourcen in eine eigene Datei (jjdh-data.jar) ausgelagert, in der jjdh.jar (geproguardete Version von jjdh-normal.jar) befinden sich nur noch die.class Dateien, um so ein geringeres Downloadvolumen bei Updates der Webstart-Version zu erreichen. Das ANT-Skript und unser Abstraktion des Resourcen - Management wurden entsprechend modifiziert. Teil II Aktueller Stand 6 ToDo s bis zur 1. Präsentation (Heisse Phase) Aufgelistet werden jeweils das Feature, der Primär- (aber natürlich nicht Allein-) Verantwortlicher sowie eine kurze Einschätzung des Status. Dieses Liste ist als Wiki und -Ersatz gedacht. Sie sollte also ständig aktualisiert werden und somit den aktuellen Status widerspiegeln. 6.1 Features mit hoher Priorität Hier stehen die wichtigsten der aktuell noch offenen Punkte: () - () Features mit niedriger Priorität Hier finden sich angedachte und noch nicht implementierte Features, die aus Zeitgründen wahrscheinlich nicht mehr zu schaffen sind: Sound loopen bzw. n-mal hintereinander spielen (Dennis) -? Billigen Schatten implementieren () -? Sound Visualisation Partikel Engine (Dennis) -? 4

5 Selektion / Piking von Objekten (Jonas) - Bump - Mapping () -? Height - Mapping () -? Loader für Quake 3 Karten (Jonas) -? Morphing von Meshes ineinander () -? State Sorting () -? One Big NIO - Buffer (Dennis) -? Kollisionserkennung () -? () -? () -? 6.3 Erledigte Features Die hier aufgelisteten Features sollten im Prinzip erfolgreich implementiert sein: Folien für die Präsentation erstellen (Jonas und Dennis) - Public final Für die Folien soll eine einheitliche Formatforlage benutzt werden (Dennis). Technische Vorgabe: Breiter als hoch und möglichst quadratisch. Zudem sollte auch eine absolute Grössenangabe ( width = 512 ) vorhanden sein, damit das JEdorPane richtig rendern kann (und nicht alles in eine Zeile packt ;-). Alle Effekte in ein grosses Programm integrieren (Jonas und Dennis) - Public final Dabei soll die neue Sceengraph API genutzt werden. Zudem umfasst dieser Punkt insbesondere auch die Wiederverwertung / das Recyceln von altem Code. Für die Reihenfolge gilt die folgende Roadmap: Grundlegende Struktur anlegen (Jonas und Dennis) Erledigt OnOffNode (Dennis) Erledigt Triggering (Jonas) Erledigt Landschaft / Heightmap integrieren (Jonas) Erledigt NewSkybox integrieren (Dennis) Erledigt Folien in die Lanschaft stellen (Dennis) Animierte MD2 Meshes integrieren (Dennis) Erledigt Schriften integrieren (Dennis) Erledigt Spiegel integrieren (Jonas) Erledigt Zusätzliche Camera integrieren (Jonas) Erledigt SimleSceengraph TreeView integrieren (Dennis) Erledigt () -? () -? Overlay / GlassPane Effekte (Dennis) - Public final 5

6 MD2 s animiert (Dennis) - Public final Arbeit an dieser Dokumentation (Dennis) - Public final Sound stoppen und Lautstärke ändern können (Dennis) - Public final HTML in JOGL rendern (Dennis) - Public final Erstellung von Package - JavaDoc (Dennis) - Public final Vertex - Shader Flag (Jonas) - Public final 2D - Übersichtskarte (Jonas) - Public final Nebel integrieren (Jonas) Public final Sound (Dennis) - Public final Simple Scenegraph (Dennis) - Public final Fountain (Springbrunnen) Partikel Engine (Jonas) - Public Final FramebufferObject Kapselung (Jonas) - Public Final Camera Implementierung (Jonas) - Public final () -? () -? Teil III Entwurf vom (Aufgabe 19) 7 Einleitung Dies ist die Dokumentation des Java Programmes jjdh, welches als Semesteraufgabe von Jonas Jacobi und Dennis Heidsiek in Rahmen der Vorlesung OpenGL mit Java an der Universität Oldenburg entstanden ist. Dieses Dokument ist noch nicht abgeschlossen, so dass u. U. noch grössere Änderungen vorkommen können - insbesondere erhebt es keinen Anspruch auf Vollständigkeit bzw. Verbindlichkeit! 8 Grundsätzliches 8.1 Grundliegende Ziele Die grundsätzlichen Ziele unseres Programm sind: Erreichen einer guten Note (überraschenderweise ;-) Implementierung mehrerer GL - Features 6

7 Effiziente Implementierung, um auch grössere bzw. komplexere Szenen darstellen zu können Gute Ausnutzung alter wie neuer Hardware Ausnutzung von Java Features Gutes Benutzbarbeit und Deployment 8.2 Daraus resultierende Designentscheidungen Da es in der Vorlesung OpenGL mit Java um die Vermittelung von Kenntnissen und Fähigkeiten im Umgang mit OpenGL geht, haben wir uns dazu entschlossen in der Semesteraufgabe eine Lösung zu erstellen, die zum einen möglichst viele verschiedene Techniken zum Erzeugen bestimmter grafischer Effekte mit OpenGL vorführt und die zum anderen moderne softwaretechnische Mittel dazu einsetzt. Wir haben uns dagegen entschieden ein Spiel oder etwas ähnliches zu programmieren, da bei einem solchen Projekt viel Arbeit in Funktionalität fließen müsste, die nicht direkt etwas mit OpenGL und damit den Lernzielen der Veranstaltung zu tun hat (z. B. wäre eine möglichst realisitsche und effiziente Physik - Engine zu implementieren, wass eine nicht triviale Aufgabe darstellt). Die entgütltige Abgabe wird also aller Voraussicht nach aus verschiedenen Teilen bestehen. Es werden ein oder auch mehrere Szenarien erstellt, in denen unterschiedliche Techniken zu sehen sein werden, die eventuell auch über das in der Vorlesung bzw. den Übungen konkret behandelte hinausgehen. Dazu sollen so unterschiedliche Dinge wie Höhenkarten, Bumpmapping, Lightmaps, Spiegel, Flaggen- und Wassereffekte oder auch eine Particle Engine gehören. Durch die Implementierung dieser Features steben wir ein tieferes Verständnis von OpenGL an. Es soll außerdem möglichst einfach sein, neue Szenarien für unsere Engine zu erstellen. Daher soll die Software möglichst in die Lage versetzt werden, extern erstellte 3D-Modelle zu laden und anzuzeigen. Weiterhin werden wir die API so gestalten, dass die Benutzung möglichst leicht und dennoch flexibel ist. So wollen wir gesteigerten Wert auf eine gute objektorientierte Kapselung des OpenGL-Subsystems legen, sowie auf den Einsatz moderner Softwaretechniken wie Design Pattern. zudem haben wir uns entschlossen, das neue JOGL (d. h. die Reimplementierung, um dem JSR zu genügen) einzusetzen und auch von den Sprachfeatures von Java 5 Gebrauch zu machen. 9 Ausführlichere Beschreibung ausgewählter Highlights Hier gehen wir auf verschiedene besonders hervorzuhebende Bereiche unseres Projektes ein. 9.1 Active Rendering Hierbei handelt es sich um den bewussten Verzicht, eine Instanz der Klasse GLAutoDrawable zu benutzen und stattdessen diese funktionalität selbst zu implementieren. Dies ermöglicht 7

8 uns einen erhöhten Einfluss auf den Rendering Prozess, einen massgeschneiderten Ersatz des GLEventListener sowie die besonders gute Aussnutzung von alter wie neuer Hardwae. 9.2 Das Packet jjdh.opengl.meshes Das Paket enthält die Klassen, die zum Erzeugen grafischer Objekte dient. Die Klassen bieten dabei eine größt mögliche Eigenintelligenz, so dass Objekte mit möglichst wenig Aufwand zu erstellen sind. Dabei ist das API allerdings flexibel genug, dass auch seltenere Anforderungen umzusetzen werden können. Beispielsweise lassen sich automatisch Normalen generieren, was bei Bedarf aber auch abgeschaltet werden kann. 9.3 Mehrstufige Rending - Pipeline Einer der primären Ziele unseres Programms ist Effizienz. Damit kommt der konkreten technischen Umsetzung der Klassen aus dem Packet jjdh.opengl.meshes eine besondere Umsetzung zu. Gleichzeitig soll die API jedoch möglichst einfach, flexiblel und objektorientiert sein. Eine effiziente Realisierung ist dagegen die Speicherung gleichartiger Elementarer Bausteine in VertexArrays. Wir planen deshalb eine mehrstufige Rendering Pipeline: die oberste Schicht soll eine einfache Objektorientierte Modellierung von Meshes ermöglichen. Diese sollen dann auttomatisch in VertexArrays (d. h. in Klassen aus dem Packet jjdh.opengl.meshes.buffers) umgewandelt und dabei weitesgehend optimiert werden. Diese Arrays sollen dann als Display- Listen oder VertexArrays (je nachdem, ob sich der Inhalt dynamisch ändern soll) an OpenGL übergeben werden. Dies ist ein anspruchsvolles Problem, auf dass wir aller Vorraussicht nach viel Zeit investieren werden müssen. 9.4 Einlesen eines externen Grafikformates Wir planen, einen 3DS Loader zu implementieren. Dies hätte grosse Vorteile, da dieses Format von fast allen 3D Modellierungsprogrammen gelesen und gespeichert werden kann, so dass unser Program viel leichter erweiterbar wäre. Allerdings hängt dieser Schritt von der vorherigen Implementierung einer guten Rendering - Pipeline ab. Zudem gibt es noch einige offene Fragen zu lösen, wie z. B. die Integration von Texturen in 3DS Dateien. 9.5 Grafische Effekte Wir planen insbesondere die Implementierung einer für viele Effekte nutzbaren und insbesondere leicht erweiter- und anpassbaren Particle-Engine. Zudem planen wir die Unterstützung diverser fortgeschrittener Techniken wie Bumpmapping, Lightmaps, Flaggen- und Wassereffekten. 9.6 Gute Benutzbarbeit Wir planen, die automatische Erzeugung einer kommentierten Tastenbelgung zu implementieren, um den Nuzer so einen möglichst intuitiven Zugang zu unserem Programm zu ermöglichen. Zudem soll ein komfortables Starmenü mit mehreren Optionen für den Benutzer (wie z. B. dem Fullscreen Modus) gweschaffen werden. Der Inhalt dieses Launchers soll dynamisch durch Reflektion zur Laufzeit eingelesen werden. 8

9 9.7 Deployment Unser Program solch für den Endbenutzer als einzelne JAR - Datei verfügbar gemacht werden. Wir planen eine eigene Kapselung für den Zugriff auf Resourcen, so dass unser Programm sowohl als JAR Datei als auch im entpackten Zustand ohne Modifikationen laufbar ist. Zudem soll die JAR - Datei optimiert sein, d. h. wir setzten Deployment Tools wie den Bytecode Optimierer und Verschleierer Proguard ein. Dabei haben wir unseren Build - Prozess durch den Einsatz einer umfanreichen ANT Datei so weit wie möglich automatisiert. Eventuell werden wir auch das Tool OneJar einsetzen uns so die jogl.jar (sowie möglicherweise andere externe Bibliotheken) in unsere Deployment JAR zu integrieren. 9