Referencia de la Clase Yukino::Input

Clase que gestiona el sistema de entrada. Más...

#include <Input.h>

Lista de todos los miembros.

Métodos públicos

UINT Init (void)
 Función para inicializar el objeto Input.
void Release (void)
 Función para finalizar el objeto Input.
void Update (void)
 Función para actualizar el estado de la entrada.
bool GetKey (int key) const
 Función para preguntar si una tecla está pulsada.
bool KbHit (void) const
 Función para preguntar si el teclado está pulsado.
bool EnableKeyRepeat (int delay, int interval)
 Función para activar la repetición de pulsaciones.
bool DisableKeyRepeat (void)
 Función para desactivar la repetición de pulsaciones.
int GetMouseX (void) const
 Función para obtener la coordenada X del ratón.
int GetMouseY (void) const
 Función para obtener la coordenada Y del ratón.
int GetMouseRelX (void) const
 Función para obtener la coordenada relativa X del ratón.
int GetMouseRelY (void) const
 Función para obtener la coordenada relativa Y del ratón.
bool MouseButton (int button) const
 Función para preguntar si un botón del ratón está pulsado.
bool LeftButton (void) const
 Función para preguntar si el botón izquierdo del ratón está pulsado.
bool MiddleButton (void) const
 Función para preguntar si el botón central del ratón está pulsado.
bool RightButton (void) const
 Función para preguntar si el botón derecho del ratón está pulsado.
bool WheelUp (void) const
 Función para preguntar si el WheelUp del ratón está pulsado.
bool WheelDown (void) const
 Función para preguntar si el WheelDown del ratón está pulsado.
bool MouseInRect (Rect *rect)
 Función para preguntar si el ratón está en una región.

Métodos públicos estáticos

static InputGetInstance (void)
 Función para obtener la instancia de Input.


Descripción detallada

Clase que gestiona el sistema de entrada.

La clase Input gestiona los temas relacionados con el sistema de entrada. Estos basicamente son, manejar y controlar el teclado y el ratón.


Documentación de las funciones miembro

bool Yukino::Input::DisableKeyRepeat ( void   )  [inline]

Función para desactivar la repetición de pulsaciones.

Esta función sirve para desactivar la repetición de pulsaciones.

Ver también:
EnableKeyRepeat().
Devuelve:
Si todo va bien devuelve true, sino devuelve false.

bool Yukino::Input::EnableKeyRepeat ( int  delay,
int  interval 
) [inline]

Función para activar la repetición de pulsaciones.

Esta función sirve para activar la repetición de pulsaciones.

Parámetros:
delay Tiempo en ms de espera para empezar las repeticiones.
interval Tiempo en ms entre repetición y repetición.
Ver también:
DisableKeyRepeat().
Devuelve:
Si todo va bien devuelve true, sino devuelve false.

Input * Yukino::Input::GetInstance ( void   )  [static]

Función para obtener la instancia de Input.

Esta función crea una instancia de Input, en caso de no estar creada, y devuelve un puntero a esta si tiene exito pidiendo memoria.

Devuelve:
Devuelve un puntero al objeto Input si todo ha ido bien, en caso de no haber memoria para el objeto devuelve NULL.

bool Yukino::Input::GetKey ( int  key  )  const [inline]

Función para preguntar si una tecla está pulsada.

Esta función sirve para preguntar si una tecla está pulsada.

Parámetros:
key La tecla en cuestión.
Ver también:
KbHit().
Devuelve:
Si devuelve true, es que la tecla está pulsada.

int Yukino::Input::GetMouseRelX ( void   )  const [inline]

Función para obtener la coordenada relativa X del ratón.

Esta función sirve para obtener la coordenada relativa X del ratón.

Ver también:
GetMouseX(), GetMouseY(), GetMouseRelY().
Devuelve:
La coordenada relativa X del ratón.

int Yukino::Input::GetMouseRelY ( void   )  const [inline]

Función para obtener la coordenada relativa Y del ratón.

Esta función sirve para obtener la coordenada relativa Y del ratón.

Ver también:
GetMouseX(), GetMouseY(), GetMouseRelX().
Devuelve:
La coordenada relativa Y del ratón.

