Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members
Public Member Functions | Public Attributes
input::Cursor Class Reference

Interface to the mouse cursor. More...

#include <Cursor.h>

Inheritance diagram for input::Cursor:
engine::Object

List of all members.

Public Member Functions

 Cursor ()
const core::position2dgetAbsolutePosition () const
const core::position2dgetPosition () const
virtual bool isAutoCenter ()
 Returns if the cursor is currently auto-center.
virtual void setAutoCenter (bool reset)
 Changes the auto-center state of the mouse cursor.
virtual void setPosition (s32 x, s32 y)=0
virtual void setPosition (const core::position2d &pos)=0
virtual void setVisible (bool set)=0
 Changes the visible state of the mouse cursor.
virtual ~Cursor ()

Public Attributes

core::position2d mAbsolutePosition
bool mAutoCenter
core::position2d mPosition

Detailed Description

Interface to the mouse cursor.


Constructor & Destructor Documentation

input::Cursor::Cursor ( )
input::Cursor::~Cursor ( ) [virtual]

Member Function Documentation

const core::position2d & input::Cursor::getAbsolutePosition ( ) const

Returns the current position of the mouse cursor.

Returns:
Returns the current position of the cursor.

References mAbsolutePosition.

const core::position2d & input::Cursor::getPosition ( ) const

Returns the current position of the mouse cursor.

Returns:
Returns the current position of the cursor.

References mPosition.

bool input::Cursor::isAutoCenter ( ) [virtual]

Returns if the cursor is currently auto-center.

References mAutoCenter.

void input::Cursor::setAutoCenter ( bool  reset) [virtual]

Changes the auto-center state of the mouse cursor.

References mAutoCenter.

virtual void input::Cursor::setPosition ( const core::position2d pos) [pure virtual]

Sets the new position of the cursor.

Parameters:
pos,:New position of the cursor.
virtual void input::Cursor::setPosition ( s32  x,
s32  y 
) [pure virtual]

Sets the new position of the cursor.

Parameters:
x,:New X position of the cursor.
y,:New Y position of the cursor.
virtual void input::Cursor::setVisible ( bool  set) [pure virtual]

Changes the visible state of the mouse cursor.


Member Data Documentation

Referenced by Cursor(), and getAbsolutePosition().

Referenced by Cursor(), isAutoCenter(), and setAutoCenter().

Referenced by Cursor(), and getPosition().


The documentation for this class was generated from the following files:

The KG Game Engine
The KG Game Engine Documentation © 2006-2011 by Kat'Oun. Generated on Sat Jul 2 2011 00:50:07 by Doxygen (1.7.4)