Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
EventMouse Class Reference

The mouse event. More...

Inherits Event.

Public Types

enum  MouseEventType
 MouseEventType Different types of MouseEvent.
 
- Public Types inherited from Event
enum  Type
 Type Event type.
 

Public Member Functions

 EventMouse (MouseEventType mouseEventCode)
 Constructor. More...
 
 ctor ( var mouseEventCode)
 Constructor. More...
 
 EventMouse ( local mouseEventCode)
 Constructor. More...
 
void setScrollData (float scrollX, float scrollY)
 Set mouse scroll data. More...
 
var setScrollData ( var scrollX, var scrollY)
 Set mouse scroll data. More...
 
local setScrollData ( local scrollX, local scrollY)
 Set mouse scroll data. More...
 
float getScrollX () const
 Get mouse scroll data of x axis. More...
 
local getScrollX ()
 Get mouse scroll data of x axis. More...
 
float getScrollY () const
 Get mouse scroll data of y axis. More...
 
var getScrollY ()
 Get mouse scroll data of y axis. More...
 
local getScrollY ()
 Get mouse scroll data of y axis. More...
 
void setCursorPosition (float x, float y)
 Set the cursor position. More...
 
var setLocation ( var x, var y)
 Set the cursor position. More...
 
local setCursorPosition ( local x, local y)
 Set the cursor position. More...
 
void setMouseButton (int button)
 Set mouse button. More...
 
var setButton ( var button)
 Set mouse button. More...
 
local setMouseButton ( local button)
 Set mouse button. More...
 
int getMouseButton () const
 Get mouse button. More...
 
var getButton ()
 Get mouse button. More...
 
local getMouseButton ()
 Get mouse button. More...
 
float getCursorX () const
 Get the cursor position of x axis. More...
 
var getLocationX ()
 Get the cursor position of x axis. More...
 
local getCursorX ()
 Get the cursor position of x axis. More...
 
float getCursorY () const
 Get the cursor position of y axis. More...
 
var getLocationY ()
 Get the cursor position of y axis. More...
 
local getCursorY ()
 Get the cursor position of y axis. More...
 
Vec2 getLocation () const
 Returns the current touch location in OpenGL coordinates. More...
 
var getLocation ()
 Returns the current touch location in OpenGL coordinates. More...
 
local getLocation ()
 Returns the current touch location in OpenGL coordinates. More...
 
Vec2 getPreviousLocation () const
 Returns the previous touch location in OpenGL coordinates. More...
 
local getPreviousLocation ()
 Returns the previous touch location in OpenGL coordinates. More...
 
Vec2 getStartLocation () const
 Returns the start touch location in OpenGL coordinates. More...
 
Vec2 getDelta () const
 Returns the delta of 2 current touches locations in screen coordinates. More...
 
Vec2 getLocationInView () const
 Returns the current touch location in screen coordinates. More...
 
Vec2 getPreviousLocationInView () const
 Returns the previous touch location in screen coordinates. More...
 
Vec2 getStartLocationInView () const
 Returns the start touch location in screen coordinates. More...
 
local getStartLocationInView ()
 Returns the start touch location in screen coordinates. More...
 
- Public Member Functions inherited from Event
virtual ~Event ()
 Destructor.
 
Type getType () const
 Gets the event type. More...
 
var getType ()
 Gets the event type. More...
 
local getType ()
 Gets the event type. More...
 
void stopPropagation ()
 Stops propagation for current event.
 
var stopPropagation ()
 Stops propagation for current event.
 
local stopPropagation ()
 Stops propagation for current event.
 
bool isStopped () const
 Checks whether the event has been stopped. More...
 
var isStopped ()
 Checks whether the event has been stopped. More...
 
local isStopped ()
 Checks whether the event has been stopped. More...
 
NodegetCurrentTarget ()
 Gets current target of the event. More...
 
var getCurrentTarget ()
 Gets current target of the event. More...
 
local getCurrentTarget ()
 Gets current target of the event. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
- Protected Member Functions inherited from Event
 Event (Type type)
 Constructor.
 
 Event ( var type)
 Constructor.
 
 Event ( local type)
 Constructor.
 

Detailed Description

The mouse event.

Constructor & Destructor Documentation

EventMouse ( MouseEventType  mouseEventCode)

Constructor.

A given mouse event type.

var ctor ( var  mouseEventCode)

Constructor.

A given mouse event type.

local EventMouse ( local  mouseEventCode)

Constructor.

A given mouse event type.

Member Function Documentation

void setScrollData ( float  scrollX,
float  scrollY 
)
inline

Set mouse scroll data.

The scroll data of x axis. The scroll data of y axis.

var setScrollData ( var  scrollX,
var  scrollY 
)
inline

Set mouse scroll data.

The scroll data of x axis. The scroll data of y axis.

local setScrollData ( local  scrollX,
local  scrollY 
)
inline

Set mouse scroll data.

The scroll data of x axis. The scroll data of y axis.

float getScrollX ( ) const
inline

Get mouse scroll data of x axis.

The scroll data of x axis.

var getScrollX ( )
inline

Get mouse scroll data of x axis.

The scroll data of x axis.

local getScrollX ( )
inline

Get mouse scroll data of x axis.

The scroll data of x axis.

float getScrollY ( ) const
inline

Get mouse scroll data of y axis.

The scroll data of y axis.

var getScrollY ( )
inline

Get mouse scroll data of y axis.

The scroll data of y axis.

local getScrollY ( )
inline

Get mouse scroll data of y axis.

The scroll data of y axis.

void setCursorPosition ( float  x,
float  y 
)
inline

Set the cursor position.

The x coordinate of cursor position. The y coordinate of cursor position.

var setLocation ( var  x,
var  y 
)
inline

Set the cursor position.

The x coordinate of cursor position. The y coordinate of cursor position.

local setCursorPosition ( local  x,
local  y 
)
inline

Set the cursor position.

The x coordinate of cursor position. The y coordinate of cursor position.

void setMouseButton ( int  button)
inline

Set mouse button.

a given mouse button.

var setButton ( var  button)
inline

Set mouse button.

a given mouse button.

local setMouseButton ( local  button)
inline

Set mouse button.

a given mouse button.

int getMouseButton ( ) const
inline

Get mouse button.

The mouse button.

var getButton ( )
inline

Get mouse button.

The mouse button.

local getMouseButton ( )
inline

Get mouse button.

The mouse button.

float getCursorX ( ) const
inline

Get the cursor position of x axis.

The x coordinate of cursor position.

var getLocationX ( )
inline

Get the cursor position of x axis.

The x coordinate of cursor position.

local getCursorX ( )
inline

Get the cursor position of x axis.

The x coordinate of cursor position.

float getCursorY ( ) const
inline

Get the cursor position of y axis.

The y coordinate of cursor position.

var getLocationY ( )
inline

Get the cursor position of y axis.

The y coordinate of cursor position.

local getCursorY ( )
inline

Get the cursor position of y axis.

The y coordinate of cursor position.

Vec2 getLocation ( ) const

Returns the current touch location in OpenGL coordinates.

The current touch location in OpenGL coordinates.

var getLocation ( )

Returns the current touch location in OpenGL coordinates.

The current touch location in OpenGL coordinates.

local getLocation ( )

Returns the current touch location in OpenGL coordinates.

The current touch location in OpenGL coordinates.

Vec2 getPreviousLocation ( ) const

Returns the previous touch location in OpenGL coordinates.

The previous touch location in OpenGL coordinates.

local getPreviousLocation ( )

Returns the previous touch location in OpenGL coordinates.

The previous touch location in OpenGL coordinates.

Vec2 getStartLocation ( ) const

Returns the start touch location in OpenGL coordinates.

The start touch location in OpenGL coordinates.

local getStartLocation ( )

Returns the start touch location in OpenGL coordinates.

The start touch location in OpenGL coordinates.

Vec2 getDelta ( ) const

Returns the delta of 2 current touches locations in screen coordinates.

The delta of 2 current touches locations in screen coordinates.

var getDelta ( )

Returns the delta of 2 current touches locations in screen coordinates.

The delta of 2 current touches locations in screen coordinates.

local getDelta ( )

Returns the delta of 2 current touches locations in screen coordinates.

The delta of 2 current touches locations in screen coordinates.

Vec2 getLocationInView ( ) const

Returns the current touch location in screen coordinates.

The current touch location in screen coordinates.

var getLocationInView ( )

Returns the current touch location in screen coordinates.

The current touch location in screen coordinates.

local getLocationInView ( )

Returns the current touch location in screen coordinates.

The current touch location in screen coordinates.

Vec2 getPreviousLocationInView ( ) const

Returns the previous touch location in screen coordinates.

The previous touch location in screen coordinates.

local getPreviousLocationInView ( )

Returns the previous touch location in screen coordinates.

The previous touch location in screen coordinates.

Vec2 getStartLocationInView ( ) const

Returns the start touch location in screen coordinates.

The start touch location in screen coordinates.

local getStartLocationInView ( )

Returns the start touch location in screen coordinates.

The start touch location in screen coordinates.


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