Represents a rectangular area of an image defined as single-precision floating point X and Y coordinates of its upper left corner and its width and height. This type should be allocated on stack and passed to functions by value or by reference. Never use System::SmartPtr class to manage objects of this type. More...

#include <rectangle_f.h>

Public Member Functions
	RectangleF ()
	Constructs a new instance of RectangleF object that represents a rectangle with X and Y coordinates and width and hegiht values set to 0. More...

	RectangleF (float x, float y, float width, float height)
	Constructs a new instance of RectangleF object that represents a rectangle with the specified coordinates of its upper left corner and width and height. More...

	RectangleF (const PointF &location, const SizeF &size)
	Constructs a new instance of RectangleF object that represents a rectangle with the coordinates of its upper left corner specified as an instance of PointF class and its width and height as an instance of SizeF class. More...

	RectangleF (const Rectangle &rect)
	Constructs a new instance of RectangleF object that represents the rectangle equivalent to the specified one. More...

PointF	get_Location () const
	Returns an instance of the PointF class that specifies the location of the upper left corner of the rectangle represented by the current object. More...

void	set_Location (PointF value)
	Sets the location of the upper left corner of the rectangle represented by the current object. More...

SizeF	get_Size () const
	Returns an instance of the SizeF class that specifies the width and height of the rectangle represented by the current object. More...

void	set_Size (SizeF value)
	Sets the width and height of the rectangle represented by the current object. More...

float	get_X () const
	Returns the X coordinate of the upper left corner of the rectangle represented by the current object. More...

void	set_X (float value)
	Sets the X coordinate of the upper left corner of the rectangle represented by the current object. More...

float	get_Y () const
	Returns the Y coordinate of the upper left corner of the rectangle represented by the current object. More...

void	set_Y (float value)
	Sets the Y coordinate of the upper left corner of the rectangle represented by the current object. More...

float	get_Width () const
	Returns the width of the rectangle represented by the current object. More...

void	set_Width (float value)
	Sets the width of the rectangle represented by the current object. More...

float	get_Height () const
	Returns the height of the rectangle represented by the current object. More...

void	set_Height (float value)
	Sets the height of the rectangle represented by the current object. More...

float	get_Left () const
	Returns the X coordinate of the left edge of the rectangle represented by the current object. More...

float	get_Top () const
	Returns the Y coordinate of the top edge of the rectangle represented by the current object. More...

float	get_Right () const
	Returns the X coordinate of the right edge of the rectangle represented by the current object. More...

float	get_Bottom () const
	Returns the y coordinate of the bottom edge of the rectangle represented by the current object. More...

bool	get_IsEmpty () const
	Determines if X and Y coordinates of the upper left corner of the recangle represented by the current object as well as its width and height have values of 0. More...

bool	Equals (const RectangleF &rect) const
	Determines if the rectangles represented by the current and the specified objects are identical. More...

bool	Contains (float x, float y)
	Determines if the specified point is located within the rectangle represented by the current object. More...

bool	Contains (const PointF &point)
	Determines if the specified point is located within the rectangle represented by the current object. More...

bool	Contains (const RectangleF &rect)
	Determines if the specified rectangle is located within the rectangle represented by the current object. More...

void	Inflate (float width, float height)
	Increases the width and height of the rectangle represented by the current object, maintaining the location of the geometrical center of the rectangle. The width and height are increased in both directions by the specified amounts. More...

void	Inflate (const SizeF &size)
	Increases the width and height of the rectangle represented by the current object, maintaining the location of the geometrical center of the rectangle. The width and height are increased in both directions by the amounts specified by width and height values of the specified size object correspondingly. More...

void	Intersect (const RectangleF &rect)
	Replaces the rectangle represented by the current object with the rectangle that results from the its intersection with the rectangle represented by the specified object. More...

bool	IntersectsWith (const RectangleF &rect)
	Determines if the rectangles represented by the current and specified objects intesect. More...

void	Offset (const PointF &pos)
	Offsets the position of the rectangle represented by the current object by the specified amounts. More...

void	Offset (float x, float y)
	Offsets the position of the rectangle represented by the current object by the specified amounts. More...

bool	operator== (std::nullptr_t) const
	Always returns false. More...

bool	operator!= (std::nullptr_t) const
	Always returns true. More...

int	GetHashCode () const
	Returns a hash code of the current object. More...

System::String	ToString () const
	Returns the string representation of the current object. More...

Static Public Member Functions
static RectangleF	FromLTRB (float left, float top, float right, float bottom)
	Constructs a new RectangleF object that represents a rectangle with the specified edge locations. More...

static RectangleF	Inflate (const RectangleF &rect, float x, float y)
	Increases the width and height of the rectangle represented by the specified object, maintaining the location of the geometrical center of the rectangle. The width and height are increased in both directions by the specified amounts. More...

static RectangleF	Intersect (const RectangleF &a, const RectangleF &b)
	Returns a rectangle that is a result of intersection of the specified rectangles. More...

static RectangleF	Union (const RectangleF &a, const RectangleF &b)
	Returns a rectangle that is a result of union of the specified rectangles. More...

Static Public Attributes
static const RectangleF	Empty
	An empty rectangle i.e. a rectangle whose location and size values have zero values. More...

Detailed Description

Represents a rectangular area of an image defined as single-precision floating point X and Y coordinates of its upper left corner and its width and height. This type should be allocated on stack and passed to functions by value or by reference. Never use System::SmartPtr class to manage objects of this type.

Constructor & Destructor Documentation

◆ RectangleF() [1/4]

System::Drawing::RectangleF::RectangleF ( )

Constructs a new instance of RectangleF object that represents a rectangle with X and Y coordinates and width and hegiht values set to 0.

◆ RectangleF() [2/4]

System::Drawing::RectangleF::RectangleF	(	float	x,
		float	y,
		float	width,
		float	height
	)

Constructs a new instance of RectangleF object that represents a rectangle with the specified coordinates of its upper left corner and width and height.

Parameters

x	A value of the X coordinate of the upper left corner of the rectangle
y	A value of the Y coordinate of the upper left corner of the rectangle
width	The width of the rectangle
height	The height of the rectangle

◆ RectangleF() [3/4]

System::Drawing::RectangleF::RectangleF	(	const PointF &	location,
		const SizeF &	size
	)

Constructs a new instance of RectangleF object that represents a rectangle with the coordinates of its upper left corner specified as an instance of PointF class and its width and height as an instance of SizeF class.

Parameters

location	Specifies the location of the upper left corner of the rectangle
size	Specifies the width and hegiht of the rectangle

◆ RectangleF() [4/4]

System::Drawing::RectangleF::RectangleF ( const Rectangle & rect )

explicit

Constructs a new instance of RectangleF object that represents the rectangle equivalent to the specified one.

Parameters

rect	An instance of Rectangle class that specifies the position and size of the rectangle to be represented by the object being constructed

Member Function Documentation

◆ Contains() [1/3]

bool System::Drawing::RectangleF::Contains ( const PointF & point )

Determines if the specified point is located within the rectangle represented by the current object.

Parameters

point A point to check

Returns: True if the specified point is located within the rectangle represented by the current object, otherwise - false

◆ Contains() [2/3]

bool System::Drawing::RectangleF::Contains ( const RectangleF & rect )

Determines if the specified rectangle is located within the rectangle represented by the current object.

Parameters

rect	A rectangle to check

Returns: True if the specified rectangle is located within the rectangle represented by the current object, otherwise - false

◆ Contains() [3/3]

bool System::Drawing::RectangleF::Contains	(	float	x,
		float	y
	)

Determines if the specified point is located within the rectangle represented by the current object.

Parameters

x	The X coordinate of the point to check
y	The Y coordinate of the point to check

Returns: True if the specified point is located within the rectangle represented by the current object, otherwise - false

◆ Equals()

bool System::Drawing::RectangleF::Equals ( const RectangleF & rect ) const

Determines if the rectangles represented by the current and the specified objects are identical.

Parameters

rect	The RectangleF object to compare the current object with

Returns: True if the rectangles represented by the current and the specified objects are identical, otherwise - false

◆ FromLTRB()

static RectangleF System::Drawing::RectangleF::FromLTRB	(	float	left,
		float	top,
		float	right,
		float	bottom
	)

inlinestatic

Constructs a new RectangleF object that represents a rectangle with the specified edge locations.

Parameters

left	The X coordinate of the left edge of the rectangle
top	The Y coordinate of the top edge of the rectangle
right	The X coordinate of the right edge of the rectangle
bottom	The Y coordinate of the bottom edge of the rectangle

Returns: An instance of RectangleF class that represents the speified rectangle

◆ get_Bottom()

float System::Drawing::RectangleF::get_Bottom ( ) const

inline

Returns the y coordinate of the bottom edge of the rectangle represented by the current object.

◆ get_Height()

float System::Drawing::RectangleF::get_Height ( ) const

inline

Returns the height of the rectangle represented by the current object.

◆ get_IsEmpty()

bool System::Drawing::RectangleF::get_IsEmpty ( ) const

inline

Determines if X and Y coordinates of the upper left corner of the recangle represented by the current object as well as its width and height have values of 0.

Returns: True if X and Y coordinates of the upper left corner of the recangle represented by the current object as well as its width and height have values of 0, otherwise - false

◆ get_Left()

float System::Drawing::RectangleF::get_Left ( ) const

inline

Returns the X coordinate of the left edge of the rectangle represented by the current object.

◆ get_Location()

PointF System::Drawing::RectangleF::get_Location ( ) const

inline

Returns an instance of the PointF class that specifies the location of the upper left corner of the rectangle represented by the current object.

◆ get_Right()

float System::Drawing::RectangleF::get_Right ( ) const

inline

Returns the X coordinate of the right edge of the rectangle represented by the current object.

◆ get_Size()

SizeF System::Drawing::RectangleF::get_Size ( ) const

inline

Returns an instance of the SizeF class that specifies the width and height of the rectangle represented by the current object.

◆ get_Top()

float System::Drawing::RectangleF::get_Top ( ) const

inline

Returns the Y coordinate of the top edge of the rectangle represented by the current object.

◆ get_Width()

float System::Drawing::RectangleF::get_Width ( ) const

inline

Returns the width of the rectangle represented by the current object.

◆ get_X()

float System::Drawing::RectangleF::get_X ( ) const

inline

Returns the X coordinate of the upper left corner of the rectangle represented by the current object.

◆ get_Y()

float System::Drawing::RectangleF::get_Y ( ) const

inline

Returns the Y coordinate of the upper left corner of the rectangle represented by the current object.

◆ GetHashCode()

int System::Drawing::RectangleF::GetHashCode ( ) const

Returns a hash code of the current object.

◆ Inflate() [1/3]

static RectangleF System::Drawing::RectangleF::Inflate	(	const RectangleF &	rect,
		float	x,
		float	y
	)

static

Increases the width and height of the rectangle represented by the specified object, maintaining the location of the geometrical center of the rectangle. The width and height are increased in both directions by the specified amounts.

Parameters

rect	A rectangle to inflate
x	The amount by which the width of the rectangle is to be increased in both directions
y	The amount by which the height of the rectangle is to be increased in both directions

Returns: The RectangleF object representing the enlarged rectangle

◆ Inflate() [2/3]

void System::Drawing::RectangleF::Inflate ( const SizeF & size )

Increases the width and height of the rectangle represented by the current object, maintaining the location of the geometrical center of the rectangle. The width and height are increased in both directions by the amounts specified by width and height values of the specified size object correspondingly.

Parameters

size	The SizeF object specifying the amounts to increase the width and height of the rectangle by

◆ Inflate() [3/3]

void System::Drawing::RectangleF::Inflate	(	float	width,
		float	height
	)

Increases the width and height of the rectangle represented by the current object, maintaining the location of the geometrical center of the rectangle. The width and height are increased in both directions by the specified amounts.

Parameters

width	The amount by which the width of the rectangle is to be increased in both directions
height	The amount by which the height of the rectangle is to be increased in both directions

◆ Intersect() [1/2]

static RectangleF System::Drawing::RectangleF::Intersect	(	const RectangleF &	a,
		const RectangleF &	b
	)

static

Returns a rectangle that is a result of intersection of the specified rectangles.

Parameters

a	The first rectangle to intersect
b	The second rectangle to intersect

Returns: The result of intersection of a with b

◆ Intersect() [2/2]

void System::Drawing::RectangleF::Intersect ( const RectangleF & rect )

Replaces the rectangle represented by the current object with the rectangle that results from the its intersection with the rectangle represented by the specified object.

