C#Code
C#Code
Public Member Functions | Protected Attributes
Libraries.Sprites.BaseSpriteProperty Class Reference
Inheritance diagram for Libraries.Sprites.BaseSpriteProperty:
Libraries.ObjectProperties.BaseObjectProperty Libraries.BaseObject Libraries.Sprites.PointInSprite2DProperty Libraries.Sprites.PointInSprite2DProperty Libraries.Sprites.SpriteTextProperty Libraries.Sprites.ClickableSprite2DProperty Libraries.Sprites.ClickableSprite2DProperty Libraries.Sprites.ClickableSprite2DProperty Libraries.Sprites.ClickableSprite2DProperty

List of all members.

Public Member Functions

abstract void Update (int timePassed, Sprite2D sprite)
virtual void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device, Microsoft.Xna.Framework.Graphics.SpriteBatch spriteBatch, Sprite2D obj)
abstract void Update (int timePassed, Sprite2D sprite)
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 sprite property for Sprite2D objects. Sprite properties are used to do things to sprites, like animate rotations, textures, etc.


Member Function Documentation

virtual void Libraries.Sprites.BaseSpriteProperty.Clear ( ) [virtual]
string Libraries.Sprites.BaseSpriteProperty.GetID ( )

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

Reimplemented from Libraries.BaseObject.

abstract StringType Libraries.Sprites.BaseSpriteProperty.GetPropertyType ( ) [pure virtual]
virtual void Libraries.Sprites.BaseSpriteProperty.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device,
Microsoft.Xna.Framework.Graphics.SpriteBatch  spriteBatch,
Sprite2D  obj 
) [virtual]

Render the text. device - Ignored, can be null.

spriteBatch - Sprite batch to render with. Is assumed to be handled externally.
obj - Object the property is in. Must be a button property.
void Libraries.Sprites.BaseSpriteProperty.SetID ( string  ID)

Set the property ID to be the given ID.

ID - ID that represents the property.

Reimplemented from Libraries.BaseObject.

abstract void Libraries.Sprites.BaseSpriteProperty.Update ( int  timePassed,
Sprite2D  sprite 
) [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.Sprites.ClickableSprite2DProperty, Libraries.Sprites.PointInSprite2DProperty, Libraries.Sprites.SpriteTextProperty, Libraries.Sprites.ClickableSprite2DProperty, and Libraries.Sprites.PointInSprite2DProperty.

abstract void Libraries.Sprites.BaseSpriteProperty.Update ( int  timePassed,
Sprite2D  sprite 
) [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.Sprites.ClickableSprite2DProperty, Libraries.Sprites.PointInSprite2DProperty, Libraries.Sprites.SpriteTextProperty, Libraries.Sprites.ClickableSprite2DProperty, and Libraries.Sprites.PointInSprite2DProperty.


Member Data Documentation

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

Reimplemented from Libraries.BaseObject.


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