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 ECURSOR_ICON | addIcon (const gui::SCursorSprite &icon) |
Add a custom sprite as cursor icon. More... | |
virtual void | changeIcon (ECURSOR_ICON iconId, const gui::SCursorSprite &sprite) |
replace a cursor icon. More... | |
virtual ECURSOR_ICON | getActiveIcon () const |
Gets the currently active icon. More... | |
virtual ECURSOR_PLATFORM_BEHAVIOR | getPlatformBehavior () const |
Return platform specific behavior. More... | |
virtual const core::position2d < s32 > & | getPosition ()=0 |
Returns the current position of the mouse cursor. More... | |
virtual core::position2d< f32 > | getRelativePosition ()=0 |
Returns the current position of the mouse cursor. More... | |
virtual core::dimension2di | getSupportedIconSize () const |
Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work. More... | |
virtual bool | isVisible () const =0 |
Returns if the cursor is currently visible. More... | |
virtual void | setActiveIcon (ECURSOR_ICON iconId) |
Sets the active cursor icon. More... | |
virtual void | setPlatformBehavior (ECURSOR_PLATFORM_BEHAVIOR behavior) |
Set platform specific behavior flags. More... | |
virtual void | setPosition (const core::position2d< f32 > &pos)=0 |
Sets the new position of the cursor. More... | |
virtual void | setPosition (f32 x, f32 y)=0 |
Sets the new position of the cursor. More... | |
virtual void | setPosition (const core::position2d< s32 > &pos)=0 |
Sets the new position of the cursor. More... | |
virtual void | setPosition (s32 x, s32 y)=0 |
Sets the new position of the cursor. More... | |
virtual void | setReferenceRect (core::rect< s32 > *rect=0)=0 |
Sets an absolute reference rect for setting and retrieving the cursor position. More... | |
virtual void | setVisible (bool visible)=0 |
Changes the visible state of the mouse cursor. More... | |
![]() | |
bool | drop () const |
Drops the object. Decrements the reference counter by one. More... | |
const c8 * | getDebugName () const |
Returns the debug name of the object. More... | |
s32 | getReferenceCount () const |
Get the reference count. More... | |
void | grab () const |
Grabs the object. Increments the reference counter by one. More... | |
IReferenceCounted () | |
Constructor. More... | |
virtual | ~IReferenceCounted () |
Destructor. More... | |
Additional Inherited Members | |
![]() | |
void | setDebugName (const c8 *newName) |
Sets the debug name of the object. More... | |
Interface to manipulate the mouse cursor.
Definition at line 97 of file ICursorControl.h.
|
inlinevirtual |
Add a custom sprite as cursor icon.
Definition at line 166 of file ICursorControl.h.
References irr::gui::ECI_NORMAL.
|
inlinevirtual |
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 173 of file ICursorControl.h.
|
inlinevirtual |
Gets the currently active icon.
Definition at line 162 of file ICursorControl.h.
References irr::gui::ECI_NORMAL.
|
inlinevirtual |
Return platform specific behavior.
Definition at line 184 of file ICursorControl.h.
References irr::gui::ECPB_NONE.
|
pure virtual |
Returns the current position of the mouse cursor.
\return Returns the current position of the cursor. The returned position
is the position of the mouse cursor in pixel units.
|
pure virtual |
Returns the current position of the mouse cursor.
\return 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.
|
inlinevirtual |
Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work.
Definition at line 176 of file ICursorControl.h.
|
pure virtual |
Returns if the cursor is currently visible.
|
inlinevirtual |
Sets the active cursor icon.
Setting cursor icons is so far only supported on Win32 and Linux
Definition at line 159 of file ICursorControl.h.
|
inlinevirtual |
Set platform specific behavior flags.
Definition at line 179 of file ICursorControl.h.
|
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. |
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. |
|
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.
\param x New x-coord of the cursor. The coordinates are pixel units.
y | New y-coord of the cursor. The coordinates are pixel units. |
|
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. |
|
pure virtual |
Changes the visible state of the mouse cursor.
\param 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 Fri Dec 20 2013 11:17:08 by Doxygen
(1.8.5) |