Class that allows access to the GUI system mouse cursor. More...
Public Member Functions | |
MouseCursor (void) | |
Constructor for MouseCursor objects. | |
~MouseCursor (void) | |
Destructor for MouseCursor objects. | |
void | setImage (const String &imageset, const String &image_name) |
Set the current mouse cursor image. | |
void | setImage (const Image *image) |
Set the current mouse cursor image. | |
const Image * | getImage (void) const |
Get the current mouse cursor image. | |
void | draw (void) const |
Makes the cursor draw itself. | |
void | setPosition (const Point &position) |
Set the current mouse cursor position. | |
void | offsetPosition (const Point &offset) |
Offset the mouse cursor position by the deltas specified in offset. | |
void | setConstraintArea (const Rect *area) |
Set the area that the mouse cursor is constrained to. | |
void | setUnifiedConstraintArea (const URect *area) |
Set the area that the mouse cursor is constrained to. | |
void | hide (void) |
Hides the mouse cursor. | |
void | show (void) |
Shows the mouse cursor. | |
void | setVisible (bool visible) |
Set the visibility of the mouse cursor. | |
bool | isVisible (void) const |
return whether the mouse cursor is visible. | |
Point | getPosition (void) const |
Return the current mouse cursor position as a pixel offset from the top-left corner of the display. | |
Rect | getConstraintArea (void) const |
return the current constraint area of the mouse cursor. | |
const URect & | getUnifiedConstraintArea (void) const |
return the current constraint area of the mouse cursor. | |
Point | getDisplayIndependantPosition (void) const |
Return the current mouse cursor position as display resolution independant values. | |
void | notifyDisplaySizeChanged (const Size &new_size) |
Function used to notify the MouseCursor of changes in the display size. | |
Static Public Member Functions | |
static MouseCursor & | getSingleton (void) |
Return singleton MouseCursor object. | |
static MouseCursor * | getSingletonPtr (void) |
Return pointer to singleton MouseCursor object. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventImageChanged |
The cursor image of the widget has changed. | |
Protected Member Functions | |
virtual void | onImageChanged (MouseCursorEventArgs &e) |
event triggered internally when image of mouse cursor changes |
Class that allows access to the GUI system mouse cursor.
The MouseCursor provides functionality to access the position and imagery of the mouse cursor / pointer
void CEGUI::MouseCursor::draw | ( | void | ) | const |
Makes the cursor draw itself.
Rect CEGUI::MouseCursor::getConstraintArea | ( | void | ) | const |
return the current constraint area of the mouse cursor.
Point CEGUI::MouseCursor::getDisplayIndependantPosition | ( | void | ) | const |
Return the current mouse cursor position as display resolution independant values.
const Image* CEGUI::MouseCursor::getImage | ( | void | ) | const [inline] |
Get the current mouse cursor image.
Point CEGUI::MouseCursor::getPosition | ( | void | ) | const [inline] |
Return the current mouse cursor position as a pixel offset from the top-left corner of the display.
static MouseCursor& CEGUI::MouseCursor::getSingleton | ( | void | ) | [static] |
Return singleton MouseCursor object.
Reimplemented from CEGUI::Singleton< MouseCursor >.
static MouseCursor* CEGUI::MouseCursor::getSingletonPtr | ( | void | ) | [static] |
Return pointer to singleton MouseCursor object.
Reimplemented from CEGUI::Singleton< MouseCursor >.
const URect& CEGUI::MouseCursor::getUnifiedConstraintArea | ( | void | ) | const |
return the current constraint area of the mouse cursor.
void CEGUI::MouseCursor::hide | ( | void | ) | [inline] |
Hides the mouse cursor.
bool CEGUI::MouseCursor::isVisible | ( | void | ) | const [inline] |
return whether the mouse cursor is visible.
void CEGUI::MouseCursor::notifyDisplaySizeChanged | ( | const Size & | new_size | ) |
Function used to notify the MouseCursor of changes in the display size.
You normally would not call this directly; rather you would call the function System::notifyDisplaySizeChanged and that will then call this function for you.
new_size | Size object describing the new display size in pixels. |
void CEGUI::MouseCursor::offsetPosition | ( | const Point & | offset | ) |
Offset the mouse cursor position by the deltas specified in offset.
offset | Point object which describes the amount to move the cursor in each axis. |
void CEGUI::MouseCursor::setConstraintArea | ( | const Rect * | area | ) |
Set the area that the mouse cursor is constrained to.
area | Pointer to a Rect object that describes the area of the display that the mouse is allowed to occupy. The given area will be clipped to the current Renderer screen area - it is never possible for the mouse to leave this area. If this parameter is NULL, the constraint is set to the size of the current Renderer screen area. |
Set the current mouse cursor image.
imageset | String object holding the name of the Imageset that contains the desired Image. | |
image_name | String object holding the name of the desired Image on Imageset imageset. |
UnknownObjectException | thrown if imageset is not known, or if imageset contains no Image named image_name. |
void CEGUI::MouseCursor::setPosition | ( | const Point & | position | ) |
Set the current mouse cursor position.
position | Point object describing the new location for the mouse. This will be clipped to within the renderer screen area. |
void CEGUI::MouseCursor::setUnifiedConstraintArea | ( | const URect * | area | ) |
Set the area that the mouse cursor is constrained to.
area | Pointer to a URect object that describes the area of the display that the mouse is allowed to occupy. The given area will be clipped to the current Renderer screen area - it is never possible for the mouse to leave this area. If this parameter is NULL, the constraint is set to the size of the current Renderer screen area. |
void CEGUI::MouseCursor::setVisible | ( | bool | visible | ) | [inline] |
Set the visibility of the mouse cursor.
visible | 'true' to show the mouse cursor, 'false' to hide it. |
void CEGUI::MouseCursor::show | ( | void | ) | [inline] |
Shows the mouse cursor.