From Human Computer Interaction Laboratory

Jump to: navigation, search

(Zpět na VRECKO Manuál)

Příprava

Před první kompilací VRECKA je potřeba provést několik kroků:

  • Napsat správcům ([email removed], [email removed], [email removed]), ať vám přidělí práva pro čtení SVN archívu VRECKA. Budeme potřebovat Váš login na fakultní počítače (x...). Heslo nám neposílejte.
  • Instalace SVN klienta pro stahování zdrojových kódů. Doporučujeme Tortoise SVN.
  • Instalace vývojového prostředí - MS Visual Studio 2010. Pro studenty FI je k dispozici (zdarma) na MSDN serveru.
  • VRECKO PACK. Jedna se balík s datovými soubory (zkompilované potřebné knihovny, předdefinované scény, 3D modely, ...) potřebnými pro kompilaci a běh VRECKA. Stáhnout jej můžete zde: VRECKO PACK.
    • Pozn.: Ve výjimečných případech (např. velké změny VRECKA během semestru) je možné, že VRECKO PACK na výše uvedeném odkazu nebude obsahovat některé datové soubory (textury, modely,...) či knihovny potřebné pro zkompilování nových součástí. Pokud by tato situace nastala, je možné stáhnout vždy nejaktuálnější VRECKO PACK také ZDE.
  • Knihovny PhysX. Jestliže chcece využívat v rámci VRECKA PhysX engine (standardně vypnutý - nekompiluje se), je potřeba navíc stáhnout a nainstalovat PhysX SDK... Pro většinu současných projektů ve VRECKU není PhysX potřeba. [TODO - jakou verzi, odkaz ke stažení. Vysvětlení, proč to není součástí VRECKO PACKu].

Před první kompilací

  1. Vytvořte adresář (obvykle názvy jsou HCI či OSG). Např: C:\HCI\
  2. V tomto adresáři vytvořte adresář VRECKO (např. C:\HCI\VRECKO\ )
  3. Pravým tlačítkem klikněte na nově vytvořený adresář VRECKO a vyberte "SVN Checkout..."
  4. Položku "URL of repository" nastavte na:
    https://svn.fi.muni.cz/fi/hcisvn_vrecko/trunk
    a klikněte na OK. Po zadání přihlašovacích údajů (váš fakultní login (x...) a heslo) se z repositáře stáhne nejnovější verze zdrojových souborů VRECKA.
  5. Balík VRECKO PACK rozbalte do adresáře HCI.
  6. Nastavení cest ve Visual Studiu: spusťte program ".../HCI/!TOOLS/PathGenerator.exe", pomocí kterého integrujete cesty do Visual Studia. Pokud je tlačítko "Integrate with Visual Studio" zašedlé, následujte instrukce v Help->"How to use generator".
  7. To je (mělo by být) všechno. Nyní můžete VRECKO zkompilovat a poté i spustit.

Pozn.: Pokud byste při přidávání cest udělali chybu (nebo přecházíte na novou verzi Vrecka a chcete pro jistotu přidat cesty znovu), tak je možné se vrátit ke standardnímu nastavení a přidat Vrecko-cesty znovu. Standardní nastavení cest NENÍ úplně prázdné - jsou tu cesty k základním knihovnám VisualStudia, takže bez nich se budou objevovat chyby ve stylu "missing 'float.h' " apod. Bohužel návrat ke standardnímu nastavení vymaže cesty, které jste přidali ručně i mimo Vrecko (bývá to nVidia PhysX, Phantom knihovny apod.) Ke standardnímu nastavení se vrátí tak, že v Property Pages, kam normálně přidáváte Vrecko-cesty (viz ono README_Nastaveni_cest.txt), namísto toho vyberete na straně "Inherit from parent or project defaults" a potvrdíte dialog - v tu chvíli se cesty regenerují a po otevření dialogu stačí už standardně přidat Vrecko-cesty.

Kompilace

Jestliže se vše povedlo, můžete otevřít "solution" VRECKA (...\HCI\VRECKO\VisualStudio\VisualStudio.sln) ve VS2010 a začít kompilovat. Kompilace všech (zhruba třicetí) projektů VRECKA obvykle trvá několik minut.

Pokud víte, že některé projekty (plug-iny) nebudete používat, je možné jejich kompilaci vypnout (menu Build -> Configuration Manager) a tím vše urychlit. Základ VRECKA, který určitě budete potřebovat tvoří tyto projekty:

  • vreckoApp
  • vreckoDP_base
  • vrecko
  • base
  • TextOutput

Spouštění

Po úspěšné kompilaci konečně můžete VRECKO poprvé spustit. Nejjednodušší cestou je vyzkoušení hotových příkladů. Ty najdete v adresáři ...\HCI\VRECKO\bin\examples.

POZOR - DULEŽITÉ Koncept VRECKA je takový, že existuje jen jediná aplikace - vreckoApp.exe, která už je hotová a obykle se nemění (až na opravy chyb). Tato aplikace načte jeden nebo víc .xml konfiguračních souborů, které popisují jak objekty použité ve světě, tak i uživatelem definované Ability, které jsou uloženy v plug-inech (DLL knihovny). VRECKO příslušné Ability najde a zavolá jejich inicializační funkce a až tady se poprvé dostane na řadu Váš kód. Pokud tedy rozšiřujete funkcionalitu VRECKA nebo děláte novou aplikaci, Vaše práce spočívá ve vytvoření nové DLL knihovny s jednou nebo více abilitami a příslušného XML souboru, který tyto ability inicializuje.

Pro více detailů viz Konfigurace.

Debuging ve Visual Studiu

Než budete moci spoustět VRECKO ve VS2010 v debug režimu, je potřeba nastavit několik věcí. Jednak "StartUp Project". Vyberte projekt "vreckoApp", klikněte na něj pravým tlačítkem a vyberte "Set as StartUp Project". Dále je potřeba nastavit vlastnosti - opět pravým tlačítkem klikněte na projekt "vreckoApp" a zvolte "Properties". Zvolte položku "Debugging" a nastavte parametry

  • Working Directory na "..\..\bin".
  • do Command Arguments vepište xml soubor(y) s popisem scény - například .\data\DynamicArt\Main.xml


(Zpět na VRECKO Manuál)