VRML programmieren

• benötigt den Text des offiziellen ISO 14772 Standard (oder ein gutes Buch über VRML97)
• erfordert, dass man Konzepte wie Modularisierung und Datentypen verstanden hat
• kann man in "javascript", weil es bequem ist
• geht auch in java, wenn man höhere Anforderungen hat
• erfordert dass man zum Texteditor greifen muss,
  wobei "Cosmoworlds" ein Programmgerüst liefern kann.

Inhalt:

• Blick in den Standard
• Eventinformation
• Datentypen
• Modularisierung
• Ein Einstieg in "javascript"
• Umgang mit Cosmoworlds und Texteditor
• Fehlersuche in Cosmoplayer

Blick in den Standard

Betrachtet man einen VRML Knoten (hier der häufig benutzte "Transform" Knoten, der z.B. für Verschiebung, Drehung usw. zuständig ist) im offizellen VRML97 Standard ISO/IEC 14772 (in der Liste der VRML Knoten unter http://www.web3d.org/x3d/specifications/vrml/ISO_IEC_14772-All/part1/nodesRef.html#Transform )

• Die Eventinformation ist wichtig um entscheiden zu können, wie verschiedene VRML Knoten über Events (Nachrichten) miteinander verbunden werden können.
  
• Die Information über den Datentyp, die verhindert, dass Nachrichten ausgetauscht werden können, die nicht zueinander passen.
• Den Fieldname, der zur eindeutigen Kennzeichnung dient.
• Den Defaultwert, der benutzt wird, wenn der VRML Knoten benutzt wird, ohne dass diesem Fieldname expliziet ein Wert zugewiesen wird (eventIn und eventOut Fieldnamen haben keinen Defaultwert).
• Der Wertebereich, der zeigt, welche Werte für diesen Fieldname zulässig sind.

Eventinformation

Vergleicht man die Notation im Standard mit dem Bild, dass sich in Dune

• eventIn: dieser Fieldname kann eine Nachricht empfangen
• eventOut: dieser Fieldname kann eine Nachricht verschicken
• exposedField: dieser Fieldname kann sowohl eine Nachricht empfangen als auch verschicken
• field: dieser Fieldname kann weder Nachrichten empfangen noch verschicken.
  Das deutet häufig darauf hin, dass die Berechnung der entsprechenden Daten aufwendig ist. Da sich der Wert während des Programmlaufs nicht ändern kann, muss diese Berechnung nur einmal beim Programmstart durchgeführt werden.

Datentypen

Datentypen sind ein wichtiges Programmierprinzip. Sie verhindern, dass Daten ausgetauscht werden können, die nicht zueinander passen.

Es macht zum Beispiel in der Regel wenig Sinn, wenn eine Zeitinformation (ein Wert) einer Verschiebung (drei Werte) zugewiesen werden soll. Über dieses einfache Beispiel hinaus gibt es noch feinere Unterscheidungen.
Betrachtet man die Liste aller möglichen Datentypen in VRML, wie in http://www.web3d.org/x3d/specifications/vrml/ISO_IEC_14772-All/part1/fieldsRef.html#Introduction

• SFVec3f: Dieser Datentyp ist für drei zusammengehörende beliebige (Fliesskomma-)Zahlen zuständig.
  Beispiel: translation von Transform representiert eine Verschiebung.
• SFRotation: Dieser Datentyp ist für Rotationen (vier Werte: Drehachse und Winkel) zuständig.
  Beispiel: rotation von Transform representiert eine Drehung
• SFColor: Dieser Datentyp ist für drei zusammengehörende (Fliesskomma-)Zahlen im Wertebereich zwischen 0 und 1 zuständig. Die 3 Zahlen sind dabei den Farben Rot, Blau und Grün (RGB). Dabei bedeuten zum Beispiel:
  • 0.0 0.0 0.0 Schwarz
  • 0.5 0.5 0.5 Grau genau zwischen Schwarz und Weiss
  • 1.0 1.0 1.0 Weiss
  • 1.0 0.0 0.0 pures Rot
  • 0.0 1.0 0.0 pures Grün
  • 0.0 0.0 1.0 pures Blau
  Beispiel: diffuseColor von Material ist die Farbmaterialeigenschaft für diffuses Licht.
• MFNode: Dieser relativ häufig vorkommende Datentyp beschreibt eine Aufzählung von VRML-Knoten.
  Beispiel: children von Transform representiert die VRML Knoten, die durch einen Transformknoten bewegt werden.
• SFBool: Dieser Datentyp kann nur einen von zwei verschiedene Werte enthalten: TRUE (wahr) oder FALSE (falsch).
  Beispiel: isOver vom Touchsensor verschickt die Information, ob sich die Maus (bzw. "Zeige-Gerät") über dem Touchsensor befindet, oder nicht.
• SFInt32: Dieser Datentyp kann nur einen ganzzahligen Wert enthalten (zum Beispiel -5, 0, 1, 2).
  Beispiel: whichChoice vom Switchknoten. Er schaltet zwischen verschiedenen VRML Knoten (deren Liste in choice angegeben werden) um. Dabei wird wie in VRML/Java üblich mit der Zählung mit 0 begonnen. Negative Werte bedeuten hier, dass kein VRML Knoten aus der Liste gezeigt wird.
• SFFloat: Dieser Datentyp kann eine beliebige (Fliesskomma) Zahl enthalten (zum Beispiel -3.141, 0.5, 1.0). Dieser Datentyp ist einer der häufigsten im VRML Standard.
  
• MFString: Dieser Datentype enthält eine Aufzählung von einzelnen Textbausteinen.
  Die einzelen Textbausteine werden dabei von " und " eingeschlossen (z.B. "das ist ein String")
  Beispiel: url von Inline enthält eine Reihe von WWW-Adressen, die nacheinander durchprobiert werden, solange bis eine gültige Adresse gefunden wird.

Modularisierung

Modularisierung ist wahrscheinlich das wichtigste Programmierkonzept überhaupt. Man versteht darunter die Kunst, ein Problem in isolierte Teilprobleme zu unterteilen und dabei Übersichtlichkeit, Wartbarkeit und Wiederverwendbarkeit zu fördern.

Modularisierung bedeutet nicht nur, Programme in verschiede Dateien aufzuteilen, sonder auch, übersichtliche Einheiten innerhalb einer Datei zu bilden. VRML verfügt deshalb über mehrere Möglichkeiten zur Modularisierung:

• Inline
  Ist die einfache Möglichkeit, ein anderes VRML-File mit seiner URL (URL=Universal Resource Locator: "webadresse" (z.B. "http://www.csv.ica.uni-stuttgart.de/vrml/scenegraph.wrl", kann aber auch ein Filenamen auf dem lokalen Rechner sein (z.B. "file:/tmp/test.wrl")) (beschrieben üder den Fieldname url) an einer bestimmten Stelle in den Szenengraph einzubinden.
  Das Programm Cosmoworlds besitzt über File -> Import as Inline eine direkte Unterstützung fuer den Inline Knoten. Der sehr mächtige Inline-Editor erlaubt es sogar, ein VRML-File über Inlines in mehrere Files zu zerteilen. Die einzelnen Files k&ouuml;nnen dann von Programmen mit VRML-Lesefähigkeit weiterbearbeitet werden und später wieder ins ursprüngliche VRML File zurückgedrückt werden.
  Verglichen damit ist die Unterstützung fuer den Inline Knoten im Programm Dune ist minimal.
• PROTO
  Der PROTO Befehl erlaubt es, sich eigene neue VRML Knoten aus den bestehenden VMRL Befehlen zu zusammenzubasteln und dabei alle Featueres wie Eventinformation, Datentypen, interne ROUTE's usw. zu verwenden.
  
• EXTERNPROTO
  EXTERNPROTO Befehl verbindet die Eigenschaften von PROTO und Inline, so dass neue VRML Knoten über eine URL erreichbar sind. Damit lässt sich eine Programmbibleotheken im Internet aufbauen.

Die Benutzung eines fertigen PROTO/EXTERNPROTO kann einem allerdings viel Arbeit abnehmen, deshalb hier ein Beispiel.

Cover/Covise bietet für die Unterstützung immersiver Umgebungen einen 3D RaumSensor an, der laut Standard nicht existiert (Obwohl man legale Erweiterungen zum VRML Standard über PROTOs implementieren kann (der VRML Browser erkennt "seinen" Knoten, alle anderen VRML Browser benutzen das PROTO)).
Der Cover/Covise funktioniert wie der PlaneSensor, leider existiert noch kein genau entsprechendes PROTO, aber es existiert ein ähnliches SpaceSensor-PROTO als Emulation mit 2D-VRML-Browsern.

Für die Benutzung eines EXTERNPROTO benötigt man einen Header und entsprechende Benutzung. Für den emulierten SpaceSensor laden Sie sich das File http://www.csv.ica.uni-stuttgart.de/vrml/programming/externproto_header_und_aufruf.wrl

#VRML V2.0 utf8

#Header 

EXTERNPROTO SpaceSensor [
   eventOut     SFVec3f translation_changed
   eventIn      MFNode addChildren
   eventIn      MFNode removeChildren
   exposedField MFNode children
   field        SFVec3f bboxCenter
   field        SFVec3f bboxSize
   ]
   [ 
     "urn:www.csv.ica.uni-stuttgart.de:library:SpaceSensor",
     "SpaceSensor.wrl",
     "http://www.csv.ica.uni-stuttgart.de/vrml/spacesensor/SpaceSensor.wrl" 
   ]

#Benutzung

SpaceSensor {}

Achten Sie darauf, dass die erste Zeile mit "#VRML V2.0 utf8" beginnt, sonst sind seltsame Fehlermeldungen wie "File is empty" vorprogrammiert.
Betrachten Sie den Header des PROTO und vergleichen sie ihn mit der Spezifikation im VRML Standard für den "Group"-Knoten. Er ist identisch, nur dass zusätzlich noch das Feld "translation_changed" vorkommt, entsprechend dem "PlaneSensor"-Knoten.

Es gehört zur Wartbarkeit von Programmen, ähnliche Dinge entsprechend zu benennen und etwas Zeit in das Suchen nach sinnvollen Bezeichnungen zu investieren.

Dieses PROTO läuft auch nicht anders, wenn statt der Bezeichnung "translation_changed" zum Beispiel "Kartoffelpuffer", "Tuba" oder "Klapperstorch" gewält worden wäre. Berüchtigt sind auch Namen wie "a17", "h25" usw. ("da musste man nicht so viel tippen"). Einem Benutzer der VRML Welt bleiben diese Namen in der Regel verborgen. Trotzdem würde man bei solchen Namen sagen, dass es sich um ein "schlecht geschriebenes" Stück Software handelt.

Übrigens werden die www-Adressen unterhalb des PROTO-Headers nacheinander durchlaufen. Hier kommt zuallererst eine Adresse, anhand derer ein VRML Browser eigene Erweiterungen erkennen kann. Liegt das nicht vor, versucht er, das VRML File von der Platte zu laden, ansonsten wird das File aus dem Internet geladen.

Das Feld "children" des SpaceSensors bedeutet, dass an diesem Punkt die VRML-Nodes eingefügt werden müssen, der Szenengraph sieht dann so aus:

(beim SpaceSensor von Cover/Covise, der wie ein PlaneSensor funktioniert, sieht der Szenengraph übrigens so:

aus, leider kann man das nicht so einfach über ein PROTO emulieren)

Die Felder "addChildren" und "removeChildren" bedeuten analog zum "Group"-Knoten, dass zur Laufzeit VRML-Nodes eingefügt oder entfernt werden können (wird hier nicht benutzt).

Die 2D Emulation des 3D SpaceSensors erfordert die Parameter einer sogenannten "Bounding Box".
Damit ist die Grösse und Position des Würfels gemeint, der ein VRML Objekt gerade noch einschliesst. Cosmoworlds kann Bounding Box Daten liefern. Starten Sie dazu Cosmoworlds und benutzen Sie File -> Import für irgendeinen einzelnen VRML Körper, dem Sie den SpaceSensor zuordnen wollen.
In der Windowsversion von cosmoworlds muss die Bounding Box "zu Fuss" mit Hilfe der Gitter ungefähr abgelesen werden. Bei diesem Problem ist es nicht wichtig, wenn das Gitter etwas grösser als das Object ist. Benutzen Sie placement -> Grid Properties ... , um die jeweiligen Längen abzulesen.
Hier kann man zum Beispiel eine Boundingbox von x=6/y=2.5/z=4 ablesen.

Da hier die Struktur des Szenengraphen entscheidend ist, ist Dune (obwohl seine Unterstützung für EXTERNPROTO nur sehr düftig ist) die bessere Wahl. Da (älteren Versionen) von Dune (noch) das (vollständige) File -> Import von Cosmoworlds fehlt, muss man ggf. das File mit EXTERNPROTO Header und Benutzung und das File mit dem VRML Körper vorher zusammenfügen. Das könnte man in einem Texteditor machen, am einfachsten geht es per Cut and Paste über die Kommandozeile.
Unter Unix artigen Betriebssystemen benutzt man zum Beispiel

cat externproto_header_und_benutzung.wrl vrmlkoerper.wrl > protobenutzung.wrl

copy externproto_header_und_benutzung.wrl+vrmlkoerper.wrl  protobenutzung.wrl

BUG: Currently, EXTERNPROTO definitions are not read
BUG: Default field values are incorrect
using [] as default  field value
BUG: Currently, EXTERNPROTO definitions are not read
BUG: Default field values are incorrect
using 0.0,0.0,0.0 as default SFVec3f field value
BUG: Currently, EXTERNPROTO definitions are not read
BUG: Default field values are incorrect
using 0.0,0.0,0.0 as default SFVec3f field value

Zuerst füllen Sie das "children" Feld. Dazu verschieben Sie einfach im Scenengraphen den VRML Körper in den SpaceSensor.

Dass der VRML Körper jetzt nicht mehr zu sehen ist, ist immerhalb normaler Parameter und liegt daran, dass white_dune EXTERNPROTO Benutzungen (noch) nicht anzeigt.

Danach übertragen Sie die vorher abgelesenen Bounding Box Werte (10 stellige Genauigkeit ist sicher nicht notwendig), die in Cosmoworlds zu sehen sind.

Einen Körper zu verschieben ist aber nicht der eigentliche Sinn eines SpaceSensors. Die Information über das Verschieben soll zugäglich gemacht werden. Also benutzen Sie den RouteView von dune (ggf. View -> Route View) um translation_changed des SpaceSensors in die Transform->scale (Vergrössern/Verkleinern) eines anderen Objektes zu leiten.

Beim Aufprobieren mit Preview können Sie sowohl ein erwartetes

als auch ein unerwartetes Ergebnis

sehen. Der tiefere Grund liegt darin, dass er erlaubte Wertebereich bei scale von Transform zwischen 0 und Unendlich liegt. Liegt eine der Grössen < 0, kann zum Beispiel bei Cosmoplayer durch Drücken der "\" Taste eine entsprechende Fehlermeldung angezeigt werden.

* Transform with illegal scale factor (-4.853672, -1.353548, 3.326290) encountered.

Um zu Vermeiden, dass der Fehler auftritt, kann man Scriptprogrammierung benutzen.

Ein Einstieg in "javascript"

Das in einen VRML Browser eingebaute "javascript" wird auch als "VRML-Script" bezeichnet, da die HTML spezifischen Befehle von "javascript" im VRML-Browser nicht funktionen (sollten) und gegen VRML spezifischen Befehle ausgetauscht wurden. Offiziell heisst diese Computersprache "ECMA-Script", nach dem gleichnamigen Normierungsgremium der Europäischen Gemeinschaft.

Die wichtigsten Konstruktionen in "javascript" sind:

• Zuweisungsbefehle:
  haben die typische Form
  

     linke_seite = rechte_seite ;
  

  
  Dabei wird der Ergebnis von rechte_seite berechnet und auf linke_seite übertragen.
  
  Dabei kann die linke_seite sein:
  • variablenname
  • arrayname[index]
    Das bedeutet, dass der index'te Bestandteil eines Arrays (Liste) oder eines Datentyps, der mehrere Werte aufnehmen kann (z.B. mit dem Datentyp SFVec3f oder SFRotation) gemeint ist. In javascript beginnt die Zählung mit 0, das heisst das erste Element des Arrays hat den Index 0, das zweite Element den Index 1 usw.
  • sfnode_variable.fieldname
    Diese eher selten benutzte Konstruktion bedeutet, dass die Variable sfnode_variable vom Typ SFNode dazu genutzt werden kann, um ohne den ROUTE Befehl Daten an den fieldname eines VRML-Knoten zu übergeben/(bzw. von VRML-Knoten zu lesen).
    Ein Beispielsfragment findet sich unter http://tecfa.unige.ch/guides/vrml/vrml97/spec/part1/javascript.html#AccessingOtherNode
    
  Dabei kann die rechte_seite sein:
  • variablenname
  • arrayname[index]
  • sfnode_variable.fieldname
    
  • funktionsaufruf(argument1,argument2,usw.)
    klasse.funktionsaufruf(argument1,argument2,usw.)
    Hierbei wird eine vorher definierte oder in die Sprache eingebaute Funktion aufgerufen. Typische Aufrufe sind z.B. Math.random(), Math.sin(3.141) oder Math.max(x,y). Details dazu finden sich unter http://www.el-mundo.es/internet/ecmascript.html
    Speziell bei VRML ist noch die Browserklasse wichtig, (siehe http://tecfa.unige.ch/guides/vrml/vrml97/spec/part1/javascript.html#TableC.1)
    Beispiele dafür sind:
    
    • Browser.createVrmlFromString('Sphere {}')
      Erstellt einen neuen VRML-Knoten (Typ MFNode so dass zu Group.children reroutet werden kann)
    • Browser.getCurrentFrameRate()
      liefert die Zahl der Neuzeichnungen des Fensters zurück. Das kann genutzt werden, um über einen Switch-Knoten auf weniger detailierte Objekte umzuschalten.
  • alle bisherigen Konstruktionen verbunden mit mathematischen Operatoren wie + - * / sowie Klammerung. Es gilt wie in der Mathematik ueblich, Punkt vor Strich.
  Ein typisches Beispiel für einen Zuweisungsbefehl ist:

      
   translation_changed[0]=value*Math.sin(value);
  



• Verzweigungsbefehle:
  haben die typische Form
  

      
     if (rechte_seite1 vergleichsoperator rechte_seite2)
        {
        irgendwelche_befehle1;
        irgendwelche_befehle2;
        usw.
        }
     else
        {
        irgendwelche_befehle3;      
        irgendwelche_befehle4;
        usw.      
        }
  

  
  Wobei der gesamte else-Zweig weggelassen werden kann.
  Dabei wird abhängig von Ergebnis des ersten Befehls (wahr oder falsch) entweder der folgende oder der else-Zweig ausgeführt.
  Typische Vergleichsoperatoren sind:
  • == gleich
  • != ungleich
  • < kleiner
  • <= kleiner gleich
  • > grösser
  • >= grösser gleich
  Für rechte_seite1 und rechte_seite2 gilt das bei rechte_seite der Zuweisungsanweisung Gesagte.
  Ein typisches Beispiel ist:

      
  if (value < 0.5)
     {
     switch_wert=0;           
     } 
  else
     {
     switch_wert=1;           
     } 
  

• Schleifen:
  haben die typische Form:

  for ( anfangsbefehl ; vergleich ; inkrementbefehl )
     {
     irgendwelche_befehle5;
     irgendwelche_befehle6;
     usw.
     }
  

  
  Dabei ist anfangsbefehl der Befehl, der beim Betreten der Schleife ausgeführt wird, vergleich ein Vergleich wie bereits bei der Verzweigung kennengelernt um zu Entscheiden, ob die Schleife abgebrochen wird und inkrementbefehl der Befehl, der nach jedem Schleifendurchlauf weiterschaltet.
  Ein typisches Beispiel ist:

  for (i=0;i<3;i=i+1)
     {
     vec3f1[i]=vec3f2[i];
     }
  

  Das entspricht den einzelnen Zuweisungen
  

     vec3f1[0]=vec3f2[0];
     vec3f1[1]=vec3f2[1];
     vec3f1[2]=vec3f2[2];
  

Umgang mit Cosmoworlds und Texteditor

Um einen Scriptknoten mit Javascript zu erstellen ist sehr viel mehr nötig, als die bisher kennengelernten Befehle.
Glücklicherweise ist Cosmoworlds in der Lage, einem den Hauptteil dieser Arbeit abzunehmen.


Klicken Sie (ggf. nach dem Einschalten von View -> Toolbars -> Create) auf das Script Icon ("Open Script Editor") Es erscheint



Tragen Sie einen neuen Scriptnamen ein.

und klicken Sie auf das javascript icon. Danach klicken Sie auf das "Edit Script" icon.

Jetzt müssen Sie Eventinformation, Datentyp und den Fieldname eingeben. Wir entschliessen uns, SFVec3f unseres SpaceSensor EXTERNPROTOs zu verarbeiten (eventIn).

Bevor dem nächsten Klicken auf "Add" machen wir uns klar, scale von Transform ( http://tecfa.unige.ch/guides/vrml/vrml97/spec/part1/nodesRef.html#Transform als Ziel (eventOut) zu benutzen (Datentyp SFVec3f).

Das Fenster mit der Vorlage mit dem Scriptknoten sieht jetzt so aus:

Die Werte des eventIn meine_translation_in stehen jetzt in der Variable value der Funktion meine_translation_in, die Ausgabewerte zum eventOut meine_scale_out werden in meine_scale_out[0], meine_scale_out[1] und meine_scale_out[2] erwartet, da es sich dabei um den Datentyp SFVec3f (3 Werte) handelt.
Um den Fehler mit den negativen Scalewerten entschliessen wir uns zum Testen des jeweiligen Eingabewertes gegen grösser Null. Wenn ja, setzen wir den Scalewert auf den jeweiligen Eingabewert, sonst auf 0.1.


function meine_translation_in(value, time)
{
   for (i=0;i<3;i++)
      {
      if (value[i]>0)
         {
         meine_scale_out[i]=value[i];
         }
      else
         {
         meine_scale_out[i]=0.1;
         }
      }
}



Nachdem wir dieses Programmstück in den Editor eingegeben haben, Danach drücken wir den Reiter "Parse Script" um Fehler zu finden.

Das ist nicht der Fall.

Wenn alles fehlerfrei ist, speichert man das VRML File (z.B. als script.wrl) ab, und verbindet es mit dem bisherigen File (z.B. protobenutzung.wrl) z.B. mit Hilfe der Kommandozeile


copy protobenutzung.wrl+script.wrl protobenutzung2.wrl


Danach verändert man die Routewege mit Dune (löschen von Routes siehe http://www.csv.ica.uni-stuttgart.de/vrml/dune/docs/usage_docs/dune_de.html#route)

Und testen Sie das Ganze.
Schlagen Sie jetzt die Knotenliste des VRML Standards (http://www.web3d.org/x3d/specifications/vrml/ISO_IEC_14772-All/part1/nodesRef.html#Transform) an einer beliebigen Stelle auf und benutzen Sie einen eventIn/exposedField (nicht mit dem SFVec3f Typ) des hier beschriebenen VRML Knoten als Ziel eines Scripts.

Fehlersuche in Cosmoplayer

Beim Programmieren ist es ziemlich "normal", dass die ersten Versionen eines neuen Programmteils Fehler enthalten.

Leider werden sind Fehlermeldungen in Cosmoplayer ausgesprochen unauffällig.
Leuchtet im Navigationsbalken von Cosmoplayer eine Reihe roter Lämpchen auf



so bedeutet das, dass Cosmoplayer auf einen Fehler gestossen ist.
Klickt man auf die Lämpchen, öffnet sich die sogenannte VRML Console, die die Fehlermeldung anzeigt.

Die gezeigte Fehlermeldung "# File is empty" ist sehr charakteristisch. Sie zeigt an, dass der vorgeschriebene VRML Header


#VRML V2.0 utf8

nicht am absoluten Anfang des File gefunden wurde.
Leuchtet im Navigationsbalken von Cosmoplayer eine Reihe gelber Lämpchen auf

so bedeutet das, dass Cosmoplayer auf eine Warnung gestossen ist.
Die VRML Console lässt sich auch mit der "\" Taste öffnen. Genauer lässt sich das Verhalten der VRML Console einstellen, indem man im Navigationsbalken auf das Häckchen klickt

und im sich öffnenden Fenster auf den Reiter "Advanced" klickt.


Während Fehler und "print" Ausgaben bei in "javascript" geschriebenen Scriptknoten bei Cosmoplayer in der VRML Console erscheinen, werden Fehler und "println" Ausgaben bei in java geschriebenen Scriptknoten in die java Console geschrieben. Bei netscape 4.7X ist sie über Communicator -> Tools -> Java Console erreichbar.