Jypeli  5
The simple game programming library
Widget luokkareferenssi

Käyttöliittymän komponentti. Lisää...

Luokan Widget luokkakaavio
GameObject ControlContexted CustomDrawable GameObjectBase IGameObjectInternal GameObjectContainer GameObjectBase IGameObjectInternal Tagged Destroyable IGameObject Tagged Destroyable IGameObject Tagged Destroyable Updatable Tagged Destroyable Updatable Background BarGauge BindableWidget ListWidget< T, O > MessageDisplay ScoreItemWidget ScrollableList< O > Window

Julkiset jäsenfunktiot

void Draw (Matrix parentTransformation)
 
void InitControl ()
 
 Widget (Animation animation)
 Alustaa widgetin. Lisää...
 
 Widget (ILayout layout)
 Alustaa widgetin. Lisää...
 
 Widget (double width, double height, Shape shape)
 Alustaa widgetin. Lisää...
 
 Widget (double width, double height)
 Alustaa widgetin. Lisää...
 
- Julkiset jäsenfunktiot inherited from GameObject
void OnArrivedAt (Vector location)
 Kutsutaan, kun on saavuttu haluttuun paikkaan (MoveTo-metodi) Lisää...
 
override void Destroy ()
 Tuhoaa olion. Tuhottu olio poistuu pelistä. Lisää...
 
 GameObject (double width, double height)
 Alustaa uuden peliolion. Lisää...
 
 GameObject (Image image)
 Alustaa uuden peliolion. Kappaleen koko ja ulkonäkö ladataan parametrina annetusta kuvasta. Lisää...
 
 GameObject (double width, double height, Shape shape)
 Alustaa uuden peliolion. Lisää...
 
object Clone ()
 Tekee oliosta kopion. Lisää...
 
bool IsInside (Vector point)
 Onko piste p tämän olion sisäpuolella. Lisää...
 
void Add (IGameObject childObject)
 Lisää annetun peliolion tämän olion lapseksi. Lapsiolio liikkuu tämän olion mukana, ja sen paikka ja koko ilmaistaan suhteessa tähän olioon. Lisää...
 
void Remove (IGameObject childObject)
 Poistaa lapsiolion. Jos haluat tuhota olion, kutsu mielummin olion Destroy-metodia. Lisää...
 
virtual void Update (Time time)
 Peliolion päivitys. Tätä kutsutaan, kun IsUpdated-ominaisuuden arvoksi on asetettu true ja olio on lisätty peliin. IsUpdated Lisää...
 
void SetImage (StorageFile file)
 Lataa kuvan tiedostosta ja asettaa sen oliolle. Lisää...
 
virtual void Move (Vector movement)
 Siirtää oliota. Lisää...
 
virtual void MoveTo (Vector location, double speed)
 Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Laukaisee tapahtuman ArrivedAt, kun paikkaan on päästy. Lisää...
 
void SetImage (StorageFile file)
 Lataa kuvan tiedostosta ja asettaa sen oliolle. Lisää...
 
void MirrorImage ()
 Kääntää olion kuvan vaakasuunnassa. Lisää...
 
void FlipImage ()
 Kääntää olion kuvan pystysuunnassa. Lisää...
 
void Add (IGameObject childObject)
 Lisää annetun peliolion tämän olion lapseksi. Lapsiolio liikkuu tämän olion mukana, ja sen paikka ja koko ilmaistaan suhteessa tähän olioon. Lisää...
 
void Remove (IGameObject childObject)
 Poistaa lapsiolion. Jos haluat tuhota olion, kutsu mielummin olion Destroy-metodia. Lisää...
 
virtual void Clear ()
 Poistaa kaikki lapsioliot. Lisää...
 
bool IsInside (Vector point)
 Onko piste p tämän olion sisäpuolella. Lisää...
 
bool IsInsideRect (Vector point)
 Onko piste p tämän olion ympäröivän suorakulmion sisäpuolella. Lisää...
 
override void Destroy ()
 Tuhoaa olion. Tuhottu olio poistuu pelistä. Lisää...
 
 GameObject (double width, double height)
 Alustaa uuden peliolion. Lisää...
 
 GameObject (double width, double height, Shape shape)
 Alustaa uuden peliolion. Lisää...
 
 GameObject (Animation animation)
 Alustaa uuden peliolion. Kappaleen koko ja ulkonäkö ladataan parametrina annetusta kuvasta. Lisää...
 
 GameObject (ILayout layout)
 Alustaa widgetin. Lisää...
 
override void Update (Time time)
 Peliolion päivitys. Tätä kutsutaan, kun IsUpdated-ominaisuuden arvoksi on asetettu true ja olio on lisätty peliin. IsUpdated Lisää...
 
bool SeesObject (GameObject obj)
 Näkeekö olio toisen. Lisää...
 
bool SeesObject (GameObject obj, Predicate< GameObject > isObstacle)
 Näkeekö olio toisen. Lisää...
 
bool SeesObject (GameObject obj, object obstacleTag)
 Näkeekö olio toisen. Lisää...
 
bool SeesTarget (Vector targetPosition)
 Näkeekö olio paikkaan. Lisää...
 
bool SeesTarget (Vector targetPosition, Predicate< GameObject > isObstacle)
 Näkeekö olio paikkaan. Lisää...
 
bool SeesTarget (Vector targetPosition, object obstacleTag)
 Näkeekö olio paikkaan. Lisää...
 
bool IsBlocking (Vector pos1, Vector pos2)
 Onko olio kahden paikan välissä. Lisää...
 
void FadeColorTo (Color targetColor, double seconds)
 Muuttaa olion väriä toiseen hitaasti liukumalla. Lisää...
 
void InitLayout (double width, double height)
 
void InitLayout (double width, double height, ILayout layout)
 
void RefreshLayout ()
 Päivittää lapsiolioiden paikat ja koot, jos widgetille on asetettu asettelija. Tätä metodia EI yleensä tarvitse kutsua itse, sillä asettelija päivitetään automaattisesti jokaisella framella. Tämä metodi on tarpeellinen esim. silloin, kun widgetille on lisätty lapsiolioita (tai muutettu niiden ominaisuuksia) ja niiden paikat tarvitsee päivittää välittömästi lisäyksen jälkeen. Silloinkin tätä tarvitsee kutsua vain kerran, viimeisimmän muutoksen jälkeen. Lisää...
 
virtual void Move (Vector movement)
 Siirtää oliota. Lisää...
 
override void MoveTo (Vector location, double speed, Action doWhenArrived)
 Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Laukaisee annetun aliohjelman, kun paikkaan on päästy. Lisää...
 
void StopMoveTo ()
 Pysäyttää MoveTo-aliohjelmalla aloitetun liikkeen. Lisää...
 
void Oscillate< WaveForm > (Vector axis, double amplitude, double frequency, double phase=0, double damping=0)
 Laittaa kappaleen liikkumaan edestakaisin nykyisen paikkansa ympärillä tietyn akselin suuntaisesti. Aaltomuotoa voi vaihtaa tyyppiparametrin avulla, esim. Oscillate<Triangle> Lisää...
 
void Oscillate (Vector axis, double amplitude, double frequency, double phase=0, double damping=0)
 Laittaa kappaleen liikkumaan edestakaisin nykyisen paikkansa ympärillä tietyn akselin suuntaisesti. Lisää...
 
void OscillateAngle< WaveForm > (double direction, UnlimitedAngle amplitude, double frequency, double damping=0)
 Laittaa kappaleen pyörimään edestakaisin tietyn aaltomuodon mukaisesti. Aaltomuotoa voi vaihtaa tyyppiparametrin avulla, esim. OscillateAngle<Triangle> Lisää...
 
void OscillateAngle (double direction, UnlimitedAngle amplitude, double frequency, double damping=0)
 Laittaa kappaleen pyörimään edestakaisin. Lisää...
 
void SetEquilibrium ()
 Asettaa uuden tasapainoaseman värähtelyille. Lisää...
 
void ClearOscillations ()
 Poistaa kaikki värähtelyt kappaleelta. Lisää...
 
virtual void Stop ()
 Pysäyttää kaiken liikkeen. Lisää...
 
- Julkiset jäsenfunktiot inherited from GameObjectBase
void OnAddedToGame ()
 Kutsutaan kun olio lisätään peliin. Lisää...
 
void OnRemoved ()
 Kutsutaan kun olio poistetaan pelistä. Lisää...
 
void MoveTo (Vector location, double speed)
 Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Lisää...
 
- Julkiset jäsenfunktiot inherited from IGameObjectInternal
void OnAddedToGame ()
 
void OnRemoved ()
 

Suojatut jäsenfunktiot

virtual void Draw (Matrix parentTransformation, Matrix transformation)
 
virtual void DrawChildObjects (ref Matrix parentTransformation, ref Matrix transformation, ref Matrix childTransformation)
 
- Suojatut jäsenfunktiot inherited from GameObject
virtual void MoveToTarget ()
 
virtual void InitChildren ()
 
void NotifyParentAboutChangedSizingAttributes ()
 Should be called whenever properties that might affect layouts are changed. Lisää...
 
