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. | |
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 |
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.
References CEGUI::Image::draw(), and CEGUI::System::getSingleton().
Rect CEGUI::MouseCursor::getConstraintArea | ( | void | ) | const |
return the current constraint area of the mouse cursor.
References CEGUI::URect::asAbsolute(), CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), and CEGUI::Renderer::getSize().
Referenced by CEGUI::Titlebar::onMouseButtonDown().
Point CEGUI::MouseCursor::getDisplayIndependantPosition | ( | void | ) | const |
Return the current mouse cursor position as display resolution independant values.
References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, and CEGUI::System::getSingleton().
const Image* CEGUI::MouseCursor::getImage | ( | void | ) | const [inline] |
Get the current mouse cursor image.
Referenced by CEGUI::Tooltip::positionSelf(), and setImage().
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.
Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMousePosition(), and CEGUI::Tooltip::positionSelf().
MouseCursor & CEGUI::MouseCursor::getSingleton | ( | void | ) | [static] |
Return singleton MouseCursor object.
Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::ListHeaderSegment::initDragMoving(), CEGUI::ListHeaderSegment::initSegmentHoverState(), CEGUI::ListHeaderSegment::initSizingHoverState(), MouseCursor(), CEGUI::Titlebar::onCaptureLost(), CEGUI::MenuItem::onCaptureLost(), CEGUI::DragContainer::onDragPositionChanged(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::Window::onMouseEnters(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::Tooltip::positionSelf(), setConstraintArea(), CEGUI::FrameWindow::setCursorForPoint(), CEGUI::System::setDefaultMouseCursor(), setUnifiedConstraintArea(), CEGUI::DragContainer::updateActiveMouseCursor(), and ~MouseCursor().
MouseCursor * CEGUI::MouseCursor::getSingletonPtr | ( | void | ) | [static] |
Return pointer to singleton MouseCursor object.
Referenced by CEGUI::ButtonBase::onCaptureLost().
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::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. |
References CEGUI::Vector2::d_x, CEGUI::Vector3::d_x, CEGUI::Vector2::d_y, and CEGUI::Vector3::d_y.
Referenced by CEGUI::System::injectMouseMove().
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. |
References CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::URect::d_max, CEGUI::URect::d_min, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::UVector2::d_x, CEGUI::UVector2::d_y, CEGUI::Rect::getHeight(), CEGUI::Rect::getIntersection(), getSingleton(), and CEGUI::Rect::getWidth().
Referenced by MouseCursor(), CEGUI::Titlebar::onCaptureLost(), and CEGUI::Titlebar::onMouseButtonDown().
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. |
References getImage().
Referenced by CEGUI::ListHeaderSegment::initDragMoving(), CEGUI::ListHeaderSegment::initSegmentHoverState(), CEGUI::ListHeaderSegment::initSizingHoverState(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::Window::onMouseEnters(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::setCursorForPoint(), and CEGUI::DragContainer::updateActiveMouseCursor().
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. |
References CEGUI::Vector2::d_x, CEGUI::Vector3::d_x, CEGUI::Vector2::d_y, and CEGUI::Vector3::d_y.
Referenced by CEGUI::System::injectMousePosition().
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. |
References CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::URect::d_max, CEGUI::URect::d_min, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::UVector2::d_x, CEGUI::UVector2::d_y, CEGUI::Rect::getHeight(), getSingleton(), and CEGUI::Rect::getWidth().
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.