C#Code
C#Code
Public Member Functions | Protected Attributes
Libraries.Mouse.BaseMouseProperty Class Reference
Inheritance diagram for Libraries.Mouse.BaseMouseProperty:
Libraries.Mouse.MouseDisplayConsolePosProperty Libraries.Mouse.MouseDisplayConsolePosProperty

List of all members.

Public Member Functions

 BaseMouseProperty ()
abstract void Update (int timePassed, BaseMouse mouse)
virtual void Render (Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch, Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
virtual void RenderSprites (Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch)
virtual void Render3D (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
void SetID (string ID)
string GetID ()
virtual void Clear ()
abstract StringType GetPropertyType ()
 BaseMouseProperty ()
abstract void Update (int timePassed, BaseMouse mouse)
virtual void Render (Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch, Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
virtual void RenderSprites (Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch)
virtual void Render3D (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
void SetID (string ID)
string GetID ()
virtual void Clear ()
abstract StringType GetPropertyType ()

Protected Attributes

string m_ID
 String that represents the property. Value should be null if the property is unnamed.

Detailed Description

Base mouse property. Derive to create properties that can be added to the mouse for extending functionality.


Constructor & Destructor Documentation

Libraries.Mouse.BaseMouseProperty.BaseMouseProperty ( )

Default constructor.

Libraries.Mouse.BaseMouseProperty.BaseMouseProperty ( )

Default constructor.


Member Function Documentation

virtual void Libraries.Mouse.BaseMouseProperty.Clear ( ) [virtual]

Clear the data objects stored in the object.

virtual void Libraries.Mouse.BaseMouseProperty.Clear ( ) [virtual]

Clear the data objects stored in the object.

string Libraries.Mouse.BaseMouseProperty.GetID ( )

Retrive the ID stored in the property. It is the actual string stored in the property, so don't change it willy nilly. Return:
Value is the ID of the property.

string Libraries.Mouse.BaseMouseProperty.GetID ( )

Retrive the ID stored in the property. It is the actual string stored in the property, so don't change it willy nilly.

abstract StringType Libraries.Mouse.BaseMouseProperty.GetPropertyType ( ) [pure virtual]

Retrive the property type ID. This is what represents what type of property it is.

Return:
Value is the ID assocated with the property type.

Implemented in Libraries.Mouse.MouseDisplayConsolePosProperty, and Libraries.Mouse.MouseDisplayConsolePosProperty.

abstract StringType Libraries.Mouse.BaseMouseProperty.GetPropertyType ( ) [pure virtual]

Retrive the property type ID. This is what represents what type of property it is.

Implemented in Libraries.Mouse.MouseDisplayConsolePosProperty, and Libraries.Mouse.MouseDisplayConsolePosProperty.

virtual void Libraries.Mouse.BaseMouseProperty.Render ( Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch,
Microsoft.Xna.Framework.Graphics.GraphicsDevice  device 
) [virtual]

Renders the property. If there is 3D and 2D to render, 3D is rendered first.

spriteBatch - Used to draw sprites.
device - Used to draw 3D.
virtual void Libraries.Mouse.BaseMouseProperty.Render ( Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch,
Microsoft.Xna.Framework.Graphics.GraphicsDevice  device 
) [virtual]

Renders the property. If there is 3D and 2D to render, 3D is rendered first.

spriteBatch - Used to draw sprites.
device - Used to draw 3D.
virtual void Libraries.Mouse.BaseMouseProperty.Render3D ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [virtual]

Render the sprite portion of the property, if any.

device - Device to use.
virtual void Libraries.Mouse.BaseMouseProperty.Render3D ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [virtual]

Render the sprite portion of the property, if any.

virtual void Libraries.Mouse.BaseMouseProperty.RenderSprites ( Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch) [virtual]

Render the sprite portion of the property, if any.

virtual void Libraries.Mouse.BaseMouseProperty.RenderSprites ( Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch) [virtual]

Render the sprite portion of the property, if any.

spriteBatch - Sprite batch to use.
void Libraries.Mouse.BaseMouseProperty.SetID ( string  ID)

Set the property ID to be the given ID.

ID - ID that represents the property.
void Libraries.Mouse.BaseMouseProperty.SetID ( string  ID)

Set the property ID to be the given ID.

ID - ID that represents the property.
abstract void Libraries.Mouse.BaseMouseProperty.Update ( int  timePassed,
BaseMouse  mouse 
) [pure virtual]

Update the property.

timePassed - How long the update is for.
sprite - The sprite the property is in. This way the property can make changes to the sprite.

Implemented in Libraries.Mouse.MouseDisplayConsolePosProperty, and Libraries.Mouse.MouseDisplayConsolePosProperty.

abstract void Libraries.Mouse.BaseMouseProperty.Update ( int  timePassed,
BaseMouse  mouse 
) [pure virtual]

Update the property.

timePassed - How long the update is for.
sprite - The sprite the property is in. This way the property can make changes to the sprite.

Implemented in Libraries.Mouse.MouseDisplayConsolePosProperty, and Libraries.Mouse.MouseDisplayConsolePosProperty.


Member Data Documentation

String that represents the property. Value should be null if the property is unnamed.


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