Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials |
Interface to manipulate the mouse cursor. More...
#include <ICursorControl.h>
Public Member Functions | |
virtual const core::position2d < s32 > & | getPosition ()=0 |
Returns the current position of the mouse cursor. | |
virtual core::position2d< f32 > | getRelativePosition ()=0 |
Returns the current position of the mouse cursor. | |
virtual bool | isVisible () const =0 |
Returns if the cursor is currently visible. | |
virtual void | setPosition (s32 x, s32 y)=0 |
Sets the new position of the cursor. | |
virtual void | setPosition (const core::position2d< s32 > &pos)=0 |
Sets the new position of the cursor. | |
virtual void | setPosition (f32 x, f32 y)=0 |
Sets the new position of the cursor. | |
virtual void | setPosition (const core::position2d< f32 > &pos)=0 |
Sets the new position of the cursor. | |
virtual void | setReferenceRect (core::rect< s32 > *rect=0)=0 |
Sets an absolute reference rect for setting and retrieving the cursor position. | |
virtual void | setVisible (bool visible)=0 |
Changes the visible state of the mouse cursor. |
Interface to manipulate the mouse cursor.
Definition at line 18 of file ICursorControl.h.
virtual const core::position2d<s32>& irr::gui::ICursorControl::getPosition | ( | ) | [pure virtual] |
Returns the current position of the mouse cursor.
virtual core::position2d<f32> irr::gui::ICursorControl::getRelativePosition | ( | ) | [pure virtual] |
Returns the current position of the mouse cursor.
virtual bool irr::gui::ICursorControl::isVisible | ( | ) | const [pure virtual] |
Returns if the cursor is currently visible.
Sets the new position of the cursor.
x | New x-coord of the cursor. The coordinates are pixel units. | |
y | New y-coord of the cursor. The coordinates are pixel units. |
virtual void irr::gui::ICursorControl::setPosition | ( | const core::position2d< s32 > & | pos | ) | [pure virtual] |
Sets the new position of the cursor.
pos,: | New position of the cursor. The coordinates are pixel units. |
Sets the new position of the cursor.
The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window.
x | New x-coord of the cursor. | |
y | New x-coord of the cursor. |
virtual void irr::gui::ICursorControl::setPosition | ( | const core::position2d< f32 > & | pos | ) | [pure virtual] |
Sets the new position of the cursor.
The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window.
pos | New position of the cursor. |
virtual void irr::gui::ICursorControl::setReferenceRect | ( | core::rect< s32 > * | rect = 0 |
) | [pure virtual] |
Sets an absolute reference rect for setting and retrieving the cursor position.
If this rect is set, the cursor position is not being calculated relative to the rendering window but to this rect. You can set the rect pointer to 0 to disable this feature again. This feature is useful when rendering into parts of foreign windows for example in an editor.
rect,: | A pointer to an reference rectangle or 0 to disable the reference rectangle. |
virtual void irr::gui::ICursorControl::setVisible | ( | bool | visible | ) | [pure virtual] |
Changes the visible state of the mouse cursor.
visible,: | The new visible state. If true, the cursor will be visible, if false, it will be invisible. |
The Irrlicht
Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated
on Sun Oct 24 12:42:03 2010 by Doxygen
(1.6.2) |