Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Classes | Public Attributes | Static Public Attributes | Properties | List of all members
SiliconStudio.Paradox.Engine.SpriteComponent Class Reference

Add a Sprite to an Entity. It could be an animated sprite. More...

Inheritance diagram for SiliconStudio.Paradox.Engine.SpriteComponent:
SiliconStudio.Paradox.EntityModel.EntityComponent SiliconStudio.Core.IContentUrl

Classes

struct  AnimationInfo
 

Public Attributes

Color Color = Color.White
 The color to apply on the sprite. More...
 
SpriteEffects SpriteEffect
 The effect to apply on the sprite. More...
 
Effect Effect
 The effect to use to render the sprite. More...
 

Static Public Attributes

static PropertyKey
< SpriteComponent > 		Key = new PropertyKey<SpriteComponent>("Key", typeof(SpriteComponent))
 

Properties

SpriteGroup SpriteGroup [get, set]
 The group of sprites associated to the component. More...
 
int CurrentFrame [get, set]
 Gets or sets the current frame of the animation. More...
 
Sprite CurrentSprite [get]
 Gets the current sprite. More...
 
override PropertyKey DefaultKey [get]
 
- Properties inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
Entity Entity [get, set]
 Gets or sets the owner entity. More...
 
Entity EnsureEntity [get]
 Gets the entity and throws an exception if the entity is null. More...
 
virtual PropertyKey DefaultKey [get]
 The default key this component is associated to. More...
 
- Properties inherited from SiliconStudio.Core.IContentUrl
string Url [get, set]
 The URL of this asset. More...
 

Additional Inherited Members

- Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
 EntityComponent ()
 Initializes a new instance of the EntityComponent class. More...
 
- Static Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
static PropertyKey GetDefaultKey< T > ()
 Gets the default key for the specified entity component type. More...
 

Detailed Description

Add a Sprite to an Entity. It could be an animated sprite.

Definition at line 21 of file SpriteComponent.cs.

Member Data Documentation

Color SiliconStudio.Paradox.Engine.SpriteComponent.Color = Color.White

The color to apply on the sprite.

Definition at line 35 of file SpriteComponent.cs.

Effect SiliconStudio.Paradox.Engine.SpriteComponent.Effect

The effect to use to render the sprite.

Definition at line 47 of file SpriteComponent.cs.

PropertyKey<SpriteComponent> SiliconStudio.Paradox.Engine.SpriteComponent.Key = new PropertyKey<SpriteComponent>("Key", typeof(SpriteComponent))
static

Definition at line 23 of file SpriteComponent.cs.

SpriteEffects SiliconStudio.Paradox.Engine.SpriteComponent.SpriteEffect

The effect to apply on the sprite.

Definition at line 41 of file SpriteComponent.cs.

Property Documentation

int SiliconStudio.Paradox.Engine.SpriteComponent.CurrentFrame
getset

Gets or sets the current frame of the animation.

Definition at line 74 of file SpriteComponent.cs.

Sprite SiliconStudio.Paradox.Engine.SpriteComponent.CurrentSprite
get

Gets the current sprite.

Definition at line 93 of file SpriteComponent.cs.

override PropertyKey SiliconStudio.Paradox.Engine.SpriteComponent.DefaultKey
get

Definition at line 159 of file SpriteComponent.cs.

SpriteGroup SiliconStudio.Paradox.Engine.SpriteComponent.SpriteGroup
getset

The group of sprites associated to the component.

Definition at line 58 of file SpriteComponent.cs.

The documentation for this class was generated from the following file: