C# Class SadConsole.Input.MouseInfo

Processes mouse input data.
Show file Open project: Thraka/SadConsole Class Usage Examples

Public Properties

Property Type Description
Cell Cell
Console IConsole
ConsoleLocation Microsoft.Xna.Framework.Point
ScreenLocation Microsoft.Xna.Framework.Point
WorldLocation Microsoft.Xna.Framework.Point

Public Methods

Method Description
Clone ( ) : MouseInfo

Returns a clone of this object.
Fill ( IConsole data ) : void

Sets the WorldLocation and ConsoleLocation properties based on the cell size of the provided console. If absolute positioning is used on the console, then the properties will represent pixels.

This method alters the data of the mouse information based on the provided console. It

ProcessMouse ( GameTime gameTime ) : void

Fills out the state of the mouse.

Method Details

Clone() public method

Returns a clone of this object.
public Clone ( ) : MouseInfo
return MouseInfo

Fill() public method

Sets the WorldLocation and ConsoleLocation properties based on the cell size of the provided console. If absolute positioning is used on the console, then the properties will represent pixels.
This method alters the data of the mouse information based on the provided console. It
public Fill ( IConsole data ) : void
data IConsole The console to get the data from.
return void

ProcessMouse() public method

Fills out the state of the mouse.
public ProcessMouse ( GameTime gameTime ) : void
gameTime GameTime
return void

Property Details

Cell public property

The cell of the current console under the mouse.
public Cell Cell
return Cell

Console public property

The current console under the mouse.
public IConsole Console
return IConsole

ConsoleLocation public property

Which cell x,y the mouse is over on the console.
public Point,Microsoft.Xna.Framework ConsoleLocation
return Microsoft.Xna.Framework.Point

ScreenLocation public property

Where the mouse is located on the screen.
public Point,Microsoft.Xna.Framework ScreenLocation
return Microsoft.Xna.Framework.Point

WorldLocation public property

What cell in the gameworld (top-left of window is 0,0) the mouse is located.
public Point,Microsoft.Xna.Framework WorldLocation
return Microsoft.Xna.Framework.Point