int Yukino::Input::GetMouseX ( void   )  const [inline]

Función para obtener la coordenada X del ratón.

Esta función sirve para obtener la coordenada X del ratón.

Ver también:
GetMouseY(), GetMouseRelX(), GetMouseRelY().
Devuelve:
La coordenada X del ratón.

int Yukino::Input::GetMouseY ( void   )  const [inline]

Función para obtener la coordenada Y del ratón.

Esta función sirve para obtener la coordenada Y del ratón.

Ver también:
GetMouseX(), GetMouseRelX(), GetMouseRelY().
Devuelve:
La coordenada Y del ratón.

UINT Yukino::Input::Init ( void   ) 

Función para inicializar el objeto Input.

Esta función sirve para inicializar el objeto Input.

Ver también:
Release().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: INPUT_ERROR_GETKEYSTATE.

bool Yukino::Input::KbHit ( void   )  const

Función para preguntar si el teclado está pulsado.

Esta función sirve para preguntar si el teclado está pulsado.

Ver también:
GetKey().
Devuelve:
Si devuelve true, es que la teclado está pulsado.

bool Yukino::Input::LeftButton ( void   )  const [inline]

Función para preguntar si el botón izquierdo del ratón está pulsado.

Esta función sirve para preguntar si el botón izquierdo está pulsado.

Ver también:
MouseButton(), MiddleButton(), RightButton(), WheelUp(), WheelDown().
Devuelve:
Si devuelve true, es que el botón está pulsado.

bool Yukino::Input::MiddleButton ( void   )  const [inline]

Función para preguntar si el botón central del ratón está pulsado.

Esta función sirve para preguntar si el botón central está pulsado.

Ver también:
MouseButton(), LeftButton(), RightButton(), WheelUp(), WheelDown().
Devuelve:
Si devuelve true, es que el botón está pulsado.

bool Yukino::Input::MouseButton ( int  button  )  const [inline]

Función para preguntar si un botón del ratón está pulsado.

Esta función sirve para preguntar si un botón del ratón está pulsado.

Parámetros:
button El botón en cuestión.
Ver también:
LeftButton(), MiddleButton(), RightButton(), WheelUp(), WheelDown().
Devuelve:
Si devuelve true, es que el botón está pulsado.

bool Yukino::Input::MouseInRect ( Rect rect  )  [inline]

Función para preguntar si el ratón está en una región.

Esta función sirve para preguntar si el ratón está en una región.

Parámetros:
rect La región en cuestión.
Devuelve:
Si devuelve true, es que el ratón está en la región.

void Yukino::Input::Release ( void   ) 

Función para finalizar el objeto Input.

Esta función sirve para finalizar el objeto Input.

Ver también:
Init().

bool Yukino::Input::RightButton ( void   )  const [inline]

Función para preguntar si el botón derecho del ratón está pulsado.

Esta función sirve para preguntar si el botón derecho está pulsado.

Ver también:
MouseButton(), LeftButton(), MiddleButton(), WheelUp(), WheelDown().
Devuelve:
Si devuelve true, es que el botón está pulsado.

void Yukino::Input::Update ( void   ) 

Función para actualizar el estado de la entrada.

Esta función sirve para actualizar el estado de la entrada.

bool Yukino::Input::WheelDown ( void   )  const [inline]

Función para preguntar si el WheelDown del ratón está pulsado.

Esta función sirve para preguntar si el WheelDown del ratón está pulsado.

Ver también:
MouseButton(), LeftButton(), MiddleButton(), RightButton(), WheelUp().
Devuelve:
Si devuelve true, es que el botón está pulsado.

bool Yukino::Input::WheelUp ( void   )  const [inline]

Función para preguntar si el WheelUp del ratón está pulsado.

Esta función sirve para preguntar si el WheelUp del ratón está pulsado.

Ver también:
MouseButton(), LeftButton(), MiddleButton(), RightButton(), WheelDown().
Devuelve:
Si devuelve true, es que el botón está pulsado.


La documentación para esta clase fué generada a partir de los siguientes archivos:
Generado el Sun Jun 25 03:44:44 2006 para Yukino por  doxygen 1.4.7