Käyttöliittymän komponentti. Samankaltainen kuin GameObject, mutta toimii vain ruutukoordinaateissa. Lisää...

Luokan Widget luokkakaavio

Julkiset jäsenfunktiot
	Widget (ILayout layout)
	Widget (Animation animation)
	Widget (double width, double height)
	Alustaa uuden widgetin.
	Widget (double width, double height, Shape shape)
	Alustaa uuden widgetin.
bool	IsInside (Vector point)
	Onko piste `p` tämän widgetin sisäpuolella.
void	Add (Widget childObject)
	Lisää annetun peliolion tämän olion lapseksi. Lapsiolio liikkuu tämän olion mukana, ja sen paikka ja kulma ilmaistaan suhteessa tähän olioon.
void	Remove (Widget childObject)
	Poistaa lapsiolion, mutta ei tuhoa sitä.
virtual void	Clear ()
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.
virtual void	Destroy ()
	Tuhoaa olion. Tuhottu olio poistuu pelistä.
void	Dispose ()
virtual void	Update (Time time)
	Widgetin päivitys.
Julkiset attribuutit
Vector	TextureWrapSize = new Vector( 1.0, 1.0 )
	Määrittää kuinka moneen kertaan kuva piirretään. Esimerkiksi (3.0, 2.0) piirtää kuvan 3 kertaa vaakasuunnassa ja 2 kertaa pystysuunnassa.
Suojatut jäsenfunktiot
internal void	NotifyParentAboutChangedSizingAttributes ()
	Should be called whenever properties that might affect layouts are changed.
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.
internal virtual void	Draw (Matrix parentTransformation, Matrix transformation)
	Kutsutaan, kun olio piirretään.
internal virtual void	DrawChildObjects (ref Matrix parentTransformation, ref Matrix childTransformation)
Ominaisuudet
Widget	Parent `[get, set]`
	Olio, jonka lapsiolio tämä olio on. Jos `null`, olio ei ole minkään olion lapsiolio.
ListenContext	ControlContext `[get]`
virtual Sizing	HorizontalSizing `[get, set]`
	Koon asettaminen vaakasuunnassa, kun olio on asettelijan sisällä.
virtual Sizing	VerticalSizing `[get, set]`
	Koon asettaminen pystysuunnassa, kun olio on asettelijan sisällä.
virtual Vector	PreferredSize `[get, set]`
	Koko, jota oliolla tulisi olla asettelijan sisällä. Todellinen koko voi olla pienempi, jos tilaa ei ole tarpeeksi.
bool	SizingByLayout `[get, set]`
ILayout	Layout `[get, set]`
	Asettelija lapsiolioille. Asettaa lapsiolioiden koon sekä paikan.
object	Tag `[get, set]`
	Vapaasti asetettava muuttuja.
TimeSpan	CreationTime `[get, set]`
	Olion luomisaika.
TimeSpan	Lifetime `[get]`
	Olion elinaika. Lasketaan siitä lähtien, kun olio luodaan.
TimeSpan	MaximumLifetime `[get, set]`
	Olion suurin mahdollinen elinaika. Kun `Lifetime` on suurempi kuin tämä, olio kuolee.
virtual Vector	Size `[get, set]`
	Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa.
double	Width `[get, set]`
	Olion leveys (X-suunnassa, leveimmässä kohdassa).
double	Height `[get, set]`
	Olion korkeus (Y-suunnassa, korkeimmassa kohdassa).
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.
Vector	AbsolutePosition `[get]`
	Olion absoluuttinen paikka pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin `Position`.
Angle	AbsoluteAngle `[get]`
	Olion absoluuttinen kulma pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin `Angle`.
double	Left `[get, set]`
	Olion vasemman reunan x-koordinaatti.
double	Right `[get, set]`
	Olion oikean reunan x-koordinaatti.
double	Top `[get, set]`
	Olion yläreunan y-koordinaatti.
double	Bottom `[get, set]`
	Olion alareunan y-koordinaatti.
double	X `[get, set]`
	Olion paikan X-koordinaatti.
double	Y `[get, set]`
	Olion paikan Y-koordinaatti.
virtual Angle	Angle `[get, set]`
	Olion kulma. Nolla = osoittaa oikealle.
Animation	Animation `[get, set]`
	Animaatio. Voi olla `null`, jolloin piirretään vain väri.
virtual Image	Image `[get, set]`
	Olion kuva. Voi olla `null`, jolloin piirretään vain väri.
virtual Color	Color `[get, set]`
	Väri, jonka värisenä olio piirretään, jos tekstuuria ei ole määritelty.
Color	BorderColor `[get, set]`
	Reunojen väri.
bool	TextureFillsShape `[get, set]`
	Määrittää, täyttääkö tekstuuri olion muodon jos olio on suurempi kuin sille määrätty tekstuuri.
virtual Shape	Shape `[get, set]`
	Olion muoto.
Game	Game `[get, set]`
	Peli, johon olio on lisätty. `null`, jos oliota ei ole lisätty peliin.
bool	Visible `[get, set]`
	Piirretäänkö olio ruudulle.
bool	IsModal `[get, set]`
	Jos `true`, pelin sekä ikkunan alla olevien widgettien ohjaimet eivät ole käytössä kun ikkuna on näkyvissä.
bool	IsAddedToGame `[get]`
	Onko olio lisätty peliin.
bool	IsDestroyed `[get]`
	Onko olio tuhottu.
Tapahtumat
Action	AddedToGame
	Tapahtuu, kun olio lisätään peliin.
Action	RemovedFromGame
	Tapahtuu, kun olio poistetaan pelistä.
Action	Destroyed
	Tapahtuu, kun olio tuhotaan.

Yksityiskohtainen selite

Käyttöliittymän komponentti. Samankaltainen kuin GameObject, mutta toimii vain ruutukoordinaateissa.

Rakentajien & purkajien dokumentaatio

Widget	(	double	width,
		double	height
	)		`[inline]`

Alustaa uuden widgetin.

Parametrit:

width	Leveys.
height	Korkeus.

Widget	(	double	width,
		double	height,
		Shape	shape
	)		`[inline]`

Alustaa uuden widgetin.

Parametrit:

width	Leveys.
height	Korkeus.
shape	Muoto.

Jäsenfunktioiden dokumentaatio

void Add ( Widget childObject ) [inline]

Lisää annetun peliolion tämän olion lapseksi. Lapsiolio liikkuu tämän olion mukana, ja sen paikka ja kulma ilmaistaan suhteessa tähän olioon.

virtual void Destroy ( ) [inline, virtual]

Tuhoaa olion. Tuhottu olio poistuu pelistä.

Toteuttaa luokan Destroyable.

Uudelleentoteutetaan luokassa InputBox.

internal virtual void Draw	(	Matrix	parentTransformation,
		Matrix	transformation
	)		`[inline, protected, virtual]`

Kutsutaan, kun olio piirretään.

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

virtual Vector GetMaximumSize ( ) [inline, protected, virtual]

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.

Palauttaa:

Uudelleentoteutetaan luokassa Window.

bool IsInside ( Vector point ) [inline]

Onko piste p tämän widgetin sisäpuolella.

internal void NotifyParentAboutChangedSizingAttributes ( ) [inline, protected]

Should be called whenever properties that might affect layouts are changed.

void RefreshLayout ( ) [inline]

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.

void Remove ( Widget childObject ) [inline]

Poistaa lapsiolion, mutta ei tuhoa sitä.

virtual void Update ( Time time ) [inline, virtual]

Widgetin päivitys.

Parametrit:

time Peliaika.

Uudelleentoteutetaan luokassa InputBox.

Jäsendatan dokumentaatio

Vector TextureWrapSize = new Vector( 1.0, 1.0 )

Määrittää kuinka moneen kertaan kuva piirretään. Esimerkiksi (3.0, 2.0) piirtää kuvan 3 kertaa vaakasuunnassa ja 2 kertaa pystysuunnassa.

Ominaisuuksien dokumentaatio

Angle AbsoluteAngle [get]

Olion absoluuttinen kulma pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Angle.

Vector AbsolutePosition [get]

Olion absoluuttinen paikka pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Position.

