Interface IAnimationHandle
Interface for an animation handle.
Namespace: Ritchie.Toolbox.Animation
Assembly: Ritchie.Toolbox.dll
Syntax
public interface IAnimationHandleProperties
IsActive
Gets a value indicating whhether the animation is active.
Declaration
bool IsActive { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsCancelled
Gets a value indicating whether an animation has been cancelled.
Declaration
bool IsCancelled { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsCompleted
Gets a value indicating whether an animation has completed.
Declaration
bool IsCompleted { get; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Cancel()
Cancel the animation.
Declaration
void Cancel()Start()
Start the animation, if it has not already started.
Declaration
IAnimationHandle Start()Returns
| Type | Description |
|---|---|
| IAnimationHandle | This. |
Then(IAnimation)
Adds the specified animation to the list of animations to start after this one has completed.
Declaration
IAnimationHandle Then(IAnimation nextAnimation)Parameters
| Type | Name | Description |
|---|---|---|
| IAnimation | nextAnimation | Any animation. |
Returns
| Type | Description |
|---|---|
| IAnimationHandle | This animation. |
WhileActive(IAnimationUpdateAction)
Adds an action to be executed each time the animation updates.
Declaration
IAnimationHandle WhileActive(IAnimationUpdateAction updateAction)Parameters
| Type | Name | Description |
|---|---|---|
| IAnimationUpdateAction | updateAction | Any type implementing IAnimationUpdateAction. |
Returns
| Type | Description |
|---|---|
| IAnimationHandle | The animation. |