OHJ-7400 Graafisen käyttöliittymän ohjelmointi, syksy 2013 Harjoitustyöohje (runko Pinball Mästeriin) Päivityshistoria: 3.9 Ensimmäinen versio ohjeesta julkaistu. 6.9 Korjattu yksi vasen oikeaksi ja lisätty testikuvat webbisivulle 11.9 Lisätty välipalautusajat + asiaa kopioinnista 8.10 Lisätty deadline, korjattu esimerkkitiedostoa ja lisätty pari tarkennusta Yleistä Tämän harjoitustyö on pakollinen osasuoritus kurssiin. Työssä ohjelmoidaan tämän työohjeen mukainen ohjelma Qt 5.1.0:lla käyttäen kehitysympäristönä Qt Creatoria. (http://download.qtproject.org/archive/qt/5.1/5.1.0/qt-windows-opensource-5.1.0-mingw48_opengl-x86-offline.exe) Harjoitustyö tehdään enintään kahden hengen ryhmissä. Yksin saa tehdä, mutta parityö on suositeltavaa. Ryhmän muodostus tapahtuu ilmoittamalla ryhmän tiedot kurssin kotisivuilta löytyvällä seittilomakkeella. Ryhmän muodostamiselle ei ole määrätty takaraja-ajankohtaa, mutta ilmoittautumisen yhteydessä generoitavaa ryhmätunnusta tarvitaan muun muassa välipalautusajan varaamiseen. Välipalautus Harjoitustyön alkuvaiheessa ohjelmoidaan käyttöliittymän prototyyppi, josta tulee käydä ilmi pääikkunan valikoiden sisällöt ja layout, ja laaditaan suunnitellun ohjelman rakenteesta luokkakaavio. Välipalautustilaisuudessa, jossa prototyyppi ja kaavio esitellään assistentille, käyminen on pakollista. Välipalautukseen on varattu aikaa vain 10 minuuttia ryhmää kohti, joten huolehtikaa, että ohjelmanne on käyttövalmiina ja luokkakaavio paperille tulostettuna tai piirrettynä (kerätään pois) aikanne alkaessa. Välipalautustilaisuudet järjestetään viikolla 41 (7.10.-11.10.). Etukäteisilmoittautuminen tapahtuu ilmoitustaululla olevaan listaan ryhmätunnuksella. Lista on ilmoitustaululla (TCkäytävällä, TC205:n ja TC207:n välissä) viikolla 40 ja kerätään pois aamulla maanantaina 7.10. Tämä on siis takaraja ilmoittautumiselle. Välipalautukset arvostellaan asteikolla hyväksytty/hylätty. Mikäli suoritus hylätään, ryhmä voi jatkaa kurssilla, mutta harjoitustyön arvosana laskee yhdellä. Välipalautus hylätään, jos kaikkia vaatimuksia ei ole toteutettu, ryhmä ei ilmesty ajoissa paikalle tai jos assistentti katsoo ryhmän työn muuten riittämättömäksi. Koko ryhmän tulee pääsääntöisesti olla läsnä välipalautuksessa. Painavasta syystä tästä voidaan poiketa, mutta asiasta tulee sopia etukäteen. Välipalautustilaisuudessa tulee painaa mieleen assistentti, koska lopulliset palautukset tehdään samalle henkilölle. Välipalautusvaiheesta voi saada pelkän hyväksynnän lisäksi työn lopulliseen arvosteluun vaikuttavan bonuspisteen, mikäli esiteltävä toteutus ylittää selvästi minimivaatimukset, ts. toiminnallisuutta on riittävästi. Bonuspisteen arvo on +1/3 piste työn lopulliseen arvosanaan. Harjoitustyön lopullinen palautus Harjoitustyön lopullisen version tulee olla palautettuna (perillä) viimeistään perjantai 15.11.2013 klo 12.00. Palautus tapahtuu sähköpostitse. Lähdekoodit pakataan zip-tiedostoon ja
palautetaan näin syntynyt paketti liitetiedostona joko osoitteeseen antti.h.nieminen@tut.fi tai janne.lautamaki@tut.fi riippuen välipalautuksenne vastaanottaneesta assistentista. Paketin nimeksi annetaan ryhmätunnus. (Esim. 4.zip on siis (ainoa) validi palautuspaketin nimi ryhmälle 4.) Paketin koon tulisi olla alle 500 KB poistakaa siis turhat objektitiedostot yms. ennen paketointia. Projektitiedosto (.pro) ei ole tarkastuksen kannalta turha, joten se tulee luonnollisesti löytyä. Samasta hakemistosta sen kanssa tulee löytyä readme.txt-niminen tekstitiedosto, johon ryhmä voi tarpeelliseksi katsoessaan dokumentoida oleellisia asioita toteutuksestaan. Palautussähköpostin otsikon (subject) tulee olla Grako, htyo 1, ryhma X, jossa X on korvattu ryhmätunnuksella. Sähköpostin varsinaiseen viestiosaan voi halutessaan kirjoitella terveisiä, mutta se ei ole välttämätöntä. (Mahdollisen oleellisen dokumentaation tosiaan tulee siis löytyä readme.txt:stä.) Mahdollisen bumerangipalautuksen voi otsikoida Grako, bumerangi 1, ryhma X Arvostelu Harjoitustyö arvostellaan asteikolla 0 5. Arvosana 0 tarkoittaa hylättyä työtä, jollaisen tapauksessa ryhmälle annetaan tilaisuus korjata työnsä määräajassa ja saada näin se hyväksytyksi arvosanalla 1. Tosin assistenttien niin päättäessä työ voidaan hylätä myös suoraan ilman korjausmahdollisuutta. Arvostelussa kiinnitetään huomiota muiden muassa seuraaviin seikkoihin: Tunnollisuus tehtävänannon vaatimusten toteuttamisessa, Täsmällisyys ja ohjeiden seuraaminen palautettaessa, Ohjelman toiminnan virheettömyys (testiympäristössä), virhetilanteisiin varautuminen, Ohjelman (koodin) rakenne, Ohjelman käytettävyys, Välipalautusvaiheessa palautettu luokkakaavio (+ mahdollinen välipalautusbonus), Koodin luettavuus (kommentointi jne.) ja Toteutuksen tehokkuus (erityisiä optimointitarpeita ei pitäisi olla, mutta ohjelman tulee toimia sujuvasti testattaessa). Kopiointi ja lähdemateriaalin käyttö Harjoitustyöstä saa keskustella muiden ryhmien jäsenten kanssa vain periaatteellisella tasolla. Kaikki koodin luovuttaminen toisen ryhmän käyttöön on ehdottomasti kiellettyä toimintaa. Kirjallisuuden, qt-paketin mukana tulevien esimerkkien ja verkkolähteiden tutkiminen on sallittua ja suotavaakin. Koodia voi myös sopivilta osin lainata omaan työhönsä kunhan muistaa laittaa jonkinlaisen lähdeviitteen :) Muuta Tämä työohje jättää tahallaan ottamatta kantaa moniin asioihin, jotta harjoitustyötä tehdessään pääsisi toteuttamaan itseään ja joutuisi miettimään erilaisia ratkaisuvaihtoehtoja. Ideana on, että asiat, joihin ei löydy selvää vastausta tästä työohjeesta, saa toteuttaa haluamallaan tavalla. Kannattaa kuitenkin muistaa, että tarkoitus on saada aikaan järkevä ohjelma siistillä ja käytettävällä käyttöliittymällä. On kuitenkin täysin mahdollista, että jokin tärkeä asia, johon työohjeen olisi tarkoitus ottaa kantaa, on jäänyt epähuomiossa speksaamatta. Mikäli epäilette moista, ottakaa ihmeessä yhteyttä (grako@cs.tut.fi), jotta tällaiset virheet saadaan korjattua mielellään mahdollisimman aikaisessa vaiheessa. Sinänsä sillä, missä ohjelma kehitetään, ei ole väliä. Palautetun version tulee kuitenkin toimia luokan TC205 ympäristöä vastaavassa ympäristössä, jollaisessa testaus suoritetaan. Kannattaa siis
testata myös luokassa, jos koodaa muualla. Jos ominaisuuksia ei käyttöliittymän outoudesta johtuen löydetä tulkitaan ne arvostelussa puuttuviksi. Ohjelman kuvaus ja vaatimukset Harjoitustyössä toteutetaan runko Pinball Mäster flipperipeliin (saa halutessaan nimetä myös toisin :) ). Pelissä on kaksi tilaa: editointi- ja pelitila. Editointitilassa luodaan ja muokataan kenttiä; pelitilassa luotuja kenttiä voidaan pelata. Harjoitustyön puitteissa pelitilan valmiiksi koodaaminen on vapaaehtoista ja esim. flippereissä yleensä nähtävät mailat saa jättää toteuttamatta. Mailoista, hienosta törmäilytarkistuksista ja fysiikkamallista saattaa kuitenkin saada pieniä lisäpisteitä paikkaamaan mahdollisia muita puutteita. Lisäpiste voi maksimissaan korottaa harjoitustyön arvosanaa noin 1/3 pisteellä eli 4,25+1/3 =5 :) Editointitila Editointitilassa taustakuva ja pelialuetta rajaava kuva voidaan asettaa tai vaihtaa. Editointitilassa keskeisenä elementtinä on editointialue, jonne esteet raahataan jonkinlaisesta estekokoelmasta. Valmis editoitu kenttä voidaan tallentaa, ladata uudelleen editoitavaksi ja se voidaan myös käynnistää pelattavaksi. Pelitila Pelitilaan siirryttäessä valitaan joku editointitilassa luoduista kentistä (ryhmän palautuksessa voisi olla vaikka pari hienoa kenttää mukana mutta esimerkkikenttienkin tulee toimia). Tiedoston nimi määrää pelikentän nimen (pelikenttä.conf nimi on siis pelikenttä). Järjestelmä laskee ja näyttää monestiko kukin kenttä on käynnistetty pelattavaksi ja käyttäjä saa jollain tavalla antaa kentälle halutessaan yhdestä viiteen tähteä (tätä on myöhemmin kyettävä myös muuttamaan). Kenttälista pitää pystyä järjestämään nimen, pelikertojen ja tähtimäärän perusteella. Lista voidaan myös filtteröidä siten, että se näyttää vain esim. yli kolme tähteä saaneet kentät. Ryhmä saa valita minne tiedot tähdistä ja pelikerroista tallennetaan mutta niiden tulee säilyä ohjelman sammutuksesta huolimatta. Pelitilan alussa pallo on alanurkassa. Alaspäin osoittava nuolinäppäin lataa jousen ja näppäimen vapautus päästää pallon liikkeelle (hieno laukaisuefekti olis siisti juttu mutta ei pakollinen :) ). Jos työstä tavoitellaan arvosanaksi vitosta, on pallon jollaintavalla kimpoiltava esteistä ja lopulta ajauduttava pelialueen alalaidasta ulos (ainakin jollain assarin testikerralla :) ). Summittaisena fysiikkamallina voisi esim. käyttää seuraavanlaista: pallon alaspäin suuntautuva kiihtyvyys voisi olla 1 pikselin/sekuntti ja törmäyksessä lasketaan pinnan normaalin ja tulokulman välinen kulma ja päätellään tästä lähtökulma päinvastaiseen suuntaan. Muunkinlaiset huomattavasti rumemmat fysiikat ja törmäystarkistukset ovat OK, kunhan pallo nyt jollaintavalla siellä kentällä liikkuu :) Fysiikan osalta minimivaatimuksena työn läpipääsyyn on, että pallo edes hieman nytkähtää laukaisun jälkeen ja jos muut osat ovat kunnossa voi tälläkin toteutuksella saada vielä harjoitustyön arvosanaksi nelosen. Yleistä Pelitilassa käytettävän pallon halkaisija on 20 pikseliä. Pallon keskikohta asetetaan pelin alussa 75 pikseliä ylös ja 75 pikseliä vasemmalle pelikentän oikeasta alalaidasta. Pelikentän taustakuva ei vaikuta peliin vaan on vain koriste ja saattaa joistain kentistä jopa puuttua. Jos taustakuvaa käytetään, on se skaalattava pelialuetta rajaavaan kuvan kanssa saman kokoiseksi. Pelialuetta rajaavan kuvan koko määrää pelialueen ja on kooltaan vähintään 500*500 pikseliä suuri
ja enintään 1000 pikseliä leveä ja 2500 pikseliä korkea. Vaikka koot ja etäisyydet on ilmoitettu pikseleinä niin pelialueen saa halutessaan zoomata siten, että se täyttää halutun osan ruudusta ja se on ehkä jopa järkevää. Zoomatessa esteiden, pallon ja pelialueen suhde toisiinsa pysyy vakiona. Jos siis kenttä zoomataan puolikkaan kokoiseksi niin myös esteet ja pallo kutistuvat puolikkaiksi. Peliin liittyvät taustakuvat löytyvät kansiosta./tausta, pelialuetta rajaavat kuvat löytyvät kansiosta./pelialue ja esteet löytyvät kansiosta./este Pelialuetta rajaaville kuville (muille ja esteille) ne alueet, joissa pallon liikkuu vapaasti törmäilemättä, määritellään läpinäkyviksi. Pääikkunan kokoa tulee voida muuttaa ja sen tulee olla käyttökelpoinen vielä 1024 x 600 pikselin näytöllä. Pääasiallisen käytön voi olettaa tapahtuvan vähintään 1440 x 900 pikselin näyttökoolla. Pääikkunan tulee avautua samaan paikkaan ja saman kokoisena kuin se oli edellisellä kerralla ohjelmaa suljettaessa. Luodut kentät tallennetaan kansioon./kentat/ tiedostopäätteellä.conf. Esim./kentat/kentta666.conf on siis sallittu. Kentät tallennetaan ja luetaan seuraavan tyyppisistä tiedostoista: [tausta] 926\kuva=tausta/muntaustakuva.png [pelialue] 927\kuva=pelialue/munpelialue.png [este] 928\kuva=este/este1.png 928\paikka=150, 150 929\kuva=este/este2.png 929\paikka=250, 150 930\kuva=este/este3.png 930\paikka=150, 250 931\kuva=este/este4.png 931\paikka=250, 250 Yksi tiedosto sisältää aina vain yhden kentän. Rivin aloittava luku on resurssiin liittyvä yksilöivä id, jota saa ohjelmassaan hyödyntää tai olla hyödyntämättä. Aliavain kuva viittaa resurssiin liittyvään tiedostoon ja paikka sijaintiin pelialueella. Ensimmäinen numero kuvaa etäisyyttä oikealle ja toinen etäisyyttä alaspäin vasemmasta ylänurkasta alkaen. Etäisyydet ilmoitetaan pikseleinä. Jos resurssiin liittyvää kuvaa ei löydy tai polkua tai paikkaa ei määritellä jätetään resurssi esittämättä. Samoin saa myös toimia jos jossain näissä on jotain virheitä. Jos pelialuetta ei määritellä niin tiedostoa ei ladata ohjelmaan käytettäväksi. Muita vaatimuksia Käyttöliittymän tulee sisältää vähintään Apua -valikko ( Help käy myös, jos se soveltuu paremmin käyttöliittymän kielipolitiikkaan), jonka kautta saa tehtyä valinnan Tietoja... ( About... ). Tällä tavalla tulee saada auki modaalinen dialogi, josta käy ilmi harjoitustyöryhmätunnus ryhmän jäsenten nimet, sähköpostiosoitteet ja opiskelijanumerot sekä
ryhmän työn tekemiseen käyttämä kokonaistuntimäärä. 1 1 Tuntimäärä ei vaikuta arvosanaan (ellei puutu), vaan tarkoitus on kerätä mahdollisimman oikeellista dataa sen arvioimiseksi, kuinka hyvin työn mitoitus onnistui. Vastatkaa siis mahdollisimman rehellisesti ja tarkasti.