AgateLib.Geometry.RectangleF Struct Reference

Replacement for System.Drawing.RectangleF structure. More...

List of all members.

Public Member Functions

 RectangleF (float x, float y, float width, float height)
 Constructs a RectangleF.
 RectangleF (PointF pt, SizeF sz)
 Construts a RectangleF.
 RectangleF (System.Drawing.RectangleF rect)
 Constructs a RectangleF.
bool Contains (int x, int y)
 Returns true if the RectangleF contains the specified PointF.
bool Contains (PointF pt)
 Returns true if the RectangleF contains the specified PointF.
bool Contains (RectangleF rect)
 Returns true if the RectangleF entirely contains the specified RectangleF.
override int GetHashCode ()
 Gets a hash code.
override string ToString ()
 Creates a string representing this RectangleF.
override bool Equals (object obj)
 Equality test.
bool Equals (RectangleF obj)
 Equality test.
bool IntersectsWith (RectangleF rect)
 Returns true if this intersects another RectangleF.

Static Public Member Functions

static RectangleF FromLTRB (float left, float top, float right, float bottom)
 Static method which returns a RectangleF with specified left, top, right and bottom.
static bool operator== (RectangleF a, RectangleF b)
 Equality comparison test.
static bool operator!= (RectangleF a, RectangleF b)
 Inequality comparison test.
static RectangleF Intersect (RectangleF a, RectangleF b)
 Static method returning the intersection of two RectangleFs.
static operator System.Drawing.RectangleF (RectangleF rect)
 For inter-op with System.Drawing.

Public Attributes

PointF pt
SizeF sz

Static Public Attributes

static readonly RectangleF Empty = new RectangleF(0, 0, 0, 0)
 Empty RectangleF.

Properties

float X [get, set]
 X value.
float Y [get, set]
 Y value.
float Width [get, set]
 Width.
float Height [get, set]
 Height.
float Bottom [get]
 Gets bottom.
float Left [get]
 Gets left.
float Top [get]
 Gets top.
float Right [get]
 Gets right.
PointF Location [get, set]
 Gets or sets top-left PointF.
SizeF Size [get, set]
 Gets or sets SizeF.
bool IsEmpty [get]
 True if this is (0,0,0,0).


Detailed Description

Replacement for System.Drawing.RectangleF structure.


Constructor & Destructor Documentation

AgateLib.Geometry.RectangleF.RectangleF ( float  x,
float  y,
float  width,
float  height 
)

Constructs a RectangleF.

Parameters:
x 
y 
width 
height 

AgateLib.Geometry.RectangleF.RectangleF ( PointF  pt,
SizeF  sz 
)

Construts a RectangleF.

Parameters:
pt 
sz 

AgateLib.Geometry.RectangleF.RectangleF ( System.Drawing.RectangleF  rect  ) 

Constructs a RectangleF.

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

Parameters:
rect 


Member Function Documentation

bool AgateLib.Geometry.RectangleF.Contains ( RectangleF  rect  ) 

Returns true if the RectangleF entirely contains the specified RectangleF.

Parameters:
rect 
Returns:

bool AgateLib.Geometry.RectangleF.Contains ( PointF  pt  ) 

Returns true if the RectangleF contains the specified PointF.

Parameters:
pt 
Returns:

bool AgateLib.Geometry.RectangleF.Contains ( int  x,
int  y 
)

Returns true if the RectangleF contains the specified PointF.

Parameters:
x 
y 
Returns:

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

Equality test.

Parameters:
obj 
Returns:

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

Equality test.

Parameters:
obj 
Returns:

static RectangleF AgateLib.Geometry.RectangleF.FromLTRB ( float  left,
float  top,
float  right,
float  bottom 
) [static]

Static method which returns a RectangleF with specified left, top, right and bottom.

Parameters:
left 
top 
right 
bottom 
Returns:

override int AgateLib.Geometry.RectangleF.GetHashCode (  ) 

Gets a hash code.

Returns:

static RectangleF AgateLib.Geometry.RectangleF.Intersect ( RectangleF  a,
RectangleF  b 
) [static]

Static method returning the intersection of two RectangleFs.

Parameters:
a 
b 
Returns:

bool AgateLib.Geometry.RectangleF.IntersectsWith ( RectangleF  rect  ) 

Returns true if this intersects another RectangleF.

Parameters:
rect 
Returns:

static AgateLib.Geometry.RectangleF.operator System.Drawing.RectangleF ( RectangleF  rect  )  [explicit, static]

For inter-op with System.Drawing.

Parameters:
rect 
Returns:

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

Inequality comparison test.

Parameters:
a 
b 
Returns:

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

Equality comparison test.

Parameters:
a 
b 
Returns:

override string AgateLib.Geometry.RectangleF.ToString (  ) 

Creates a string representing this RectangleF.

Returns:


Member Data Documentation

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

Empty RectangleF.


Property Documentation

float AgateLib.Geometry.RectangleF.Bottom [get]

Gets bottom.

float AgateLib.Geometry.RectangleF.Height [get, set]

Height.

bool AgateLib.Geometry.RectangleF.IsEmpty [get]

True if this is (0,0,0,0).

float AgateLib.Geometry.RectangleF.Left [get]

Gets left.

PointF AgateLib.Geometry.RectangleF.Location [get, set]

Gets or sets top-left PointF.

float AgateLib.Geometry.RectangleF.Right [get]

Gets right.

SizeF AgateLib.Geometry.RectangleF.Size [get, set]

Gets or sets SizeF.

float AgateLib.Geometry.RectangleF.Top [get]

Gets top.

float AgateLib.Geometry.RectangleF.Width [get, set]

Width.

float AgateLib.Geometry.RectangleF.X [get, set]

X value.

float AgateLib.Geometry.RectangleF.Y [get, set]

Y value.


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