Irrlicht 3D Engine: irr::gui::ICursorControl Class Reference

| Irrlicht 3D Engine |

Public Member Functions
irr::gui::ICursorControl Class Reference

Interface to manipulate the mouse cursor. More...

`#include <ICursorControl.h>`

Inheritance diagram for irr::gui::ICursorControl:

List of all members.

## Public Member Functions

- virtual ECURSOR_ICON addIcon (const gui::SCursorSprite &icon)
    Add a custom sprite as cursor icon.
- virtual void changeIcon (ECURSOR_ICON iconId, const gui::SCursorSprite &sprite)
    replace a cursor icon.
- virtual ECURSOR_ICON getActiveIcon () const
    Gets the currently active icon.
- virtual ECURSOR_PLATFORM_BEHAVIOR getPlatformBehavior () const
    Return platform specific behavior.
- 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 core::dimension2di getSupportedIconSize () const
    Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work.
- virtual bool isVisible () const =0
    Returns if the cursor is currently visible.
- virtual void setActiveIcon (ECURSOR_ICON iconId)
    Sets the active cursor icon.
- virtual void setPlatformBehavior (ECURSOR_PLATFORM_BEHAVIOR behavior)
    Set platform specific behavior flags.
- virtual void setPosition (const core::position2d< f32 > &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< s32 > &pos)=0
    Sets the new position of the cursor.
- virtual void setPosition (s32 x, s32 y)=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.

## Detailed Description

Interface to manipulate the mouse cursor.

Definition at line 97 of file ICursorControl.h.

## Member Function Documentation

virtual ECURSOR_ICON irr::gui::ICursorControl::addIcon | ( | const gui::SCursorSprite & | icon | ) | `[inline, virtual]`

Add a custom sprite as cursor icon.

Returns:
  Identification for the icon

Definition at line 166 of file ICursorControl.h.

References irr::gui::ECI_NORMAL.

virtual void irr::gui::ICursorControl::changeIcon | ( | ECURSOR_ICON | iconId,
|  | const gui::SCursorSprite & | sprite
| ) |  | `[inline, virtual]`

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.

virtual ECURSOR_ICON irr::gui::ICursorControl::getActiveIcon | ( |  | ) | const`[inline, virtual]`

Gets the currently active icon.

Definition at line 162 of file ICursorControl.h.

References irr::gui::ECI_NORMAL.

virtual ECURSOR_PLATFORM_BEHAVIOR irr::gui::ICursorControl::getPlatformBehavior | ( |  | ) | const`[inline, virtual]`

Return platform specific behavior.

Returns:
  Behavior set by setPlatformBehavior or ECPB_NONE for platforms not implementing specific behaviors.

Definition at line 184 of file ICursorControl.h.

References irr::gui::ECPB_NONE.

virtual const core::position2d<s32>& irr::gui::ICursorControl::getPosition | ( |  | ) | `[pure virtual]`

Returns the current position of the mouse cursor.

Returns:
  Returns the current position of the cursor. The returned position is the position of the mouse cursor in pixel units.

virtual core::position2d<f32> irr::gui::ICursorControl::getRelativePosition | ( |  | ) | `[pure virtual]`

Returns the current position of the mouse cursor.

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.

virtual core::dimension2di irr::gui::ICursorControl::getSupportedIconSize | ( |  | ) | const`[inline, virtual]`

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.

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.

virtual void irr::gui::ICursorControl::setActiveIcon | ( | ECURSOR_ICON | iconId | ) | `[inline, virtual]`

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.

virtual void irr::gui::ICursorControl::setPlatformBehavior | ( | ECURSOR_PLATFORM_BEHAVIOR | behavior | ) | `[inline, virtual]`

Set platform specific behavior flags.

Definition at line 179 of file ICursorControl.h.

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.

Parameters:

  pos | New position of the cursor.

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.

virtual void irr::gui::ICursorControl::setPosition | ( | const core::position2d< s32 > & | pos | ) | `[pure virtual]`

Sets the new position of the cursor.

Parameters:

  pos,: | New position of the cursor. The coordinates are pixel units.

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.

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.

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:

- ICursorControl.h