AgateLib.Geometry.Point Struct Reference

Replacement for System.Drawing.Point structure. More...

List of all members.

Public Member Functions

 Point (int x, int y)
 Constructs a point.
 Point (Point pt)
 Constructs a point.
 Point (Size size)
 Constructs a point.
override int GetHashCode ()
 Gets a hash code.
override string ToString ()
 Creates a string representing this object.
override bool Equals (object obj)
 Equality test.
bool Equals (Point obj)
 Equality test.

Static Public Member Functions

static bool operator== (Point a, Point b)
 Equality comparison test.
static bool operator!= (Point a, Point b)
 Inequality comparison test.
static operator PointF (Point a)
 Explicitly converts a point to a pointf structure.
static Point Add (Point pt, Size size)
 Adds the specified size object to the specified point object and returns the new point.
static Point Ceiling (PointF pt)
 Rounds the PointF object up.
static Point Round (PointF pt)
 Rounds the PointF object to the nearest integer.

Public Attributes

int x
int y

Static Public Attributes

static readonly Point Empty = new Point(0, 0)
 Empty point.

Properties

int X [get, set]
 Gets or sets the X value.
int Y [get, set]
 Gets or sets the Y value.
bool IsEmpty [get]
 Returns true if X and Y are zero.


Detailed Description

Replacement for System.Drawing.Point structure.


Constructor & Destructor Documentation

AgateLib.Geometry.Point.Point ( int  x,
int  y 
)

Constructs a point.

Parameters:
x 
y 

AgateLib.Geometry.Point.Point ( Point  pt  ) 

Constructs a point.

Parameters:
pt 

AgateLib.Geometry.Point.Point ( Size  size  ) 

Constructs a point.

Parameters:
size 


Member Function Documentation

static Point AgateLib.Geometry.Point.Add ( Point  pt,
Size  size 
) [static]

Adds the specified size object to the specified point object and returns the new point.

Parameters:
pt 
size 
Returns:

static Point AgateLib.Geometry.Point.Ceiling ( PointF  pt  )  [static]

Rounds the PointF object up.

Parameters:
pt 
Returns:

bool AgateLib.Geometry.Point.Equals ( Point  obj  ) 

Equality test.

Parameters:
obj 
Returns:

override bool AgateLib.Geometry.Point.Equals ( object  obj  ) 

Equality test.

Parameters:
obj 
Returns:

override int AgateLib.Geometry.Point.GetHashCode (  ) 

Gets a hash code.

Returns:

static AgateLib.Geometry.Point.operator PointF ( Point  a  )  [explicit, static]

Explicitly converts a point to a pointf structure.

Parameters:
a 
Returns:

static bool AgateLib.Geometry.Point.operator!= ( Point  a,
Point  b 
) [static]

Inequality comparison test.

Parameters:
a 
b 
Returns:

static bool AgateLib.Geometry.Point.operator== ( Point  a,
Point  b 
) [static]

Equality comparison test.

Parameters:
a 
b 
Returns:

static Point AgateLib.Geometry.Point.Round ( PointF  pt  )  [static]

Rounds the PointF object to the nearest integer.

Parameters:
pt 
Returns:

override string AgateLib.Geometry.Point.ToString (  ) 

Creates a string representing this object.

Returns:


Member Data Documentation

readonly Point AgateLib.Geometry.Point.Empty = new Point(0, 0) [static]

Empty point.


Property Documentation

bool AgateLib.Geometry.Point.IsEmpty [get]

Returns true if X and Y are zero.

int AgateLib.Geometry.Point.X [get, set]

Gets or sets the X value.

int AgateLib.Geometry.Point.Y [get, set]

Gets or sets the Y value.


The documentation for this struct was generated from the following file:
AgateLib
Awesome Game and Tool Engine Library
SourceForge.net Logo