Pygame Basics

Pygame er eit bibliotek som kan brukast til spill (naturlig nok) og andre program som krever grafikk og bevegelse. Det fins andre blibliotek, som kanskje gir oss større muligheter, og hvis du skal laga animasjonar med mange objekt som beveger seg, så bør du kanskje gjera det objektorientert.

Den offisielle webstaden for Pygame er www.pygame.org.  Pygame er ikkje innebygd i Anaconda/Spyder, så det må installerast vha programmet pip.exe. Du må først finna ut kor det er på maskinen din. Det kan feks. liggja på C:\Users\<din brukar>\AppData\Local\Continuum\anaconda3\Scripts. programmet Ledetektst og flytt til den mappa som pip ligg på vha. kommandoen cd <mappenavn>. (cd står for change directory). Så kan du installera pygame med kommandoen

"pip install pygame"

Deretter kan du gjerne testa at pygame funkar ved å gå til konsollet i Spyder og skriva run -m pygame.examples.aliens. Hvis du no ser ein gjeng med flygande tallerkenar fly over skjermen, er du klar til å programmera :)

Komma i gang

Vi skal no sjå på ein del vanlig kode som du vil finna i alle pygameprogram, og som vil gjera deg i stand til å laga mange typar animasjonar. Det einaste som kanskje burde vore med, er kommandoar som blit som lar oss visa eit bilde (det kan feks. vera ein figur eller ein bakgruunn) i vinduet vårt, Men eg ser på det som meir spill-funksjonalitet, og her har vi fokus på fysikk-simuleringar, og då vil det ofte halda å tegna sirklar og rektangel.

Så då går vi i gang. Det første vi må gjera i koden vår, er å importera og initialisera pygame:

import pygame

pygame.init()

Opna eit vindu

For å opna eit vindu på  400 x 300 px, kan vi skriva:

vindu = pygame.display.set_mode((400,300))

• Dette opnar eit vindu eller overflate til å skriva på, og lagrar det i ein variabel kalla vindu
• Denne variabelen må du bruka når du skal gjera noko i vinduet.

For vårt nyopna vindu gjeld følgande:

• Punktet (0,0) er øvre venstre hjørne i vinduet.
• x-koordinaten aukar frå venstre mot høgre, og y-koordinaten aukar frå toppen og nedover.
• I eksempelet vårt gjeld altså:
  • Øvre høgre hjørne er (400,0)
  • Nedre venstre er (0,300)
  • Nedre høgre er (400,300)

Definera fargar

Det er lurt å definera alle fargar som du har tenkt å bruka slik:

farge = (r,g,b)

• "farge" er det navnet du gir, feks. SVART. Du kan gjerne heller bruka funksjonen fargen har, feks. BAKGRUNN osb.
• (r,g,b) er eit tuppel med verdiar for rødt, grønt og blått.
  
• Verdiane skal vera heiltal mellom 0 og 255, der 0 er det mørkaste og 255 det lysaste.

Eksempel: (eg bruker vanligvis store bokstavar for konstantar, men det er ikkje nødvendig)

SVART = (0,0,0)
KVIT  = (255,255,255)
RAUD  = (255,0,0)
GROEN = (0,255,0)
BLAA  = (0,0,255)
ROSA  = (255,200,200)

Tegna figurar

Pygame har mange funksjonar for å fargeleggja og tegna ting i vinduet. Merk at for at disse skal visast må du  pygame.display.update(). Meir om dette under. Eksempel på kommandoer du kan bruka er:

vindu.fill(farge)

• fyller vinduet med den gitte fargen definert vha variabelen farge.
• feks. vindu.fill(SVART)

pygame.draw.line(vindu, farge, startpunkt, sluttpunkt, tykkelse)

• tegnar ei linje mellom startpunkt og sluttpunkt.
• tykkelse er tykkelsen på linja (i pikslar).
• Eksempel: pygame.draw.line(vindu, GROEN, (100,100), (200,100), 5)

Vi kan også tegna samanhengande linjer med følgande kommando:

pygame.draw.lines(vindu, farge, lukka, punktliste, tykkelse) 

• tegnar linjer mellom punkt som er gitt i punktliste.
• punktliste er ei liste av tuppel, som definerer ein serie med punkt. Hvis du feks. skal tegna ein "V", så kan du bruka [(100,100), (150,200), (200,100)], med lukka = False
• lukka er ein Boolsk variabel som kan ha verdi True eller False, og som indikerer om det skal vera ei linje frå siste punkt i punktlista og tilbake til det første.
• tykkelse er tykkelsen på linja (i pikslar).
• Eksempel: pygame.draw.lines(vindu, GROEN, False, [(100,100), (150,200), (200,100)], 5)

pygame.draw.rect(vindu, farge, (x,y,bredde,høgde), tykkelse)

• tegnar eit rektangel
• x og y er koordinatane til øvre venstre hjørne, og bredde og høyde seier seg sjøl. Men merk parentesar rundt disse fire verdiane!
• tykkelse er tykkelsen på linja. Hvis denne er null eller ikkje oppgitt, er rektangelet fylt.
• Eksempel: pygame.draw.rect(vindu,BLAA,(220,100,30,100))


pygame.draw.circle(vindu, farge, (x,y), radius, tykkelse)

• tegnar ein sirkel
• (x,y) er koordinatane til sentrum i sirkelen, og radius is radiusen :)
• tykkelse er tykkelsen på linja. Hvis denne er null er rektangelet fylt.
• Eksempel: pygame.draw.circle(vindu, RAUD, (235,70), 15, 0)

Visa bilder

Pygame har nyttige funksjonar som lar oss visa bilder i ulike format som PNG, JPG, GIF, og BMP. Først må vi lasta fila:

bilde = pygame.image.load(bildefil)

• returnerer ei overflate (objekt) med bildet eller figuren som fins i fila.
• bilde er det navnet vi gir denne overflata
• bildefil er navnet på bildefila og fullstendig sti til fila. 
• Eksempel: image = pygame.image.load('fig/DVD.png')

Hvis figuren har feil størrelse, så kan vi skalera den opp eller ned vha. funksjonen pygame.transform.scale:

bilde = pygame.transform.scale(image, (bredde, høyde))

• Skalerer ei overflate ved navn bilde.
• bredde og høyde er navn på variable eller tall som angir bredde og høyde
• Eksempel image = pygame.transform.scale(image, (120, 70))

Det fins også andre nyttige funksjonar som forandrar bildet, som feks pygame.transform.rotate og pygame.transform.flip som hhv. roterer og speiler bildet. Det neste som må skje er at vi kopierer bilde til vinduet vårt med funksjonen blit:

vindu.blit(bilde, (x,y))

• kopierer innhaldet i overflata bilde til overflata vindu.
• (x,y) er posisjonen der vi vil at øvre venstre hjørne av bildet skal vera i vinduet. (0,0) vil føra til at det bildet er opp i venstre hjørne av vindu.
• Eksempel: vindu.blit(image, (100,200))

Merk at det er mulig å gi (x,y) både som negative verdiar og verdiar som ligg utanfor vindu, så her må du passa på. Det er også mulig å lima same bilde inn fleire stader i same vindu.

Det fins også andre funksjonar for å tegna og manipulera bilder.

Oppdatering av skjermen

Dei du gjer i vinduet, som å fylla det med ein farge, eller å tegna ein figur, visest ikkje med ein gong. For å få det til må du bruka denne funksjonen:

pygame.display.update()

• pygame.display.update() viser deg alle tegningane du har gjort sidan siste gong du brukte funksjonen.
• Hvis dette er første gong funksjonen er brukt vil alle endringane som er gjort sidan vinduet vart laga, bli vist.
• Dette gir oss mulighet til å samla opp endringar og derved unngå potensiell blinking som kan skje hvis ein og ein endring blir vist.

Lukking av vindu med quit-knappen (raud X i Windows, raud sirkel på Mac)

For å få dette til må vi gjera to ting:

1. Laga ein uendelig loop, som ser etter event, dvs. om brukar har trykt ein tast, brukt musa eller liknande.
2. Ein kode som  sjekkar om vi har fått eit QUIT event, og håndterer dette.

while True:
    for event in pygame.event.get():
        if event.type == pygame.QUIT:
            pygame.quit()

Denne koden gjer følgande:

• while True lagar ei uendelig løkke. Vi veit ikkje når brukaren vil avslutta, så programmet må sjekka heile tida.
• pygame.event.get() returnerer ei liste med alle event som har skjedd sidan vi kalla pygame.init(), evt. sidan siste kall til pygame.event.get().
• Ei indre for-løkke går gjennom alle disse, og lagrar event i variabelen event. (Du kan kalla den noke anna)
• For kvart event sjekkar vi om det er lik pygame.QUIT som er ein verdi som betyr at brukaren har trykt på raud X (eller raud sirkel) for å lukka vinduet.
• Hvis brukaren gjorde det gjer vi:
  • bruk pygame.quit() for å lukka pygame og lukka vinduet.
  • Noken seier at du også må gjera sys.exit() for å lukka programmet, men for meg ser ikkje dette ut til å vera nødvendig.

Eksempel på program som lagar enkle figurar.

Animasjonar

For å få td. ein figur til å bevega seg, må du ha kode innanfor ei løkke som:

• viskar ut den forrige tegningen (feks. vha. screen.fill(SVART) )
• oppdaterer koordinatane og lagar neste tegningen (feks. med ein ny pygame.draw) på ein ny plass.
• brukar pygame.display.update() for å få visa endringane

Få bevegelsen til å gå fortare eller saktare

Hvis programmet ditt er kjapt kan du oppleva at animasjonen din går veldig fort. Men det er minst to måtar du kan styra hastigheten.

Du kan for eksempel skriva til pygame.time.delay(5)inne i løkka. Dette får programmet til å venta 5 millisekunder.

Ein betre måte er å bruka ei klokke:

1. Putt koden clock = pygame.time.Clock() nær starten på programmet. Den må vera etter pygame.init() men utanfor hovedløkka.
2. Inne i løkka puttar du feks. koden clock.tick(30) der 30 gir deg 30 oppdateringar i sekunder (frames per second)

Men så er det også slik at når vi simulerer fysiske system, så har vi ein parameter dt (eller liknande) som bestemmer kor ofte (i verkelig tid) vi skal rekna ut og visa ny posisjon. Hvis animasjonen går for fort, så kan vi mykje heller minka dt. Fordelen med denne tilnærminga er at simuleringen vår blir meir nøyaktig. I mange eksperiment er nok heller problemet at for å få stor nok nøyaktighet, så vil animasjonen går veldig seint. Til dette er det å sei, at for alle applikasjonar som skal ha så stor nøyaktighet som mulig, så vil vi 1) ikkje bruka animasjonar 2) ikkje bruka Eulermetoden ,og 3) antagelig heller ikkje bruka Python, men kanskje C++, eller andre språk som kjører fortare. Det som Python + Pygame er så bra til, er å læra å laga simuleringar gjennom prøving og feiling, og at disse er interaktive, slik at brukaren kan leika og læra.

LENKER

• Pygame documentation at www.pygame.org
• PyGame – A Primer.
• Pygame Graphics Examples.
• PyGame. Del av "How to thing Like a Computer Scientist".