Mouse luokkareferenssi

Hiiri peliohjaimena. Lisää...

Luokan Mouse luokkakaavio

Lista kaikista jäsenistä.

Julkiset jäsenfunktiot
void	Enable (MouseButton button)
void	Disable (MouseButton button)
bool	IsTriggeredOnChannel (int channel, Listener listener)
bool	IsCursorOn (Widget w)
	Onko hiiren kursori annetun olion päällä.
bool	IsCursorOn (IGameObject obj)
	Onko hiiren kursori annetun olion päällä.
Listener	Listen (MouseButton b, ButtonState state, Handler handler, string helpText)
	Kuuntelee hiiren nappulan painalluksia.
Listener	ListenOn (IGameObject obj, MouseButton b, ButtonState state, Handler handler, String helpText)
	Kuuntelee hiirenpainalluksia annetun peliolion päällä.
Listener	ListenOn (Widget w, MouseButton b, ButtonState state, Handler handler, String helpText)
	Kuuntelee hiirenpainalluksia annetun olion päällä.
Listener	ListenMovement (double trigger, AnalogHandler handler, string helpText)
	Kuuntelee hiiren liikettä.
Listener	ListenWheel (Handler handler, string helpText)
	Kuuntelee hiiren rullaa.
Listener	Listen< T1 > (MouseButton b, ButtonState state, Handler< T1 > handler, string helpText, T1 p1)
Listener	ListenOn< T1 > (IGameObject obj, MouseButton b, ButtonState state, Handler< T1 > handler, String helpText, T1 p1)
Listener	ListenOn< T1 > (Widget w, MouseButton b, ButtonState state, Handler< T1 > handler, String helpText, T1 p1)
Listener	ListenWheel< T1 > (Handler< T1 > handler, string helpText, T1 p1)
Listener	ListenMovement< T1 > (double trigger, AnalogHandler< T1 > handler, string helpText, T1 p1)
Listener	Listen< T1, T2 > (MouseButton b, ButtonState state, Handler< T1, T2 > handler, string helpText, T1 p1, T2 p2)
Listener	ListenOn< T1, T2 > (IGameObject obj, MouseButton b, ButtonState state, Handler< T1, T2 > handler, String helpText, T1 p1, T2 p2)
Listener	ListenOn< T1, T2 > (Widget w, MouseButton b, ButtonState state, Handler< T1, T2 > handler, String helpText, T1 p1, T2 p2)
Listener	ListenWheel< T1, T2 > (Handler< T1, T2 > handler, string helpText, T1 p1, T2 p2)
Listener	ListenMovement< T1, T2 > (double trigger, AnalogHandler< T1, T2 > handler, string helpText, T1 p1, T2 p2)
Listener	Listen< T1, T2, T3 > (MouseButton b, ButtonState state, Handler< T1, T2, T3 > handler, string helpText, T1 p1, T2 p2, T3 p3)
Listener	ListenOn< T1, T2, T3 > (IGameObject obj, MouseButton b, ButtonState state, Handler< T1, T2, T3 > handler, String helpText, T1 p1, T2 p2, T3 p3)
Listener	ListenOn< T1, T2, T3 > (Widget w, MouseButton b, ButtonState state, Handler< T1, T2, T3 > handler, String helpText, T1 p1, T2 p2, T3 p3)
Listener	ListenWheel< T1, T2, T3 > (Handler< T1, T2, T3 > handler, string helpText, T1 p1, T2 p2, T3 p3)
Listener	ListenMovement< T1, T2, T3 > (double trigger, AnalogHandler< T1, T2, T3 > handler, string helpText, T1 p1, T2 p2, T3 p3)
Listener	Listen< T1, T2, T3, T4 > (MouseButton b, ButtonState state, Handler< T1, T2, T3, T4 > handler, string helpText, T1 p1, T2 p2, T3 p3, T4 p4)
Listener	ListenOn< T1, T2, T3, T4 > (IGameObject obj, MouseButton b, ButtonState state, Handler< T1, T2, T3, T4 > handler, String helpText, T1 p1, T2 p2, T3 p3, T4 p4)
Listener	ListenOn< T1, T2, T3, T4 > (Widget w, MouseButton b, ButtonState state, Handler< T1, T2, T3, T4 > handler, String helpText, T1 p1, T2 p2, T3 p3, T4 p4)
Listener	ListenWheel< T1, T2, T3, T4 > (Handler< T1, T2, T3, T4 > handler, string helpText, T1 p1, T2 p2, T3 p3, T4 p4)
Listener	ListenMovement< T1, T2, T3, T4 > (double trigger, AnalogHandler< T1, T2, T3, T4 > handler, string helpText, T1 p1, T2 p2, T3 p3, T4 p4)
Suojatut jäsenfunktiot
override bool	IsTriggered (Listener listener)
override bool	IsAnalogTriggered (Listener listener, out AnalogState state)
Ominaisuudet
int	ActiveChannels [get]
	Multitouchia varten.
