pl.tph.javatacka.input
Class VirtualKey

java.lang.Object
  extended by pl.tph.javatacka.input.VirtualKey

public class VirtualKey
extends java.lang.Object

Klasa GameAction jest klasą wykorzystywaną przez obiekty typu InputManager do wiązania akcji inicjowanych przez użytkownika z konkretnymi akcjami wejścia (np. naciśnięcie klawisza, ale nie koniecznie).

W dalszej części dokumentacji przez klawisz należy rozumieć pewien dwustanowy obiekt, który może być wciśnięty lub wyciśnięty.

Obiekty tej klasy są synchronizowane, więc można ich bezpiecznie używać w programach wielowątkowych.

Author:
Tomasz Pieczerak (tph)
See Also:
InputManager

Field Summary
private  boolean behavior
          Sposób zachowania się klawisza w odpowiedzi na wywołanie metody isPressed().
static boolean INITIAL_PRESS_ONLY
          Z tą opcją metoda isPressed() zwróci true tylko przy pierwszym wywołaniu po tym jak klawisz został wciśnięty.
static boolean NORMAL
          Normalne zachowanie klawisza.
private  int state
          Aktualny stan klawisza.
private static int STATE_PRESSED
          Klawisz został wciśnięty.
private static int STATE_RELEASED
          Klawisz został zwolniony.
private static int STATE_WAITING_FOR_RELEASE
          Klawisz został wciśnięty, a następnie jego stan został raz sprawdzony przez metodę isPressed().
 
Constructor Summary
VirtualKey()
          Tworzy nowy obiekt klasy VirtualKey z domyślnie ustawioną opcją NORMAL.
VirtualKey(boolean behavior)
          Tworzy nowy obiekt klasy VirtualKey z wybranym trybem zachowania klawiszy.
 
Method Summary
 boolean isPressed()
          Zwraca wartość logiczną mówiącą o tym czy klawisz związany z tym obiektem VirtualKey jest aktualnie wciśnięty czy nie.
 void press()
          Wciska klawisz związany z tym obiektem VirtualKey.
 void release()
          Zwalnia klawisz związany z tym obiektem VirtualKey.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORMAL

public static final boolean NORMAL
Normalne zachowanie klawisza. To znaczy metoda isPressed() zwraca true tak długo jak długo klawisz jest wciśnięty.

See Also:
Constant Field Values

INITIAL_PRESS_ONLY

public static final boolean INITIAL_PRESS_ONLY
Z tą opcją metoda isPressed() zwróci true tylko przy pierwszym wywołaniu po tym jak klawisz został wciśnięty.

See Also:
Constant Field Values

STATE_RELEASED

private static final int STATE_RELEASED
Klawisz został zwolniony.

See Also:
Constant Field Values

STATE_PRESSED

private static final int STATE_PRESSED
Klawisz został wciśnięty.

See Also:
Constant Field Values

STATE_WAITING_FOR_RELEASE

private static final int STATE_WAITING_FOR_RELEASE
Klawisz został wciśnięty, a następnie jego stan został raz sprawdzony przez metodę isPressed(). Do momentu zwolnienia klawisza, a następnie jego ponownego wciśnięcia wywołanie tej metody zwróci false.

See Also:
Constant Field Values

behavior

private boolean behavior
Sposób zachowania się klawisza w odpowiedzi na wywołanie metody isPressed().

See Also:
isPressed(), NORMAL, INITIAL_PRESS_ONLY

state

private int state
Aktualny stan klawisza.

See Also:
STATE_RELEASED, STATE_PRESSED, STATE_WAITING_FOR_RELEASE
Constructor Detail

VirtualKey

public VirtualKey()
Tworzy nowy obiekt klasy VirtualKey z domyślnie ustawioną opcją NORMAL.

See Also:
INITIAL_PRESS_ONLY

VirtualKey

public VirtualKey(boolean behavior)
Tworzy nowy obiekt klasy VirtualKey z wybranym trybem zachowania klawiszy.

Parameters:
behavior - wybrany tryb zachowania klawiszy
See Also:
NORMAL, INITIAL_PRESS_ONLY
Method Detail

press

public void press()
Wciska klawisz związany z tym obiektem VirtualKey.


release

public void release()
Zwalnia klawisz związany z tym obiektem VirtualKey.


isPressed

public boolean isPressed()
Zwraca wartość logiczną mówiącą o tym czy klawisz związany z tym obiektem VirtualKey jest aktualnie wciśnięty czy nie. Zachowanie tej metody jest zgodne z wybranym trybem.

See Also:
NORMAL, INITIAL_PRESS_ONLY