MuGameFramework  1.0
MuGameFramework is a 2D game framework built upon C# and SFML
 All Classes Namespaces Files Functions Variables Enumerations Properties
MuGameFramework.Components.Point Struct Reference

Represents a 2D (X, Y) point on the screen More...

Public Member Functions

 Point (int x, int y)
 Create an instance of Point
override bool Equals (object obj)
 Compare a point with this for equality
override int GetHashCode ()
 Get the hash code for this object
override string ToString ()
 Print out the values of a point as a string

Static Public Member Functions

static implicit operator string (Point value)
 Print out the values of a point as a string
static Point operator+ (Point a, Point b)
 Add two Points together
static Point operator- (Point a, Point b)
 Subtract two Points
static Point operator* (Point a, Point b)
 Multiply two points together
static Point operator* (Point a, int b)
 Multiply a scalar to a point
static Point operator* (int a, Point b)
 Multiply a scalar to a point
static Point operator/ (Point a, Point b)
 Divide two points together
static Point operator/ (Point a, int b)
 Divide a scalar to a point
static Point operator/ (int a, Point b)
 Divide a scalar to a point
static bool operator== (Point a, Point b)
 Compare two points for equality
static bool operator!= (Point a, Point b)
 Compare two points for inequality

Public Attributes

int X
 X coordinate of this Point object
int Y
 Y coordinate of this Point object

Static Public Attributes

static readonly Point Zero = new Point(0, 0)
 Returns a point with the value of Zero

Detailed Description

Represents a 2D (X, Y) point on the screen

Constructor & Destructor Documentation

MuGameFramework.Components.Point.Point ( int  x,
int  y 
)

Create an instance of Point

Member Function Documentation

override bool MuGameFramework.Components.Point.Equals ( object  obj)

Compare a point with this for equality

Parameters
objPoint to compare
Returns
Result of comparison
override int MuGameFramework.Components.Point.GetHashCode ( )

Get the hash code for this object

Returns
The hash code for this object
static implicit MuGameFramework.Components.Point.operator string ( Point  value)
static

Print out the values of a point as a string

Parameters
valuePoint to print out
Returns
String of thus Point
static bool MuGameFramework.Components.Point.operator!= ( Point  a,
Point  b 
)
static

Compare two points for inequality

Parameters
aPoint A to check
bPoint B to check
Returns
Result of comparison
static Point MuGameFramework.Components.Point.operator* ( Point  a,
Point  b 
)
static

Multiply two points together

Parameters
aPoint A to multiply together
bPoint B to multiply together
Returns
Final point
static Point MuGameFramework.Components.Point.operator* ( Point  a,
int  b 
)
static

Multiply a scalar to a point

Parameters
aPoint A to multiply
bScalar to multiply by
Returns
Final point
static Point MuGameFramework.Components.Point.operator* ( int  a,
Point  b 
)
static

Multiply a scalar to a point

Parameters
aScalar to multiply by
bPoint B to multiply
Returns
Final point
static Point MuGameFramework.Components.Point.operator+ ( Point  a,
Point  b 
)
static

Add two Points together

Parameters
aPoint A to add
bPoint B to add
Returns
Final point
static Point MuGameFramework.Components.Point.operator- ( Point  a,
Point  b 
)
static

Subtract two Points

Parameters
aPoint A to subtract
bPoint B to subtract
Returns
Final point
static Point MuGameFramework.Components.Point.operator/ ( Point  a,
Point  b 
)
static

Divide two points together

Parameters
aPoint A to divide together
bPoint B to divide together
Returns
Final point
static Point MuGameFramework.Components.Point.operator/ ( Point  a,
int  b 
)
static

Divide a scalar to a point

Parameters
aPoint A to divide
bScalar to divide by
Returns
Final point
static Point MuGameFramework.Components.Point.operator/ ( int  a,
Point  b 
)
static

Divide a scalar to a point

Parameters
aScalar to divide by
bPoint B to divide
Returns
Final point
static bool MuGameFramework.Components.Point.operator== ( Point  a,
Point  b 
)
static

Compare two points for equality

Parameters
aPoint A to check
bPoint B to check
Returns
Result of comparison
override string MuGameFramework.Components.Point.ToString ( )

Print out the values of a point as a string

Returns
String of thus Point

Member Data Documentation

int MuGameFramework.Components.Point.X

X coordinate of this Point object

int MuGameFramework.Components.Point.Y

Y coordinate of this Point object

readonly Point MuGameFramework.Components.Point.Zero = new Point(0, 0)
static

Returns a point with the value of Zero


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