bool	IsCursorVisible [get, set]
	Käytetäänkö hiiren kursoria. Jos käytetään, hiiren paikka ruudulla on mitattavissa, mutta hiiri ei voi liikkua ruudun ulkopuolelle. Jos ei käytetä, hiirtä voidaan liikuttaa rajatta, mutta sen paikkaa ruudulla ei voida määrittää.
Vector	PositionOnScreen [get, set]
	Kursorin paikka ruutukoordinaateissa.
Vector	PositionOnWorld [get, set]
	Kursorin paikka maailmankoordinaateissa.
int	WheelState [get]
	Rullan asento. Vähenee alaspäin ja kasvaa ylöspäin rullattaessa.
int	WheelChange [get]
	Rullan asennon muutos viime tarkistuksesta. Vähenee alaspäin ja kasvaa ylöspäin rullattaessa. Nolla jos rullaa ei ole käytetty.

---

Yksityiskohtainen selite

Hiiri peliohjaimena.

---

Jäsenfunktioiden dokumentaatio

bool IsCursorOn

(

Widget

w

)

[inline]

Onko hiiren kursori annetun olion päällä.

bool IsCursorOn

(

IGameObject

obj

)

[inline]

Onko hiiren kursori annetun olion päällä.

Listener Listen	(	MouseButton	b,
		ButtonState	state,
		Handler	handler,
		string	helpText
	)		[inline]

Kuuntelee hiiren nappulan painalluksia.

Parametrit:

b	Kuunneltava nappula.
state	Nappulan tila.
handler	Tapahtuman käsittelijä.
helpText	Ohjeteksti.

Listener ListenMovement	(	double	trigger,
		AnalogHandler	handler,
		string	helpText
	)		[inline]

Kuuntelee hiiren liikettä.

Parametrit:

trigger	Kuinka pitkän matkan hiiren tulisi liikkua, että tulee tapahtuma.
handler	Hiiren tapahtuman käsittelijä.
helpText	Ohjeteksti.

Listener ListenOn	(	IGameObject	obj,
		MouseButton	b,
		ButtonState	state,
		Handler	handler,
		String	helpText
	)		[inline]

Kuuntelee hiirenpainalluksia annetun peliolion päällä.

Parametrit:

obj	Olio, jonka päällä hiiren kursorin tulisi olla.
b	Hiiren nappula.
state	Nappulan tila.
handler	Tapahtuman käsittelijä.
helpText	Ohjeteksti.

Listener ListenOn	(	Widget	w,
		MouseButton	b,
		ButtonState	state,
		Handler	handler,
		String	helpText
	)		[inline]

Kuuntelee hiirenpainalluksia annetun olion päällä.

Parametrit:

w	Olio, jonka päällä hiiren kursorin tulisi olla.
b	Hiiren painike.
state	Nappulan tila.
handler	Tapahtuman käsittelijä.
helpText	Ohjeteksti.

Listener ListenWheel	(	Handler	handler,
		string	helpText
	)		[inline]

Kuuntelee hiiren rullaa.

Parametrit:

handler	Hiiren rullan tapahtuman käsittelijä.
helpText	Ohjeteksti.

---

Ominaisuuksien dokumentaatio

int ActiveChannels [get]

Multitouchia varten.

Toteuttaa luokan PointingDevice.

bool IsCursorVisible [get, set]

Käytetäänkö hiiren kursoria. Jos käytetään, hiiren paikka ruudulla on mitattavissa, mutta hiiri ei voi liikkua ruudun ulkopuolelle. Jos ei käytetä, hiirtä voidaan liikuttaa rajatta, mutta sen paikkaa ruudulla ei voida määrittää.

Vector PositionOnScreen [get, set]

Kursorin paikka ruutukoordinaateissa.

Vector PositionOnWorld [get, set]

Kursorin paikka maailmankoordinaateissa.

int WheelChange [get]

Rullan asennon muutos viime tarkistuksesta. Vähenee alaspäin ja kasvaa ylöspäin rullattaessa. Nolla jos rullaa ei ole käytetty.

int WheelState [get]

Rullan asento. Vähenee alaspäin ja kasvaa ylöspäin rullattaessa.

---

Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta:

• C:/Users/tero/AppData/Local/Temp/npo_build/Jypeli/Controls/Mouse.cs