MMProg: Praktikum: WiSe 2018/19: Ball02: Unterschied zwischen den Versionen

aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Zeile 140: Zeile 140:
Sobald diese Lösung funktioniert, sollten Sie folgende Änderung vornehmen:
Sobald diese Lösung funktioniert, sollten Sie folgende Änderung vornehmen:
Laden Sie das Bild des Vogels asynchron mit Hilfe eines PixiJS-Loader-Objektes  
Laden Sie das Bild des Vogels asynchron mit Hilfe eines PixiJS-Loader-Objektes  
(https://github.com/englercj/resource-loader, http://pixijs.download/dev/docs/PIXI.loaders.Loader.html)<ref>[https://github.com/englercj/resource-loader GitHub: resource-loader
(http://pixijs.download/dev/docs/PIXI.loaders.Loader.html, https://github.com/englercj/resource-loader)<ref>[http://pixijs.download/dev/docs/PIXI.loaders.Loader.html PixiJS API Documentation: PIXI.loaders.Loader]</ref><ref>[https://github.com/englercj/resource-loader GitHub: resource-loader
]</ref><ref>[http://pixijs.download/dev/docs/PIXI.loaders.Loader.html PixiJS API Documentation: PIXI.loaders.Loader]</ref>.
]</ref>.


Eine wesentliche Änderung, die sich wegen der Asynchronität ergibt, is, dass der Ladevorgang später endet als die Ausführung der Initialisierungsfunktion.
====Asynchronität in EcmaScript 2017====
Eine wesentliche Änderung, die sich wegen der Asynchronität ergibt, ist, dass der Ladevorgang später endet als die Ausführung der Initialisierungsfunktion.
Wenn man direkt im Anschluss an die Ausführung der Initialisierungsfunktion die Game Loop startet, ist die Wahrscheinlichkeit groß, dass die Bilder noch gar nicht
Wenn man direkt im Anschluss an die Ausführung der Initialisierungsfunktion die Game Loop startet, ist die Wahrscheinlichkeit groß, dass die Bilder noch gar nicht
geladen wurden und die Anwendung daher abstürzt. Abhilfe schafft hier eine Callback-Funktion, die vom PixiJS-Loader aufgerufen wird, sobald der Ladevorgang beendet ist.  
geladen wurden und die Anwendung daher abstürzt. Abhilfe schafft hier der Einsatz von  modernen asynchronen JavaScript-Anweisungen:
Stellen Sie in der Datei <code>app3.js</code> eine Callback-Funktion bereit, deren einzige Aufgabe es ist, die Game Loop zu starten.
* <code>Promise</code>-Objekte ([https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Promise MDN web docs: Promise])
*<code>async</code>-Funktionen ([https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Statements/async_function MDN web docs: async function])
* <code>await</code>-Operator ([https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Operators/await MDN web docs: await])
 
Diese Konstrukte wurden eingeführt, da man in einem klassischen ES5-Programm häufig den Wald vor lauter Bäumen,
{{dh}} den Code vor lauter Callback-Funktionen nicht mehr gesehen hat, wenn eine Vielzahl von asynchronen Anweisungen benötigt wurden.
 
Mit ES 2015 wurde die globale Klasse <code>Promise</code> eingeführt.
Ein <code>Promise</code>-Objekt führt eine Aktion, wie das Laden eines Bildes oder das Warten auf ein Timer-Ereignis, asynchron aus. Sobald
die Aktion erfolgreich beendet wird, führt sie eine Callback-Funktion aus, die ihr in der Methode <code>then</code> übergeben wurde.
Der Callback-Funktion wird das Ergebnis der asynchronen Aktion als Ergebnis übergeben, so dass sie damit weiterarbeiten kann.
Falls diese Funktion wieder ein <code>Promise</code>-Objekt  als Ergebnis liefert, kann man den nächsten asynchronen Befehl mittels eines
weiteren Aufrufs der Methode <code>then</code> anfügen. Etc. pp. Auf diese Weise konnte man eine Abfolge von asynchronen Anweisungen zumindest
linear notieren:
 
<source lang="javascript">
myPromise
  .then(function(p_value) { ...})
  .then(function(p_value) { ...})
  .then(function(p_value) { ...})
</source>
 
Wenn man die kürzere Arrow-Schreibweise für Funktionen verwendet, die mit ES 2015 eingeführt wurde ([https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Functions/Pfeilfunktionen MDN web doc: Pfeilfunktionen]), wird der oder noch etwas kompakter und damit lesbarer:
<source lang="javascript">
myPromise
  .then(p_value => { ...})
  .then(p_value => { ...})
  .then(p_value => { ...})
</source>
 
Allerdings ist das auch nicht sonderlich schön zu lesen, vor allem wenn man umfangreiche asynchrone Funktionen zu definieren hat.
Und jede dieser Funktionen muss ein eigenes <code>Promise</code>-Objekt erstellen, was den Code auch nicht gerade lesbarer macht.
 
Daher wurden in ES 2017 die asynchronen Funktionen eingeführt:
<source lang="javascript">
async function myFunction(...)
{ ...}
</source>
 
In dieser Funktionen werden Anweisungen geschrieben, wie in jeder anderen Funktion auch. Und diese Anweisungen werden der Reihe nach abgearbeitet.
Allerdings gibt es einen fundamentalen Unterschied. Der Funktionsrumpf wird asynchron ausgeführt. Das Ergebnis der Funktion ist ein (implizites)
<code>Promise</code>-Objekt, dessen <code>then</code>-Funktion erst aufgerufen wird, sobald alle asynchronen Befehle im Rumpf
der Funktion erfolgreich beendet wurden.
 
Da heißt, bei Aufruf der Funktion wird diese sofort wieder beendet. Der Browser wird durch die Funktion nicht blockiert, wie es {{zB}} beim
synchronen Laden eines Bildes der Fall wäre.  Die im Rumpf der Funktion enthaltenen Befehle werden trotzdem der Reihe nach ausgeführt, aber asynchron.
 
Wenn Sie die Funktion <code>init</code> in der Datei <code>app01.js</code> näher betrachten, fällt Ihnen auf, das sie als <code>async</code>-Funktion
definiert wurde. In ihrem Rumpf befinden sich neben drei Standard-Anweisungen auch die Anweisung <code>await wait(500);</code>. Die Funktion <code>wait</code>
wurde von mir in der Datei <code>src/lib/wk/util/wait.js</code> definiert:
 
<source lang="javascript">
function wait(p_time)
{ return new Promise(function(p_resolve)
                    { setTimeout(p_resolve, p_time); }
                    )
}
</source>
(In Wirklichkeit habe ich die modernere Arrow-Schreibweise verwendet,
aber das Ergebnis ist dasselbe.)
 
Die Funktion <code>wait</code> erstellt ein <code>Promise</code>-Objekt, das die
Funktion <code>setTimeout</code> ausführt ([https://developer.mozilla.org/de/docs/Web/API/WindowTimers/setTimeout MDN web doc:
WindowTimers.setTimeout()]). Diese Funktion wartet eine gewisse Zeit <code>p_time</code> und ruft dann eine Callback-Funktion auf.
Das ist die typische ES5-Vorgehensweise  zur Behandlung von asynchronen Aktionen. In diesem Fall wird die Callback-Funktion <code>p_resolve</code>
aufgerufen. Das ist eine Funktion, die dem <code>Promise</code>-Objekt mitteilt, dass die asynchrone Aktion erfolgreich beendet wurde
(und das <code>Promise</code>-Objekt nun die <code>then</code>-Funktion ausführen könnte).
 
Seit ES 2017 kann man in <code>async</code>-Funktionen den <code>await</code>-Operator verwenden, um das Ergebnis eines  <code>Promise</code>-Objekts
zu verarbeiten. Das ist '''viel''' eleganter, als mit den (auch schon wieder veralteten) <code>then</code>-Funktionen.
Sie schreiben einfach den Befehl <code>await wait(500);</code> in den Rumpf Ihrer <code>async</code>-Funktion. Dann wird die (asynchrone) Verarbeitung
des Rumpfes dieser funktion um 500 ms ({{dh}} um eine halbe Sekunde) unterbrochen, bevor der nächste Befehl abgearbeitet wird.
 
====Asynchrones Laden von Bildern für PixiJS====


Ersetzen Sie in der Datei <code>app3.js</code> den Code
Ersetzen Sie in der Datei <code>app3.js</code> den Code
Zeile 163: Zeile 237:
</source>
</source>


Zum Zeitpunkt der Ausführung der Callback-Funktion wurden alle Bilder geladen und daher kann die Game Lopp nicht mehr aufgrund fehlender Medien abstürzen.
Zum Zeitpunkt der Ausführung der Callback-Funktion wurden alle Bilder geladen und daher kann die Game Loop nicht mehr aufgrund fehlender Medien abstürzen.


Nun muss noch die Initialisierungsfunktion in der Datei <code>game3.js</code> entsprechend angepasst werden.
Nun muss noch die Initialisierungsfunktion in der Datei <code>game3.js</code> entsprechend angepasst werden.

Version vom 22. November 2018, 12:29 Uhr

Dieser Artikel erfüllt die GlossarWiki-Qualitätsanforderungen nur teilweise:

Korrektheit: 3
(zu größeren Teilen überprüft)
Umfang: 4
(unwichtige Fakten fehlen)
Quellenangaben: 3
(wichtige Quellen vorhanden)
Quellenarten: 5
(ausgezeichnet)
Konformität: 3
(gut)

Vorlesung MMProg

Inhalt | EcmaScript01 | EcmaScript02 | EcmaScript03 | Ball 01| Ball 02 | Ball 03 | Pong 01

Musterlösung: Web-Auftritt (Git-Repository, noch nicht online)

Vorbereitung

Importieren Sie das leere Git-Projekt Ball02 in WebStorm. Laden Sie anschließend mittels npm i alle benötigten Node.js-Module in das Projekt.

Sie können Ihr Projekt zur Übung auch in Ihrem Git-Repository speichern. Das ist aber nicht so wichtig. Falls Sie da machen möchten, müssen Sie es zuvor von meinem (schreibgeschützten) Repository lösen:

git remote remove origin
git remote add origin https://gitlab.multimedia.hs-augsburg.de:8888/BENUTZER/Ball02.git

Ziel

Ziel dieser Praktikumsaufgabe ist es, die “HTML5 Creation Engine” PixiJS v4 kennenzulernen.[1] Bei PixiJS handelt es sich um eine sehr mächtige (und damit auch sehr große) JavaScript-Bibliothek zur Realisierung von 2D-Animationen und -Spielen.

Mit HTML5 wurde das Canvas-Element (Leinwand-Element) eingeführt.[2] „Auf“ einem Canvas-Element können Grafiken gezeichnet werden. Aktuelle Browser unterstützen üblicherweise sowohl den CanvasRenderingContext2D zum Erstellen von 2D-Grafiken[3] als auch WebGL zum Erstellen von 3D-Grafiken (auf Basis von OpenGL)[4]. Die Erstellung von Grafiken mit WebGL ist wesentlich effizienter als die Erstellung von Grafiken mit dem CanvasRenderingContext2D, zumindest dann wenn, eine Grafikkarte zur Verfügung steht, deren Prozessor (GPU) OpenGL nativ unterstützt. Dies ist insbesondere dann von Bedeutung, wenn Animationen erstellt werden, d. h., wenn 60 mal pro Sekunde (also alle 16,7 ms) eine neue Grafik auf dem Canvas angezeigt werden soll.

PixiJS ist als Ersatz für den CanvasRenderingContext2D gedacht. Die Bibliothek stellt im Wesentlichen dieselben Grafik-Befehle wie der 2D-Kontext zur Verfügung, erstellt aber, wann immer möglich, die 2D-Grafiken mit Hilfe von WebGL. Nur wenn diese Schnittstelle vom Browser nicht zur Verfügung gestellt wird, erfolgt als Fallback das Rendering mit Hilfe des 2D-Kontextes. Dies hat allerdings meist einen deutlichen Performanz-Einbruch zur Folge.

Aufgaben

In Ihrem Projekt finden Sie wiederum mehrere Web-Anwendungen: index01.html verwendet die gepackte Version von app01.js, die ihrerseits das Spiel game01.js einbindet. Et cetera.

Schreiben Sie Ihre Lösungen der Aufgabe $i$ in die Datei game$i$.js. Am einfachsten ist es, wenn Sie jeweils die Lösung der vorangegangenen Aufgabe kopieren und diese Kopie dann weiterentwickeln.

Aufgabe 1

Diese Aufgabe entspricht Aufgabe 1 der Praktikumsaufgabe MMProg: Praktikum: WiSe 2017/18: GameLoop01: Lassen Sie die Eule horizontal vom linken bis zum rechten Fensterrand des Browsers fliegen.

Im Projekt WK_Ball02_Empty ist eine mögliche Lösung dieser Aufgabe bereits enthalten, wobei allerdings ein Kreis „fliegt“ anstelle einer Eule. Ihre Aufgabe ist es nun, sich die Unterschiede zur Lösung der ersten Praktikumsaufgabe WK_Ball01, die sich durch die Verwendung von PixiJS ergeben, klar zu machen.

app01.js

  • Es wird zusätzlich die in der JavaScript-Bibliothek pixi.js enthaltene Klasse Application importiert.
  • Anstelle des GameLoop-Objektes könnte auch der PixiJS-Ticker verwendet werden. Dieser stellt jedoch nicht sicher, dass das Model garantiert 60 mal pro Sekunde aktualisiert wird. Wenn Sie irgendwann PixiJS-Animationen einsetzen möchten, müssen Sie den PixiJS-Ticker allerdings zusätzlich starten, da ansonsten die Animationen nicht animiert werden.
  • Das Root-Objekt der PixiJS-Anwendung wird erstellt. Die wichtigsten Argumente sind die Breite und Höhe der Bühne sowie das Canvas-Element, auf dem die Grafiken gezeichnet werden. (Wenn man der Anwendung kein Canvas-Element zuteilt, erstellt sie selbst eines, das man anschließend per JavaScript in das HTML-Dokument einfügen muss.) Darüber hinaus gibt es diverse weitere Optionen, wie z. B. die Festlegung, ob die Leinwand transparent ist, damit der HTML-Hintergrund durchscheint.[5]
  • Das Spiel wird mit Hilfe einer Methode init initialisiert, bevor die Game Loop gestartet werden kann. Das ist notwendig, da die Grafikobjekte, die später animiert werden sollen, zunächst erstellt werden müssen. In der ersten Praktikumsaufgabe wurde diese Tätigkeit per CSS (und nicht per JavaScript) erledigt.

game01.js

  • Der Ordner ball wurde in game umbenannt und die Datei ball01.js in game01.js unbenannt, da hier nicht nur das Ball-Objekt, sondern auch alle andere Aspekte des „Spiels“ „Ein Ball bewegt sich hin und her“ definiert werden.
  • Es gibt eine Initialisierungsfunktion (Initfunktion), die zu Beginn der Anwendung aufgerufen wird, um sie zu initialisieren.
  • Darüber hinaus gibt es auch noch eine Resetfunktion, die jedes Mal aufgerufen wird, wenn die Anwendung neu gestartet wird, z. B. weil ein neues Spiellevel begonnen werden soll. (Diese Funktion gab es im Gegensatz zur Initfunktion auch schon in der ersten Praktikumsaufgabe.) Diese Funktion ist für wiederkehrende Initialisierungaufgaben verantwortlich, wohingegen die Initialisierungsfunktion nur ein einziges Mal zu Spielbeginn aufgerufen wird. Um Code-Duplikationen zu vermeiden, ruft die Initialisierungsfunktion auch die Resetfunktion auf.
  • Das Modell der Bühne (v_stage) wird nur teilweise initialisiert. Die Breite und Höhe wird erst später von der Initfunktion festgelegt.
  • Das Ballobjekt v_ball wird erst durch die Resetfunktion initialisiert. Diese wird erstmals von der Init-Funktion aufgerufen und kann später von der Game Loop bei Spielstart oder -neustart damit zurückgesetzt werden.
  • Das Ballobjekt beinhaltet schon die y-Koordinate und die y-Geschwindigkeit des Balls. In der ursprünglichen Aufgabe fehlten diese Attribute noch. Sie wurden erst in der zweiten Aufgabe („Ball vertikal fliegen lassen“) eingeführt. Außerdem wurde der Durchmesser (d) durch den Radius (r) ersetzt.
  • Der Ankerpunkt des Balls wurde von der linken oberen Ecke der Eule ins Zentrum des Balls verschoben. Dies hat Auswirkungen auf die Implementierung der Kollisionserkennung und -behandlung.
  • Die Renderfunktion unterscheidet sich leicht. In der ursprünglichen Aufgabe wurden CSS-Attribute des animierten div-Elements verändert. Nun müssen die Attribute des PixiJS-Grafikobjekts, das in der Init-Funktion erzeugt wurde, an die aktuellen Modellwerte angepasst werden.

Die Initfunktion nimmt folgende Aufgaben wahr:

  • Breite und Höhe des Bühnenmodells werden an die Breite und Höhe der PixiJS-Anwendung angepasst.
  • Die Modelle des Spiels werden initialisiert.
  • Die View des Balls wird initialisiert und auf der PixiJS-Bühne platziert. Dies kann erst jetzt erfolgen, da das Application-Objekt der PixiJS-Anwendung erst jetzt zur Verfügung steht. Mit Hilfe der PixJS-Klasse Graphicswird zunächst ein Grafikobjekt erzeugt. Dieses wird mit Inhalt gefüllt (einem Kreis von bestimmter Farbe mit einem Rand in einer anderen Farbe) und zu guter Letzt zur PixiJS-Bühne (d. h. im Prinzip zum zugehörigen Canvaselement) hinzugefügt. Wenn sich später bestimmte Attribute des Grafikobjektes – wie z. B. die Position oder die Größe – ändern, wird die graphische Darstellung des Objektes auf dem Canvas automatisch von PixiJS angepasst. Die Änderung der Grafikattribute werden in der Funktion render vorgenommen. Dort wird derzeit allerdings nur die Position aus dem Model in die View übertragen. Andere Attribute der View ändern sich in dieser Anwendung nicht.

Aufgabe 2

Erstellen Sie eine erste Version der Lösung der Aufgabe 2, indem Sie die Lösung der Aufgabe 1 kopieren:

  • Kopieren Sie src/js/game/game01.js nach src/js/game/game02.js
  • Kopieren Sie src/js/app01.js nach src/js/app02.js und ersetzen Sie in dieser Datei './game/game01.js' durch './game/game02.js'.
  • Kopieren Sie src/index01.js nach src/index02.js und ersetzen Sie in dieser Datei <title>Ball02 (app01)</title> durch <title>Ball02 (app02)</title>. (Einen verweis auf die JavaScript-Datei app02.js gibt es in dieser Datei nicht. Der korrekte Verweis wird von webpack automatisch beim Erstellen der Dateien des Web-Ordners injiziert.)
  • Starten Sie npm run watch neu, damit auch die neu erstellten Dateien automatisch von webpack übersetzt werden.

Lösen Sie Aufgabe 2 der ersten Praktikumsaufgabe mit Hilfe von PixiJS. Das heißt, ändern Sie Ihre Version von Aufgabe 2, die Sie gerade durch Kopieren erstellt haben, so ba, dass Folgendes passiert: Lassen Sie den Ball nicht waagerecht, sondern in der horizontalen Mitte des Browserfensters senkrecht von Fensterrand zu Fensterrand fliegen. Anstelle einer Eule verwenden Sie bitte analog zu Aufgabe 1 einen farbigen „Ball“ mit Rand.

Vergessen Sie nicht auch die Kollisionserkennung und -behandlung für die beiden Bildschirmseiten top und botton zu implementieren.

Und denken Sie daran, npm run dev oder besser noch npm run watch zu verwenden. :-)

