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

Inheritance diagram for CEGUI::MouseCursor:

Collaboration diagram for CEGUI::MouseCursor:

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. More...

void	setImage (const Image *image)
	Set the current mouse cursor image.

const Image *	getImage (void) const
	Get the current mouse cursor image. More...

void	draw (void) const
	Makes the cursor draw itself. More...

void	setPosition (const Point &position)
	Set the current mouse cursor position. More...

void	offsetPosition (const Point &offset)
	Offset the mouse cursor position by the deltas specified in offset. More...

void	setConstraintArea (const Rect *area)
	Set the area that the mouse cursor is constrained to. More...

void	setUnifiedConstraintArea (const URect *area)
	Set the area that the mouse cursor is constrained to. More...

void	hide (void)
	Hides the mouse cursor. More...

void	show (void)
	Shows the mouse cursor. More...

void	setVisible (bool visible)
	Set the visibility of the mouse cursor. More...

bool	isVisible (void) const
	return whether the mouse cursor is visible. More...

Point	getPosition (void) const
	Return the current mouse cursor position as a pixel offset from the top-left corner of the display. More...

Rect	getConstraintArea (void) const
	return the current constraint area of the mouse cursor. More...

const URect &	getUnifiedConstraintArea (void) const
	return the current constraint area of the mouse cursor. More...

Point	getDisplayIndependantPosition (void) const
	Return the current mouse cursor position as display resolution independant values. More...

void	notifyDisplaySizeChanged (const Size &new_size)
	Function used to notify the MouseCursor of changes in the display size. More...

void	setExplicitRenderSize (const Size &size)
	Set an explicit size for the mouse cursor image to be drawn at. More...

const Size &	getExplicitRenderSize () const
	Return the explicit render size currently set. A return size of (0, 0) indicates that the real image size will be used.

void	invalidate ()
	Mark the cached geometry as invalid so it will be recached next time the mouse cursor is drawn.

Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.

virtual	~EventSet (void)
	Destructor for EventSet objects.

void	addEvent (const String &name)
	Add a new Event to the EventSet with the given name. More...

void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected. More...

void	removeAllEvents (void)
	Remove all Event objects from the EventSet. More...

bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in the EventSet. More...

virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...

virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...

virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...

bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...

void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...

Iterator	getIterator (void) const
	Return a EventSet::Iterator object to iterate over the events currently added to the EventSet.

Static Public Member Functions
static MouseCursor &	getSingleton (void)
	Return singleton MouseCursor object. More...

static MouseCursor *	getSingletonPtr (void)
	Return pointer to singleton MouseCursor object. More...

static void	setInitialMousePosition (const Point &position)
	Static function to pre-initialise the mouse cursor position (prior to MouseCursor instantiation). More...

Static Public Member Functions inherited from CEGUI::Singleton< MouseCursor >
static MouseCursor &	getSingleton (void)

static MouseCursor *	getSingletonPtr (void)

Static Public Attributes
static const String	EventNamespace
	Namespace for global events.

static const String	EventImageChanged

Protected Member Functions
virtual void	onImageChanged (MouseCursorEventArgs &e)
	event triggered internally when image of mouse cursor changes

Protected Member Functions inherited from CEGUI::EventSet
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...

void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.

	EventSet (EventSet &)

EventSet &	operator= (EventSet &)

Additional Inherited Members
Public Types inherited from CEGUI::EventSet
typedef ConstBaseIterator < EventMap >	Iterator

Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, String::FastLessCompare >	EventMap

Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events

bool	d_muted
	true if events for this EventSet have been muted.

Static Protected Attributes inherited from CEGUI::Singleton< MouseCursor >
static MouseCursor *	ms_Singleton

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

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.

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.

const Image* CEGUI::MouseCursor::getImage ( void ) const

inline

Get the current mouse cursor image.

Returns: The current image used to draw mouse cursor.

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.

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

static

Return singleton MouseCursor object.

Returns: Singleton MouseCursor object

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

static

Return pointer to singleton MouseCursor object.

Returns: Pointer to singleton MouseCursor object

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

Parameters

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.

Parameters

offset Point object which describes the amount to move the cursor in each axis.

Returns: Nothing.

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.

void CEGUI::MouseCursor::setExplicitRenderSize ( const Size & size )

Set an explicit size for the mouse cursor image to be drawn at.

This will override the size that is usually obtained directly from the
mouse cursor image and will stay in effect across changes to the mouse
cursor image.

Setting this size to (0, 0) will revert back to using the size as
obtained from the Image itself.

Parameters

size	Reference to a Size object that describes the size at which the cursor image should be drawn in pixels.

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.

static void CEGUI::MouseCursor::setInitialMousePosition ( const Point & position )

static

Static function to pre-initialise the mouse cursor position (prior to MouseCursor instantiation).

Calling this function prior to instantiating MouseCursor will prevent
the mouse having it's position set to the middle of the initial view.
Calling this function after the MouseCursor is instantiated will have
no effect.

Parameters

position Reference to a point object describing the initial pixel position to be used for the mouse cursor.

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.

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.

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.

Member Data Documentation

const String CEGUI::MouseCursor::EventImageChanged

static

Event fired when the mouse cursor image is changed. Handlers are passed a const MouseCursorEventArgs reference with MouseCursorEventArgs::mouseCursor set to the MouseCursor that has had it's image changed, and MouseCursorEventArgs::image set to the Image that is now set for the MouseCursor (may be 0).

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation