C#Code
C#Code
Public Member Functions | Protected Attributes
TheForum.GameCode.GameMouse Class Reference
Inheritance diagram for TheForum.GameCode.GameMouse:
Libraries.Mouse.BaseMouse Libraries.Mouse.MenuMouse Libraries.Mouse.SpriteMouse Libraries.Mouse.BaseMouse

List of all members.

Public Member Functions

 GameMouse ()
 GameMouse (bool reverseStickX, bool reverseStickY, Microsoft.Xna.Framework.Vector2 analogStickScale)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device, Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch)
override void HandleMouseInputDelegate (object message)
void SetDisableMouseClickPost (bool disable)
override void Clear ()
 GameMouse ()
void SetImagePath (string path)
override bool Load (Microsoft.Xna.Framework.Graphics.GraphicsDevice device, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device, Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch)
override void Update (int timePassed)
override void HandleMouseInputDelegate (object message)

Protected Attributes

bool m_disableClickPost
 Whether mouse clicking can post messsages. Value is true if it can, false if not.
string m_imagePath
 Path to the image to load for the mouse.
Libraries.Sprites.Sprite2D m_sprite
 Mouse sprite.
Microsoft.Xna.Framework.Graphics.SpriteBatch m_spriteM
 Sprite drawing handler.

Detailed Description

Display a mouse. Mouse is displayed with the 2D sprite batch system.


Constructor & Destructor Documentation

TheForum.GameCode.GameMouse.GameMouse ( )

Default constructor.

TheForum.GameCode.GameMouse.GameMouse ( bool  reverseStickX,
bool  reverseStickY,
Microsoft.Xna.Framework.Vector2  analogStickScale 
)

Default constructor.


Member Function Documentation

override void TheForum.GameCode.GameMouse.Clear ( ) [virtual]

Unload the mouse. Free up objects.

Reimplemented from Libraries.Mouse.BaseMouse.

override void TheForum.GameCode.GameMouse.HandleMouseInputDelegate ( object  message) [virtual]

Used for a delegate to handle a input messages.

message - Message to handle. Should be of type MouseInputMessage.

Reimplemented from Libraries.Mouse.BaseMouse.

override void TheForum.GameCode.GameMouse.HandleMouseInputDelegate ( object  message) [virtual]

Used for a delegate to handle a input messages.

message - Message to handle. Should be of type MouseInputMessage.

Reimplemented from Libraries.Mouse.BaseMouse.

override bool TheForum.GameCode.GameMouse.Load ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device,
Libraries.AssetManager  assetM 
)

Load the mouse cursor, setting up textures, sprites, etc.

device - Device to load with.
assetM - Asset manager to use for loading the mouse graphic.
override void TheForum.GameCode.GameMouse.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device,
Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch 
) [virtual]

Display the mouse.

device - Device to render 3D with.
spriteBatch - Spritebatch to draw sprites with.

Reimplemented from Libraries.Mouse.BaseMouse.

override void TheForum.GameCode.GameMouse.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device,
Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch 
) [virtual]

Display the mouse.

device - Device to render 3D with.
spriteBatch - Spritebatch to draw sprites with.

Reimplemented from Libraries.Mouse.BaseMouse.

void TheForum.GameCode.GameMouse.SetDisableMouseClickPost ( bool  disable)

Set whether the mouse button is mapped to posting the pieces.

disable - True to disable mouse click posting, false to enable.
void TheForum.GameCode.GameMouse.SetImagePath ( string  path)

Set the path to the image that gets used for the sprite. This doens't load the sprite, just set the path. I probably want to do something different later.

path - Path to the image to use.

Reimplemented from Libraries.Mouse.SpriteMouse.

override void TheForum.GameCode.GameMouse.Update ( int  timePassed) [virtual]

Update the mouse. /par timePassed - Time passed to update for.

Reimplemented from Libraries.Mouse.BaseMouse.


Member Data Documentation

Whether mouse clicking can post messsages. Value is true if it can, false if not.

Path to the image to load for the mouse.

Reimplemented from Libraries.Mouse.SpriteMouse.

Mouse sprite.

Reimplemented from Libraries.Mouse.SpriteMouse.

Microsoft.Xna.Framework.Graphics.SpriteBatch TheForum.GameCode.GameMouse.m_spriteM [protected]

Sprite drawing handler.

Reimplemented from Libraries.Mouse.SpriteMouse.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties