Interface to manipulate the mouse cursor.
More...
#include <ICursorControl.h>
Interface to manipulate the mouse cursor.
Definition at line 97 of file ICursorControl.h.
◆ addIcon()
Add a custom sprite as cursor icon.
- Returns
- Identification for the icon
Definition at line 173 of file ICursorControl.h.
◆ changeIcon()
replace a cursor icon.
Changing cursor icons is so far only supported on Win32 and Linux Note that this only changes the icons within your application, system cursors outside your application will not be affected.
Definition at line 180 of file ICursorControl.h.
◆ getActiveIcon()
virtual ECURSOR_ICON irr::gui::ICursorControl::getActiveIcon |
( |
| ) |
const |
|
inlinevirtual |
◆ getPlatformBehavior()
Return platform specific behavior.
- Returns
- Behavior set by setPlatformBehavior or ECPB_NONE for platforms not implementing specific behaviors.
Definition at line 191 of file ICursorControl.h.
default - no platform specific behavior
◆ getPosition()
Returns the current position of the mouse cursor.
- Parameters
-
updateCursor | When true ask system/OS for current cursor position. When false return the last known (buffered) position ( this is useful to check what has become of a setPosition call with float numbers). |
- Returns
- Returns the current position of the cursor. The returned position is the position of the mouse cursor in pixel units.
◆ getRelativePosition()
virtual core::position2d<f32> irr::gui::ICursorControl::getRelativePosition |
( |
bool |
updateCursor = true | ) |
|
|
pure virtual |
Returns the current position of the mouse cursor.
- Parameters
-
updateCursor | When true ask system/OS for current cursor position. When false return the last known (buffered) position (this is useful to check what has become of a setPosition call with float numbers and is often different from the values you passed in setPosition). |
- Returns
- Returns the current position of the cursor. The returned position is a value 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.
◆ getSupportedIconSize()
Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work.
Definition at line 183 of file ICursorControl.h.
dimension2d< s32 > dimension2di
Typedef for an integer dimension.
◆ isVisible()
virtual bool irr::gui::ICursorControl::isVisible |
( |
| ) |
const |
|
pure virtual |
Returns if the cursor is currently visible.
- Returns
- True if the cursor is visible, false if not.
◆ setActiveIcon()
Sets the active cursor icon.
Setting cursor icons is so far only supported on Win32 and Linux
Definition at line 166 of file ICursorControl.h.
◆ setPlatformBehavior()
◆ setPosition() [1/4]
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.
- Parameters
-
pos | New position of the cursor. |
◆ setPosition() [2/4]
virtual void irr::gui::ICursorControl::setPosition |
( |
f32 |
x, |
|
|
f32 |
y |
|
) |
| |
|
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.
- Parameters
-
x | New x-coord of the cursor. |
y | New x-coord of the cursor. |
◆ setPosition() [3/4]
Sets the new position of the cursor.
- Parameters
-
pos | New position of the cursor. The coordinates are pixel units. |
◆ setPosition() [4/4]
virtual void irr::gui::ICursorControl::setPosition |
( |
s32 |
x, |
|
|
s32 |
y |
|
) |
| |
|
pure virtual |
Sets the new position of the cursor.
- Parameters
-
x | New x-coord of the cursor. The coordinates are pixel units. |
y | New y-coord of the cursor. The coordinates are pixel units. |
◆ setReferenceRect()
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.
- Parameters
-
rect | A pointer to an reference rectangle or 0 to disable the reference rectangle. |
◆ setVisible()
virtual void irr::gui::ICursorControl::setVisible |
( |
bool |
visible | ) |
|
|
pure virtual |
Changes the visible state of the mouse cursor.
- Parameters
-
visible | The new visible state. If true, the cursor will be visible, if false, it will be invisible. |
The documentation for this class was generated from the following file: