WinForm Animation Library
Public Member Functions | Public Attributes | Properties | List of all members
WinFormAnimation.Path3D Class Reference

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

Public Member Functions

 Path3D (float startX, float endX, float startY, float endY, float startZ, float endZ, float duration, float delay, AnimationFunctions.Function function)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (float startX, float endX, float startY, float endY, float startZ, float endZ, float duration, float delay)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (float startX, float endX, float startY, float endY, float startZ, float endZ, float duration, AnimationFunctions.Function function)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (float startX, float endX, float startY, float endY, float startZ, float endZ, float duration)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (Float3D start, Float3D end, float duration, float delay, AnimationFunctions.Function function)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (Float3D start, Float3D end, float duration, float delay)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (Float3D start, Float3D end, float duration, AnimationFunctions.Function function)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (Float3D start, Float3D end, float duration)
 Initializes a new instance of the Path3D class. More...
 
 Path3D (Path x, Path y, Path z)
 Initializes a new instance of the Path3D class. More...
 
Path3D Reverse ()
 Creates and returns a new Path3D based on the current path but in reverse order More...
 

Public Attributes

Float3D Start => new Float3D(HorizontalPath.Start, VerticalPath.Start, DepthPath.Start)
 Gets the starting point of the path More...
 
Float3D End => new Float3D(HorizontalPath.End, VerticalPath.End, DepthPath.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...
 
Path DepthPath [get]
 Gets the depth path More...
 

Detailed Description

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

Definition at line 9 of file Path3D.cs.

Constructor & Destructor Documentation

WinFormAnimation.Path3D.Path3D ( float  startX,
float  endX,
float  startY,
float  endY,
float  startZ,
float  endZ,
float  duration,
float  delay,
AnimationFunctions.Function  function 
)

Initializes a new instance of the Path3D class.

Parameters
startXThe starting horizontal value
endXThe ending horizontal value
startYThe starting vertical value
endYThe ending vertical value
startZThe starting depth value
endZThe ending depth value
durationThe time in miliseconds that the animator must play this path
delayThe time in miliseconds that the animator must wait before playing this path
functionThe animation function
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 44 of file Path3D.cs.

WinFormAnimation.Path3D.Path3D ( float  startX,
float  endX,
float  startY,
float  endY,
float  startZ,
float  endZ,
float  duration,
float  delay 
)

Initializes a new instance of the Path3D class.

Parameters
startXThe starting horizontal value
endXThe ending horizontal value
startYThe starting vertical value
endYThe ending vertical value
startZThe starting depth value
endZThe ending depth value
durationThe time in miliseconds that the animator must play this path
delayThe time in miliseconds that the animator must wait before playing this path
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 91 of file Path3D.cs.

WinFormAnimation.Path3D.Path3D ( float  startX,
float  endX,
float  startY,
float  endY,
float  startZ,
float  endZ,
float  duration,
AnimationFunctions.Function  function 
)

Initializes a new instance of the Path3D class.

Parameters
startXThe starting horizontal value
endXThe ending horizontal value
startYThe starting vertical value
endYThe ending vertical value
startZThe starting depth value
endZThe ending depth value
durationThe time in miliseconds that the animator must play this path
functionThe animation function
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 137 of file Path3D.cs.

WinFormAnimation.Path3D.Path3D ( float  startX,
float  endX,
float  startY,
float  endY,
float  startZ,
float  endZ,
float  duration 
)

Initializes a new instance of the Path3D class.

Parameters
startXThe starting horizontal value
endXThe ending horizontal value
startYThe starting vertical value
endYThe ending vertical value
startZThe starting depth value
endZThe ending depth value
durationThe time in miliseconds that the animator must play this path
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 180 of file Path3D.cs.

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

Initializes a new instance of the Path3D class.

Parameters
startThe starting point in a 3D plane
endThe ending point in a 3D plane
durationThe time in miliseconds that the animator must play this path
delayThe time in miliseconds that the animator must wait before playing this path
functionThe animation function
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 213 of file Path3D.cs.

WinFormAnimation.Path3D.Path3D ( Float3D  start,
Float3D  end,
float  duration,
float  delay 
)

Initializes a new instance of the Path3D class.

Parameters
startThe starting point in a 3D plane
endThe ending point in a 3D plane
durationThe time in miliseconds that the animator must play this path
delayThe time in miliseconds that the animator must wait before playing this path
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 239 of file Path3D.cs.

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

Initializes a new instance of the Path3D class.

Parameters
startThe starting point in a 3D plane
endThe ending point in a 3D plane
durationThe time in miliseconds that the animator must play this path
functionThe animation function
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 265 of file Path3D.cs.

WinFormAnimation.Path3D.Path3D ( Float3D  start,
Float3D  end,
float  duration 
)

Initializes a new instance of the Path3D class.

Parameters
startThe starting point in a 3D plane
endThe ending point in a 3D plane
durationThe time in miliseconds that the animator must play this path
Exceptions
ArgumentOutOfRangeExceptionDuration is less than zero

Definition at line 288 of file Path3D.cs.

WinFormAnimation.Path3D.Path3D ( Path  x,
Path  y,
Path  z 
)

Initializes a new instance of the Path3D class.

Parameters
xThe horizontal path.
yThe vertical path.
zThe depth path.

Definition at line 308 of file Path3D.cs.

Member Function Documentation

Path3D WinFormAnimation.Path3D.Reverse ( )

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

Returns
A new Path which is the reverse of the current Path3D

Definition at line 348 of file Path3D.cs.

Member Data Documentation

Float3D WinFormAnimation.Path3D.End => new Float3D(HorizontalPath.End, VerticalPath.End, DepthPath.End)

Gets the ending point of the path

Definition at line 340 of file Path3D.cs.

Float3D WinFormAnimation.Path3D.Start => new Float3D(HorizontalPath.Start, VerticalPath.Start, DepthPath.Start)

Gets the starting point of the path

Definition at line 334 of file Path3D.cs.

Property Documentation

Path WinFormAnimation.Path3D.DepthPath
get

Gets the depth path

Definition at line 328 of file Path3D.cs.

Path WinFormAnimation.Path3D.HorizontalPath
get

Gets the horizontal path

Definition at line 318 of file Path3D.cs.

Path WinFormAnimation.Path3D.VerticalPath
get

Gets the vertical path

Definition at line 323 of file Path3D.cs.


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