virtual Angle Angle [get, set]

Olion kulma. Nolla = osoittaa oikealle.

Animation Animation [get, set]

Animaatio. Voi olla null, jolloin piirretään vain väri.

Color BorderColor [get, set]

Reunojen väri.

double Bottom [get, set]

Olion alareunan y-koordinaatti.

virtual Color Color [get, set]

Väri, jonka värisenä olio piirretään, jos tekstuuria ei ole määritelty.

Uudelleentoteutetaan luokissa CustomQueryWindow< W >, MessageWindow, MultiSelectWindow, PushButton ja Window.

TimeSpan CreationTime [get, set]

Olion luomisaika.

Game Game [get, set]

Peli, johon olio on lisätty. null, jos oliota ei ole lisätty peliin.

double Height [get, set]

Olion korkeus (Y-suunnassa, korkeimmassa kohdassa).

virtual Sizing HorizontalSizing [get, set]

Koon asettaminen vaakasuunnassa, kun olio on asettelijan sisällä.

virtual Image Image [get, set]

Olion kuva. Voi olla null, jolloin piirretään vain väri.

Uudelleentoteutetaan luokassa Background.

bool IsAddedToGame [get]

Onko olio lisätty peliin.

bool IsDestroyed [get]

Onko olio tuhottu.

Palauttaa:

Toteuttaa luokan Destroyable.

bool IsModal [get, set]

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

ILayout Layout [get, set]

Asettelija lapsiolioille. Asettaa lapsiolioiden koon sekä paikan.

double Left [get, set]

Olion vasemman reunan x-koordinaatti.

TimeSpan Lifetime [get]

Olion elinaika. Lasketaan siitä lähtien, kun olio luodaan.

TimeSpan MaximumLifetime [get, set]

Olion suurin mahdollinen elinaika. Kun Lifetime on suurempi kuin tämä, olio kuolee.

Widget Parent [get, set]

Olio, jonka lapsiolio tämä olio on. Jos null, olio ei ole minkään olion lapsiolio.

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.

Uudelleentoteutetaan luokassa ScoreItemWidget.

virtual Vector PreferredSize [get, set]

Koko, jota oliolla tulisi olla asettelijan sisällä. Todellinen koko voi olla pienempi, jos tilaa ei ole tarpeeksi.

Uudelleentoteutetaan luokassa InputBox.

double Right [get, set]

Olion oikean reunan x-koordinaatti.

virtual Shape Shape [get, set]

Olion muoto.

virtual Vector Size [get, set]

Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa.

Uudelleentoteutetaan luokissa InputBox, Label ja PushButton.

object Tag [get, set]

Vapaasti asetettava muuttuja.

bool TextureFillsShape [get, set]

Määrittää, täyttääkö tekstuuri olion muodon jos olio on suurempi kuin sille määrätty tekstuuri.

double Top [get, set]

Olion yläreunan y-koordinaatti.

virtual Sizing VerticalSizing [get, set]

Koon asettaminen pystysuunnassa, kun olio on asettelijan sisällä.

bool Visible [get, set]

Piirretäänkö olio ruudulle.

double Width [get, set]

Olion leveys (X-suunnassa, leveimmässä kohdassa).

double X [get, set]

Olion paikan X-koordinaatti.

double Y [get, set]

Olion paikan Y-koordinaatti.

Tapahtumien dokumentaatio

Action AddedToGame

Tapahtuu, kun olio lisätään peliin.

Action Destroyed

Tapahtuu, kun olio tuhotaan.

Toteuttaa luokan Destroyable.

Action RemovedFromGame

Tapahtuu, kun olio poistetaan pelistä.

Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta:

C:/Users/tero/AppData/Local/Temp/npo_build/Jypeli/Widgets/Widget.cs

Julkiset jäsenfunktiot

Julkiset attribuutit

Suojatut jäsenfunktiot

Ominaisuudet

Tapahtumat

Yksityiskohtainen selite

Rakentajien & purkajien dokumentaatio

Jäsenfunktioiden dokumentaatio

Jäsendatan dokumentaatio

Ominaisuuksien dokumentaatio

Tapahtumien dokumentaatio