CEGUI::MouseCursor Class Reference

Class that allows access to the GUI system mouse cursor. More...

Inheritance diagram for CEGUI::MouseCursor:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::MouseCursor:

Collaboration graph
[legend]

List of all members.

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 ImagegetImage (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 URectgetUnifiedConstraintArea (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 MouseCursorgetSingleton (void)
 Return singleton MouseCursor object.
static MouseCursorgetSingletonPtr (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


Detailed Description

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


Member Function Documentation

void CEGUI::MouseCursor::draw ( void   )  const

Makes the cursor draw itself.

Returns:
Nothing

References CEGUI::Image::draw(), and CEGUI::System::getSingleton().

Rect CEGUI::MouseCursor::getConstraintArea ( void   )  const

return the current constraint area of the mouse cursor.

Returns:
Rect object describing the active area that the mouse cursor is constrained to.

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.

Returns:
Point object describing the current mouse cursor position as resolution independant values that range from 0.0f to 1.0f, where 0.0f represents the left-most and top-most positions, and 1.0f represents the right-most and bottom-most positions.

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.

Returns:
The current image used to draw mouse cursor.

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.

Returns:
Point object describing the mouse cursor position in screen pixels.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMousePosition(), and CEGUI::Tooltip::positionSelf().

MouseCursor & CEGUI::MouseCursor::getSingleton ( void   )  [static]

MouseCursor * CEGUI::MouseCursor::getSingletonPtr ( void   )  [static]

Return pointer to singleton MouseCursor object.

Returns:
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.

Returns:
URect object describing the active area that the mouse cursor is constrained to.

void CEGUI::MouseCursor::hide ( void   )  [inline]

Hides the mouse cursor.

Returns:
Nothing.

bool CEGUI::MouseCursor::isVisible ( void   )  const [inline]

return whether the mouse cursor is visible.

Returns:
true if the mouse cursor is visible, false if the mouse cursor is hidden.

void CEGUI::MouseCursor::offsetPosition ( const Point offset  ) 

Offset the mouse cursor position by the deltas specified in offset.

Parameters:
offset Point object which describes the amount to move the cursor in each axis.
Returns:
Nothing.

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.

Parameters:
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.
Returns:
Nothing.

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().

void CEGUI::MouseCursor::setImage ( const String imageset,
const String image_name 
)

Set the current mouse cursor image.

Parameters:
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.
Returns:
Nothing.
Exceptions:
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.

Parameters:
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.

Parameters:
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.
Returns:
Nothing.

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.

Parameters:
visible 'true' to show the mouse cursor, 'false' to hide it.
Returns:
Nothing.

void CEGUI::MouseCursor::show ( void   )  [inline]

Shows the mouse cursor.

Returns:
Nothing.


Generated on Thu Nov 27 20:34:30 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1