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

Public Member Functions
	Path2D (float startX, float endX, float startY, float endY, float duration, float delay, AnimationFunctions.Function function)
	Initializes a new instance of the Path2D class. More...

	Path2D (float startX, float endX, float startY, float endY, float duration, float delay)
	Initializes a new instance of the Path2D class. More...

	Path2D (float startX, float endX, float startY, float endY, float duration, AnimationFunctions.Function function)
	Initializes a new instance of the Path2D class. More...

	Path2D (float startX, float endX, float startY, float endY, float duration)
	Initializes a new instance of the Path2D class. More...

	Path2D (Float2D start, Float2D end, float duration, float delay, AnimationFunctions.Function function)
	Initializes a new instance of the Path2D class. More...

	Path2D (Float2D start, Float2D end, float duration, float delay)
	Initializes a new instance of the Path2D class. More...

	Path2D (Float2D start, Float2D end, float duration, AnimationFunctions.Function function)
	Initializes a new instance of the Path2D class. More...

	Path2D (Float2D start, Float2D end, float duration)
	Initializes a new instance of the Path2D class. More...

	Path2D (Path x, Path y)
	Initializes a new instance of the Path2D class. More...

Path2D	Reverse ()
	Creates and returns a new Path2D based on the current path but in reverse order More...

Public Attributes
Float2D	Start => new Float2D(HorizontalPath.Start, VerticalPath.Start)
	Gets the starting point of the path More...

Float2D	End => new Float2D(HorizontalPath.End, VerticalPath.End)
	Gets the ending point of the path More...

Properties
Path	HorizontalPath `[get]`
	Gets the horizontal path More...

Path	VerticalPath `[get]`
	Gets the vertical path More...

Detailed Description

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

Definition at line 9 of file Path2D.cs.

Constructor & Destructor Documentation

WinFormAnimation.Path2D.Path2D	(	float	startX,
		float	endX,
		float	startY,
		float	endY,
		float	duration,
		float	delay,
		AnimationFunctions.Function	function
	)

Initializes a new instance of the Path2D class.

Parameters

startX	The starting horizontal value
endX	The ending horizontal value
startY	The starting vertical value
endY	The ending vertical 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 38 of file Path2D.cs.

WinFormAnimation.Path2D.Path2D	(	float	startX,
		float	endX,
		float	startY,
		float	endY,
		float	duration,
		float	delay
	)

Initializes a new instance of the Path2D class.

Parameters

startX	The starting horizontal value
endX	The ending horizontal value
startY	The starting vertical value
endY	The ending vertical 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 74 of file Path2D.cs.

WinFormAnimation.Path2D.Path2D	(	float	startX,
		float	endX,
		float	startY,
		float	endY,
		float	duration,
		AnimationFunctions.Function	function
	)

Initializes a new instance of the Path2D class.

Parameters

startX	The starting horizontal value
endX	The ending horizontal value
startY	The starting vertical value
endY	The ending vertical 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 109 of file Path2D.cs.

WinFormAnimation.Path2D.Path2D	(	float	startX,
		float	endX,
		float	startY,
		float	endY,
		float	duration
	)

Initializes a new instance of the Path2D class.

Parameters

startX	The starting horizontal value
endX	The ending horizontal value
startY	The starting vertical value
endY	The ending vertical value
duration	The time in miliseconds that the animator must play this path

Exceptions

ArgumentOutOfRangeException Duration is less than zero

Definition at line 141 of file Path2D.cs.

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

Initializes a new instance of the Path2D class.

Parameters

start	The starting point or location
end	The ending point or location
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 172 of file Path2D.cs.

WinFormAnimation.Path2D.Path2D	(	Float2D	start,
		Float2D	end,
		float	duration,
		float	delay
	)

Initializes a new instance of the Path2D class.

Parameters

start	The starting point or location
end	The ending point or location
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 197 of file Path2D.cs.

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

Initializes a new instance of the Path2D class.

Parameters

start	The starting point or location
end	The ending point or location
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 222 of file Path2D.cs.

WinFormAnimation.Path2D.Path2D	(	Float2D	start,
		Float2D	end,
		float	duration
	)

Initializes a new instance of the Path2D class.

Parameters

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

Exceptions

ArgumentOutOfRangeException Duration is less than zero

Definition at line 244 of file Path2D.cs.

WinFormAnimation.Path2D.Path2D	(	Path	x,
		Path	y
	)

Initializes a new instance of the Path2D class.

Parameters

x	The horizontal path.
y	The vertical path.

Definition at line 260 of file Path2D.cs.

Member Function Documentation

Path2D WinFormAnimation.Path2D.Reverse ( )

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

Returns: A new Path2D which is the reverse of the current Path2D

Definition at line 293 of file Path2D.cs.

Member Data Documentation

Float2D WinFormAnimation.Path2D.End => new Float2D(HorizontalPath.End, VerticalPath.End)

Gets the ending point of the path

Definition at line 285 of file Path2D.cs.

Float2D WinFormAnimation.Path2D.Start => new Float2D(HorizontalPath.Start, VerticalPath.Start)

Gets the starting point of the path

Definition at line 279 of file Path2D.cs.

Property Documentation

Path WinFormAnimation.Path2D.HorizontalPath

get

Gets the horizontal path

Definition at line 269 of file Path2D.cs.

Path WinFormAnimation.Path2D.VerticalPath

get

Gets the vertical path

Definition at line 274 of file Path2D.cs.

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

Path2D.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation