WinForm Animation Library
Public Member Functions | Properties | List of all members
WinFormAnimation.IAnimator Interface Reference

The base interface for any Animator class, custom or build-in More...

Inheritance diagram for WinFormAnimation.IAnimator:
WinFormAnimation.Animator WinFormAnimation.Animator2D WinFormAnimation.Animator3D

Public Member Functions

void Play (object targetObject, string propertyName)
 Starts the playing of the animation More...
 
void Play (object targetObject, string propertyName, SafeInvoker endCallback)
 Starts the playing of the animation More...
 
void Play< T > (T targetObject, Expression< Func< T, object >> propertySetter)
 Starts the playing of the animation More...
 
void Play< T > (T targetObject, Expression< Func< T, object >> propertySetter, SafeInvoker endCallback)
 Starts the playing of the animation More...
 
void Resume ()
 Resume the animation from where it paused More...
 
void Stop ()
 Stops the animation and resets its status, resume is no longer possible More...
 
void Pause ()
 Pause the animation More...
 

Properties

AnimatorStatus CurrentStatus [get]
 Gets the current status of the animation More...
 
bool Repeat [get, set]
 Gets or sets a value indicating whether animator should repeat the animation after its ending More...
 
bool ReverseRepeat [get, set]
 Gets or sets a value indicating whether animator should repeat the animation in reverse after its ending. More...
 

Detailed Description

The base interface for any Animator class, custom or build-in

Definition at line 9 of file IAnimator.cs.

Member Function Documentation

void WinFormAnimation.IAnimator.Pause ( )
void WinFormAnimation.IAnimator.Play ( object  targetObject,
string  propertyName 
)

Starts the playing of the animation

Parameters
targetObjectThe target object to change the property
propertyNameThe name of the property to change

Implemented in WinFormAnimation.Animator3D, WinFormAnimation.Animator2D, and WinFormAnimation.Animator.

void WinFormAnimation.IAnimator.Play ( object  targetObject,
string  propertyName,
SafeInvoker  endCallback 
)

Starts the playing of the animation

Parameters
targetObjectThe target object to change the property
propertyNameThe name of the property to change
endCallbackThe callback to get invoked at the end of the animation

Implemented in WinFormAnimation.Animator3D, WinFormAnimation.Animator2D, and WinFormAnimation.Animator.

void WinFormAnimation.IAnimator.Play< T > ( targetObject,
Expression< Func< T, object >>  propertySetter 
)

Starts the playing of the animation

Parameters
targetObjectThe target object to change the property
propertySetterThe expression that represents the property of the target object
Template Parameters
TAny object containing a property

Implemented in WinFormAnimation.Animator3D, WinFormAnimation.Animator2D, and WinFormAnimation.Animator.

void WinFormAnimation.IAnimator.Play< T > ( targetObject,
Expression< Func< T, object >>  propertySetter,
SafeInvoker  endCallback 
)

Starts the playing of the animation

Parameters
targetObjectThe target object to change the property
propertySetterThe expression that represents the property of the target object
endCallbackThe callback to get invoked at the end of the animation
Template Parameters
TAny object containing a property

Implemented in WinFormAnimation.Animator3D, WinFormAnimation.Animator2D, and WinFormAnimation.Animator.

void WinFormAnimation.IAnimator.Resume ( )

Resume the animation from where it paused

Implemented in WinFormAnimation.Animator3D, WinFormAnimation.Animator2D, and WinFormAnimation.Animator.

void WinFormAnimation.IAnimator.Stop ( )

Stops the animation and resets its status, resume is no longer possible

Implemented in WinFormAnimation.Animator3D, WinFormAnimation.Animator2D, and WinFormAnimation.Animator.

Property Documentation

AnimatorStatus WinFormAnimation.IAnimator.CurrentStatus
get

Gets the current status of the animation

Definition at line 14 of file IAnimator.cs.

bool WinFormAnimation.IAnimator.Repeat
getset

Gets or sets a value indicating whether animator should repeat the animation after its ending

Definition at line 19 of file IAnimator.cs.

bool WinFormAnimation.IAnimator.ReverseRepeat
getset

Gets or sets a value indicating whether animator should repeat the animation in reverse after its ending.

Definition at line 24 of file IAnimator.cs.


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