WinFormAnimation.Path Class Reference

The Path class is a representation of a line in a 1D plane and the speed in which the animator plays it More...

Public Member Functions
	Path ()
	Initializes a new instance of the Path class. More...
	Path (float start, float end, float duration)
	Initializes a new instance of the Path class. More...
	Path (float start, float end, float duration, AnimationFunctions.Function function)
	Initializes a new instance of the Path class. More...
	Path (float start, float end, float duration, float delay)
	Initializes a new instance of the Path class. More...
	Path (float start, float end, float duration, float delay, AnimationFunctions.Function function)
	Initializes a new instance of the Path class. More...
Path	Reverse ()
	Creates and returns a new Path based on the current path but in reverse order More...

Public Attributes
float	Change => End - Start
	Gets the difference of starting and ending values More...

Properties
float	Delay [get, set]
	Gets or sets the starting delay More...
float	Duration [get, set]
	Gets or sets the duration in milliseconds More...
float	End [get, set]
	Gets or sets the ending value More...
AnimationFunctions.Function	Function [get, set]
	Gets or sets the animation function More...
float	Start [get, set]
	Gets or sets the starting value More...

Detailed Description

The Path class is a representation of a line in a 1D plane and the speed in which the animator plays it

Definition at line 9 of file Path.cs.

Constructor & Destructor Documentation

WinFormAnimation.Path.Path

(

)

Initializes a new instance of the Path class.

Definition at line 14 of file Path.cs.

WinFormAnimation.Path.Path	(	float	start,
		float	end,
		float	duration
	)

Initializes a new instance of the Path class.

Parameters

start	The starting value
end	The ending value
duration	The time in miliseconds that the animator must play this path

Exceptions

ArgumentOutOfRangeException

Duration is less than zero

Definition at line 33 of file Path.cs.

WinFormAnimation.Path.Path	(	float	start,
		float	end,
		float	duration,
		AnimationFunctions.Function	function
	)

Initializes a new instance of the Path class.

Parameters

start	The starting value
end	The ending value
duration	The time in miliseconds that the animator must play this path
function	The animation function

Exceptions

ArgumentOutOfRangeException

Duration is less than zero

Definition at line 55 of file Path.cs.

WinFormAnimation.Path.Path	(	float	start,
		float	end,
		float	duration,
		float	delay
	)

Initializes a new instance of the Path class.

Parameters

start	The starting value
end	The ending value
duration	The time in miliseconds that the animator must play this path
delay	The time in miliseconds that the animator must wait before playing this path

Exceptions

ArgumentOutOfRangeException

Duration is less than zero

Definition at line 78 of file Path.cs.

WinFormAnimation.Path.Path	(	float	start,
		float	end,
		float	duration,
		float	delay,
		AnimationFunctions.Function	function
	)

Initializes a new instance of the Path class.

Parameters

start	The starting value
end	The ending value
duration	The time in miliseconds that the animator must play this path
delay	The time in miliseconds that the animator must wait before playing this path
function	The animation function

Exceptions

ArgumentOutOfRangeException

Duration is less than zero

Definition at line 103 of file Path.cs.

Member Function Documentation

Path WinFormAnimation.Path.Reverse

(

)

Creates and returns a new Path based on the current path but in reverse order

Returns

A new Path which is the reverse of the current Path

Definition at line 152 of file Path.cs.

Member Data Documentation

float WinFormAnimation.Path.Change => End - Start

Gets the difference of starting and ending values

Definition at line 119 of file Path.cs.

Property Documentation

float WinFormAnimation.Path.Delay

getset

Gets or sets the starting delay

Definition at line 124 of file Path.cs.

float WinFormAnimation.Path.Duration

getset

Gets or sets the duration in milliseconds

Definition at line 129 of file Path.cs.

float WinFormAnimation.Path.End

getset

Gets or sets the ending value

Definition at line 134 of file Path.cs.

AnimationFunctions.Function WinFormAnimation.Path.Function

getset

Gets or sets the animation function

Definition at line 139 of file Path.cs.

float WinFormAnimation.Path.Start

getset

Gets or sets the starting value

Definition at line 144 of file Path.cs.

---

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

• Path.cs