Parameters

rect	The RectangleF object that represents the rectangle to intersect the rectangle represented by the current object with

◆ IntersectsWith()

bool System::Drawing::RectangleF::IntersectsWith ( const RectangleF & rect )

Determines if the rectangles represented by the current and specified objects intesect.

Parameters

rect	The rectangle to check

Returns: True if the rectangles represented by the current object and rect intersect, otherwise - false

◆ Offset() [1/2]

void System::Drawing::RectangleF::Offset ( const PointF & pos )

Offsets the position of the rectangle represented by the current object by the specified amounts.

Parameters

pos The PointF object that specifies the amount by which the rectangle is offset; the point's X coordinat value specifies the amount to add to the X coordinate of the upper left corner of the rectangle and the point's Y coordinate specifies the amount to add to the Y coordinate of the upper left corner of the rectangle

◆ Offset() [2/2]

void System::Drawing::RectangleF::Offset	(	float	x,
		float	y
	)

Offsets the position of the rectangle represented by the current object by the specified amounts.

Parameters

x	The value to add to the current X coordinate of the rectangle
y	The value to add to the current Y coordinate of the rectangle

◆ operator!=()

bool System::Drawing::RectangleF::operator!= ( std::nullptr_t ) const

inline

Always returns true.

◆ operator==()

bool System::Drawing::RectangleF::operator== ( std::nullptr_t ) const

inline

Always returns false.

◆ set_Height()

void System::Drawing::RectangleF::set_Height ( float value )

inline

Sets the height of the rectangle represented by the current object.

Parameters

value The value to set

◆ set_Location()

void System::Drawing::RectangleF::set_Location ( PointF value )

inline

Sets the location of the upper left corner of the rectangle represented by the current object.

Parameters

value The value to set

◆ set_Size()

void System::Drawing::RectangleF::set_Size ( SizeF value )

inline

Sets the width and height of the rectangle represented by the current object.

Parameters

value An instance of SizeF class specifying the width and height values to set

◆ set_Width()

void System::Drawing::RectangleF::set_Width ( float value )

inline

Sets the width of the rectangle represented by the current object.

Parameters

value The value to set

◆ set_X()

void System::Drawing::RectangleF::set_X ( float value )

inline

Sets the X coordinate of the upper left corner of the rectangle represented by the current object.

Parameters

value The value to set

◆ set_Y()

void System::Drawing::RectangleF::set_Y ( float value )

inline

Sets the Y coordinate of the upper left corner of the rectangle represented by the current object.

Parameters

value The value to set

◆ ToString()

System::String System::Drawing::RectangleF::ToString ( ) const

inline

Returns the string representation of the current object.

◆ Union()

static RectangleF System::Drawing::RectangleF::Union	(	const RectangleF &	a,
		const RectangleF &	b
	)

static

Returns a rectangle that is a result of union of the specified rectangles.

Parameters

a	The first rectangle to union
b	The second rectangle to union

Returns: The result of union of a with b

Member Data Documentation

◆ Empty

const RectangleF System::Drawing::RectangleF::Empty

static

An empty rectangle i.e. a rectangle whose location and size values have zero values.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RectangleF() [1/4]

◆ RectangleF() [2/4]

◆ RectangleF() [3/4]

◆ RectangleF() [4/4]

Member Function Documentation

◆ Contains() [1/3]

◆ Contains() [2/3]

◆ Contains() [3/3]

◆ Equals()

◆ FromLTRB()

◆ get_Bottom()

◆ get_Height()

◆ get_IsEmpty()

◆ get_Left()

◆ get_Location()

◆ get_Right()

◆ get_Size()

◆ get_Top()

◆ get_Width()

◆ get_X()

◆ get_Y()

◆ GetHashCode()

◆ Inflate() [1/3]

◆ Inflate() [2/3]

◆ Inflate() [3/3]

◆ Intersect() [1/2]

◆ Intersect() [2/2]

◆ IntersectsWith()

◆ Offset() [1/2]

◆ Offset() [2/2]

◆ operator!=()

◆ operator==()

◆ set_Height()

◆ set_Location()

◆ set_Size()

◆ set_Width()

◆ set_X()

◆ set_Y()

◆ ToString()

◆ Union()

Member Data Documentation

◆ Empty