Aufgabe 2a

Ändern Sie nun die View des Balls: Anstelle eines farbigen Kreises stellen Sie bitte eine Eule oder einen Pinguin dar. Importieren Sie zunächst das gewünschte graphische Objekt in die Datei game02.js:

import img_ball from '../../img/owl-150.png';

oder

import img_ball from '../../img/tux-150.png';

(Genau genommen weisen Sie webpack mit dieser Anweisung an, das Grafikobjekt im Ordner web/img zu erzeugen und die zugehörige URL in der Variablen img_ball zu speichern. Ohne webpack müssten Sie das Bild von Hand in diesem Ordner ablegen und dem Spriteobjekt – siehe unten – die korrekte URL übergeben.)

Darüber hinaus müssen Sie dafür sorgen, das von pixi.js nicht mehr die Klasse Graphics, sondern stattdessen die Klasse Sprite importiert wird.

Ändern Sie in der Initfunktion die Befehle zur Erstellung der View so ab, dass kein Kreis mehr gezeichnet, sondern das Bild der Eule oder des Pinguins dargestellt wird.

let
  ...
  v_ball_view = Sprite.fromImage(img_ball); // img_ball contains the URL of the image

In der Initfunktion wird nur noch der Ankerpunkt in die Mitte des Viewobjekts verschoben. Dieses Objekt wird dann wieder zur PixiJS-Bühne hinzugefügt.

