The one dimensional animator class, useful for animating raw values More...

Inheritance diagram for WinFormAnimation.Animator:

Public Types
enum	KnownProperties { KnownProperties.Value, KnownProperties.Text, KnownProperties.Caption, KnownProperties.BackColor, KnownProperties.ForeColor, KnownProperties.Opacity }
	The known one dimensional properties of WinForm controls More...

Public Member Functions
	Animator ()
	Initializes a new instance of the Animator class. More...

	Animator (FPSLimiterKnownValues fpsLimiter)
	Initializes a new instance of the Animator class. More...

	Animator (Path path)
	Initializes a new instance of the Animator class. More...

	Animator (Path path, FPSLimiterKnownValues fpsLimiter)
	Initializes a new instance of the Animator class. More...

	Animator (Path[] paths)
	Initializes a new instance of the Animator class. More...

	Animator (Path[] paths, FPSLimiterKnownValues fpsLimiter)
	Initializes a new instance of the Animator class. More...

virtual void	Pause ()
	Pause the animation More...

virtual void	Play (object targetObject, string propertyName)
	Starts the playing of the animation More...

virtual void	Play (object targetObject, string propertyName, SafeInvoker endCallback)
	Starts the playing of the animation More...

virtual void	Play< T > (T targetObject, Expression< Func< T, object >> propertySetter)
	Starts the playing of the animation More...

virtual void	Play< T > (T targetObject, Expression< Func< T, object >> propertySetter, SafeInvoker endCallback)
	Starts the playing of the animation More...

virtual void	Resume ()
	Resume the animation from where it paused More...

virtual void	Stop ()
	Stops the animation and resets its status, resume is no longer possible More...

virtual void	Play (object targetObject, KnownProperties property)
	Starts the playing of the animation More...

virtual void	Play (object targetObject, KnownProperties property, SafeInvoker endCallback)
	Starts the playing of the animation More...

virtual void	Play (SafeInvoker< float > frameCallback)
	Starts the playing of the animation More...

virtual void	Play (SafeInvoker< float > frameCallback, SafeInvoker endCallback)
	Starts the playing of the animation More...

Protected Attributes
SafeInvoker	EndCallback
	The callback to get invoked at the end of the animation More...

SafeInvoker< float >	FrameCallback
	The callback to get invoked at each frame More...

object	TargetObject
	The target object to change the property of More...

Properties
Path[]	Paths `[get, set]`
	Gets or sets an array containing the list of paths of the animation More...

Path	ActivePath `[get]`
	Gets the currently active path. More...

virtual bool	Repeat `[get, set]`
	Gets or sets a value indicating whether animator should repeat the animation after its ending More...

virtual bool	ReverseRepeat `[get, set]`
	Gets or sets a value indicating whether animator should repeat the animation in reverse after its ending. More...

virtual AnimatorStatus	CurrentStatus `[get]`
	Gets the current status of the animation More...

Properties inherited from WinFormAnimation.IAnimator
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 one dimensional animator class, useful for animating raw values

Definition at line 11 of file Animator.cs.

Member Enumeration Documentation

enum WinFormAnimation.Animator.KnownProperties

strong

The known one dimensional properties of WinForm controls

Enumerator
Value	The property named 'Value' of the object
Text	The property named 'Text' of the object
Caption	The property named 'Caption' of the object
BackColor	The property named 'BackColor' of the object
ForeColor	The property named 'ForeColor' of the object
Opacity	The property named 'Opacity' of the object

Definition at line 16 of file Animator.cs.

Constructor & Destructor Documentation

WinFormAnimation.Animator.Animator ( )

Initializes a new instance of the Animator class.

Definition at line 75 of file Animator.cs.

WinFormAnimation.Animator.Animator ( FPSLimiterKnownValues fpsLimiter )

Initializes a new instance of the Animator class.

Parameters

fpsLimiter Limits the maximum frames per seconds

Definition at line 86 of file Animator.cs.

WinFormAnimation.Animator.Animator ( Path path )

Initializes a new instance of the Animator class.

Parameters

path	The path of the animation

Definition at line 97 of file Animator.cs.

WinFormAnimation.Animator.Animator	(	Path	path,
		FPSLimiterKnownValues	fpsLimiter
	)

Initializes a new instance of the Animator class.

Parameters

path	The path of the animation
fpsLimiter	Limits the maximum frames per seconds

Definition at line 111 of file Animator.cs.

WinFormAnimation.Animator.Animator ( Path[] paths )

Initializes a new instance of the Animator class.

Parameters

paths An array containing the list of paths of the animation

Definition at line 122 of file Animator.cs.

WinFormAnimation.Animator.Animator	(	Path[]	paths,
		FPSLimiterKnownValues	fpsLimiter
	)

Initializes a new instance of the Animator class.

Parameters

paths	An array containing the list of paths of the animation
fpsLimiter	Limits the maximum frames per seconds

Definition at line 135 of file Animator.cs.

Member Function Documentation

virtual void WinFormAnimation.Animator.Pause ( )

virtual

Pause the animation

Implements WinFormAnimation.IAnimator.

Definition at line 186 of file Animator.cs.

virtual void WinFormAnimation.Animator.Play	(	object	targetObject,
		string	propertyName
	)

virtual

Starts the playing of the animation

Parameters

targetObject	The target object to change the property
propertyName	The name of the property to change

Implements WinFormAnimation.IAnimator.

Definition at line 203 of file Animator.cs.

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

virtual

Starts the playing of the animation

Parameters

targetObject	The target object to change the property
propertyName	The name of the property to change
endCallback	The callback to get invoked at the end of the animation

Implements WinFormAnimation.IAnimator.

Definition at line 220 of file Animator.cs.

virtual void WinFormAnimation.Animator.Play	(	object	targetObject,
		KnownProperties	property
	)

virtual

Starts the playing of the animation

Parameters

targetObject	The target object to change the property
property	The property to change

Definition at line 324 of file Animator.cs.

virtual void WinFormAnimation.Animator.Play	(	object	targetObject,
		KnownProperties	property,
		SafeInvoker	endCallback
	)

virtual

Starts the playing of the animation

Parameters

targetObject	The target object to change the property
property	The property to change
endCallback	The callback to get invoked at the end of the animation

Definition at line 342 of file Animator.cs.

virtual void WinFormAnimation.Animator.Play ( SafeInvoker< float > frameCallback )

virtual

Starts the playing of the animation

Parameters

frameCallback The callback to get invoked at each frame

Definition at line 353 of file Animator.cs.

virtual void WinFormAnimation.Animator.Play	(	SafeInvoker< float >	frameCallback,
		SafeInvoker	endCallback
	)

virtual

Starts the playing of the animation

Parameters

frameCallback	The callback to get invoked at each frame
endCallback	The callback to get invoked at the end of the animation

Definition at line 368 of file Animator.cs.

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

virtual

Starts the playing of the animation

Parameters

targetObject	The target object to change the property
propertySetter	The expression that represents the property of the target object

Template Parameters

T	Any object containing a property

Implements WinFormAnimation.IAnimator.

Definition at line 248 of file Animator.cs.

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

virtual

Starts the playing of the animation

Parameters

targetObject	The target object to change the property
propertySetter	The expression that represents the property of the target object
endCallback	The callback to get invoked at the end of the animation

Template Parameters

T	Any object containing a property

Implements WinFormAnimation.IAnimator.

Definition at line 269 of file Animator.cs.

virtual void WinFormAnimation.Animator.Resume ( )

virtual

Resume the animation from where it paused

Implements WinFormAnimation.IAnimator.

Definition at line 293 of file Animator.cs.

virtual void WinFormAnimation.Animator.Stop ( )

virtual

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

Implements WinFormAnimation.IAnimator.

Definition at line 304 of file Animator.cs.

Member Data Documentation

SafeInvoker WinFormAnimation.Animator.EndCallback

protected

The callback to get invoked at the end of the animation

Definition at line 60 of file Animator.cs.

SafeInvoker<float> WinFormAnimation.Animator.FrameCallback

protected

The callback to get invoked at each frame

Definition at line 65 of file Animator.cs.

object WinFormAnimation.Animator.TargetObject

protected

The target object to change the property of

Definition at line 70 of file Animator.cs.

Property Documentation

Path WinFormAnimation.Animator.ActivePath

get

Gets the currently active path.

Definition at line 166 of file Animator.cs.

virtual AnimatorStatus WinFormAnimation.Animator.CurrentStatus

get

Gets the current status of the animation

Definition at line 181 of file Animator.cs.

Path [] WinFormAnimation.Animator.Paths

getset

Gets or sets an array containing the list of paths of the animation

Exceptions

InvalidOperationException Animation is running

Definition at line 147 of file Animator.cs.

virtual bool WinFormAnimation.Animator.Repeat

getset

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

Definition at line 171 of file Animator.cs.

virtual bool WinFormAnimation.Animator.ReverseRepeat

getset

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

Definition at line 176 of file Animator.cs.

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

Animator.cs

Public Types

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation