xtd::drawing::rectangle Class Reference

Inheritance diagram for xtd::drawing::rectangle:

Definition

Stores a set of four integers that represent the location and size of a rectangle.

class drawing_export_ rectangle : public xtd::object

Inheritance

xtd::object → xtd::drawing::rectangle

Namespace

xtd::drawing

Library

xtd.drawing

Examples

The following example draws a rectangle with its upper-left corner at (10, 10). The rectangle has a width of 100 and a height of 50. The second argument passed to the Pen constructor indicates that the pen width is 5 pixels.

When the rectangle is drawn, the pen is centered on the rectangle's boundary. Because the pen width is 5, the sides of the rectangle are drawn 5 pixels wide, such that 1 pixel is drawn on the boundary itself, 2 pixels are drawn on the inside, and 2 pixels are drawn on the outside. For more details on pen alignment, see How to: Set Pen Width and Alignment.

The following illustration shows the resulting rectangle. The dotted lines show where the rectangle would have been drawn if the pen width had been one pixel. The enlarged view of the upper-left corner of the rectangle shows that the thick black lines are centered on those dotted lines.

The example is designed for use with xtd.forms, and it requires xtd::forms::paint_event_args e, which is a parameter of the xtd::forms::control::paint event handler.

pen black_pen(color::from_argb(255, 0, 0, 0), 5);
e.graphics().draw_rectangle(black_pen, 10, 10, 100, 50);

Remarks

A rectangle is defined by its xtd::drawing::rectangle::width, xtd::drawing::rectangle::height, and upper-left corner represented by the xtd::drawing::rectangle::location property.

To draw rectangles, you need a xtd::drawing::graphics object and a xtd::drawing::pen object. The xtd::drawing::graphics object provides the xtd::drawing::graphics::draw_rectangle method, and the xtd::drawing::pen object stores features of the line, such as color and width. The units the rectangle is drawn in is determined by the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale properties of the graphics object used for drawing. The default unit is pixels.

To draw a xtd::drawing::rectangle filled with color, you need a xtd::drawing::graphics object and an object derived from xtd::drawing::brush such as xtd::drawing::solid_brush or xtd::drawing::texture_brush or xtd::drawing::drawing_2d::conical_gradient_brush or xtd::drawing::drawing_2d::hatch_gradient_brush or xtd::drawing::drawing_2d::linear_gradient_brush or xtd::drawing::drawing_2d::radial_gradient_brush. The xtd::drawing::graphics object provides the xtd::drawing::graphics::fill_rectangle method and the xtd::drawing::brush object provides the color and fill information.

For more advanced shapes, use a xtd::drawing::region object.

Examples

border_style.cpp, draw_image.cpp, fill_ellipse.cpp, fill_rectangle.cpp, fill_rounded_rectangle.cpp, form_paint.cpp, graph_control.cpp, graphics.cpp, image_converter.cpp, minesweeper.cpp, owner_button.cpp, painting.cpp, screen.cpp, and user_control.cpp.

Public Member Functions
void	inflate (const drawing::size &sz) noexcept
	Enlarges this xtd::drawing::rectangle by the specified amount.
void	inflate (int32 width, int32 height) noexcept
	Enlarges this xtd::drawing::rectangle by the specified amount.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< rectangle >
virtual bool	equals (const rectangle &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.

Public Fields
static const rectangle	empty
	Represents a xtd::drawing::rectangle that has xtd::drawing::rectagle::x, xtd::drawing::rectangle::y, xtd::drawing::rectangle::width and xtd::drawing::rectangle::height values set to zero.

Public Constructors
	rectangle () noexcept=default
	Initializes a new instance of the xtd::drawing::rectangle class.
	rectangle (int32 x, int32 y, int32 width, int32 height) noexcept
	Initializes a new instance of the xtd::drawing::rectangle class with the specified location and size.
	rectangle (const xtd::drawing::point &location, const xtd::drawing::size &size) noexcept
	Initializes a new instance of the xtd::drawing::rectangle class with the specified location and size.

Public Properties
int32	bottom () const noexcept
	Gets the y-coordinate that is the sum of the xtd::drawing::rectangle::y and xtd::drawing::rectangle::height property values of this xtd::drawing::rectangle structure.
point	center () const noexcept
	Gets the center property values of this xtd::drawing::rectangle structure.
int32	height () const noexcept
	Gets the height of this xtd::drawing::rectangle structure.
void	height (int32 value) noexcept
	Sets the height of this xtd::drawing::rectangle structure.
bool	is_empty () const noexcept
	Tests whether all numeric properties of this xtd::drawing::rectangle have values of zero.
int32	left () const noexcept
	Gets the x-coordinate of the left edge of this xtd::drawing::rectangle structure.
xtd::drawing::point	location () const noexcept
	Gets the coordinates of the upper-left corner of this xtd::drawing::rectangle structure.
void	location (const xtd::drawing::point &value) noexcept
	Sets the coordinates of the upper-left corner of this xtd::drawing::rectangle structure.
int32	right () const noexcept
	Gets the x-coordinate that is the sum of xtd::drawing::rectangle::x and xtd::drawing::rectangle::width property values of this xtd::drawing::rectangle structure.
xtd::drawing::size	size () const noexcept
	Gets the size of this xtd::drawing::rectangle.
void	size (const xtd::drawing::size &value) noexcept
	Sets the size of this xtd::drawing::rectangle.
int32	top () const noexcept
	Gets the y-coordinate of the top edge of this xtd::drawing::rectangle structure.
int32	width () const noexcept
	Gets the width of this xtd::drawing::rectangle structure.
void	width (int32 value) noexcept
	Sets the width of this xtd::drawing::rectangle structure.
int32	x () const noexcept
	Gets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.
void	x (int32 value) noexcept
	Sets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.
int32	y () const noexcept
	Gets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.
void	y (int32 value) noexcept
	Sets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.

Public Methods
void	add (const drawing::size &sz) noexcept
	Adds this xtd::drawing::rectangle by the specified amount.
void	add (int32 width, int32 height) noexcept
	Adds this xtd::drawing::rectangle by the specified amount.
bool	contains (const xtd::drawing::point &pt) const noexcept
	Determines if the specified point is contained within this xtd::drawing::rectangle structure.
bool	contains (const xtd::drawing::rectangle &rect) const noexcept
	Determines if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle structure.
bool	contains (int32 x, int32 y) const noexcept
	Determines if the specified point is contained within this xtd::drawing::rectangle structure.
bool	equals (const rectangle &value) const noexcept override
bool	intersects_with (const rectangle &rect) const noexcept
	Determines if this rectangle intersects with rect.
void	make_intersect (const rectangle &rect) noexcept
	Replaces this xtd::drawing::rectangle with the intersection of itself and the specified xtd::drawing::rectangle.
void	make_union (const rectangle &rect) noexcept
	Replaces this xtd::drawing::rectangle with the union of itself and the specified xtd::drawing::rectangle.
void	offset (const point &pos) noexcept
	Adjusts the location of this rectangle by the specified amount.
void	offset (int32 x, int32 y) noexcept
	Adjusts the location of this rectangle by the specified amount.
xtd::string	to_string () const noexcept override
	Converts the attributes of this xtd::drawing::rectangle to a human-readable string.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.

Public Static Methods
static rectangle	add (const rectangle &rect, int32 x, int32 y) noexcept
	Creates and returns an added copy of the specified xtd::drawing::rectangle structure. The copy is added by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.
static rectangle	add (const rectangle &rect, const drawing::size &sz) noexcept
	Creates and returns an added copy of the specified xtd::drawing::rectangle structure. The copy is added by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.
static rectangle	ceiling (const xtd::drawing::rectangle_f &rect) noexcept
	Converts the specified xtd::drawing::rectangle_f structure to a xtd::drawing::rectangle structure by rounding the xtd::drawing::rectangle_f values to the next higher integer values.
static rectangle	from_ltrb (int32 left, int32 top, int32 right, int32 bottom) noexcept
	Creates a xtd::drawing::rectangle structure with the specified edge locations.
static rectangle	inflate (const rectangle &rect, int32 x, int32 y) noexcept
	Creates and returns an enlarged copy of the specified xtd::drawing::rectangle structure. The copy is enlarged by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.
static rectangle	inflate (const rectangle &rect, const drawing::size &sz) noexcept
	Creates and returns an enlarged copy of the specified xtd::drawing::rectangle structure. The copy is enlarged by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.
static rectangle	make_intersect (const rectangle &a, const rectangle &b) noexcept
	Returns a third xtd::drawing::rectangle structure that represents the intersection of two other xtd::drawing::rectangle structures. If there is no intersection, an empty xtd::drawing::rectangle is returned.
static rectangle	make_union (const rectangle &a, const rectangle &b) noexcept
	Gets a xtd::drawing::rectangle structure that contains the union of two xtd::drawing::rectangle structures.
static rectangle	offset (const rectangle &rect, const point &pos) noexcept
	Creates and returns an offsetted copy of the specified xtd::drawing::rectangle structure. The copy is offsetted by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.
static rectangle	offset (const rectangle &rect, int32 x, int32 y) noexcept
	Creates and returns an offsetted copy of the specified xtd::drawing::rectangle structure. The copy is offsetted by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.
static rectangle	round (const rectangle_f &rect) noexcept
	Converts the specified xtd::drawing::rectangle_f to a xtd::drawing::rectangle by rounding the xtd::drawing::rectangle_f values to the nearest integer values.
static rectangle	truncate (const rectangle_f &rect) noexcept
	Converts the specified xtd::drawing::rectangle_f to a xtd::drawing::rectangle by truncating the xtd::drawing::rectangle_f values.

Additional Inherited Members
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

rectangle() [1/3]

xtd::drawing::rectangle::rectangle ( )

defaultnoexcept

Initializes a new instance of the xtd::drawing::rectangle class.

Remarks

xtd::drawing::rectagle::x, xtd::drawing::rectangle::y, xtd::drawing::rectangle::width and xtd::drawing::rectangle::height values are set to zero.

rectangle() [2/3]

xtd::drawing::rectangle::rectangle ( int32  x, int32  y, int32  width, int32  height  )

noexcept

Initializes a new instance of the xtd::drawing::rectangle class with the specified location and size.

Parameters

x	The x-coordinate of the upper-left corner of the rectangle.
y	The y-coordinate of the upper-left corner of the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.

rectangle() [3/3]

xtd::drawing::rectangle::rectangle ( const xtd::drawing::point &  location, const xtd::drawing::size &  size  )

noexcept

Initializes a new instance of the xtd::drawing::rectangle class with the specified location and size.

Parameters

location	A xtd::drawing::point that represents the upper-left corner of the rectangular region.
size	A xtd::drawing::size that represents the width and height of the rectangular region.

Member Function Documentation

bottom()

int32 xtd::drawing::rectangle::bottom ( ) const

noexcept

Gets the y-coordinate that is the sum of the xtd::drawing::rectangle::y and xtd::drawing::rectangle::height property values of this xtd::drawing::rectangle structure.

Returns

The y-coordinate that is the sum of xtd::drawing::rectangle::y and xtd::drawing::rectangle::height of this xtd::drawing::rectangle.

Remarks

The value of the xtd::drawing::rectangle::bottom property represents the y-coordinate of the first point at the bottom edge of the xtd::drawing::rectangle that is not contained in the xtd::drawing::rectangle.

Examples

graph_control.cpp, and minesweeper.cpp.

center()

point xtd::drawing::rectangle::center ( ) const

noexcept

Gets the center property values of this xtd::drawing::rectangle structure.

Returns

The center of this xtd::drawing::rectangle.

height() [1/2]

int32 xtd::drawing::rectangle::height ( ) const

noexcept

Gets the height of this xtd::drawing::rectangle structure.

Returns

The height of this Rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::height property will also cause a change in the xtd::drawing::rectangle::bottom property of the xtd::drawing::rectangle. The units the rectangle is drawn in is determined by the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale properties of the graphics object used for drawing. The default unit is pixels.

Examples

graph_control.cpp, and minesweeper.cpp.

height() [2/2]

void xtd::drawing::rectangle::height ( int32  value )

noexcept

Sets the height of this xtd::drawing::rectangle structure.

Parameters

value

The height of this Rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::height property will also cause a change in the xtd::drawing::rectangle::bottom property of the xtd::drawing::rectangle. The units the rectangle is drawn in is determined by the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale properties of the graphics object used for drawing. The default unit is pixels.

is_empty()

bool xtd::drawing::rectangle::is_empty ( ) const

noexcept

Tests whether all numeric properties of this xtd::drawing::rectangle have values of zero.

Returns

This property returns true if the xtd::drawing::rectangle::width, xtd::drawing::rectangle::height, xtd::drawing::rectangle::x, and xtd::drawing::rectangle::y properties of this xtd::drawing::rectangle all have values of zero; otherwise, false.

left()

int32 xtd::drawing::rectangle::left ( ) const

noexcept

Gets the x-coordinate of the left edge of this xtd::drawing::rectangle structure.

Returns

The x-coordinate of the left edge of this xtd::drawing::rectangle structure.

Examples

graph_control.cpp, and minesweeper.cpp.

location() [1/2]

xtd::drawing::point xtd::drawing::rectangle::location ( ) const

noexcept

Gets the coordinates of the upper-left corner of this xtd::drawing::rectangle structure.

Returns

A xtd::drawing::point that represents the upper-left corner of this xtd::drawing::rectangle structure.

Examples

screen.cpp.

location() [2/2]

void xtd::drawing::rectangle::location ( const xtd::drawing::point &  value )

noexcept

Sets the coordinates of the upper-left corner of this xtd::drawing::rectangle structure.

Parameters

value

A xtd::drawing::point that represents the upper-left corner of this xtd::drawing::rectangle structure.

right()

int32 xtd::drawing::rectangle::right ( ) const

noexcept

Gets the x-coordinate that is the sum of xtd::drawing::rectangle::x and xtd::drawing::rectangle::width property values of this xtd::drawing::rectangle structure.

Returns

The x-coordinate that is the sum of xtd::drawing::rectangle::x and xtd::drawing::rectangle::width of this xtd::drawing::rectangle.

Examples

graph_control.cpp, and minesweeper.cpp.

size() [1/2]

xtd::drawing::size xtd::drawing::rectangle::size ( ) const

noexcept

Gets the size of this xtd::drawing::rectangle.

Returns

A xtd::drawing::size that represents the width and height of this xtd::drawing::rectangle structure.

Examples

image_converter.cpp, and screen.cpp.

size() [2/2]

void xtd::drawing::rectangle::size ( const xtd::drawing::size &  value )

noexcept

Sets the size of this xtd::drawing::rectangle.

Parameters

value

A xtd::drawing::size that represents the width and height of this xtd::drawing::rectangle structure.

top()

int32 xtd::drawing::rectangle::top ( ) const

noexcept

Gets the y-coordinate of the top edge of this xtd::drawing::rectangle structure.

Returns

The y-coordinate of the top edge of this xtd::drawing::rectangle structure.

Examples

graph_control.cpp, and minesweeper.cpp.

width() [1/2]

int32 xtd::drawing::rectangle::width ( ) const

noexcept

Gets the width of this xtd::drawing::rectangle structure.

Returns

The width of this xtd::drawing::rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::width property will also cause a change in the xtd::drawing::rectangle::bottom property of the xtd::drawing::rectangle. The units the rectangle is drawn in is determined by the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale properties of the graphics object used for drawing. The default unit is pixels.

Examples

graph_control.cpp, graphics.cpp, and minesweeper.cpp.

width() [2/2]

void xtd::drawing::rectangle::width ( int32  value )

noexcept

Sets the width of this xtd::drawing::rectangle structure.

Parameters

value

The width of this xtd::drawing::rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::width property will also cause a change in the xtd::drawing::rectangle::bottom property of the xtd::drawing::rectangle. The units the rectangle is drawn in is determined by the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale properties of the graphics object used for drawing. The default unit is pixels.

x() [1/2]

int32 xtd::drawing::rectangle::x ( ) const

noexcept

Gets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.

Returns

The x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::x property will also cause a change in the xtd::drawing::rectangle::right property of the xtd::drawing::rectangle.

x() [2/2]

void xtd::drawing::rectangle::x ( int32  value )

noexcept

Sets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.

Parameters

value

The x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::x property will also cause a change in the xtd::drawing::rectangle::right property of the xtd::drawing::rectangle.

y() [1/2]

int32 xtd::drawing::rectangle::y ( ) const

noexcept

Gets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.

Returns

The y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::y property will also cause a change in the xtd::drawing::rectangle::bottom property of the xtd::drawing::rectangle.

y() [2/2]

void xtd::drawing::rectangle::y ( int32  value )

noexcept

Sets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.

Parameters

value

The y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure. The default is 0.

Remarks

Changing the xtd::drawing::rectangle::y property will also cause a change in the xtd::drawing::rectangle::bottom property of the xtd::drawing::rectangle.

add() [1/4]

void xtd::drawing::rectangle::add ( const drawing::size &  sz )

noexcept

Adds this xtd::drawing::rectangle by the specified amount.

Parameters

sz	The amount to add this rectangle.

Remarks

This method adds this rectangle, not a copy of it.

add() [2/4]

void xtd::drawing::rectangle::add ( int32  width, int32  height  )

noexcept

Adds this xtd::drawing::rectangle by the specified amount.

Parameters

width	The amount to add this xtd::drawing::rectangle horizontally.
height	The amount to add this xtd::drawing::rectangle verticaly.

Remarks

This method adds this rectangle, not a copy of it.

contains() [1/3]

bool xtd::drawing::rectangle::contains ( const xtd::drawing::point &  pt ) const

noexcept

Determines if the specified point is contained within this xtd::drawing::rectangle structure.

Parameters

pt	The xtd::drawing::point to test.

Returns

This method returns true if the point represented by pt is contained within this xtd::drawing::rectangle structure; otherwise false.

Remarks

The containing rectangle must be normalized for this method to return accurate results.

contains() [2/3]

bool xtd::drawing::rectangle::contains ( const xtd::drawing::rectangle &  rect ) const

noexcept

Determines if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle structure.

Parameters

rect	The xtd::drawing::rectangle to test.

Returns

This method returns true if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle structure; otherwise false.

Remarks

The containing rectangle must be normalized for this method to return accurate results.

contains() [3/3]

bool xtd::drawing::rectangle::contains ( int32  x, int32  y  ) const

noexcept

Determines if the specified point is contained within this xtd::drawing::rectangle structure.

Parameters

x	The x-coordinate of the point to test.
y	The y-coordinate of the point to test.

Returns

This method returns true if the point defined by x and y is contained within this xtd::drawing::rectangle structure; otherwise false.

Remarks

The containing rectangle must be normalized for this method to return accurate results.

intersects_with()

bool xtd::drawing::rectangle::intersects_with ( const rectangle &  rect ) const

noexcept

Determines if this rectangle intersects with rect.

Parameters

rect	The rectangle to test.

Returns

This method returns true if there is any intersection, otherwise false.

make_intersect() [1/2]

void xtd::drawing::rectangle::make_intersect ( const rectangle &  rect )

noexcept

Replaces this xtd::drawing::rectangle with the intersection of itself and the specified xtd::drawing::rectangle.

Parameters

rect	The xtd::drawing::rectangle with which to intersect.

make_union() [1/2]

void xtd::drawing::rectangle::make_union ( const rectangle &  rect )

noexcept

Replaces this xtd::drawing::rectangle with the union of itself and the specified xtd::drawing::rectangle.

Parameters

rect	The xtd::drawing::rectangle with which to union.

offset() [1/4]

void xtd::drawing::rectangle::offset ( const point &  pos )

noexcept

Adjusts the location of this rectangle by the specified amount.

Parameters

pos	Amount to offset the location.

Remarks

This method adjusts the location of the upper-left corner horizontally by the x-coordinate of the specified point, and vertically by the y-coordinate of the specified point.

offset() [2/4]

void xtd::drawing::rectangle::offset ( int32  x, int32  y  )

noexcept

Adjusts the location of this rectangle by the specified amount.

Parameters

x	The horizontal offset.
y	The vertical offset.

to_string()

xtd::string xtd::drawing::rectangle::to_string ( ) const

overridevirtualnoexcept

Converts the attributes of this xtd::drawing::rectangle to a human-readable string.

Returns

A string that contains the position, width, and height of this Rectangle structure ¾ for example, {x=20, y=20, width=100, height=50}.

Reimplemented from xtd::object.

inflate() [1/4]

void xtd::drawing::rectangle::inflate ( const drawing::size &  sz )

noexcept

Enlarges this xtd::drawing::rectangle by the specified amount.

Parameters

sz	The amount to inflate this rectangle.

Remarks

This method enlarges this rectangle, not a copy of it. The rectangle is enlarged in both directions along an axis. For example, if a 50 by 50 rectangle is enlarged by 50 in the x-axis, the resultant rectangle will be 150 units long (the original 50, the 50 in the minus direction, and the 50 in the plus direction) maintaining the rectangle's geometric center.

inflate() [2/4]

void xtd::drawing::rectangle::inflate ( int32  width, int32  height  )

noexcept

Enlarges this xtd::drawing::rectangle by the specified amount.

Parameters

width	The amount to inflate this xtd::drawing::rectangle horizontally.
height	The amount to inflate this xtd::drawing::rectangle verticaly.

Remarks

This method enlarges this rectangle, not a copy of it. The rectangle is enlarged in both directions along an axis. For example, if a 50 by 50 rectangle is enlarged by 50 in the x-axis, the resultant rectangle will be 150 units long (the original 50, the 50 in the minus direction, and the 50 in the plus direction) maintaining the rectangle's geometric center.

If either x or y is negative, the xtd::drawing::rectangle structure is deflated in the corresponding direction.

add() [3/4]

static rectangle xtd::drawing::rectangle::add ( const rectangle &  rect, int32  x, int32  y  )

staticnoexcept

Creates and returns an added copy of the specified xtd::drawing::rectangle structure. The copy is added by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.

Parameters

rect	The xtd::drawing::rectangle with which to start. This rectangle is not modified.
x	The amount to add the specified rectangle horizontally.
y	The amount to add the specified rectangle vertically.

Returns

The added xtd::drawing::rectangle.

Remarks

This method makes a copy of rect, adds the copy, and then returns the added copy.

add() [4/4]

static rectangle xtd::drawing::rectangle::add ( const rectangle &  rect, const drawing::size &  sz  )

staticnoexcept

Creates and returns an added copy of the specified xtd::drawing::rectangle structure. The copy is added by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.

Parameters

rect	The xtd::drawing::rectangle with which to start. This rectangle is not modified.
sz	The amount to add the specified rectangle.

Returns

The added xtd::drawing::rectangle.

Remarks

This method makes a copy of rect, adds the copy, and then returns the added copy.

ceiling()

static rectangle xtd::drawing::rectangle::ceiling ( const xtd::drawing::rectangle_f &  rect )

staticnoexcept

Converts the specified xtd::drawing::rectangle_f structure to a xtd::drawing::rectangle structure by rounding the xtd::drawing::rectangle_f values to the next higher integer values.

Parameters

rect	The xtd::drawing::rectangle_f structure to be converted.

Returns

Returns a xtd::drawing::rectangle.

from_ltrb()

static rectangle xtd::drawing::rectangle::from_ltrb ( int32  left, int32  top, int32  right, int32  bottom  )

staticnoexcept

Creates a xtd::drawing::rectangle structure with the specified edge locations.

Parameters

left	The x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.
top	The y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.
right	The x-coordinate of the lower-right corner of this xtd::drawing::rectangle structure.
bottom	The y-coordinate of the lower-right corner of this xtd::drawing::rectangle structure.

Returns

The new xtd::drawing::rectangle that this method creates.

Remarks

This method creates a xtd::drawing::rectangle with the specified upper-left and lower-right corners.

inflate() [3/4]

static rectangle xtd::drawing::rectangle::inflate ( const rectangle &  rect, int32  x, int32  y  )

staticnoexcept

Creates and returns an enlarged copy of the specified xtd::drawing::rectangle structure. The copy is enlarged by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.

Parameters

rect	The xtd::drawing::rectangle with which to start. This rectangle is not modified.
x	The amount to inflate the specified rectangle horizontally.
y	The amount to inflate the specified rectangle vertically.

Returns

The enlarged xtd::drawing::rectangle.

Remarks

This method makes a copy of rect, enlarges the copy, and then returns the enlarged copy. The rectangle is enlarged in both directions along an axis. For example, if a 50 by 50 rectangle is enlarged by 50 in the x-axis, the resultant rectangle will be 150 units long (the original 50, the 50 in the minus direction, and the 50 in the plus direction) maintaining the rectangle's geometric center.

inflate() [4/4]

static rectangle xtd::drawing::rectangle::inflate ( const rectangle &  rect, const drawing::size &  sz  )

staticnoexcept

Creates and returns an enlarged copy of the specified xtd::drawing::rectangle structure. The copy is enlarged by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.

Parameters

rect	The xtd::drawing::rectangle with which to start. This rectangle is not modified.
sz	The amount to inflate the specified rectangle.

Returns

The enlarged xtd::drawing::rectangle.

Remarks

This method makes a copy of rect, enlarges the copy, and then returns the enlarged copy. The rectangle is enlarged in both directions along an axis. For example, if a 50 by 50 rectangle is enlarged by 50 in the x-axis, the resultant rectangle will be 150 units long (the original 50, the 50 in the minus direction, and the 50 in the plus direction) maintaining the rectangle's geometric center.

make_intersect() [2/2]

static rectangle xtd::drawing::rectangle::make_intersect ( const rectangle &  a, const rectangle &  b  )

staticnoexcept

Returns a third xtd::drawing::rectangle structure that represents the intersection of two other xtd::drawing::rectangle structures. If there is no intersection, an empty xtd::drawing::rectangle is returned.

Parameters

a	A rectangle to intersect.
b	A rectangle to intersect.

Returns

A xtd::drawing::rectangle that represents the intersection of a and b.

make_union() [2/2]

static rectangle xtd::drawing::rectangle::make_union ( const rectangle &  a, const rectangle &  b  )

staticnoexcept

Gets a xtd::drawing::rectangle structure that contains the union of two xtd::drawing::rectangle structures.

Parameters

a	A rectangle to union.
b	A rectangle to union.

Returns

A xtd::drawing::rectangle structure that bounds the union of the two xtd::drawing::rectangle structures.

offset() [3/4]

static rectangle xtd::drawing::rectangle::offset ( const rectangle &  rect, const point &  pos  )

staticnoexcept

Creates and returns an offsetted copy of the specified xtd::drawing::rectangle structure. The copy is offsetted by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.

Parameters

rect	The xtd::drawing::rectangle with which to start. This rectangle is not modified.
pos	The amount to offset the specified rectangle.

Returns

The offsetted xtd::drawing::rectangle.

Remarks

This method makes a copy of rect, offsets the copy, and then returns the offsetted copy.

offset() [4/4]

static rectangle xtd::drawing::rectangle::offset ( const rectangle &  rect, int32  x, int32  y  )

staticnoexcept

Creates and returns an offsetted copy of the specified xtd::drawing::rectangle structure. The copy is offsetted by the specified amount. The original xtd::drawing::rectangle structure remains unmodified.

Parameters

rect	The xtd::drawing::rectangle with which to start. This rectangle is not modified.
x	The amount to offset the specified rectangle horizontally.
y	The amount to offset the specified rectangle vertically.

Returns

The offsetted xtd::drawing::rectangle.

Remarks

This method makes a copy of rect, offsets the copy, and then returns the offsetted copy.

round()

static rectangle xtd::drawing::rectangle::round ( const rectangle_f &  rect )

staticnoexcept

Converts the specified xtd::drawing::rectangle_f to a xtd::drawing::rectangle by rounding the xtd::drawing::rectangle_f values to the nearest integer values.

Parameters

rect	The xtd::drawing::rectangle_f to be converted.

Returns

The rounded integer value of the xtd::drawing::rectangle.

truncate()

static rectangle xtd::drawing::rectangle::truncate ( const rectangle_f &  rect )

staticnoexcept

Converts the specified xtd::drawing::rectangle_f to a xtd::drawing::rectangle by truncating the xtd::drawing::rectangle_f values.

Parameters

rect	The xtd::drawing::rectangle_f to be converted.

Returns

The truncated value of the xtd::drawing::rectangle.

equals() [1/2]

virtual bool xtd::object::equals ( const object &  obj ) const

virtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Examples

The following code example compares the current instance with another object.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output :
//
// false
// false
// true
// true

Reimplemented from xtd::object.

equals() [2/2]

template<typename object_a_t , typename object_b_t >

static bool xtd::object::equals ( const object_a_t &  object_a, const object_b_t &  object_b  )

inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters

object_a	The first object to compare.
object_b	The second object to compare.

Returns

true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.

Examples

The following code example compares different objects.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  string s1 = "Tom";
  string s2 = "Carol";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Tom";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Carol";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
}
 
// This code produces the following output :
//
// object::equals("Tom", "Carol") => false
// object::equals("Tom", "Tom") => true
// object::equals("", "Tom") => false
// object::equals("Carol", "") => false
// object::equals("", "") => true

Member Data Documentation

empty

const rectangle xtd::drawing::rectangle::empty

static

Represents a xtd::drawing::rectangle that has xtd::drawing::rectagle::x, xtd::drawing::rectangle::y, xtd::drawing::rectangle::width and xtd::drawing::rectangle::height values set to zero.

---

The documentation for this class was generated from the following file:

• xtd.drawing/include/xtd/drawing/rectangle.hpp