GUIInput.h

#pragma once

namespace RTE {

	/// An interface class inherited by the different types of input methods.
	class GUIInput {

	public:
		// Mouse & Key events
		enum {
			None,
			Released, // Has just been released
			Pushed, // Has just been pushed down
			Repeat // Is repeating
		} Event;

		// Mouse & Key states
		enum {
			Up,
			Down
		} State;

		// Modifiers
		enum {
			ModNone = 0x00,
			ModShift = 0x01,
			ModCtrl = 0x02,
			ModAlt = 0x04,
			ModCommand = 0x08
		} Modifier;

		// Extra keys
		enum {
			Key_None = 0,
			Key_Backspace = 0x00000008,
			Key_Tab = 0x00000009,
			Key_Enter = 0x0000000D,
			Key_Escape = 0x0000001B,
			Key_LeftArrow = 0x00000086,
			Key_RightArrow = 0x00000087,
			Key_UpArrow = 0x00000088,
			Key_DownArrow = 0x00000089,
			Key_Insert = 0x00000095,
			Key_Delete = 0x00000096,
			Key_Home = 0x00000097,
			Key_End = 0x00000098,
			Key_PageUp = 0x00000099,
			Key_PageDown = 0x0000009A
		} Keys;

		/// Constructor method used to instantiate a GUIInput object in system
		/// memory.
		/// @param whichPlayer Whether the keyboard and joysticks also can control the mouse cursor.
		GUIInput(int whichPlayer, bool keyJoyMouseCursor = false);

		virtual ~GUIInput();

		/// Destroy the screen
		virtual void Destroy();

		/// Sets the offset for the mouse input to be adjusted by. This should
		/// be used when the GUI is being drawn somewhere else on the screen than
		/// the upper left corner. These values should be from the GUI to the upper
		/// left corner.
		/// @param mouseOffsetX The new offset.
		void SetMouseOffset(int mouseOffsetX, int mouseOffsetY) {
			m_MouseOffsetX = mouseOffsetX;
			m_MouseOffsetY = mouseOffsetY;
		}

		/// Sets the offset for the mouse input to be adjusted by. This should
		/// These values should be from the GUI to the upper of the screen.
		/// left corner.
		/// @param mouseOffsetX The new offset.
		void GetMouseOffset(int& mouseOffsetX, int& mouseOffsetY) const {
			mouseOffsetX = m_MouseOffsetX;
			mouseOffsetY = m_MouseOffsetY;
		}

		/// Updates the Input.
		virtual void Update();

		/// Copies the keyboard buffer into an array. The keyboard buffer is
		/// ordered by ascii code and each entry contains a GUInput::Event enum
		/// state.
		/// @param Buffer Buffer array.
		void GetKeyboard(unsigned char* Buffer) const;

		unsigned char GetAsciiState(unsigned char ascii) const;

		unsigned char GetScanCodeState(unsigned char scancode) const;

		bool GetTextInput(std::string_view& text) const {
			text = m_TextInput;
			return !m_TextInput.empty();
		}

		/// Copies the mouse button states into an array
		/// @param Events State array.
		void GetMouseButtons(int* Events, int* States) const;

		void ClearMouseState();

		static void SetNetworkMouseButton(int whichPlayer, int state1, int state2, int state3);

		/// Gets the mouse position
		/// @param X Pointers to store the X and Y coordinates in
		void GetMousePosition(int* X, int* Y) const;

		static void SetNetworkMouseMovement(int whichPlayer, int x, int y);

		/// Gets the key modifiers.
		int GetModifier() const;

		/// This function returns how much the mouse scroll wheel has moved. Positive integer is scroll up, negative is scroll down.
		/// @return Mouse scroll wheel movement in integer value.
		int GetMouseWheelChange() const {
			return m_MouseWheelChange;
		}

		/// Sets whether the keyboard and joysticks also control the mouse.
		/// @param enableKeyJoyMouseCursor Whether the keyboard and joysticks also control the mouse or not.
		void SetKeyJoyMouseCursor(bool enableKeyJoyMouseCursor) { m_KeyJoyMouseCursor = enableKeyJoyMouseCursor; }

		/// Enables receiving text input events.
		virtual void StartTextInput();

		/// Disables receiving text input events.
		virtual void StopTextInput();

	protected:
		enum Constants {
			KEYBOARD_BUFFER_SIZE = 256
		};

		// Keyboard buffer holding the key states
		unsigned char m_KeyboardBuffer[KEYBOARD_BUFFER_SIZE];
		unsigned char m_ScanCodeState[KEYBOARD_BUFFER_SIZE];
		std::string m_TextInput;
		bool m_HasTextInput;
		int m_TextInputActive{0};

		// Mouse button states
		// Order:    Left, Middle, Right
		int m_MouseButtonsEvents[3];
		int m_MouseButtonsStates[3];

		static int m_NetworkMouseButtonsEvents[4][3];
		static int m_NetworkMouseButtonsStates[4][3];
		static int m_PrevNetworkMouseButtonsStates[4][3];

		static bool m_OverrideInput;

		int m_MouseX;
		int m_MouseY;
		int m_LastFrameMouseX;
		int m_LastFrameMouseY;

		static int m_NetworkMouseX[4];
		static int m_NetworkMouseY[4];

		int m_Player;

		int m_MouseWheelChange; //!< the amount and direction that the mouse wheel has moved.

		// These offset the mouse positions so that the cursor is shifted for all events
		int m_MouseOffsetX;
		int m_MouseOffsetY;

		int m_Modifier;

		// Whether the keyboard and joysticks also control the mouse
		bool m_KeyJoyMouseCursor;
	};
} // namespace RTE