.. index:: pair: class; EE::Window::Cursor
.. _doxid-class_e_e_1_1_window_1_1_cursor:

class EE::Window::Cursor
========================

.. toctree::
	:hidden:

	enum_EE_Window_Cursor_SysType.rst
	enum_EE_Window_Cursor_Type.rst

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <cursor.hpp>
	
	class Cursor {
	public:
		// enums
	
		enum :ref:`SysType<doxid-class_e_e_1_1_window_1_1_cursor_1a5eedaf57c5c6325482632628264f35b4>`;
		enum :ref:`Type<doxid-class_e_e_1_1_window_1_1_cursor_1a1addbcf0acd62620d7d9eb9349bda5bd>`;

		// construction
	
		virtual :target:`~Cursor<doxid-class_e_e_1_1_window_1_1_cursor_1a4319885cd22d7bbc028db8c448480eed>`();

		// methods
	
		static :ref:`Cursor::Type<doxid-class_e_e_1_1_window_1_1_cursor_1a1addbcf0acd62620d7d9eb9349bda5bd>` :target:`fromName<doxid-class_e_e_1_1_window_1_1_cursor_1a7632bf90cc05fb72424372e7540e8d90>`(std::string name);
		const :ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`& :ref:`getId<doxid-class_e_e_1_1_window_1_1_cursor_1a8903d4b2e56dbbad5240c0b7a4259106>`() const;
		const std::string& :ref:`getName<doxid-class_e_e_1_1_window_1_1_cursor_1a1b8b81293fcce68974554a02addf93bd>`() const;
		const :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>`& :ref:`getHotSpot<doxid-class_e_e_1_1_window_1_1_cursor_1ac8d5c20abd59e0aef3db23049a1c16d9>`() const;
		:ref:`Graphics::Image<doxid-class_e_e_1_1_graphics_1_1_image>`* :ref:`getImage<doxid-class_e_e_1_1_window_1_1_cursor_1a840863f656c5a93e4f0f041305a8fd64>`() const;
	};
.. _details-class_e_e_1_1_window_1_1_cursor:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Methods
-------

.. index:: pair: function; getId
.. _doxid-class_e_e_1_1_window_1_1_cursor_1a8903d4b2e56dbbad5240c0b7a4259106:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`& getId() const



.. rubric:: Returns:

The cursor id

.. index:: pair: function; getName
.. _doxid-class_e_e_1_1_window_1_1_cursor_1a1b8b81293fcce68974554a02addf93bd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::string& getName() const



.. rubric:: Returns:

The cursor name

.. index:: pair: function; getHotSpot
.. _doxid-class_e_e_1_1_window_1_1_cursor_1ac8d5c20abd59e0aef3db23049a1c16d9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>`& getHotSpot() const



.. rubric:: Returns:

The cursor hotspot, this means, the position inside the cursor image, where the click is taken

.. index:: pair: function; getImage
.. _doxid-class_e_e_1_1_window_1_1_cursor_1a840863f656c5a93e4f0f041305a8fd64:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Graphics::Image<doxid-class_e_e_1_1_graphics_1_1_image>`* getImage() const



.. rubric:: Returns:

The pointer to the image that represents the cursor