ERY.AgateLib.Geometry.Point

ERY.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.
 Point (System.Drawing.Point pt)
 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 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.
static operator System.Drawing.Point (Point pt)
 Explicit conversion to System.Drawing.Point object.

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

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

Constructs a point.

Parameters:
x 
y 

ERY.AgateLib.Geometry.Point.Point ( Point  pt  ) 

Constructs a point.

Parameters:
pt 

ERY.AgateLib.Geometry.Point.Point ( Size  size  ) 

Constructs a point.

Parameters:
size 

ERY.AgateLib.Geometry.Point.Point ( System.Drawing.Point  pt  ) 

Constructs a point.

[Experimental - The API is likely to change in the future.]

Parameters:
pt 

Member Function Documentation

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

Equality comparison test.

Parameters:
a 
b 
Returns:

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

Inequality comparison test.

Parameters:
a 
b 
Returns:

override int ERY.AgateLib.Geometry.Point.GetHashCode (  ) 

Gets a hash code.

Returns:

override string ERY.AgateLib.Geometry.Point.ToString (  ) 

Creates a string representing this object.

Returns:

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

Equality test.

Parameters:
obj 
Returns:

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

Equality test.

Parameters:
obj 
Returns:

static Point ERY.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 ERY.AgateLib.Geometry.Point.Ceiling ( PointF  pt  )  [static]

Rounds the PointF object up.

Parameters:
pt 
Returns:

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

Rounds the PointF object to the nearest integer.

Parameters:
pt 
Returns:

static ERY.AgateLib.Geometry.Point.operator System.Drawing.Point ( Point  pt  )  [explicit, static]

Explicit conversion to System.Drawing.Point object.

Parameters:
pt 
Returns:

Member Data Documentation

int ERY.AgateLib.Geometry.Point.x

int ERY.AgateLib.Geometry.Point.y

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

Empty point.

Property Documentation

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

Gets or sets the X value.

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

Gets or sets the Y value.

bool ERY.AgateLib.Geometry.Point.IsEmpty [get]

Returns true if X and Y are zero.

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