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

The Float2D class contains two values and represents a point in a 2D plane More...

Inheritance diagram for WinFormAnimation.Float2D:

Public Member Functions

 Float2D (float x, float y)
 Initializes a new instance of the Float2D class. More...
 
 Float2D ()
 Initializes a new instance of the Float2D class. More...
 
TypeCode GetTypeCode ()
 Returns the T:System.TypeCode for this instance. More...
 
bool ToBoolean (IFormatProvider provider)
 Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information. More...
 
byte ToByte (IFormatProvider provider)
 Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information. More...
 
char ToChar (IFormatProvider provider)
 Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information. More...
 
DateTime ToDateTime (IFormatProvider provider)
 Converts the value of this instance to an equivalent T:System.DateTime using the specified culture-specific formatting information. More...
 
decimal ToDecimal (IFormatProvider provider)
 Converts the value of this instance to an equivalent T:System.Decimal number using the specified culture-specific formatting information. More...
 
double ToDouble (IFormatProvider provider)
 Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information. More...
 
short ToInt16 (IFormatProvider provider)
 Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information. More...
 
int ToInt32 (IFormatProvider provider)
 Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information. More...
 
long ToInt64 (IFormatProvider provider)
 Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information. More...
 
sbyte ToSByte (IFormatProvider provider)
 Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information. More...
 
float ToSingle (IFormatProvider provider)
 Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information. More...
 
ushort ToUInt16 (IFormatProvider provider)
 Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information. More...
 
uint ToUInt32 (IFormatProvider provider)
 Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information. More...
 
ulong ToUInt64 (IFormatProvider provider)
 Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information. More...
 
string ToString (IFormatProvider provider)
 Converts the value of this instance to an equivalent T:System.String using the specified culture-specific formatting information. More...
 
object ToType (Type conversionType, IFormatProvider provider)
 Converts the value of this instance to an T:System.Object of the specified T:System.Type that has an equivalent value, using the specified culture-specific formatting information. More...
 
bool Equals (Float2D other)
 Indicates whether the current object is equal to another object of the same type. More...
 
bool Equals (Point other)
 Indicates whether the current object is equal to a Point object. More...
 
bool Equals (PointF other)
 Indicates whether the current object is equal to a PointF object. More...
 
bool Equals (Size other)
 Indicates whether the current object is equal to a Size object. More...
 
bool Equals (SizeF other)
 Indicates whether the current object is equal to a SizeF object. More...
 
override bool Equals (object obj)
 Determines whether the specified T:System.Object is equal to the current T:System.Object. More...
 
override int GetHashCode ()
 Serves as a hash function for a particular type. This code will change of the values of the X and Y changes. Make sure to not change the values while stored in a hash dependent data structure. More...
 
override string ToString ()
 Returns a string that represents the current Float2D. More...
 

Static Public Member Functions

static bool operator== (Float2D left, Float2D right)
 Compares two Float2D objects for equality More...
 
static bool operator!= (Float2D left, Float2D right)
 Compares two Float2D objects for in-equality More...
 
static implicit operator Size (Float2D float2D)
 Represents the values as an instance of the Size class More...
 
static implicit operator Point (Float2D float2D)
 Represents the values as an instance of the Point class More...
 
static implicit operator SizeF (Float2D float2D)
 Represents the values as an instance of the SizeF class More...
 
static implicit operator PointF (Float2D float2D)
 Represents the values as an instance of the PointF class More...
 
static Float2D FromPoint (Point point)
 Creates and returns a new instance of the Float2D class from a Point instance More...
 
static Float2D FromPoint (PointF point)
 Creates and returns a new instance of the Float2D class from a PointF instance More...
 
static Float2D FromSize (Size size)
 Creates and returns a new instance of the Float2D class from a Size instance More...
 
static Float2D FromSize (SizeF size)
 Creates and returns a new instance of the Float2D class from a SizeF instance More...
 

Properties

float X [get, set]
 Gets the horizontal value of the point More...
 
float Y [get, set]
 Gets the vertical value of the point More...
 

Detailed Description

The Float2D class contains two values and represents a point in a 2D plane

Definition at line 10 of file Float2D.cs.

Constructor & Destructor Documentation

WinFormAnimation.Float2D.Float2D ( float  x,
float  y 
)

Initializes a new instance of the Float2D class.

Parameters
xThe horizontal value
yThe vertical value

Definition at line 22 of file Float2D.cs.

WinFormAnimation.Float2D.Float2D ( )

Initializes a new instance of the Float2D class.

Definition at line 31 of file Float2D.cs.

Member Function Documentation

bool WinFormAnimation.Float2D.Equals ( Float2D  other)

Indicates whether the current object is equal to another object of the same type.

Returns
true if the current object is equal to the other parameter; otherwise, false.
Parameters
otherAn object to compare with this object.

Definition at line 362 of file Float2D.cs.

bool WinFormAnimation.Float2D.Equals ( Point  other)

Indicates whether the current object is equal to a Point object.

Returns
true if the current object is equal to the other parameter; otherwise, false.
Parameters
otherAn object to compare with this object.

Definition at line 374 of file Float2D.cs.

bool WinFormAnimation.Float2D.Equals ( PointF  other)

Indicates whether the current object is equal to a PointF object.

Returns
true if the current object is equal to the other parameter; otherwise, false.
Parameters
otherAn object to compare with this object.

Definition at line 386 of file Float2D.cs.

bool WinFormAnimation.Float2D.Equals ( Size  other)

Indicates whether the current object is equal to a Size object.

Returns
true if the current object is equal to the other parameter; otherwise, false.
Parameters
otherAn object to compare with this object.

Definition at line 398 of file Float2D.cs.

bool WinFormAnimation.Float2D.Equals ( SizeF  other)

Indicates whether the current object is equal to a SizeF object.

Returns
true if the current object is equal to the other parameter; otherwise, false.
Parameters
otherAn object to compare with this object.

Definition at line 410 of file Float2D.cs.

override bool WinFormAnimation.Float2D.Equals ( object  obj)

Determines whether the specified T:System.Object is equal to the current T:System.Object.

Returns
true if the specified T:System.Object is equal to the current T:System.Object; otherwise, false.
Parameters
objThe T:System.Object to compare with the current T:System.Object.

Definition at line 424 of file Float2D.cs.

static Float2D WinFormAnimation.Float2D.FromPoint ( Point  point)
static

Creates and returns a new instance of the Float2D class from a Point instance

Parameters
pointThe object to create the Float2D instance from
Returns
The newly created Float2D instance

Definition at line 566 of file Float2D.cs.

static Float2D WinFormAnimation.Float2D.FromPoint ( PointF  point)
static

Creates and returns a new instance of the Float2D class from a PointF instance

Parameters
pointThe object to create the Float2D instance from
Returns
The newly created Float2D instance

Definition at line 576 of file Float2D.cs.

static Float2D WinFormAnimation.Float2D.FromSize ( Size  size)
static

Creates and returns a new instance of the Float2D class from a Size instance

Parameters
sizeThe object to create the Float2D instance from
Returns
The newly created Float2D instance

Definition at line 586 of file Float2D.cs.

static Float2D WinFormAnimation.Float2D.FromSize ( SizeF  size)
static

Creates and returns a new instance of the Float2D class from a SizeF instance

Parameters
sizeThe object to create the Float2D instance from
Returns
The newly created Float2D instance

Definition at line 596 of file Float2D.cs.

override int WinFormAnimation.Float2D.GetHashCode ( )

Serves as a hash function for a particular type. This code will change of the values of the X and Y changes. Make sure to not change the values while stored in a hash dependent data structure.

Returns
A hash code for the current Float2D.

Definition at line 455 of file Float2D.cs.

TypeCode WinFormAnimation.Float2D.GetTypeCode ( )

Returns the T:System.TypeCode for this instance.

Returns
The enumerated constant that is the T:System.TypeCode of the class or value type that implements this interface.

Definition at line 52 of file Float2D.cs.

static implicit WinFormAnimation.Float2D.operator Point ( Float2D  float2D)
static

Represents the values as an instance of the Point class

Parameters
float2DThe Float2D class to convert
Returns
A new instance of the Point class representing the values in the Float2D instance

Definition at line 516 of file Float2D.cs.

static implicit WinFormAnimation.Float2D.operator PointF ( Float2D  float2D)
static

Represents the values as an instance of the PointF class

Parameters
float2DThe Float2D class to convert
Returns
A new instance of the PointF class representing the values in the Float2D instance

Definition at line 545 of file Float2D.cs.

static implicit WinFormAnimation.Float2D.operator Size ( Float2D  float2D)
static

Represents the values as an instance of the Size class

Parameters
float2DThe Float2D class to convert
Returns
A new instance of the Size class representing the values in the Float2D instance

Definition at line 502 of file Float2D.cs.

static implicit WinFormAnimation.Float2D.operator SizeF ( Float2D  float2D)
static

Represents the values as an instance of the SizeF class

Parameters
float2DThe Float2D class to convert
Returns
A new instance of the SizeF class representing the values in the Float2D instance

Definition at line 531 of file Float2D.cs.

static bool WinFormAnimation.Float2D.operator!= ( Float2D  left,
Float2D  right 
)
static

Compares two Float2D objects for in-equality

Parameters
leftLeft Float2D object
rightRight Float2D object
Returns
false if both objects are equal, otherwise true

Definition at line 488 of file Float2D.cs.

static bool WinFormAnimation.Float2D.operator== ( Float2D  left,
Float2D  right 
)
static

Compares two Float2D objects for equality

Parameters
leftLeft Float2D object
rightRight Float2D object
Returns
true if both objects are equal, otherwise false

Definition at line 471 of file Float2D.cs.

bool WinFormAnimation.Float2D.ToBoolean ( IFormatProvider  provider)

Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information.

Returns
A Boolean value equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 69 of file Float2D.cs.

byte WinFormAnimation.Float2D.ToByte ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information.

Returns
An 8-bit unsigned integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 86 of file Float2D.cs.

char WinFormAnimation.Float2D.ToChar ( IFormatProvider  provider)

Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information.

Returns
A Unicode character equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 103 of file Float2D.cs.

DateTime WinFormAnimation.Float2D.ToDateTime ( IFormatProvider  provider)

Converts the value of this instance to an equivalent T:System.DateTime using the specified culture-specific formatting information.

Returns
A T:System.DateTime instance equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 121 of file Float2D.cs.

decimal WinFormAnimation.Float2D.ToDecimal ( IFormatProvider  provider)

Converts the value of this instance to an equivalent T:System.Decimal number using the specified culture-specific formatting information.

Returns
A T:System.Decimal number equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 139 of file Float2D.cs.

double WinFormAnimation.Float2D.ToDouble ( IFormatProvider  provider)

Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information.

Returns
A double-precision floating-point number equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 157 of file Float2D.cs.

short WinFormAnimation.Float2D.ToInt16 ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information.

Returns
An 16-bit signed integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 175 of file Float2D.cs.

int WinFormAnimation.Float2D.ToInt32 ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information.

Returns
An 32-bit signed integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 192 of file Float2D.cs.

long WinFormAnimation.Float2D.ToInt64 ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information.

Returns
An 64-bit signed integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 210 of file Float2D.cs.

sbyte WinFormAnimation.Float2D.ToSByte ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information.

Returns
An 8-bit signed integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 228 of file Float2D.cs.

float WinFormAnimation.Float2D.ToSingle ( IFormatProvider  provider)

Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information.

Returns
A single-precision floating-point number equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 246 of file Float2D.cs.

string WinFormAnimation.Float2D.ToString ( IFormatProvider  provider)

Converts the value of this instance to an equivalent T:System.String using the specified culture-specific formatting information.

Returns
A T:System.String instance equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Definition at line 315 of file Float2D.cs.

override string WinFormAnimation.Float2D.ToString ( )

Returns a string that represents the current Float2D.

Returns
A string that represents the current Float2D.

Definition at line 556 of file Float2D.cs.

object WinFormAnimation.Float2D.ToType ( Type  conversionType,
IFormatProvider  provider 
)

Converts the value of this instance to an T:System.Object of the specified T:System.Type that has an equivalent value, using the specified culture-specific formatting information.

Returns
An T:System.Object instance of type conversionType whose value is equivalent to the value of this instance.
Parameters
conversionTypeThe T:System.Type to which the value of this instance is converted.
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Definition at line 334 of file Float2D.cs.

ushort WinFormAnimation.Float2D.ToUInt16 ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information.

Returns
An 16-bit unsigned integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 263 of file Float2D.cs.

uint WinFormAnimation.Float2D.ToUInt32 ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.

Returns
An 32-bit unsigned integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 281 of file Float2D.cs.

ulong WinFormAnimation.Float2D.ToUInt64 ( IFormatProvider  provider)

Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.

Returns
An 64-bit unsigned integer equivalent to the value of this instance.
Parameters
providerAn T:System.IFormatProvider interface implementation that supplies culture-specific formatting information.
Exceptions
InvalidCastExceptionThis method is not supported

Definition at line 299 of file Float2D.cs.

Property Documentation

float WinFormAnimation.Float2D.X
getset

Gets the horizontal value of the point

Definition at line 38 of file Float2D.cs.

float WinFormAnimation.Float2D.Y
getset

Gets the vertical value of the point

Definition at line 43 of file Float2D.cs.


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