Stadtplan / Minimap. Erzeugt von Doxygen Don Okt :26:46

Transkript

1 Stadtplan / Minimap Erzeugt von Doxygen Don Okt :26:46

2

3 Inhaltsverzeichnis

4

5 Kapitel 1 Hierarchie-Verzeichnis 1.1 Klassenhierarchie Die Liste der Ableitungen ist -mit Einschränkungen- alphabetisch sortiert: AssetPostprocessor SceenTilePostprocessor ?? Editor MinimapInspector ?? EditorWindow ScreenShotMenu ?? IMinimapDrawable ?? MinimapGraph ?? MinimapRoute ?? MoveableObject ?? PointOfInterest ?? RouteDrawer ?? LayerSystem ?? MetaProvider ?? MinimapGraphics ?? MinimapLayer ?? ScreenshotLayer ?? MinimapLayerFactory ?? MinimapPathProvider ?? MinimapSettings ?? MinimapTile ?? MonoBehaviour Minimap ?? NodeHelper ??

6 2 Hierarchie-Verzeichnis

7 Kapitel 2 Klassen-Verzeichnis 2.1 Auflistung der Klassen Hier folgt die Aufzählung aller Klassen, Strukturen, Varianten und Schnittstellen mit einer Kurzbeschreibung: IMinimapDrawable Interface für alle Objekte, die auf der Map gezeichnet werden können....?? LayerSystem Das LayerSystem verwaltet alle Layer. Es bestimmt welche Layer zu welchem Zeipunkt gezeichnet werden. Es ist ebenfalls ein ImageProvider, was bedeutet, das es dafür verantwortlich ist die ScreenShots aus den Dateien zu laden ?? MetaProvider Stellt die notwendigen Daten für die Minimap zur Verfügung ?? Minimap Diese Klasse ist die Hauptklasse des Minimap-Projekts. In dieser werden alle Variablen Initialisiert und verwertet. Ebenfalls bestimmt diese Klasse was genau angezeigt werden soll und was nicht ?? MinimapGraph Die Klasse Graph zeigt alle gültigen Wege an, mit denen eine Route bestimmt werden kann. Diese Klasse ist ein statisches Drawable ?? MinimapGraphics Das Graphicsobjekt zeichnet auf seiner Zeichenfläche. Dieses Objekt wird für sämtliche Zeichenoperationen verwendet ?? MinimapInspector ?? MinimapLayer Ein Layer ist eine geordnete Menge von IDrawables, die auf der Map angezeigt werden können ?? MinimapLayerFactory Diese Klasse erzeugt die Layer und dessen Drawables, die hinterher vom LayerSystem verwaltet werden ?? MinimapPathProvider Beinhaltet die Dateipfade zu den Ressourcen ??

8 4 Klassen-Verzeichnis MinimapRoute Die Route stellt den Weg zwischen Punkten auf der Minimap dar. Da diese sich im dynamisch verändern kann, muss diese auch als dynamisches Drawable betrachtet werden ?? MinimapSettings Diese Klasse beinhaltet alle notwendigen Daten der abgespeicherten Screenshots. Hier mit können Länge, Breite usw. des Screenshots abgefragt werden.?? MinimapTile Diese Struktur ist eine leere Zeichenfläche an einer bestimmten Position. Wenn man sich ein Blatt Papier vorstellt, wäre ein Tile ein Stück dieses Papiers an einer bestimmten Stelle ?? MoveableObject MoveableObjects sind dynamische Objekte, welche ständig aktuallisiert werden müssen, da diese sich bewegen können ?? NodeHelper ?? PointOfInterest Ist ein PointOfInterest, welcher auf der Minimap angezeigt werden kann. Diese Klasse hält die notwendigen Daten für die Beschreibung und Darstellung für einen PointOfInterest bereit ?? RouteDrawer ?? SceenTilePostprocessor Macht alle notwendigen Einstellungen, die beim Import der Bilder fr die Straenkarte gemacht werden mssen ?? ScreenshotLayer Ein Layer ist eine geordnete Menge von IDrawables, die auf der Map angezeigt werden können ?? ScreenShotMenu Reprsentiert das Menelement "Steetmap -> Take Map Screenshots" und die Funktionalitt fr das Schieen der Screenshots fr die Streetmap im Unity Editor.??

9 Kapitel 3 Klassen-Dokumentation 3.1 IMinimapDrawable Schnittstellenreferenz Interface für alle Objekte, die auf der Map gezeichnet werden können Klassendiagramm für IMinimapDrawable: IMinimapDrawable MinimapGraph MinimapRoute MoveableObject PointOfInterest RouteDrawer Öffentliche Methoden void Draw (MinimapGraphics g) Zeichnet das Objekt auf die Map Propertys Rect Boundary [get] Zeichnungsbereich des Objektes (Angegeben in Weltpositionen!) für das Clipping des Drawables Ausführliche Beschreibung Interface für alle Objekte, die auf der Map gezeichnet werden können Definiert in Zeile 7 der Datei IMinimapDrawable.cs.

10 6 Klassen-Dokumentation Dokumentation der Elementfunktionen void IMinimapDrawable.Draw ( MinimapGraphics g ) Zeichnet das Objekt auf die Map g Das Graphicsobjekt, das auf der Map zeichnen kann Implementiert in MoveableObject, PointOfInterest, RouteDrawer, MinimapRoute und Minimap- Graph Dokumentation der Propertys Rect IMinimapDrawable.Boundary [get] Zeichnungsbereich des Objektes (Angegeben in Weltpositionen!) für das Clipping des Drawables. Definiert in Zeile 14 der Datei IMinimapDrawable.cs. 3.2 LayerSystem Klassenreferenz Das LayerSystem verwaltet alle Layer. Es bestimmt welche Layer zu welchem Zeipunkt gezeichnet werden. Es ist ebenfalls ein ImageProvider, was bedeutet, das es dafür verantwortlich ist die ScreenShots aus den Dateien zu laden. Öffentliche Methoden LayerSystem () void Add (MinimapLayer layer) void Add (MinimapLayerID layerid, bool isstatic, int priority, List< IMinimapDrawable > drawables) Erzeugt, falls noch nicht vorhanden ein neues Layer mit der ID layerid void AddDrawable (MinimapLayerID layerid, IMinimapDrawable drawable) Diese Methode fügt dem Layer das die LayerID layerid hat, ein neues Drawable hinzu. void RemoveDrawable (MinimapLayerID layerid, IMinimapDrawable drawable) Löscht ein Drawable aus dem Layer layerid. void Remove (MinimapLayerID layerid) Löscht das Layer mit der ID layerid void Remove (MinimapLayer layer) Löscht das Layer layer void HideLayer (MinimapLayerID layerid) Entfernt, bzw. versteckt die gezeichneten Pixel der einzelnen Drawables eines Layers.

11 3.2 LayerSystem Klassenreferenz 7 void ShowLayer (MinimapLayerID layerid) Zeichnet die Pixel eines versteckten Layers durch HideLayer erneut. void DrawLayers (MinimapTile[,] tilegrid) Zeichnet alle Layer auf das TileGrid. void DrawOnlyDynamicLayers (MinimapTile[,] tilegrid) Zeichnet alle dynamischen Layer (Layer die nicht statisch sind) auf das TileGrid void DrawOnlyStaticLayers (MinimapTile[,] tilegrid) Zeichnet alle statischen Layer auf das TileGrid void SortLayers () Sortiert die Liste mit den Layern nach der Layerpriorität. Das Layer mit der geringsten Priorität steht an erster Stelle! MinimapLayer GetLayer (MinimapLayerID layerid) Gibt die Referenz des Layers layerid zurück. void Start (int numberoftilesxaxis, int numberoftilesyaxis) Durchsucht die Klasse void Update (MinimapTile[,] tilegrid, bool tilegridhaschanged, bool drawonlystatic) Diese Methode aktualisiert alle angezeigten Layer. Statische Layer werden nur einmal beim wechsel auf ein neues TileGrid gezeichnet!. Propertys List< MinimapLayer > Layers [get] Ausführliche Beschreibung Das LayerSystem verwaltet alle Layer. Es bestimmt welche Layer zu welchem Zeipunkt gezeichnet werden. Es ist ebenfalls ein ImageProvider, was bedeutet, das es dafür verantwortlich ist die ScreenShots aus den Dateien zu laden. Definiert in Zeile 12 der Datei LayerSystem.cs Beschreibung der Konstruktoren und Destruktoren LayerSystem.LayerSystem ( ) Erzeugt eine neue Instanz des LayerSystems. Definiert in Zeile 48 der Datei LayerSystem.cs Dokumentation der Elementfunktionen void LayerSystem.Add ( MinimapLayer layer ) Fügt das Layer layer hinzu.

12 8 Klassen-Dokumentation layer Das layer, das hinzugefügt werden soll Definiert in Zeile 63 der Datei LayerSystem.cs void LayerSystem.Add ( MinimapLayerID layerid, bool isstatic, int priority, List< IMinimapDrawable > drawables ) Erzeugt, falls noch nicht vorhanden ein neues Layer mit der ID layerid layerid isstatic priority drawables die ID des Layers, das neu hinzugefügt werden soll. Sagt aus, ob das neue Layer statisch sein soll Die Priorität des Layers Alle Drawables, die das Layer enthalten soll Definiert in Zeile 85 der Datei LayerSystem.cs void LayerSystem.AddDrawable ( MinimapLayerID layerid, IMinimapDrawable drawable ) Diese Methode fügt dem Layer das die LayerID layerid hat, ein neues Drawable hinzu. layerid drawable Die ID des Layers, dem ein Drawable hinzugefügt werden soll. Das Drawable, das dem Layer hinzugefügt werden soll. Definiert in Zeile 115 der Datei LayerSystem.cs void LayerSystem.DrawLayers ( MinimapTile tilegrid[,] ) Zeichnet alle Layer auf das TileGrid. tilegrid das tilegrid, auf dem die Layer gezeichnet werden sollen Definiert in Zeile 233 der Datei LayerSystem.cs void LayerSystem.DrawOnlyDynamicLayers ( MinimapTile tilegrid[,] ) Zeichnet alle dynamischen Layer (Layer die nicht statisch sind) auf das TileGrid tilegrid das tilegrid, auf dem die dynamischen Layer gezeichnet werden sollen

13 3.2 LayerSystem Klassenreferenz 9 Definiert in Zeile 251 der Datei LayerSystem.cs void LayerSystem.DrawOnlyStaticLayers ( MinimapTile tilegrid[,] ) Zeichnet alle statischen Layer auf das TileGrid tilegrid das tilegrid, auf dem die statischen Layer gezeichnet werden sollen Definiert in Zeile 268 der Datei LayerSystem.cs MinimapLayer LayerSystem.GetLayer ( MinimapLayerID layerid ) Gibt die Referenz des Layers layerid zurück. Rückgabe Das Layer mit der LayerID layerid. Falls kein Layer mit dieser ID vorhanden ist wird null zurückgegeben. layerid Die ID, die das Layer identifiziert. Definiert in Zeile 303 der Datei LayerSystem.cs void LayerSystem.HideLayer ( MinimapLayerID layerid ) Entfernt, bzw. versteckt die gezeichneten Pixel der einzelnen Drawables eines Layers. layerid Die ID des Layers, das versteckt werden soll Definiert in Zeile 196 der Datei LayerSystem.cs void LayerSystem.Remove ( MinimapLayerID layerid ) Löscht das Layer mit der ID layerid layerid Die ID des Layers, das gelöscht werden soll Definiert in Zeile 168 der Datei LayerSystem.cs.

14 10 Klassen-Dokumentation void LayerSystem.Remove ( MinimapLayer layer ) Löscht das Layer layer layerid das Layer, das gelöscht werden soll Definiert in Zeile 183 der Datei LayerSystem.cs void LayerSystem.RemoveDrawable ( MinimapLayerID layerid, IMinimapDrawable drawable ) Löscht ein Drawable aus dem Layer layerid. layerid drawable Die ID des Layers, aus dem das Drawable gelöscht werden soll. Das Drawable, das aus dem Layer entfernt werden soll. Definiert in Zeile 143 der Datei LayerSystem.cs void LayerSystem.ShowLayer ( MinimapLayerID layerid ) Zeichnet die Pixel eines versteckten Layers durch HideLayer erneut. layerid Die ID des Layers, das wieder angezeigt werden soll Definiert in Zeile 217 der Datei LayerSystem.cs void LayerSystem.SortLayers ( ) Sortiert die Liste mit den Layern nach der Layerpriorität. Das Layer mit der geringsten Priorität steht an erster Stelle! Definiert in Zeile 279 der Datei LayerSystem.cs void LayerSystem.Start ( int numberoftilesxaxis, int numberoftilesyaxis ) Durchsucht die Klasse LayerFactory nach öffentlichen statischen Methoden, die einen Layer zuürckgeben und keine Paramter haben. Diese erzeugten Layer werden dann dem System zur Verwaltung zugeordnet. Definiert in Zeile 318 der Datei LayerSystem.cs.

15 3.3 MetaProvider Klassenreferenz void LayerSystem.Update ( MinimapTile tilegrid[,], bool tilegridhaschanged, bool drawonlystatic ) Diese Methode aktualisiert alle angezeigten Layer. Statische Layer werden nur einmal beim wechsel auf ein neues TileGrid gezeichnet!. tilegrid das tilegrid, auf dem die Layer gezeichnet werden sollen Definiert in Zeile 363 der Datei LayerSystem.cs Dokumentation der Propertys List<MinimapLayer> LayerSystem.Layers [get] Definiert in Zeile 37 der Datei LayerSystem.cs. 3.3 MetaProvider Klassenreferenz Stellt die notwendigen Daten für die Minimap zur Verfügung. Öffentliche Methoden MetaProvider (string path) Erzeugt ein neues Objekt des Metaproviders void ProvideData () Holt sich alle Daten aus dem XML-File und speichert diese in Klassen ab Propertys List< PointOfInterest > PointsOfInterest Ausgelesene PointsOfInterest [get] Ausführliche Beschreibung Stellt die notwendigen Daten für die Minimap zur Verfügung. Definiert in Zeile 13 der Datei MetaProvider.cs Beschreibung der Konstruktoren und Destruktoren MetaProvider.MetaProvider ( string path ) Erzeugt ein neues Objekt des Metaproviders

16 12 Klassen-Dokumentation path Ist der Pfad, in der die Datei liegt Definiert in Zeile 36 der Datei MetaProvider.cs Dokumentation der Elementfunktionen void MetaProvider.ProvideData ( ) Holt sich alle Daten aus dem XML-File und speichert diese in Klassen ab Definiert in Zeile 56 der Datei MetaProvider.cs Dokumentation der Propertys List<PointOfInterest> MetaProvider.PointsOfInterest [get] Ausgelesene PointsOfInterest Definiert in Zeile 28 der Datei MetaProvider.cs. 3.4 Minimap Klassenreferenz Diese Klasse ist die Hauptklasse des Minimap-Projekts. In dieser werden alle Variablen Initialisiert und verwertet. Ebenfalls bestimmt diese Klasse was genau angezeigt werden soll und was nicht. Klassendiagramm für Minimap: MonoBehaviour Minimap

17 3.4 Minimap Klassenreferenz 13 Zusammengehörigkeiten von Minimap: MonoBehaviour Minimap Öffentliche Attribute GameObject TrackedObject Das Gameobject, das die Minimap gegebenenfalls verfolgen soll. int NumberOfTilesXAxis int Zoom Die Anzahl der Tiles entlang der X- und Y-Achse Der Zoombereich, auf die combinedtextur, es wird in Tilestufen gezoomt int maxdrawticks bool TrackObject Das Attribut bestimmt, ob das Objekt, an das diese Minimap hängt von der Kamera verfolgt werden soll. bool DrawTileGridWithRect Dieses Attribut gibt an, ob das TileGrid anhand eines Rechtecks gezeichnet werden soll. Wenn es auf false steht, dann wird das TileGrid anhand des TrackedObjects gezeichnet. bool DrawStaticOnly Veranlasst die Minimap dazu, nur statische Variablen zu zeichnen. Rect TileArea Dieses Attribut, beinhaltet einen Bereich von Tiles, die auf der Minimap dargestellt werden sollen. Propertys Texture2D CombinedTexture [get] Die aus dem TileGrid zusammengesetze Textur MinimapTile[,] TileGrid [get] Das TileGrid, das alle aktuellen Zeichenbereiche beinhaltet LayerSystem LayerSystem [get] Verwaltet die einzelnen Layer auf den einzelnen Tiles im TileGrid

18 14 Klassen-Dokumentation Ausführliche Beschreibung Diese Klasse ist die Hauptklasse des Minimap-Projekts. In dieser werden alle Variablen Initialisiert und verwertet. Ebenfalls bestimmt diese Klasse was genau angezeigt werden soll und was nicht. Definiert in Zeile 9 der Datei Minimap.cs Dokumentation der Datenelemente bool Minimap.DrawStaticOnly Veranlasst die Minimap dazu, nur statische Variablen zu zeichnen. Definiert in Zeile 71 der Datei Minimap.cs bool Minimap.DrawTileGridWithRect Dieses Attribut gibt an, ob das TileGrid anhand eines Rechtecks gezeichnet werden soll. Wenn es auf false steht, dann wird das TileGrid anhand des TrackedObjects gezeichnet. Definiert in Zeile 63 der Datei Minimap.cs int Minimap.maxDrawTicks Definiert in Zeile 53 der Datei Minimap.cs int Minimap.NumberOfTilesXAxis Die Anzahl der Tiles entlang der X- und Y-Achse Definiert in Zeile 23 der Datei Minimap.cs Rect Minimap.TileArea Dieses Attribut, beinhaltet einen Bereich von Tiles, die auf der Minimap dargestellt werden sollen. Definiert in Zeile 79 der Datei Minimap.cs GameObject Minimap.TrackedObject Das Gameobject, das die Minimap gegebenenfalls verfolgen soll. Definiert in Zeile 19 der Datei Minimap.cs bool Minimap.TrackObject Das Attribut bestimmt, ob das Objekt, an das diese Minimap hängt von der Kamera verfolgt werden soll.

19 3.5 MinimapGraph Klassenreferenz 15 Definiert in Zeile 58 der Datei Minimap.cs int Minimap.Zoom Der Zoombereich, auf die combinedtextur, es wird in Tilestufen gezoomt Definiert in Zeile 32 der Datei Minimap.cs Dokumentation der Propertys Texture2D Minimap.CombinedTexture [get] Die aus dem TileGrid zusammengesetze Textur Definiert in Zeile 91 der Datei Minimap.cs LayerSystem Minimap.LayerSystem [get] Verwaltet die einzelnen Layer auf den einzelnen Tiles im TileGrid Definiert in Zeile 107 der Datei Minimap.cs MinimapTile [,] Minimap.TileGrid [get] Das TileGrid, das alle aktuellen Zeichenbereiche beinhaltet Definiert in Zeile 99 der Datei Minimap.cs. 3.5 MinimapGraph Klassenreferenz Die Klasse Graph zeigt alle gültigen Wege an, mit denen eine Route bestimmt werden kann. Diese Klasse ist ein statisches Drawable Klassendiagramm für MinimapGraph: IMinimapDrawable MinimapGraph

20 16 Klassen-Dokumentation Zusammengehörigkeiten von MinimapGraph: IMinimapDrawable MinimapGraph Öffentliche Methoden void Draw (MinimapGraphics g) Zeichnet das Objekt auf die Map Propertys Rect Boundary [get, set] Ausführliche Beschreibung Die Klasse Graph zeigt alle gültigen Wege an, mit denen eine Route bestimmt werden kann. Diese Klasse ist ein statisches Drawable Definiert in Zeile 8 der Datei MinimapGraph.cs Dokumentation der Elementfunktionen void MinimapGraph.Draw ( MinimapGraphics g ) Zeichnet das Objekt auf die Map g Das Graphicsobjekt, das auf der Map zeichnen kann Implementiert IMinimapDrawable. Definiert in Zeile 24 der Datei MinimapGraph.cs.

21 3.6 MinimapGraphics Klassenreferenz Dokumentation der Propertys Rect MinimapGraph.Boundary [get], [set] Definiert in Zeile 14 der Datei MinimapGraph.cs. 3.6 MinimapGraphics Klassenreferenz Das Graphicsobjekt zeichnet auf seiner Zeichenfläche. Dieses Objekt wird für sämtliche Zeichenoperationen verwendet. Zusammengehörigkeiten von MinimapGraphics: MinimapTile GraphicsTile MinimapGraphics Öffentliche Methoden MinimapGraphics getinstance () Statische und einmalige Instanz dieser Klasse. void DrawLine (float x0, float y0, float x1, float y1, Color color) void DrawLine (Vector2 start, Vector2 end) Zeichnet eine Linie von start zu end void DrawLine (Vector2 start, Vector2 end, Color color) Zeichnet eine Linie von start zu end void DrawEllipse (float x, float y, int a, int b, Color color) void DrawEllipse (int x, int y, int width, int height) Zeichnet eine Ellipse. void DrawEllipse (int x, int y, int width, int height, Color color) Zeichnet eine Ellipse. void DrawTexture (int cx, int cy, Texture2D texture) Zeichnet eine Textur und speichert die überschriebenen Pixel zwischen. void DrawString (int x, int y, int size, string text)

22 18 Klassen-Dokumentation Zeichnet einen String auf eine Textur. void DrawString (int x, int y, int size, string text, Color color) Zeichnet einen String auf eine Textur. Öffentliche Attribute MinimapTile GraphicsTile Die Textur, auf die gezeichnet wird Ausführliche Beschreibung Das Graphicsobjekt zeichnet auf seiner Zeichenfläche. Dieses Objekt wird für sämtliche Zeichenoperationen verwendet. Definiert in Zeile 8 der Datei MinimapGraphics.cs Dokumentation der Elementfunktionen void MinimapGraphics.DrawEllipse ( float x, float y, int a, int b, Color color ) Definiert in Zeile 179 der Datei MinimapGraphics.cs void MinimapGraphics.DrawEllipse ( int x, int y, int width, int height ) Zeichnet eine Ellipse. x y width height x-position der Ellipse y-position der Ellipse Länge der Ellipse Höhe der Ellipse Definiert in Zeile 199 der Datei MinimapGraphics.cs void MinimapGraphics.DrawEllipse ( int x, int y, int width, int height, Color color ) Zeichnet eine Ellipse. x y width height color x-position der Ellipse y-position der Ellipse Länge der Ellipse Höhe der Ellipse Farbe der Ellipse

23 3.6 MinimapGraphics Klassenreferenz 19 Definiert in Zeile 221 der Datei MinimapGraphics.cs void MinimapGraphics.DrawLine ( float x0, float y0, float x1, float y1, Color color ) Definiert in Zeile 79 der Datei MinimapGraphics.cs void MinimapGraphics.DrawLine ( Vector2 start, Vector2 end ) Zeichnet eine Linie von start zu end start end Anfangspunkt Entpunkt Definiert in Zeile 97 der Datei MinimapGraphics.cs void MinimapGraphics.DrawLine ( Vector2 start, Vector2 end, Color color ) Zeichnet eine Linie von start zu end start end color Anfangspunkt Entpunkt Farbe der Linie Definiert in Zeile 114 der Datei MinimapGraphics.cs void MinimapGraphics.DrawString ( int x, int y, int size, string text ) Zeichnet einen String auf eine Textur. x y size text x-position des Strings y-position des Strings Textgröße Text, der geschrieben werden soll Definiert in Zeile 466 der Datei MinimapGraphics.cs void MinimapGraphics.DrawString ( int x, int y, int size, string text, Color color ) Zeichnet einen String auf eine Textur.

24 20 Klassen-Dokumentation x y size text color x-position des Strings y-position des Strings Textgröße Text, der geschrieben werden soll Farbe des Textes Definiert in Zeile 489 der Datei MinimapGraphics.cs void MinimapGraphics.DrawTexture ( int cx, int cy, Texture2D texture ) Zeichnet eine Textur und speichert die überschriebenen Pixel zwischen. x y texture X-Position der Textur Y-Position der Textur Die Textur, die gezeichnet werden soll Definiert in Zeile 307 der Datei MinimapGraphics.cs MinimapGraphics MinimapGraphics.getInstance ( ) Statische und einmalige Instanz dieser Klasse. Rückgabe Die einmalige Instanz dieser Klasse Definiert in Zeile 29 der Datei MinimapGraphics.cs Dokumentation der Datenelemente MinimapTile MinimapGraphics.GraphicsTile Die Textur, auf die gezeichnet wird. Definiert in Zeile 13 der Datei MinimapGraphics.cs.

25 3.7 MinimapInspector Klassenreferenz MinimapInspector Klassenreferenz Klassendiagramm für MinimapInspector: Editor MinimapInspector Zusammengehörigkeiten von MinimapInspector: Editor MinimapInspector Öffentliche Methoden override void OnInspectorGUI () Ausführliche Beschreibung Definiert in Zeile 6 der Datei MinimapInspector.cs Dokumentation der Elementfunktionen

26 22 Klassen-Dokumentation override void MinimapInspector.OnInspectorGUI ( ) Definiert in Zeile 8 der Datei MinimapInspector.cs. 3.8 MinimapLayer Klassenreferenz Ein Layer ist eine geordnete Menge von IDrawables, die auf der Map angezeigt werden können. Klassendiagramm für MinimapLayer: MinimapLayer ScreenshotLayer Öffentliche Methoden MinimapLayer () Erzeugt eine neue Instanz von Layer virtual void Draw (MinimapTile[,] tilegrid) Zeichnet all seine Drawables auf das tilegrid, wenn dieses Layer sichtbar ist (Layer.IsVisible = true) virtual MinimapLayer Add (IMinimapDrawable drawable) Fügt ein neues Drawable dem Layer hinzu. virtual void Remove (IMinimapDrawable drawable) Entfernt ein Drawable aus dem Layer Öffentliche Attribute MinimapLayerID ID ID des Layers bool IsVisible Sagt aus, ob der Layer gezeichnet werden soll. bool IsStatic Sagt aus, ob der Layer statisch ist, also einmal gezeichnet wird, oder ob er dynamisch ist. int Priority

27 3.8 MinimapLayer Klassenreferenz 23 Die Priorität des Layers. Umso kleiner der Wert, umso höher die Priorität. Die Priorität bedeutet in diesem Fall, welches Layer, über einem anderen liegt. Ein Layer mit einer höheren Priorität liegt über einem anderen. Geschützte Attribute List< IMinimapDrawable > drawables Alle IDrawables, die gezeichnet werden können Propertys List< IMinimapDrawable > DrawableObjects [get, set] Alle IDrawables, die gezeichnet werden können Ausführliche Beschreibung Ein Layer ist eine geordnete Menge von IDrawables, die auf der Map angezeigt werden können. Definiert in Zeile 9 der Datei MinimapLayer.cs Beschreibung der Konstruktoren und Destruktoren MinimapLayer.MinimapLayer ( ) Erzeugt eine neue Instanz von Layer Definiert in Zeile 37 der Datei MinimapLayer.cs Dokumentation der Elementfunktionen virtual MinimapLayer MinimapLayer.Add ( IMinimapDrawable drawable ) [virtual] Fügt ein neues Drawable dem Layer hinzu. drawable Das Drawable, das dem Layer hinzugefügt werden soll Erneute Implementation in ScreenshotLayer. Definiert in Zeile 102 der Datei MinimapLayer.cs virtual void MinimapLayer.Draw ( MinimapTile tilegrid[,] ) [virtual] Zeichnet all seine Drawables auf das tilegrid, wenn dieses Layer sichtbar ist (Layer.IsVisible = true)

28 24 Klassen-Dokumentation tilegrid Das TileGrid, auf das gezeichnet werden soll. Erneute Implementation in ScreenshotLayer. Definiert in Zeile 58 der Datei MinimapLayer.cs virtual void MinimapLayer.Remove ( IMinimapDrawable drawable ) [virtual] Entfernt ein Drawable aus dem Layer drawable Das Drawable, das aus dem Layer entfernt werden soll Erneute Implementation in ScreenshotLayer. Definiert in Zeile 115 der Datei MinimapLayer.cs Dokumentation der Datenelemente List<IMinimapDrawable> MinimapLayer.drawables [protected] Alle IDrawables, die gezeichnet werden können Definiert in Zeile 32 der Datei MinimapLayer.cs MinimapLayerID MinimapLayer.ID ID des Layers Definiert in Zeile 14 der Datei MinimapLayer.cs bool MinimapLayer.IsStatic Sagt aus, ob der Layer statisch ist, also einmal gezeichnet wird, oder ob er dynamisch ist. Definiert in Zeile 22 der Datei MinimapLayer.cs bool MinimapLayer.IsVisible Sagt aus, ob der Layer gezeichnet werden soll. Definiert in Zeile 18 der Datei MinimapLayer.cs int MinimapLayer.Priority Die Priorität des Layers. Umso kleiner der Wert, umso höher die Priorität. Die Priorität bedeutet in diesem Fall, welches Layer, über einem anderen liegt. Ein Layer mit einer höheren Priorität liegt über einem anderen.

29 3.9 MinimapLayerFactory Klassenreferenz 25 Definiert in Zeile 28 der Datei MinimapLayer.cs Dokumentation der Propertys List<IMinimapDrawable> MinimapLayer.DrawableObjects [get], [set] Alle IDrawables, die gezeichnet werden können Definiert in Zeile 46 der Datei MinimapLayer.cs. 3.9 MinimapLayerFactory Klassenreferenz Diese Klasse erzeugt die Layer und dessen Drawables, die hinterher vom LayerSystem verwaltet werden. Öffentliche, statische Methoden static MinimapLayer CreatePointOfInterestLayer () Erzeugt ein neues PointOfInterest Layer mit Drawables. static MinimapLayer CreateScreenShotLayer () Erzeugt ein neues ScreenShotLayer, Achtung hier werden keine Drawables erzeugt, da diese vom TileGrid abhängen, was bedeutet hier müssen die Drawables manuell angelegt werden static MinimapLayer CreateMoveableObjectLayer () Erzeugt ein neues MoveableObjectLayer, Achtung hier müssen die Drawables später eingefügt werden, da es sich hier bei um ein dynamisches Layer handelt. static MinimapLayer CreateRouteLayer () Erzeugt ein neues RouteLayer, was die Route von einem Knoten im Graphen zu einem anderen darstellen soll. static MinimapLayer CreateGraphLayer () Erzeugt ein neues GraphLayer, was den Graph auf dem TileGrid darstellt Ausführliche Beschreibung Diese Klasse erzeugt die Layer und dessen Drawables, die hinterher vom LayerSystem verwaltet werden. Das LayerSystem greift alle öffentlichen-statischen Methoden ab, die einen Layer als Rückgabetypen haben und keine entgegennehmen. Definiert in Zeile 11 der Datei MinimapLayerFactory.cs Dokumentation der Elementfunktionen static MinimapLayer MinimapLayerFactory.CreateGraphLayer ( ) [static] Erzeugt ein neues GraphLayer, was den Graph auf dem TileGrid darstellt.

30 26 Klassen-Dokumentation Rückgabe Das neu erzeugte Layer Definiert in Zeile 153 der Datei MinimapLayerFactory.cs static MinimapLayer MinimapLayerFactory.CreateMoveableObjectLayer ( ) [static] Erzeugt ein neues MoveableObjectLayer, Achtung hier müssen die Drawables später eingefügt werden, da es sich hier bei um ein dynamisches Layer handelt. Rückgabe Das neu erzeugte Layer Definiert in Zeile 75 der Datei MinimapLayerFactory.cs static MinimapLayer MinimapLayerFactory.CreatePointOfInterestLayer ( ) [static] Erzeugt ein neues PointOfInterest Layer mit Drawables. Rückgabe Das neu erzeugte Layer Definiert in Zeile 19 der Datei MinimapLayerFactory.cs static MinimapLayer MinimapLayerFactory.CreateRouteLayer ( ) [static] Erzeugt ein neues RouteLayer, was die Route von einem Knoten im Graphen zu einem anderen darstellen soll. Rückgabe Das neu erzeugte Layer Definiert in Zeile 126 der Datei MinimapLayerFactory.cs static MinimapLayer MinimapLayerFactory.CreateScreenShotLayer ( ) [static] Erzeugt ein neues ScreenShotLayer, Achtung hier werden keine Drawables erzeugt, da diese vom TileGrid abhängen, was bedeutet hier müssen die Drawables manuell angelegt werden Rückgabe The screen shot layer. Definiert in Zeile 55 der Datei MinimapLayerFactory.cs.

31 3.10 MinimapPathProvider Klassenreferenz MinimapPathProvider Klassenreferenz Beinhaltet die Dateipfade zu den Ressourcen Statische öffentliche Attribute static string RESOURCE_PATH = "minimap/" static string SCREENSHOT_PATH = RESOURCE_PATH + "screenshots/" static string ICON_PATH = RESOURCE_PATH + "icons/" Ausführliche Beschreibung Beinhaltet die Dateipfade zu den Ressourcen Definiert in Zeile 7 der Datei MinimapPathProvider.cs Dokumentation der Datenelemente string MinimapPathProvider.ICON PATH = RESOURCE_PATH + icons/ [static] Definiert in Zeile 11 der Datei MinimapPathProvider.cs string MinimapPathProvider.RESOURCE PATH = minimap/ [static] Definiert in Zeile 9 der Datei MinimapPathProvider.cs string MinimapPathProvider.SCREENSHOT PATH = RESOURCE_PATH + screenshots/ [static] Definiert in Zeile 10 der Datei MinimapPathProvider.cs MinimapRoute Klassenreferenz Die Route stellt den Weg zwischen Punkten auf der Minimap dar. Da diese sich im dynamisch verändern kann, muss diese auch als dynamisches Drawable betrachtet werden.

32 28 Klassen-Dokumentation Klassendiagramm für MinimapRoute: IMinimapDrawable MinimapRoute Zusammengehörigkeiten von MinimapRoute: IMinimapDrawable MinimapRoute Öffentliche Methoden void Draw (MinimapGraphics g) Zeichnet das Objekt auf die Map Propertys Rect Boundary [get, set] Ausführliche Beschreibung Die Route stellt den Weg zwischen Punkten auf der Minimap dar. Da diese sich im dynamisch verändern kann, muss diese auch als dynamisches Drawable betrachtet werden.

33 3.12 MinimapSettings Klassenreferenz 29 Definiert in Zeile 9 der Datei MinimapRoute.cs Dokumentation der Elementfunktionen void MinimapRoute.Draw ( MinimapGraphics g ) Zeichnet das Objekt auf die Map g Das Graphicsobjekt, das auf der Map zeichnen kann Implementiert IMinimapDrawable. Definiert in Zeile 25 der Datei MinimapRoute.cs Dokumentation der Propertys Rect MinimapRoute.Boundary [get], [set] Definiert in Zeile 15 der Datei MinimapRoute.cs MinimapSettings Klassenreferenz Diese Klasse beinhaltet alle notwendigen Daten der abgespeicherten Screenshots. Hier mit können Länge, Breite usw. des Screenshots abgefragt werden. Öffentliche Attribute string SegmentName int WorldTileWidth Die Breite eines Tiles in Welteinheiten. int WorldTileHeight Die Höhe eines Tiles in Welteinheiten. int PixelTileWidth Die Breite eines Tiles in Pixeln. int PixelTileHeight Die Höhe eines Tiles in Pixeln. Rect WorldArea Der Bereich, über den die Screenshots gemacht wurden.

34 30 Klassen-Dokumentation Ausführliche Beschreibung Diese Klasse beinhaltet alle notwendigen Daten der abgespeicherten Screenshots. Hier mit können Länge, Breite usw. des Screenshots abgefragt werden. Definiert in Zeile 8 der Datei MinimapSettings.cs Dokumentation der Datenelemente int MinimapSettings.PixelTileHeight Die Höhe eines Tiles in Pixeln. Definiert in Zeile 34 der Datei MinimapSettings.cs int MinimapSettings.PixelTileWidth Die Breite eines Tiles in Pixeln. Definiert in Zeile 29 der Datei MinimapSettings.cs string MinimapSettings.SegmentName Der Segmentname sorgt für die unterscheidbarkeit der Screenshotkategorien untereinander, wobei eine Kategorisierung z.b. nach Zoomfaktor bei den Screenshots geschehen kann. Definiert in Zeile 14 der Datei MinimapSettings.cs Rect MinimapSettings.WorldArea Der Bereich, über den die Screenshots gemacht wurden. Definiert in Zeile 39 der Datei MinimapSettings.cs int MinimapSettings.WorldTileHeight Die Höhe eines Tiles in Welteinheiten. Definiert in Zeile 24 der Datei MinimapSettings.cs int MinimapSettings.WorldTileWidth Die Breite eines Tiles in Welteinheiten. Definiert in Zeile 19 der Datei MinimapSettings.cs.

35 3.13 MinimapTile Klassenreferenz MinimapTile Klassenreferenz Diese Struktur ist eine leere Zeichenfläche an einer bestimmten Position. Wenn man sich ein Blatt Papier vorstellt, wäre ein Tile ein Stück dieses Papiers an einer bestimmten Stelle. Öffentliche Attribute int X int Y x-position des Tiles y-position des Tiles Texture2D GraphicsTexture Zeichenbereich des Tiles bool HasChanged Diese Variable muss immer auf true gesetzt werden, wenn sich an diesem Tile irgendetwas geändert hat Ausführliche Beschreibung Diese Struktur ist eine leere Zeichenfläche an einer bestimmten Position. Wenn man sich ein Blatt Papier vorstellt, wäre ein Tile ein Stück dieses Papiers an einer bestimmten Stelle. Definiert in Zeile 8 der Datei MinimapTile.cs Dokumentation der Datenelemente Texture2D MinimapTile.GraphicsTexture Zeichenbereich des Tiles Definiert in Zeile 21 der Datei MinimapTile.cs bool MinimapTile.HasChanged Diese Variable muss immer auf true gesetzt werden, wenn sich an diesem Tile irgendetwas geändert hat Definiert in Zeile 26 der Datei MinimapTile.cs int MinimapTile.X x-position des Tiles Definiert in Zeile 13 der Datei MinimapTile.cs.

36 32 Klassen-Dokumentation int MinimapTile.Y y-position des Tiles Definiert in Zeile 17 der Datei MinimapTile.cs MoveableObject Klassenreferenz MoveableObjects sind dynamische Objekte, welche ständig aktuallisiert werden müssen, da diese sich bewegen können. Klassendiagramm für MoveableObject: IMinimapDrawable MoveableObject Zusammengehörigkeiten von MoveableObject: IMinimapDrawable MoveableObject Öffentliche Methoden void Draw (MinimapGraphics g) Zeichnet das Objekt auf die Map

37 3.14 MoveableObject Klassenreferenz 33 Propertys Rect Boundary [get, set] Texture2D Image [get, set] Das Aussehen des Drawables, die Textur, die auf der Minimap dargestellt wird. GameObject DynamicObject [get, set] Beinhaltet das Gameobjekt, an das dieses Drawable gebunden ist Ausführliche Beschreibung MoveableObjects sind dynamische Objekte, welche ständig aktuallisiert werden müssen, da diese sich bewegen können. Definiert in Zeile 8 der Datei MoveableObject.cs Dokumentation der Elementfunktionen void MoveableObject.Draw ( MinimapGraphics g ) Zeichnet das Objekt auf die Map g Das Graphicsobjekt, das auf der Map zeichnen kann Implementiert IMinimapDrawable. Definiert in Zeile 51 der Datei MoveableObject.cs Dokumentation der Propertys Rect MoveableObject.Boundary [get], [set] Definiert in Zeile 24 der Datei MoveableObject.cs GameObject MoveableObject.DynamicObject [get], [set] Beinhaltet das Gameobjekt, an das dieses Drawable gebunden ist. Das Gameobjekt, an das dieses Drawable gebunden ist. Definiert in Zeile 46 der Datei MoveableObject.cs Texture2D MoveableObject.Image [get], [set] Das Aussehen des Drawables, die Textur, die auf der Minimap dargestellt wird. Definiert in Zeile 33 der Datei MoveableObject.cs.

38 34 Klassen-Dokumentation 3.15 NodeHelper Klassenreferenz Öffentliche, statische Methoden static BCLane GetNearestLane (Vector3 worldposition) static BCGraphPart GetNearestGraphPart (Vector3 worldposition) Ausführliche Beschreibung Definiert in Zeile 5 der Datei NodeHelper.cs Dokumentation der Elementfunktionen static BCGraphPart NodeHelper.GetNearestGraphPart ( Vector3 worldposition ) [static] Definiert in Zeile 31 der Datei NodeHelper.cs static BCLane NodeHelper.GetNearestLane ( Vector3 worldposition ) [static] Definiert in Zeile 7 der Datei NodeHelper.cs PointOfInterest Klassenreferenz Ist ein PointOfInterest, welcher auf der Minimap angezeigt werden kann. Diese Klasse hält die notwendigen Daten für die Beschreibung und Darstellung für einen PointOfInterest bereit. Klassendiagramm für PointOfInterest: IMinimapDrawable PointOfInterest

39 3.16 PointOfInterest Klassenreferenz 35 Zusammengehörigkeiten von PointOfInterest: IMinimapDrawable PointOfInterest Öffentliche Methoden void Draw (MinimapGraphics g) Zeichnet das Objekt auf die Map Öffentliche Attribute String Name Der Name des PointOfInterest String Type Der Typ des PointOfInterest zb. Kino String Description Beschreibung zum PointOfInterest Propertys Rect Boundary [get, set] Texture2D Image [get, set] Das Aussehen des Drawables, die Textur, die auf der Minimap dargestellt wird Ausführliche Beschreibung Ist ein PointOfInterest, welcher auf der Minimap angezeigt werden kann. Diese Klasse hält die notwendigen Daten für die Beschreibung und Darstellung für einen PointOfInterest bereit. Definiert in Zeile 12 der Datei PointOfInterest.cs.

40 36 Klassen-Dokumentation Dokumentation der Elementfunktionen void PointOfInterest.Draw ( MinimapGraphics g ) Zeichnet das Objekt auf die Map g Das Graphicsobjekt, das auf der Map zeichnen kann Implementiert IMinimapDrawable. Definiert in Zeile 51 der Datei PointOfInterest.cs Dokumentation der Datenelemente String PointOfInterest.Description Beschreibung zum PointOfInterest Definiert in Zeile 25 der Datei PointOfInterest.cs String PointOfInterest.Name Der Name des PointOfInterest Definiert in Zeile 17 der Datei PointOfInterest.cs String PointOfInterest.Type Der Typ des PointOfInterest zb. Kino Definiert in Zeile 21 der Datei PointOfInterest.cs Dokumentation der Propertys Rect PointOfInterest.Boundary [get], [set] Definiert in Zeile 37 der Datei PointOfInterest.cs Texture2D PointOfInterest.Image [get], [set] Das Aussehen des Drawables, die Textur, die auf der Minimap dargestellt wird. Definiert in Zeile 46 der Datei PointOfInterest.cs.

41 3.17 RouteDrawer Klassenreferenz RouteDrawer Klassenreferenz Klassendiagramm für RouteDrawer: IMinimapDrawable RouteDrawer Zusammengehörigkeiten von RouteDrawer: IMinimapDrawable RouteDrawer Öffentliche Methoden RouteDrawer () void SetRoute (Vector3 startpos, Vector3 targetpos) Bewirkt, dass beim nchsten Aufruf von Draw eine Route ber das Straennetz ber die angegebenen Koordinaten gezeichnet wird. void Draw (MinimapGraphics drawer) Zeichnet das Objekt auf die Map Propertys Rect Boundary [get]

42 38 Klassen-Dokumentation Ausführliche Beschreibung Definiert in Zeile 5 der Datei RouteDrawer.cs Beschreibung der Konstruktoren und Destruktoren RouteDrawer.RouteDrawer ( ) Definiert in Zeile 12 der Datei RouteDrawer.cs Dokumentation der Elementfunktionen void RouteDrawer.Draw ( MinimapGraphics g ) Zeichnet das Objekt auf die Map g Das Graphicsobjekt, das auf der Map zeichnen kann Implementiert IMinimapDrawable. Definiert in Zeile 39 der Datei RouteDrawer.cs void RouteDrawer.SetRoute ( Vector3 startpos, Vector3 targetpos ) Bewirkt, dass beim nchsten Aufruf von Draw eine Route ber das Straennetz ber die angegebenen Koordinaten gezeichnet wird. Definiert in Zeile 31 der Datei RouteDrawer.cs Dokumentation der Propertys Rect RouteDrawer.Boundary [get] Definiert in Zeile 20 der Datei RouteDrawer.cs SceenTilePostprocessor Klassenreferenz Macht alle notwendigen Einstellungen, die beim Import der Bilder fr die Straenkarte gemacht werden mssen.

43 3.19 ScreenshotLayer Klassenreferenz 39 Klassendiagramm für SceenTilePostprocessor: AssetPostprocessor SceenTilePostprocessor Zusammengehörigkeiten von SceenTilePostprocessor: AssetPostprocessor SceenTilePostprocessor Ausführliche Beschreibung Macht alle notwendigen Einstellungen, die beim Import der Bilder fr die Straenkarte gemacht werden mssen. Definiert in Zeile 7 der Datei SceenTilePostprocessor.cs ScreenshotLayer Klassenreferenz Ein Layer ist eine geordnete Menge von IDrawables, die auf der Map angezeigt werden können.

44 40 Klassen-Dokumentation Klassendiagramm für ScreenshotLayer: MinimapLayer ScreenshotLayer Zusammengehörigkeiten von ScreenshotLayer: MinimapLayer ScreenshotLayer Öffentliche Methoden ScreenshotLayer () override void Draw (MinimapTile[,] tilegrid) Zeichnet alle sichtbaren Screenshots für das aktuelle Tilegrid override MinimapLayer Add (IMinimapDrawable drawable) Fügt ein neues Drawable dem Layer hinzu. override void Remove (IMinimapDrawable drawable) Entfernt ein Drawable aus dem Layer Weitere Geerbte Elemente

45 3.19 ScreenshotLayer Klassenreferenz Ausführliche Beschreibung Ein Layer ist eine geordnete Menge von IDrawables, die auf der Map angezeigt werden können. Definiert in Zeile 10 der Datei ScreenshotLayer.cs Beschreibung der Konstruktoren und Destruktoren ScreenshotLayer.ScreenshotLayer ( ) Definiert in Zeile 14 der Datei ScreenshotLayer.cs Dokumentation der Elementfunktionen override MinimapLayer ScreenshotLayer.Add ( IMinimapDrawable drawable ) [virtual] Fügt ein neues Drawable dem Layer hinzu. drawable Das Drawable, das dem Layer hinzugefügt werden soll Erneute Implementation von MinimapLayer. Definiert in Zeile 65 der Datei ScreenshotLayer.cs override void ScreenshotLayer.Draw ( MinimapTile tilegrid[,] ) [virtual] Zeichnet alle sichtbaren Screenshots für das aktuelle Tilegrid tilegrid Das TileGrid, auf das gezeichnet werden soll. Erneute Implementation von MinimapLayer. Definiert in Zeile 30 der Datei ScreenshotLayer.cs override void ScreenshotLayer.Remove ( IMinimapDrawable drawable ) [virtual] Entfernt ein Drawable aus dem Layer drawable Das Drawable, das aus dem Layer entfernt werden soll Erneute Implementation von MinimapLayer. Definiert in Zeile 70 der Datei ScreenshotLayer.cs.

46 42 Klassen-Dokumentation 3.20 ScreenShotMenu Klassenreferenz Reprsentiert das Menelement "Steetmap -> Take Map Screenshots" und die Funktionalitt fr das Schieen der Screenshots fr die Streetmap im Unity Editor. Klassendiagramm für ScreenShotMenu: EditorWindow ScreenShotMenu Zusammengehörigkeiten von ScreenShotMenu: EditorWindow ScreenShotMenu Ausführliche Beschreibung Reprsentiert das Menelement "Steetmap -> Take Map Screenshots" und die Funktionalitt fr das Schieen der Screenshots fr die Streetmap im Unity Editor. Definiert in Zeile 9 der Datei ScreenShotMenu.cs.