Rectangle Class Reference

Inheritance diagram for Rectangle:

Public Member Functions
	Rectangle ()
	Initializes a new instance of the Rectangle class with default values (0, 0, 0, 0).
	Rectangle (int x, int y, uint width, uint height)
	Initializes a new instance of the Rectangle class with specified integer coordinates and dimensions.
	Rectangle (Point point, Size size)
	Initializes a new instance of the Rectangle class with location and size.
override bool	Equals (object? obj)
	Determines whether the specified object is equal to the current RectangleT<TPosition,TSize>.
override int	GetHashCode ()
	Returns a hash code for the current point.
override string	ToString ()
	Returns a string representation of the rectangle.

Properties
TPosition	X [get]
	Gets or sets the X coordinate of the top-left corner of the rectangle.
TPosition	Y [get]
	Gets the Y coordinate of the top-left corner of the rectangle.
TSize	Width [get]
	Gets the width of the rectangle.
TSize	Height [get]
	Gets the height of the rectangle.
PointT< TPosition >	Position [get]
	Gets the position of the rectangle.
SizeT< TSize >	Size [get]
	Gets the size of the rectangle.

Detailed Description

Represents a rectangle with integer coordinates and dimensions.

Since

IDSImaging.Peak.Common 1.3

Definition at line 137 of file Rectangle.cs.

Constructor & Destructor Documentation

Rectangle() [1/3]

Rectangle ( )

inline

Initializes a new instance of the Rectangle class with default values (0, 0, 0, 0).

Definition at line 142 of file Rectangle.cs.

Rectangle() [2/3]

Rectangle ( int x, int y, uint width, uint height )

inline

Initializes a new instance of the Rectangle class with specified integer coordinates and dimensions.

Parameters

x	The X coordinate of the top-left corner of the rectangle.
y	The Y coordinate of the top-left corner of the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.

Definition at line 153 of file Rectangle.cs.

Rectangle() [3/3]

Rectangle ( Point point, Size size )

inline

Initializes a new instance of the Rectangle class with location and size.

Parameters

point	The top-left corner of the rectangle
size	The size of the rectangle

Definition at line 162 of file Rectangle.cs.

Member Function Documentation

Equals()

override bool Equals ( object? obj )

inlineinherited

Determines whether the specified object is equal to the current RectangleT<TPosition,TSize>.

Parameters

obj	The object to compare with the current rectangle.

Returns

true if the objects are equal; otherwise, false.

Definition at line 80 of file Rectangle.cs.

GetHashCode()

override int GetHashCode ( )

inlineinherited

Returns a hash code for the current point.

Definition at line 113 of file Rectangle.cs.

ToString()

override string ToString ( )

inlineinherited

Returns a string representation of the rectangle.

Returns

A string that represents the current rectangle.

Definition at line 122 of file Rectangle.cs.

Property Documentation

Height

TSize Height

getinherited

Gets the height of the rectangle.

Definition at line 63 of file Rectangle.cs.

Position

PointT<TPosition> Position

getinherited

Gets the position of the rectangle.

Definition at line 68 of file Rectangle.cs.

Size

SizeT<TSize> Size

getinherited

Gets the size of the rectangle.

Definition at line 73 of file Rectangle.cs.

Width

TSize Width

getinherited

Gets the width of the rectangle.

Definition at line 58 of file Rectangle.cs.

X

TPosition X

getinherited

Gets or sets the X coordinate of the top-left corner of the rectangle.

Definition at line 48 of file Rectangle.cs.

Y

TPosition Y

getinherited

Gets the Y coordinate of the top-left corner of the rectangle.

Definition at line 53 of file Rectangle.cs.