v_ball_view.anchor.set(0.5); // center the anchor

p_stage_view.addChild(v_ball_view);

Aufgabe 3

Lösen Sie Aufgabe 3 der ersten Praktikumsaufgabe mit Hilfe von PixiJS: Lassen Sie der Ball von der Mitte des Browserfensters aus schräg über den Bildschirm fliegen. In x-Richtung soll er doppelt so schnell sein (200 Pixel/s) wie in y-Richtung (100 Pixel/s). (Diesmal sollten Sie gleich eine Eule oder einen Pinguin fliegen lassen und nicht erst einen Kreis.)

Einen Nachteil hat die Lösung der Aufgabe 2a allerdings: Das Bild des Vogels wird mittels Sprite.fromImage synchron geladen. Das heißt, solange bis das Bild geladen wurde, ist die Anwendung „eingefroren“. Bei einem kleinen Bild ist das sicher kein Problem, wenn aber eine Vielzahl von oder große Medien geladen werden müssen – wie dies bei realen Web-Anwendungen der Fall ist –, ist dies sicher keine Option mehr.

Sie sollten die Aufgabe zunächst einmal auf Basis Ihrer Erkenntnisse von Aufgabe 2a lösen.

Sobald diese Lösung funktioniert, sollten Sie folgende Änderung vornehmen: Laden Sie das Bild des Vogels asynchron mit Hilfe eines PixiJS-Loader-Objektes (http://pixijs.download/dev/docs/PIXI.loaders.Loader.html, https://github.com/englercj/resource-loader)[6][7].

Asynchronität in EcmaScript 2017

Eine wesentliche Änderung, die sich wegen der Asynchronität ergibt, ist, dass der Ladevorgang später endet als die Ausführung der Initialisierungsfunktion. Wenn man direkt im Anschluss an die Ausführung der Initialisierungsfunktion die Game Loop startet, ist die Wahrscheinlichkeit groß, dass die Bilder noch gar nicht geladen wurden und die Anwendung daher abstürzt. Abhilfe schafft hier der Einsatz von modernen asynchronen JavaScript-Anweisungen:

Diese Konstrukte wurden eingeführt, da man in einem klassischen ES5-Programm häufig den Wald vor lauter Bäumen, d. h. den Code vor lauter Callback-Funktionen nicht mehr gesehen hat, wenn eine Vielzahl von asynchronen Anweisungen benötigt wurden.

Mit ES 2015 wurde die globale Klasse Promise eingeführt. Ein Promise-Objekt führt eine Aktion, wie das Laden eines Bildes oder das Warten auf ein Timer-Ereignis, asynchron aus. Sobald die Aktion erfolgreich beendet wird, führt sie eine Callback-Funktion aus, die ihr in der Methode then übergeben wurde. Der Callback-Funktion wird das Ergebnis der asynchronen Aktion als Ergebnis übergeben, so dass sie damit weiterarbeiten kann. Falls diese Funktion wieder ein Promise-Objekt als Ergebnis liefert, kann man den nächsten asynchronen Befehl mittels eines weiteren Aufrufs der Methode then anfügen. Etc. pp. Auf diese Weise konnte man eine Abfolge von asynchronen Anweisungen zumindest linear notieren:

myPromise
  .then(function(p_value) { ...})
  .then(function(p_value) { ...})
  .then(function(p_value) { ...})

Wenn man die kürzere Arrow-Schreibweise für Funktionen verwendet, die mit ES 2015 eingeführt wurde (MDN web doc: Pfeilfunktionen), wird der oder noch etwas kompakter und damit lesbarer:

myPromise
  .then(p_value => { ...})
  .then(p_value => { ...})
  .then(p_value => { ...})

Allerdings ist das auch nicht sonderlich schön zu lesen, vor allem wenn man umfangreiche asynchrone Funktionen zu definieren hat. Und jede dieser Funktionen muss ein eigenes Promise-Objekt erstellen, was den Code auch nicht gerade lesbarer macht.

Daher wurden in ES 2017 die asynchronen Funktionen eingeführt:

async function myFunction(...)
{ ...}

In dieser Funktionen werden Anweisungen geschrieben, wie in jeder anderen Funktion auch. Und diese Anweisungen werden der Reihe nach abgearbeitet. Allerdings gibt es einen fundamentalen Unterschied. Der Funktionsrumpf wird asynchron ausgeführt. Das Ergebnis der Funktion ist ein (implizites) Promise-Objekt, dessen then-Funktion erst aufgerufen wird, sobald alle asynchronen Befehle im Rumpf der Funktion erfolgreich beendet wurden.

Da heißt, bei Aufruf der Funktion wird diese sofort wieder beendet. Der Browser wird durch die Funktion nicht blockiert, wie es z. B. beim synchronen Laden eines Bildes der Fall wäre. Die im Rumpf der Funktion enthaltenen Befehle werden trotzdem der Reihe nach ausgeführt, aber asynchron.

Wenn Sie die Funktion init in der Datei app01.js näher betrachten, fällt Ihnen auf, das sie als async-Funktion definiert wurde. In ihrem Rumpf befinden sich neben drei Standard-Anweisungen auch die Anweisung await wait(500);. Die Funktion wait wurde von mir in der Datei src/lib/wk/util/wait.js definiert:

function wait(p_time)
{ return new Promise(function(p_resolve)
                     { setTimeout(p_resolve, p_time); }
                    )
}

(In Wirklichkeit habe ich die modernere Arrow-Schreibweise verwendet, aber das Ergebnis ist dasselbe.)

Die Funktion wait erstellt ein Promise-Objekt, das die Funktion setTimeout ausführt ([https://developer.mozilla.org/de/docs/Web/API/WindowTimers/setTimeout MDN web doc: WindowTimers.setTimeout()]). Diese Funktion wartet eine gewisse Zeit p_time und ruft dann eine Callback-Funktion auf. Das ist die typische ES5-Vorgehensweise zur Behandlung von asynchronen Aktionen. In diesem Fall wird die Callback-Funktion p_resolve aufgerufen. Das ist eine Funktion, die dem Promise-Objekt mitteilt, dass die asynchrone Aktion erfolgreich beendet wurde (und das Promise-Objekt nun die then-Funktion ausführen könnte).

Seit ES 2017 kann man in async-Funktionen den await-Operator verwenden, um das Ergebnis eines Promise-Objekts zu verarbeiten. Das ist viel eleganter, als mit den (auch schon wieder veralteten) then-Funktionen. Sie schreiben einfach den Befehl await wait(500); in den Rumpf Ihrer async-Funktion. Dann wird die (asynchrone) Verarbeitung des Rumpfes dieser funktion um 500 ms (d. h. um eine halbe Sekunde) unterbrochen, bevor der nächste Befehl abgearbeitet wird.

Asynchrones Laden von Bildern für PixiJS

Ersetzen Sie in der Datei app3.js den Code

game.init(PIXI, c_stage, c_pixi_app.stage);
new GameLoopPixi(c_pixi_app.ticker, game.update, game.render).start();

durch

game.init
( PIXI, c_stage, c_pixi_app.stage,
  // callback function: if the game has been initialized, start it.
  function()
  { new GameLoopPixi(c_pixi_app.ticker, game.update, game.render).start(); }
);

Zum Zeitpunkt der Ausführung der Callback-Funktion wurden alle Bilder geladen und daher kann die Game Loop nicht mehr aufgrund fehlender Medien abstürzen.

Nun muss noch die Initialisierungsfunktion in der Datei game3.js entsprechend angepasst werden.

Zunächst wird sie um einen Callback-Parameter f_ready erweitert:

function init(p_pixi, p_stage, p_stage_view, f_ready)

In diesem Parameter wird der Initialisierungsmethode die zuvor definierte Callback-Funktion übergeben, die aufgerufen weren muss, sobald der Initalisierungsvorgang vollständig abgearbeitet wurde.

Bislang wird das Bild der Eule synchron geladen und dem View-Objekt zugewiesen. Dies soll künfig jedoch asynchron erfolgen. Löschen Sie daher in der Initialisierungsfunktion zunächst alle drei Befehle, die mit dem View-Objekt v_ball_view zu tun haben.

Die benötigten Medien (hier: das Bild der Eule) werden künftig mit Hilfe eines PixiJS-Loaders asynchron geladen:

p_pixi
    .loader
    .add('sprite', sprite)
    .load(function(p_loader, p_resources)
          {
            
            f_ready();
          }
    );

Der Pixi-Loader p_pixi.loader wird zunächst angewiesen, das Medium, dessen URL in der Variablen sprite steht, zu laden und unter dem (sehr einfaltsreichen) Namen 'sprite' in einem JavaScript-Objekt zu speichern. Es ist durchaus üblich, eine Vielzahl von Medien auf einmal (d. h. parallel) zu laden:

p_pixi.loader.add(...).add(...).add(...).add(...)...

oder auch

p_pixi.loader.add(...);
p_pixi.loader.add(...);
p_pixi.loader.add(...);
p_pixi.loader.add(...);
...

Zu guter Letzt wird die Methode p_pixi.loader.load(...) aufgerufen. Diese startet alle erwünschten Ladevorgänge und führt, sobald alle Ressourcen geladen wurden, die ihr übergebene Callback-Funktion aus. Dieser Callback-Funktion werden vom Pixi-Loader zwei Argumente übergeben:

  • Das Loader-Objekt, mit dem die Medien geladen wurden. (Dieses Objekt wird allerdings nur in Ausnahmenfällen benötigt.)
  • Ein Ressource-Objekt, in dem alle zuvorgeladenen Medien unter den in den Add-Anweisungen angegebenen Namen enthalten sind.

Innerhalb dieser Funktion kann nun das View-Objekt des Balls erstellt und in der PixiJS-Bühne gespeichert werden. Fügen Sie daher vor dem Befehl f_ready(); folgende Befehle ein:

v_ball_view = new p_pixi.Sprite(p_resources['sprite'].texture);
v_ball_view.anchor.set(0.5); // center the anchor

p_stage_view.addChild(v_ball_view);

Beachten Sie, dass das geladene Bild als Textur für das Ball-View-Objekt verwendet wird. Ein Bild kann also durchaus für diverse PixiJS-Grafik-Objekte als Textur verwendet werden. Beispielsweise können viele gleichartige Moorhühner oder Vögel oder Schweine erzeugt werden, ohne dass die zugehörige Textur mehrfach vom Server geladen werden muss.

Ganz wichtig ist es, als letzten Befehl der soeben definierten Callback-Funktion die Callback-Funktion f_ready auszuführen (also mittels f_ready(); aufzurufen). Anderenfalls wird die Game Loop nie gestartet und die Web-Anwendung verharrt im Initialzustand.

Wenn Sie schon dabei sind, sollten Sie gleich noch eine zweite Unsauberkeit eliminieren. Die Konfiguration der Modell-Objekte v_stage und v_ball sollte mittels einer JSON-Datei erfolgen. Im leeren Projekt finden Sie die JSON-Datei src/js/init3.json, die diese beiden Objekte enthält. Importieren Sie diese Datei in die Datei game3.js (vgl. HTML5-Tutorium: JavaScript: Hello World 05) und weisen Sie die beiden importierten Objekte den Variablen v_stage bzw. v_ball zu.

Tipp: Um die Anzahl der WebStorm-Warnings zu reduzieren, können Sie direkt vor den JSON-Import-Befehl zusätzlich folgenden Import-Befehl einfügen:

import '../../json/init3.js';

Die Datei init3.js enthält keinerlei ausführbaren Code, sondern nur einen Kommentar, der von Webpack spätestens dann entfernt wird, wenn die Ausgabedatei app3.bundle.js mittels grunt compress komprimiert wird. Der Kommentar hat es allerdings in sich. Er beschreit im JSDoc-Format[8] den Inhalt der JSON-Datei. Dieser Kommentar wird von WebStorm interpretiert, um die Anzahl der Warnings zu reduzieren.

Aufgabe 3a

Erweitern Sie Ihre Lösung von Aufgabe 3 so, dass 5 unterschiedliche Vögel auf unterschiedlichen Routen über die Bühne fliegen. In der Datei src/json/init3a.json finden Sie die zuanimierenden Objekte. Anstelle eines Objektes ball ist hier ein Array balls definiert, das fünf Ball-Objekte enthält. Jedes dieser Objekte hat neben den bereits bekannten Attributen ein weiteres Attribut img, das beschreibt, mit welcher Textur das Objekt visualisiert werden soll.

Importieren Sie diese JSON-Datei wieder und speichern Sie die darin enthaltenen Objekte in den Variablen v_stage bzw. v_balls (nicht v_ball!). Definieren Sie außerdem eine Variable v_ball_views und initialisieren Sie diese mit einem leeren Array. In diesem werden anschließend von der Initialisierungsmethode die zugehörigen View-Objeke abgelegt.

Alls nächstes müssen Sie die Methode update umbenennen und um den Parameter p_ball erweitern:

function update_ball(p_ball, dt)

Bislang hat die Update-Methode auf das global definierte Ball-Modell v_ball zugegriffen, um die neue Postiion zuberechnen und die Kollissionserkennung und -behandlung durchzuführen. Nun gibt es fünf Ball-Objekte. Die Update-Funktion muss für jeden einzelnen dieser Bälle durchgeführt werden. Daher wird sie fünfmal aufgerufen. Bei jedem Aufruf wird ihr im Parameter p_ball ein anderer Ball zur Bearbeitung übergeben.

Die eigentliche Update-Methode code>update existiert weiterhin, doch ihre Aufgabe hat sich geändert: Sie muss mit Hilfe einer For-Schleife[9] das Array v_balls durchlaufen und für jedes Element die (Hilfs-)Methode update_ball aufrufen.

Die Renderfunktion muss analog angepasst werden: Sie muss ebenfalls das Array v_balls durchlaufen. Für jedes Ball-Modell-Objekt muss dessen aktuelle Position dem zugehörigen Ball-View-Objekt zuweisen werden. Das aktuelle View-Objekt findet sie jeweils im Array v_ball_views an derselben Position. (Sie könnten auch das Array v_ball_views durchlaufen. Das macht keinen Unterschied, weil beide Arrays gleichviele Elemente enthalten.)

Zu guter Letzt muss noch die Callback-Funktion des Pixi-Loaders angepasst werden. Diese muss ebenfalls das Array v_balls durchlaufen und für jedes Modell-Objekt ein zugehöriges View-Objekt erzeugen. Jedes neu erzeugte View-Objekt wird abschließend mittels

v_ball_views.push(l_ball_view);
p_stage_view.addChild(l_ball_view);

sowohl ans Ende des Arrays v_ball_views als auch in die PixiJS-Bühne eingefügt.

Eine Sache ist bei der Erzeugung der Views noch zu beachten. Es gibt zwei Texturen und in jedem Modell-Objekt ist vermerkt, welche Textur verwendet werden soll.

Importieren Sie also die URLs beider Texturen:

import owl from '../../img/owl-50.png';
import tux from '../../img/tux-50.png';

und laden sie die zugehörigen Bilder anschließend mit Hilfe des Pixi-Loaders:

p_pixi.loader.add('owl', owl).add('tux', tux)...

Beim Erzeugen der Views (innerhalb der zuvor genannten For-Schleife) verwenden Sie dann jeweils die im Model-Objekt beschriebene Textur:

let l_ball_view = new p_pixi.Sprite(p_resources[v_balls[i].img].texture);

Aufgaben 4 bis 10

Nun können und sollten Sie zur Übung die Aufgaben 4 bis 10 der ersten Praktikumsaufgabe ebenfalls mit Hilfe von PixiJS lösen. Laden Sie dabei die Bilder wieder asynchron und verwenden Sie JSON zur Konfiguration. Sie sollten ruhig auch mal mehr als einen Vogel animieren, z. B. indem Sie mehrere Eulen hintereinander die Wand entlang fliegen lassen.

Quellen

  1. Kowarschick (MMProg): Wolfgang Kowarschick; Vorlesung „Multimedia-Programmierung“; Hochschule: Hochschule Augsburg; Adresse: Augsburg; Web-Link; 2018; Quellengüte: 3 (Vorlesung)