SiliconStudio.Paradox.Engine.AnimationComponent Class Reference

Add animation capabilities to an Entity. It will usually apply to ModelComponent.ModelViewHierarchy More...

Inheritance diagram for SiliconStudio.Paradox.Engine.AnimationComponent:

Public Member Functions
	AnimationComponent ()
void	Play (string name)
	Plays right away the animation with the specified name, instantly removing all other blended animations. More...
void	Crossfade (string name, TimeSpan fadeTimeSpan)
	Crossfades to a new animation. More...
void	Blend (string name, float desiredWeight, TimeSpan fadeTimeSpan)
	Blends progressively a new animation. More...
PlayingAnimation	NewPlayingAnimation (string name)
Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
	EntityComponent ()
	Initializes a new instance of the EntityComponent class. More...

Static Public Attributes
static PropertyKey < AnimationComponent >	Key = new PropertyKey<AnimationComponent>("Key", typeof(AnimationComponent))

Properties
Dictionary< string, AnimationClip >	Animations [get]
TrackingCollection < PlayingAnimation >	PlayingAnimations [get]
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
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 animation capabilities to an Entity. It will usually apply to ModelComponent.ModelViewHierarchy

Data is stored as in http://altdevblogaday.com/2011/10/23/low-level-animation-part-2/.

Definition at line 25 of file AnimationComponent.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Engine.AnimationComponent.AnimationComponent

(

)

Definition at line 33 of file AnimationComponent.cs.

Member Function Documentation

void SiliconStudio.Paradox.Engine.AnimationComponent.Blend	(	string	name,
		float	desiredWeight,
		TimeSpan	fadeTimeSpan
	)

Blends progressively a new animation.

Parameters

name	The name.
desiredWeight	The desired weight.
fadeTimeSpan	The fade time span.

Exceptions

ArgumentException

name

Definition at line 99 of file AnimationComponent.cs.

void SiliconStudio.Paradox.Engine.AnimationComponent.Crossfade	(	string	name,
		TimeSpan	fadeTimeSpan
	)

Crossfades to a new animation.

Parameters

name	The name.
fadeTimeSpan	The fade time span.

Exceptions

ArgumentException

name

Definition at line 76 of file AnimationComponent.cs.

PlayingAnimation SiliconStudio.Paradox.Engine.AnimationComponent.NewPlayingAnimation

(

string

name

)

Definition at line 118 of file AnimationComponent.cs.

void SiliconStudio.Paradox.Engine.AnimationComponent.Play

(

string

name

)

Plays right away the animation with the specified name, instantly removing all other blended animations.

Parameters

name	The animation name.

Definition at line 64 of file AnimationComponent.cs.

Member Data Documentation

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

static

Definition at line 31 of file AnimationComponent.cs.

Referenced by SiliconStudio.Paradox.Engine.AnimationProcessor.GenerateAssociatedData(), ScriptTest.ScriptSceneSerialization.LoadScene(), and ScriptTest.ScriptDebug.ProcessClient().

Property Documentation

Dictionary<string, AnimationClip> SiliconStudio.Paradox.Engine.AnimationComponent.Animations

get

Definition at line 56 of file AnimationComponent.cs.

override PropertyKey SiliconStudio.Paradox.Engine.AnimationComponent.DefaultKey

get

Definition at line 130 of file AnimationComponent.cs.

TrackingCollection<PlayingAnimation> SiliconStudio.Paradox.Engine.AnimationComponent.PlayingAnimations

get

Definition at line 125 of file AnimationComponent.cs.

---

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

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Engine/Engine/AnimationComponent.cs