Systeem Ontwerp. Christophe Deloo, Roy Straver & Machiel Visser. Versie 2 ( )

Transcriptie

1 Systeem Ontwerp Christophe Deloo, Roy Straver & Machiel Visser Versie 2 ( )

2 Inhoudsopgave Voorwoord Inleiding Domein Toestanden Objecten Klassen Gebruikersinterface Weergave Bediening

3 Voorwoord Alvorens de implementatie moet het ontwerp voor de 3D scenario editor uitgewerkt worden. Het ontwerp dient als leidraad en houvast tijdens de implementatiefase. Evenzo helpt dit ontwerp bij het vooruitzien van moeilijkheden. We zullen waar nodig ontwerp specificaties schematisch weergeven om zo de overzichtelijkheid te vergroten. 2

4 1 Inleiding In de 3D scenario editor staat het plaatsen van units en paden centraal. Aan de hand van het door ons verrichte onderzoek hebben we besloten om deze twee functionaliteiten op te delen in twee verschillende tools, de unit tool en de path tool. De unit tool is bestemd voor het plaatsen van nieuwe units, het wijzigen van unit eigenschappen en het verwijderen van units. De path tool is bestemd voor het plaatsen van nieuwe paden, het wijzigen van pad eigenschappen en het verwijderen van paden. Naast de functionaliteiten voor het plaatsen van units en paden is het ook belangrijk dat de editor ondersteuning biedt voor het wijzigen van missie (omgevings) gerelateerde eigenschappen. Deze eigenschappen zijn instelbaar in een derde tool, de general tool. We hebben bewust niet de functionaliteit voor het plaatsen van triggers in dit ontwerp document gespecificeerd omdat deze wegens een lagere prioriteit van ondergeschikt belang is. Echter is het voor de hand liggend dat voor het plaatsen van triggers de editor wordt voorzien van een vierde tool, de trigger tool. In het ontwerp van het systeem proberen we op deze manier zoveel mogelijk rekening te houden met toekomstige uitbreidingen. De editor zal uiteindelijk de mogelijkheid geven tot het selecteren en van meerdere units. Dit in tegenstelling tot paden. Waarvoor hoogstens één waypoint van één pad geselecteerd kan worden. Daarnaast zal het niet mogelijk zijn om een unit en een waypoint (pad) tegelijk geselecteerd te hebben. In ons onderzoek hebben we tevens besloten om de editor te voorzien van twee verschillende weergaven voor de viewport. Een 2D top-down weergave en een 3D weergave. Voor de 3D weergave zal de editor ondersteuning bieden voor twee verschillende besturingen. Een gebaseerd op de s gebruikt in real-time-strategy spellen, de rts-. Deze draait om het punt op de grond waarnaar het gericht staat en is zeer geschikt om snel en op overzichtelijke wijze door de omgeving te manoeuvreren. De andere, daarentegen draait om zijn eigen punt, de free-. Deze biedt meer bewegingsvrijheid maar is minder geschikt voor het behouden van overzicht. Voor het plaatsen van units in de hoogte hebben we geconcludeerd dat we onderscheid moeten maken tussen drie mogelijkheden. Het plaatsen van een unit op een ondergrond (floor), ten opzicht van het grondniveau (ground) en ten opzichte van het zeeniveau (sea). Voor het plaatsen van waypoints maken we alleen onderscheid tussen grond- en zeeniveau. Het ontwerp is opgedeeld in een aantal verschillende specificaties die elk het systeem vanuit een andere hoek belichten. Allereerst zullen we beginnen met het omschrijven van het domein waarin de 3D scenario editor moet opereren. Vervolgens zullen de functionaliteiten en de architectuur van de 3D scenario editor aan de hand van toestands- en klassendiagrammen nader uitgewerkt worden. Deze algemene diagrammen zullen waar nodig ondersteund worden met sequence diagrammen. Tot slot zal zowel de weergave als de bediening van de gebruikersinterface uitvoerig gespecificeerd worden. 3

5 2 Domein In het huidige systeem vormt de Instructor Console (2D scenario editor) samen met een aantal andere onderdelen FACSIM. Deze onderdelen werken samen doormiddel van interfaces. Dit systeem is op te delen in de volgende subsystemen: Multi Functional Display (MFD), Visual Installation (VIS), Radio Installation (RAD), de Logger (LOG), Audio Visual Installation (AVI) en de Instructor Console (INS). Het LOG systeem wordt niet door de eindgebruikers direct gebruikt maar is er ter ondersteuning van de andere onderdelen. De bedoeling is dat onze 3D scenario editor ook een onderdeel wordt van een geheel systeem bestaande uit verschillende subsystemen. Deze subsystemen moeten via netwerk protocollen met elkaar kunnen communiceren. Zo zal er ook op de een of andere manier met de editor gecommuniceerd moeten worden. Voor de communicatie tussen de editor en de verschillende subsystemen kan gebruik gemaakt worden van een netwerk protocol dat toegespitst is op gedistribueerde simulatie systemen. Op dit moment zijn er twee populaire protocollen voor deze doeleinden geschikt, het Distributed Interactive Simulation (DIS) protocol en het nieuwere High Level Architecture (HLA). Binnen TNO is gekozen voor het DIS standaard. Een wens van TNO is om de editor gescheiden te houden van de simulatie. Om dit te realiseren wil TNO gebruik maken van VR-Forces. VR-Forces is een simulatie toolkit die ondersteuning biedt voor het simuleren, opbouwen en bekijken van militaire oefeningen. Daarnaast biedt het de mogelijkheid om een eigen applicatie te integreren in VR-Forces aan de hand van de Remote Control API van VR-Forces zelf. De editor zal gebruik maken van VR-Forces om een opgebouwd scenario te simuleren. Via de Remote Control zal communicatie tussen de editor en VR-Forces plaatsvinden. Over deze verbinding zullen veranderingen in de omgeving (zoals verplaatsingen van units) doorgegeven worden. Omdat VR-Forces over een interface beschikt die overweg kan met DIS en HLA is het alleen van belang dat de editor overweg kan met de Remote Control API van VR-Forces. Dit betekend dat het DIS protocol onzichtbaar blijft voor de editor. De 3D scenario editor zal gebruik maken van EVE voor de visualisatie van de omgeving met bijbehorende units en paden. De grafische gebruikersinterface van de editor zal met wxwidgets (een open source widget toolkit) gemaakt worden. De instructor zal aan de hand van deze gebruikersinterface met een muis en toetsenboord de editor kunnen bedienen. 4

6 Domein van de 3D scenario editor 5

7 3 Toestanden Het systeem is op te delen in drie tools: de general tool, de unit tool en de path tool. Deze drie tools zijn onderling bereikbaar. De toestanden en transities behorende tot de unit en path tool zijn vergelijkbaar. Omdat de voornaamste functionaliteiten van de 3D scenario editor ook tijdens de simulatie gebruikt moeten kunnen worden hebben we de toestand waarin het systeem zich bevindt tijdens de simulatie buiten beschouwing gelaten. Bij het opstarten van het systeem wordt het systeem eerst geïnitialiseerd waarna het zich in de general tool toestand bevindt. In de general tool kunnen onder andere algemene instellingen betreffende de missie aangepast worden. In deze toestand kan via de menubar/toolbar de create mode van de unit tool of path tool geactiveerd worden. Door een unit in de viewport te selecteren kan de edit mode van de unit tool direct vanuit de general tool bereikt worden. Hetzelfde geldt voor bij het selecteren van een waypoint (path). Na het selecteren van een waypoint bevindt het systeem zich in de edit mode van de path tool. In de create mode van de unit tool kunnen nieuwe units aangemaakt worden. Evenzo voor de create mode van de path tool, waar nieuwe paden (met waypoints) gecreëerd kunnen worden. Door het selecteren/deselecteren van een togglebutton kan geschakeld worden tussen de edit en create mode van deze tools. In de edit mode kunnen de eigenschappen van al geplaatste units en paden (met bijbehorende waypoints) gewijzigd worden. Vanuit zowel de unit als path tool kan via de menubar/toolbar een andere tool geactiveerd worden. Via de menubar/toolbar wordt voor de unit en path tool altijd de create mode geactiveerd. Door een pad via de viewport in de unit tool te selecteren wordt de edit mode van de path tool geactiveerd. Dit geldt ook voor het selecteren van een unit in de path tool. Bij het selecteren van een object in de viewport wordt dus altijd de edit mode van de unit of path tool geselecteerd. Veel overige functionaliteiten zijn toepasbaar vanuit elke toestand, hierdoor zijn ze niet opgenomen in het toestandsdiagram. Zo kan in elke toestand de weergave van de viewport veranderend worden (tussen 2D en 3D, de zichtbare objecten, ect.). Daarnaast kan vanuit elke toestand van veranderd worden, een nieuwe kaart ingeladen worden of de 3D scenario editor afgesloten worden 6

8 Toestandsdiagram 7

9 4 Objecten Onze taak is om een 3D scenario editor te maken die gebruik maakt van EVE. EVE zal de 3D weergaven van de omgeving verzorgen. Dit betekent dat de eigenschappen van objecten in de omgeving en de omgeving zelf aan EVE doorgegeven worden, evenals alle updates waarin objecten aangepast of toegevoegd worden. Hiervoor is EVE voorzien van een ObjectManager. De ObjectManager, zoals de naam al doet vermoeden, beheert alle aangemaakte objecten. EVE omvat een algemene structuur welke de mogelijkheid biedt voor het definiëren van objecten met specifieke attributen. De 3D scenario editor zal dus voor basis objecten zoals units en paden (waypoints) extensief gebruik maken van deze structuur. Objecten definities kunnen in XML gespecificeerd worden. Object definitie in XML formaat voor een unit in EVE In EVE zullen object definities voor een unit, pad, waypoint en de missie gedefinieerd worden. De object definities zijn opgebouwd uit de attributen waarvan het merendeel afleidbaar is uit het Programma van Eisen. 8

10 5 Klassen De GUIController klasse vormt de brug tussen de gebruiker en EVE. Al het invoer afkomstig van de gebruiker wordt door de GUIController verwerkt. De GUIController is een subklasse van de MainFrame klasse. In de MainFrame staat alle broncode verwerkt voor de opbouw van de grafische gebruikersinterface. De broncode is genereert met de GUI-builder wxglade, welke gebruik maakt van wxwidgets. In MainFrame staat voor elke event (in de GUI) de aangeroepen functie beschreven. De GUIController klasse overschrijft elk van deze functies met de daadwerkelijke implementatie. Naast deze functies omvat de GUIController ook de nodige attributen en functies voor het aanmaken, wijzigen, verwijderen en selecteren van objecten zoals units en paden. De GUIController heeft zo direct toegang tot de ObjectManager. Naast een ObjectManager heeft de GUIController ook toegang tot de SystemManager van EVE. Deze omvat onder andere de nodige functionaliteiten voor het berekenen van intersecties in de omgeving. De functionaliteiten worden afgehandeld door de CameraController klasse. Deze klasse is voorzien van attributen en functies nodig voor het ondersteunen van de drie verschillende modi. De Main klasse dient voor het initialiseren van EVE en de 3D scenario editor en de EveApplication klasse voor het aansturen van EVE. Veranderingen welke invloed hebben op de simulatie dienen uitgewisseld te worden met VR-Forces. Deze uitwisseling kan via de VRInterface plaatsvinden, welke afgestemd is op het gebruik van de Remote Control API van VR-Forces. 9

11 Klassendiagram 10

12 In de onderstaande diagram is de initialisatie van EVE en de 3D scenario editor schematisch weergegeven. Initialisatie Evenzo is dit document voorzien van een sequence diagram die het proces voor het aanmaken van een enkele unit beschrijft. Een korte toelichting is hier op zijn plaats. In eerste instantie activeert de gebruiker de create mode door een togglebutton te selecteren. Dit zorgt ervoor dat een nieuwe unit wordt aangemaakt en geselecteerd. Een nieuw aangemaakte unit krijgt altijd automatisch dezelfde eigenschappen toebedeeld als de unit die geselecteerd was voor het in drukken van de togglebutton. In het geval geen enkele unit geselecteerd was krijgt het de default eigenschappen. Vervolgens worden de eigenschappen van de nieuw geselecteerde unit in de grafische gebruikersinterface geladen (toolpanel voor units). De gebruiker kan deze naar wens weer aanpassen. Het bewegen van de muis in de viewport zorgt ervoor dat de geselecteerde unit in de omgeving wordt verplaatst. Door in de viewport op de linker muisknop te drukken wordt weer een nieuwe unit aangemaakt en geselecteerd. Alleen de eigenschappen van het geselecteerde object kunnen aangepast worden, hierdoor staan de positie en alle overige eigenschappen van de vorige geselecteerde unit vast. Door nu dezelfde togglebutton te deselecteren wordt de nieuw geselecteerde unit verwijderd en de vorige aangemaakte unit weer geselecteerd, waarna zijn eigenschappen in de toolpanel worden geladen. Nu is er in totaal één unit in de omgeving geplaatst. Het telkens aanmaken van een nieuwe unit bij het indrukken van de linker muisknop maakt het mogelijk om snel achtereenvolgend units plaatsen. Echter betekent dit wel dat bij het verlaten van de create mode de laatst aangemaakte unit verwijderd moet worden. Een unit is dus pas definitief geplaatst in de omgeving als de gebruiker de linker muisknop heeft ingedrukt. 11

13 Creatie van een unit 12

14 Het aanmaken van een pad met bijbehorende waypoints geschiedt op een vergelijkbare wijze als dat van unit. Echter is er wel sprake van een onvermijdbaar verschil. Een pad bestaat namelijk uit verschillende waypoints. De gebruiker kan de create mode activeren door net zoals voor units een togglebutton in te drukken, waarna een nieuw waypoint wordt aangemaakt en geselecteerd. Deze waypoint wordt automatisch gekoppeld aan de laatste waypoint van het pad van de hiervoor geselecteerde waypoint. In het geval geen enkel waypoint geselecteerd was wordt een nieuw pad aangemaakt waar de nieuwe waypoint onderdeel van wordt. De grafische gebruikers interface wordt naast de togglebutton voorzien van een knop waarmee altijd een nieuw pad wordt aangemaakt (onafhankelijk of er al een waypoint geselecteerd is). Een nieuw aangemaakte waypoint krijgt evenals bij units automatisch dezelfde eigenschappen als de hiervoor geselecteerde waypoint. De gebruiker krijgt nu de tijd om de waypoint in de omgeving te plaatsen. Zodra de linker muisknop wordt ingedrukt staat zijn positie vast en wordt een nieuw waypoint aangemaakt en geselecteerd. Zo kan men op dezelfde manier als voor units snel waypoints plaatsen om zo een pad op te zetten. De functionaliteit voor het selecteren van units verschilt ook van dat van waypoints. Het is namelijk mogelijk om meerdere units te selecteren. Hierdoor zijn er voor units drie functies nodig die het selecteren regelen. Een functie die een unit aan de selectie toevoegt door de selectie te verwijderen (zodat er altijd één unit is geselecteerd), een functie die een unit toevoegt zonder de selectie te verwijderen en een functie die een unit uit de selectie verwijderd. Omdat er in tegenstelling tot units slechts één waypoint geselecteerd kan worden zijn de laatste twee functies niet nodig voor waypoints. Echter biedt de grafische gebruikers interface de mogelijkheid om een pad te selecteren zonder direct een waypoint aan te wijzen. Omdat het niet mogelijk is om een pad geselecteerd te hebben zonder dat er een waypoint geselecteerd is wordt automatisch de laatste waypoint van het pad geselecteerd bij het selecteren van een pad. Er zijn dus twee functies nodig, één voor het selecteren van een pad en één voor het selecteren van een waypoint. Beide functies verwijderen de vorige selectie, zodat er altijd hoogstens één waypoint geselecteerd is. 13

15 5 Gebruikersinterface In dit hoofdstuk wordt de weergave en bediening van de gebruikersinterface omschreven. 5.1 Weergave De gebruikersinterface wordt met wxwidgets gemaakt aan de hand van de GUI-builder wxglade. De grafische gebruikersinterface is opgebouwd uit een menubar, toolbar, statusbar, viewport, het toolpanel en de navigation tool. Via de menubar zijn onder andere de functionaliteiten voor het inladen van een nieuwe kaart en het inladen en opslaan van een scenario te bereiken. In de toolbar staan een aantal knoppen waarmee tussen verschillende modi geschakeld kan worden. Met de knoppen uiterst links in de toolbar kan de simulatie gestopt, gepauzeerd en gestart worden. Rechts daarvan, staan nog een reeks van knoppen. Met de eerste drie knoppen kan geschakeld worden tussen de general tool, de unit tool en de path tool. Met de volgende drie knoppen, links boven de viewport, kan geschakeld worden tussen de drie 's. De overige knoppen dienen voor het aan en uit zetten van het weer en de zichtbaarheid van team kleuren (alliance), unit namen (labels), unit droplines en units en paden zelf. In de statusbar staan onder meer de positie van de en het geselecteerde object weergeven. In de viewport wordt de omgeving afgebeeld. Het deel van de omgeving dat afgebeeld wordt is afhankelijk van de positie en oriëntatie van de welke met de muis en toetsenbord te bedienen is. De weergave hangt af van de geselecteerde. De inhoud van het toolpanel veranderd bij het activeren van een tool. In de unit tool staan de nodige opties voor het selecteren, maken, verwijderen en wijzigen van units. Hetzelfde geldt voor de path tool voor paden. In de general tool staan alle opties voor het instellen van algemene missie gerelateerde eigenschappen. Naast de zo net genoemde tools is er op de grafische gebruiksinterface ook een plekje vrij gemaakt voor speciale functionaliteiten betreffende de positionering van de, de navigation tool. In deze tool staat een afbeelding van de volledige omgeving in klein formaat van bovenaf bekeken. Op deze afbeelding staat ook de positie en kijkrichting van de aangegeven. De is over de omgeving te door op een plek te klikken op de afbeelding. Naast de afbeelding staan tevens enkele knoppen om het beeld (positionering en oriëntatie van de ) aan te passen aan de hand van een geselecteerd object. 14

16 Structuur grafische gebruiksinterface 15

17 Inhoud toolpanel Veel functionaliteiten zullen ook te bereiken zijn door met de rechter muisknop te klikken in de viewport. Hierbij verschijnt er een menulijst bovenop de viewport. De beschikbare functionaliteiten zijn afhankelijk van de toestand waarin het systeem zich bevindt en de plek waar de muiscursor naar wijst in de omgeving (afgebeeld in de viewport). Zo kan de muiscursor gericht staan op een unit, een waypoint (pad) of een punt van het terrein. Het opvragen van de menulijst is alleen mogelijk buiten de create mode. 16

18 5.2 Bediening In de onderstaande twee tabellen staan voor zowel de muis als het toetsenboord de bediening voor de verscheidene functionaliteiten beschreven betreffende de viewport. In de verticale richting staan de in gebruik genomen knoppen/toetsen en in de horizontale richting de verschillende modi waarin het systeem kan verkeren. Hierin maken we onderscheid tussen de verschillende weergaven ('s) en of het systeem zich in de create toestand bevindt voor de unit en path tool. Naast de functionaliteiten die in de tabellen beschreven staan kan met de linker muisknop op de knoppen van de gebruikersinterface geklikt worden en met het toetsenbord gegevens in tekstvelden worden ingevoerd. Functionaliteiten van muis en toetsenboord in verschillende modi 2D top-down weergave 3D weergave met rts- 3D weergave met free- General tool en edit mode van unit en path tool Create mode unit en path tool General tool en edit mode van unit en path tool Create mode unit en path tool General tool en edit mode van unit en path tool Create mode unit en path tool Slepen - Selectie - Selectie - Selectie Links klikken Selecteer object Nieuw object plaatsen Selecteer object of deselecteer units Nieuw object plaatsen Selecteer object of deselecteer waypoint (pad) Nieuw object plaatsen Links ingedrukt en slepen Selectie Nieuw object plaatsen en roteren Selectie Nieuw object plaatsen en roteren Selectie Nieuw object plaatsen en roteren Rechts klikken Menulijst weergeven Naar edit mode Menulijst weergeven Naar edit mode Menulijst weergeven Naar edit mode Rechts ingedrukt en slepen Positioneer achterwaarts en zijdelings) Positioneer achterwaarts en zijdelings) Positioneer achterwaarts en zijdelings) Positioneer achterwaarts en zijdelings) Positioneer achterwaarts en zijdelings) Positioneer achterwaarts en zijdelings) Midden klikken Midden ingedrukt en slepen - - Roteer (pitch en yaw) Roteer (pitch en yaw) Roteer (pitch en yaw) Roteer (pitch en yaw) 17

19 Muiswiel bewegen SHIFT en muiswiel bewegen Pijltjes CTRL en links klikken CTRL en muiswiel bewegen Positioneer (voorwaarts en achterwaarts ten opzicht van Zie muiswiel bewegen Positioneer achterwaarts en zijdelings ten opzicht van Zie links klikken Selectie in de hoogte Positioneer (voorwaarts en achterwaarts ten opzicht van Zie muiswiel bewegen Positioneer achterwaarts en zijdelings ten opzicht van Zie links klikken Selectie in de hoogte Positioneer (voorwaarts en achterwaarts ten opzicht van Zie muiswiel bewegen Positioneer achterwaarts en zijdelings ten opzicht van Meervoudige selectie (alleen voor units) Selectie in de hoogte Positioneer (voorwaarts en achterwaarts ten opzicht van Zie muiswiel bewegen Positioneer achterwaarts en zijdelings ten opzicht van Zie links klikken Selectie in de hoogte Positioneer (voorwaarts en achterwaarts ten opzicht van Positioneer nauwkeurig (voorwaarts en achterwaarts ten opzicht van Positioneer achterwaarts en zijdelings ten opzicht van Meervoudige selectie (alleen voor units) Selectie in de hoogte Positioneer (voorwaarts en achterwaarts ten opzicht van Positioneer nauwkeurig (voorwaarts en achterwaarts ten opzicht van Positioneer achterwaarts en zijdelings ten opzicht van Zie links klikken Selectie in de hoogte SHIFT, CTRL en muiswiel bewegen Selectie nauwkeurig in de hoogte Selectie nauwkeurig in de hoogte DEL - Naar edit mode ESC - Naar edit mode W Wireframe weergave aan- en S T Weergave prestaties aan- en Weergave terrein texture aan- en Wireframe weergave aan- en Weergave prestaties aan- en Weergave terrein texture aanen Selectie nauwkeurig in de hoogte Selectie verwijderen Deselecteer units Wireframe weergave aan- en Weergave prestaties aan- en Weergave terrein texture aan- en Selectie nauwkeurig in de hoogte Naar edit mode Naar edit mode Wireframe weergave aan- en Weergave prestaties aan- en Weergave terrein texture aanen Selectie nauwkeurig in de hoogte Selectie verwijderen Deselecteer waypoint (pad) Wireframe weergave aan- en Weergave prestaties aan- en Weergave terrein texture aan- en Selectie nauwkeurig in de hoogte Naar edit mode Naar edit mode Wireframe weergave aan- en Weergave prestaties aan- en Weergave terrein texture aanen 18

20 Omdat in alle toestanden de verschillende soorten 's op dezelfde manier bestuurd worden is een compact overzicht op zijn plaats. Functionaliteiten van muis en toetsenboord voor de verschillende s Rechts ingedrukt en slepen Midden ingedrukt en slepen Muisiwiel bewegen Pijltjes 2D top-down weergave 3D weergave met rts 3D weergave met free- Positioneer achterwaarts en zijdelings) - Roteer (pitch en yaw) Positioneer (voorwaarts en achterwaarts ten opzicht van Positioneer achterwaarts en zijdelings ten opzicht van 19