virtual Vector GetMaximumSize ()
 Antaa widgetin maksimikoon siinä tapauksessa, että kokoa ei ole annettu rakentajassa (tai tarkemmin sanoen muuttujan SizingByLayout arvo on true). Olio ei siis automaattisesti kasva tätä isommaksi. Lisää...
 
virtual void MoveToTarget ()
 
- Suojatut jäsenfunktiot inherited from GameObjectBase
void OnDestroyed ()
 
 GameObjectBase ()
 

Ominaisuudet

Color BorderColor [get, set]
 Reunojen väri. Lisää...
 
ListenContext ControlContext [get]
 
bool IsModal [get, set]
 Jos true, pelin sekä ikkunan alla olevien widgettien ohjaimet eivät ole käytössä kun ikkuna on näkyvissä. Lisää...
 
- Ominaisuudet inherited from GameObject
List< ListenerAssociatedListeners [get]
 
IEnumerable< IGameObjectObjects [get]
 Olion lapsioliot. Ei voi muokata. Lisää...
 
bool IsVisible [get, set]
 Piirretäänkö oliota ruudulle. Lisää...
 
override Vector Size [get, set]
 Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa. Lisää...
 
override Angle Angle [get, set]
 Olion kulma tai rintamasuunta. Nolla = osoittaa oikealle. Lisää...
 
override Animation Animation [get, set]
 Animaatio. Voi olla null, jolloin piirretään vain väri. Lisää...
 
Vector TextureWrapSize [get, set]
 Määrittää kuinka moneen kertaan kuva piirretään. Esimerkiksi (3.0, 2.0) piirtää kuvan 3 kertaa vaakasuunnassa ja 2 kertaa pystysuunnassa. Lisää...
 
Color Color [get, set]
 Väri, jonka värisenä olio piirretään, jos tekstuuria ei ole määritelty. Lisää...
 
bool TextureFillsShape [get, set]
 Jos true, kuva piirretään niin, ettei se mene olion muodon ääriviivojen yli. Toisin sanoen kuva piirretään tarkasti vain muodon määrittämälle alueelle. Lisää...
 
virtual Shape Shape [get, set]
 Olion muoto. Lisää...
 
Game Game [get]
 Peli, johon olio on lisätty. null, jos oliota ei ole lisätty peliin. Lisää...
 
bool IsAddedToGame [get, set]
 Onko olio lisätty peliin. Lisää...
 
virtual Color Color [get, set]
 Väri, jonka värisenä olio piirretään, jos tekstuuria ei ole määritelty. Lisää...
 
bool IgnoresLighting [get, set]
 Jättääkö olio kentän valaistuksen huomiotta. Asetettu oletuksena käyttöliittymäkomponenteilla (widget). Lisää...
 
SynchronousList< GameObjectObjects [get]
 Olion lapsioliot. Saa muuttaa. Lisää...
 
int ObjectCount [get]
 Olion lapsiolioiden lukumäärä. Kuten Objects.Count, mutta optimoitu. Lisää...
 
virtual Sizing HorizontalSizing [get, set]
 Koon asettaminen vaakasuunnassa, kun olio on asettelijan sisällä. Lisää...
 
virtual Sizing VerticalSizing [get, set]
 Koon asettaminen pystysuunnassa, kun olio on asettelijan sisällä. Lisää...
 
virtual Vector PreferredSize [get, set]
 Koko, jota oliolla tulisi olla asettelijan sisällä. Todellinen koko voi olla pienempi, jos tilaa ei ole tarpeeksi. Lisää...
 
bool SizingByLayout [get, set]
 
ILayout Layout [get, set]
 Asettelija lapsiolioille. Asettaa lapsiolioiden koon sekä paikan. Lisää...
 
- Ominaisuudet inherited from GameObjectBase
Game Game [get]
 Peli. Lisää...
 
Layer Layer [get, set]
 Kerros, jolle peliolio on lisätty. Lisää...
 
bool RotateImage [get, set]
 Pyöritetäänkö kuvaa olion kulman mukana. Lisää...
 
IGameObject Parent [get, set]
 Olio, jonka lapsiolio tämä olio on. Jos null, olio ei ole minkään olion lapsiolio. Lisää...
 
bool IsUpdated [get, set]
 Tarvitseeko olio päivittämistä. Kun perit oman luokkasi tästä luokasta, aseta tämä arvoon true, kun luokan olio tarvitsee päivittämistä. Lisää...
 
object Tag [get, set]
 Vapaasti asetettava muuttuja. Lisää...
 
virtual Brain Brain [get, set]
 Olion aivot. Ks. Brain Lisää...
 
bool IsDestroyed [get]
 Onko olio tuhottu. Lisää...
 
abstract Vector Size [get, set]
 Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa. Lisää...
 
virtual Vector Position [get, set]
 Olion paikka. Jos olio on jonkun toisen peliolion lapsi, paikka on suhteessa tämän vanhempaan (Parent). Muuten paikka on paikka pelimaailmassa. Lisää...
 
abstract Angle Angle [get, set]
 Olion kulma tai rintamasuunta. Nolla = osoittaa oikealle. Lisää...
 
TimeSpan CreationTime [get, protected set]
 Olion luomisaika. Lisää...
 
TimeSpan Lifetime [get]
 Olion elinaika. Lasketaan siitä lähtien, kun olio luodaan. Lisää...
 
TimeSpan MaximumLifetime [get, set]
 Olion suurin mahdollinen elinaika. Kun Lifetime on suurempi kuin tämä, olio kuolee. Lisää...
 
TimeSpan LifetimeLeft [get, set]
 Olion jäljellä oleva elinaika. Lisää...
 
double Width [get, set]
 Olion leveys (X-suunnassa, leveimmässä kohdassa). Lisää...
 
double Height [get, set]
 Olion korkeus (Y-suunnassa, korkeimmassa kohdassa). Lisää...
 
Vector AbsolutePosition [get, set]
 Olion absoluuttinen paikka pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Position. Lisää...
 
Angle AbsoluteAngle [get, set]
 Olion absoluuttinen kulma pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Angle. Lisää...
 
double Left [get, set]
 Olion vasemman reunan x-koordinaatti. Lisää...
 
double Right [get, set]
 Olion oikean reunan x-koordinaatti. Lisää...
 
double Top [get, set]
 Olion yläreunan y-koordinaatti. Lisää...
 
double Bottom [get, set]
 Olion alareunan y-koordinaatti. Lisää...
 
double AbsLeft [get]
 Olion vasemman reunan absoluuttinen x-koordinaatti. Lisää...
 
double AbsRight [get]
 Olion oikean reunan absoluuttinen x-koordinaatti. Lisää...
 
double AbsTop [get]
 Olion yläreunan absoluuttinen y-koordinaatti. Lisää...
 
double AbsBottom [get]
 Olion alareunan absoluuttinen y-koordinaatti. Lisää...
 
double X [get, set]
 Olion paikan X-koordinaatti. Lisää...
 
double Y [get, set]
 Olion paikan Y-koordinaatti. Lisää...
 
Vector UnitX [get]
 Suhteellinen x-suuntavektori lapsiolioille. Varoitus: suhteessa vanhempi-olioon! Jos haluat käyttää suoraan kentässä, käytä AbsoluteUnitX. Lisää...
 
Vector UnitY [get]
 Suhteellinen y-suuntavektori lapsiolioille. Varoitus: suhteessa vanhempi-olioon! Jos haluat käyttää suoraan kentässä, käytä AbsoluteUnitY. Lisää...
 
Vector AbsoluteUnitX [get]
 Suhteellinen x-suuntavektori lapsiolioille. Suhteessa suoraan kentän koordinaatteihin. Lisää...
 
Vector AbsoluteUnitY [get]
 Suhteellinen y-suuntavektori lapsiolioille. Suhteessa suoraan kentän koordinaatteihin. Lisää...
 
abstract Animation Animation [get, set]
 Animaatio. Voi olla null, jolloin piirretään vain väri. Lisää...
 
Image Image [get, set]
 Olion kuva. Voi olla null, jolloin piirretään vain väri. Lisää...
 
- Ominaisuudet inherited from Tagged
object Tag [get, set]
 
- Ominaisuudet inherited from Destroyable
bool IsDestroyed [get]
 
- Ominaisuudet inherited from IGameObjectInternal
Layer Layer [set]
 
List< ListenerAssociatedListeners [get]
 
bool IsAddedToGame [set]
 
- Ominaisuudet inherited from IGameObject
Layer Layer [get]
 
IGameObject Parent [get, set]
 
Brain Brain [get, set]
 
bool IsVisible [get, set]
 
bool IsAddedToGame [get]
 
bool IgnoresLighting [get, set]
 
TimeSpan CreationTime [get]
 
TimeSpan Lifetime [get]
 
TimeSpan MaximumLifetime [get, set]
 
Vector Size [get, set]
 
double Width [get, set]
 
double Height [get, set]
 
Vector Position [get, set]
 
Angle Angle [get, set]
 
double X [get, set]
 
double Y [get, set]
 
double Left [get, set]
 
double Top [get, set]
 
double Right [get, set]
 
double Bottom [get, set]
 
Vector UnitX [get]
 
Vector UnitY [get]
 
Vector AbsoluteUnitX [get]
 
Vector AbsoluteUnitY [get]
 
Vector AbsolutePosition [get, set]
 
Angle AbsoluteAngle [get, set]
 
Animation Animation [get, set]
 
Image Image [get, set]
 
Color Color [get, set]
 
Shape Shape [get, set]
 
Vector TextureWrapSize [get, set]
 
bool TextureFillsShape [get, set]
 
bool RotateImage [get, set]
 
- Ominaisuudet inherited from Updatable
bool IsUpdated [get]
 
- Ominaisuudet inherited from ControlContexted
ListenContext ControlContext [get]
 
bool IsModal [get]
 
- Ominaisuudet inherited from CustomDrawable
bool IsVisible [get, set]
 

Additional Inherited Members

- Julkiset attribuutit inherited from GameObjectBase
IntPoint PosInLevel
 
List< Object > Data
 
- Suojellut attribuutit inherited from GameObject
Timer moveTimer = null
 
Vector moveTarget = null
 
double moveSpeed
 
bool autoResizeChildObjects = true
 
Action arrivedAction = null
 
- Tapahtumat inherited from GameObject
Action< GameObject, VectorArrivedAt
 Tapahtuu, kun on saavuttu haluttuun paikkaan (MoveTo-metodi) Lisää...
 
- Tapahtumat inherited from GameObjectBase
Action AddedToGame
 Tapahtuu, kun olio lisätään peliin. Lisää...
 
Action Removed
 Tapahtuu, kun olio poistetaan pelistä (tuhotaan tai ei). Lisää...
 
Action Destroyed
 Tapahtuu, kun olio tuhotaan. Lisää...
 
- Tapahtumat inherited from Destroyable
Action Destroyed
 
- Tapahtumat inherited from IGameObject
Action AddedToGame
 
Action Removed
 

Yksityiskohtainen selite

Käyttöliittymän komponentti.

Määrittely tiedoston Appearance.cs rivillä 9.

Rakentajien & purkajien dokumentaatio

◆ Widget() [1/4]

Widget ( Animation  animation)

Alustaa widgetin.

Parametrit
animation

Määrittely tiedoston Widget.cs rivillä 20.

◆ Widget() [2/4]

Widget ( ILayout  layout)

Alustaa widgetin.

Parametrit
layout

Määrittely tiedoston Widget.cs rivillä 31.

◆ Widget() [3/4]

Widget ( double  width,
double  height,
Shape  shape 
)

Alustaa widgetin.

Parametrit
width
height
shape

Määrittely tiedoston Widget.cs rivillä 44.

◆ Widget() [4/4]

Widget ( double  width,
double  height 
)

Alustaa widgetin.

Parametrit
width
height

Määrittely tiedoston Widget.cs rivillä 56.

Jäsenfunktioiden dokumentaatio

◆ Draw() [1/2]

virtual void Draw ( Matrix  parentTransformation,
Matrix  transformation 
)
protectedvirtual

Uudelleentoteutetaan luokissa Label, PushButton, InputBox, Background, MessageDisplay, BarGauge, CountDisplay ja ProgressBar.

Määrittely tiedoston Appearance.cs rivillä 22.

◆ Draw() [2/2]

void Draw ( Matrix  parentTransformation)

Toteuttaa luokan CustomDrawable.

Määrittely tiedoston Appearance.cs rivillä 26.

◆ DrawChildObjects()

virtual void DrawChildObjects ( ref Matrix  parentTransformation,
ref Matrix  transformation,
ref Matrix  childTransformation 
)
protectedvirtual

Määrittely tiedoston Appearance.cs rivillä 82.

◆ InitControl()

void InitControl ( )

Määrittely tiedoston Control.cs rivillä 22.

Ominaisuuksien dokumentaatio

◆ BorderColor

Color BorderColor
getset

Reunojen väri.

Määrittely tiedoston Appearance.cs rivillä 14.

◆ ControlContext

ListenContext ControlContext
get

Määrittely tiedoston Control.cs rivillä 14.

◆ IsModal

bool IsModal
getset

Jos true, pelin sekä ikkunan alla olevien widgettien ohjaimet eivät ole käytössä kun ikkuna on näkyvissä.

Määrittely tiedoston Control.cs rivillä 20.


Dokumentaatio tälle luokalle luotiin seuraavista tiedostoista: