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

Constructor & Destructor Documentation

Rectangle() [1/3]

Rectangle ( )

inline

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

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.

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

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.

GetHashCode()

override int GetHashCode ( )

inlineinherited

Returns a hash code for the current point.

ToString()

override string ToString ( )

inlineinherited

Returns a string representation of the rectangle.

Returns

A string that represents the current rectangle.

Property Documentation

Height

TSize Height

getinherited

Gets the height of the rectangle.

Position

PointT<TPosition> Position

getinherited

Gets the position of the rectangle.

Size

SizeT<TSize> Size

getinherited

Gets the size of the rectangle.

Width

TSize Width

getinherited

Gets the width of the rectangle.

X

TPosition X

getinherited

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

Y

TPosition Y

getinherited

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