The three dimensional animator class, useful for animating values created from three underlying values More...

Inheritance diagram for WinFormAnimation.Animator3D:

Public Types
enum	KnownProperties { KnownProperties.BackColor, KnownProperties.ForeColor }
	The known three dimensional properties of WinForm controls More...

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

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

	Animator3D (Path3D path)
	Initializes a new instance of the Animator3D class. More...

	Animator3D (Path3D path, FPSLimiterKnownValues fpsLimiter)
	Initializes a new instance of the Animator3D class. More...

	Animator3D (Path3D[] paths)
	Initializes a new instance of the Animator3D class. More...

	Animator3D (Path3D[] paths, FPSLimiterKnownValues fpsLimiter)
	Initializes a new instance of the Animator3D 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...

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

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

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

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

Public Attributes
Path3D	ActivePath
	Gets the currently active path. More...

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

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

bool	IsEnded
	A boolean value indicating if the EndInvoker already invoked More...

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

float	XValue
	The latest horizontal value More...

float	YValue
	The latest vertical value More...

float	ZValue
	The latest depth value More...

Properties
Animator	HorizontalAnimator `[get, protected set]`
	Gets the horizontal animator. More...

Animator	VerticalAnimator `[get, protected set]`
	Gets the vertical animator. More...

Animator	DepthAnimator `[get, protected set]`
	Gets the depth animator. More...

Path3D[]	Paths `[get, set]`
	Gets or sets an array containing the list of paths of the animation 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 three dimensional animator class, useful for animating values created from three underlying values

Definition at line 12 of file Animator3D.cs.

Member Enumeration Documentation

enum WinFormAnimation.Animator3D.KnownProperties

strong

The known three dimensional properties of WinForm controls

Enumerator
BackColor	The property named 'BackColor' of the object
ForeColor	The property named 'ForeColor' of the object

Definition at line 17 of file Animator3D.cs.

Constructor & Destructor Documentation

WinFormAnimation.Animator3D.Animator3D ( )

Initializes a new instance of the Animator3D class.

Definition at line 71 of file Animator3D.cs.

WinFormAnimation.Animator3D.Animator3D ( FPSLimiterKnownValues fpsLimiter )

Initializes a new instance of the Animator3D class.

Parameters

fpsLimiter Limits the maximum frames per seconds

Definition at line 82 of file Animator3D.cs.

WinFormAnimation.Animator3D.Animator3D ( Path3D path )

Initializes a new instance of the Animator3D class.

Parameters

path	The path of the animation

Definition at line 93 of file Animator3D.cs.

WinFormAnimation.Animator3D.Animator3D	(	Path3D	path,
		FPSLimiterKnownValues	fpsLimiter
	)

Initializes a new instance of the Animator3D class.

Parameters

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

Definition at line 107 of file Animator3D.cs.

WinFormAnimation.Animator3D.Animator3D ( Path3D[] paths )

Initializes a new instance of the Animator3D class.

Parameters

paths An array containing the list of paths of the animation

Definition at line 118 of file Animator3D.cs.

WinFormAnimation.Animator3D.Animator3D	(	Path3D[]	paths,
		FPSLimiterKnownValues	fpsLimiter
	)

Initializes a new instance of the Animator3D class.

Parameters

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

Definition at line 131 of file Animator3D.cs.

Member Function Documentation

virtual void WinFormAnimation.Animator3D.Pause ( )

virtual

Pause the animation

Implements WinFormAnimation.IAnimator.

Definition at line 260 of file Animator3D.cs.

virtual void WinFormAnimation.Animator3D.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 279 of file Animator3D.cs.

virtual void WinFormAnimation.Animator3D.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 296 of file Animator3D.cs.

void WinFormAnimation.Animator3D.Play	(	object	targetObject,
		KnownProperties	property
	)

Starts the playing of the animation

Parameters

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

Definition at line 401 of file Animator3D.cs.

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

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 418 of file Animator3D.cs.

void WinFormAnimation.Animator3D.Play ( SafeInvoker< Float3D > frameCallback )

Starts the playing of the animation

Parameters

frameCallback The callback to get invoked at each frame

Definition at line 429 of file Animator3D.cs.

void WinFormAnimation.Animator3D.Play	(	SafeInvoker< Float3D >	frameCallback,
		SafeInvoker	endCallback
	)

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 443 of file Animator3D.cs.

virtual void WinFormAnimation.Animator3D.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 326 of file Animator3D.cs.

virtual void WinFormAnimation.Animator3D.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 346 of file Animator3D.cs.

virtual void WinFormAnimation.Animator3D.Resume ( )

virtual

Resume the animation from where it paused

Implements WinFormAnimation.IAnimator.

Definition at line 371 of file Animator3D.cs.

virtual void WinFormAnimation.Animator3D.Stop ( )

virtual

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

Implements WinFormAnimation.IAnimator.

Definition at line 384 of file Animator3D.cs.

Member Data Documentation

Path3D WinFormAnimation.Animator3D.ActivePath

Initial value:

=> new Path3D(
            HorizontalAnimator.ActivePath,
            VerticalAnimator.ActivePath,
            DepthAnimator.ActivePath)

Gets the currently active path.

Definition at line 142 of file Animator3D.cs.

SafeInvoker WinFormAnimation.Animator3D.EndCallback

protected

The callback to get invoked at the end of the animation

Definition at line 35 of file Animator3D.cs.

SafeInvoker<Float3D> WinFormAnimation.Animator3D.FrameCallback

protected

The callback to get invoked at each frame

Definition at line 40 of file Animator3D.cs.

bool WinFormAnimation.Animator3D.IsEnded

protected

A boolean value indicating if the EndInvoker already invoked

Definition at line 45 of file Animator3D.cs.

object WinFormAnimation.Animator3D.TargetObject

protected

The target object to change the property of

Definition at line 50 of file Animator3D.cs.

float WinFormAnimation.Animator3D.XValue

protected

The latest horizontal value

Definition at line 55 of file Animator3D.cs.

float WinFormAnimation.Animator3D.YValue

protected

The latest vertical value

Definition at line 60 of file Animator3D.cs.

float WinFormAnimation.Animator3D.ZValue

protected

The latest depth value

Definition at line 65 of file Animator3D.cs.

Property Documentation

virtual AnimatorStatus WinFormAnimation.Animator3D.CurrentStatus

get

Gets the current status of the animation

Definition at line 229 of file Animator3D.cs.

Animator WinFormAnimation.Animator3D.DepthAnimator

getprotected set

Gets the depth animator.

Definition at line 160 of file Animator3D.cs.

Animator WinFormAnimation.Animator3D.HorizontalAnimator

getprotected set

Gets the horizontal animator.

Definition at line 150 of file Animator3D.cs.

Path3D [] WinFormAnimation.Animator3D.Paths

getset

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

Exceptions

InvalidOperationException Animation is running

Definition at line 168 of file Animator3D.cs.

virtual bool WinFormAnimation.Animator3D.Repeat

getset

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

Definition at line 201 of file Animator3D.cs.

virtual bool WinFormAnimation.Animator3D.ReverseRepeat

getset

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

Definition at line 211 of file Animator3D.cs.

Animator WinFormAnimation.Animator3D.VerticalAnimator

getprotected set

Gets the vertical animator.

Definition at line 155 of file Animator3D.cs.

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

Animator3D.cs

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation