Class Index | File Index

Classes


Class Mouse


Defined in: input.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Mouse()
Creates an instance of the Mouse object
Field Summary
Field Attributes Field Name and Description
 
Canvas reference.
<static>  
Mouse.state
Current mouse state.
<static>  
Mouse.x
Current mouse x.
<static>  
Mouse.y
Current mouse y.
Method Summary
Method Attributes Method Name and Description
 
addCustomEvents(canvas, onmousedown, onmousemove, onmouseup)
Setup links to custom events outside the Mouse object.
 
addEvents(canvas)
Setup links to events inside the Mouse object.
 
Return Input device type.
 
Get the state of mouse input, mousedown, mousemove or mouseup.
 
getX()
Return x position of mouse point.
 
getY()
Return y position of mouse point.
 
Mouse down event.
 
Mouse move event.
 
Mouse up event.
Class Detail
Mouse()
Creates an instance of the Mouse object
See:
input.js
Field Detail
{[object HTMLCanvasElement]} canvas
Canvas reference.

<static> {Number} Mouse.state
Current mouse state.

<static> {Number} Mouse.x
Current mouse x.

<static> {Number} Mouse.y
Current mouse y.
Method Detail
addCustomEvents(canvas, onmousedown, onmousemove, onmouseup)
Setup links to custom events outside the Mouse object.
Parameters:
{[object HTMLCanvasElement]} canvas
Canvas object.
{Object} onmousedown
Mouse down event reference.
{Object} onmousemove
Mouse move event reference.
{Object} onmouseup
Mouse up event reference.

addEvents(canvas)
Setup links to events inside the Mouse object.
Parameters:
{[object HTMLCanvasElement]} canvas
Canvas object.

{String} getDeviceType()
Return Input device type.
Returns:
{String} Input device type.

{String} getState()
Get the state of mouse input, mousedown, mousemove or mouseup.
Returns:
{String} Returns state string: mousedown, mousemove or mouseup.

{Number} getX()
Return x position of mouse point.
Returns:
{Number} x Mouse point.

{Number} getY()
Return y position of mouse point.
Returns:
{Number} y Mouse point.

onmousedown(e)
Mouse down event.
Parameters:
{Event} e
Mouse down event.

onmousemove(e)
Mouse move event.
Parameters:
{Event} e
Mouse move event.

onmouseup(e)
Mouse up event.
Parameters:
{Event} e
Mouse up event.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri May 06 2011 14:41:27 GMT+0100 (BST)