xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
List of all members
xtd::drawing::rectangle_f Class Reference

#include <rectangle_f.h>

Definition

Stores a set of four floating-point numbers that represent the location and size of a rectangle. For more advanced region functions, use a xtd::drawing::region object.

class drawing_export_ rectangle_f : public xtd::object
Inheritance
xtd::objectxtd::drawing::rectangle_f
Namespace
xtd::drawing
Library
xtd.drawing
Remarks
A rectangle is defined by its width, height, and upper-left corner.

Fields

static const rectangle_f empty
 Represents a xtd::drawing::rectangle_F that has xtd::drawing::rectagle_f::x, xtd::drawing::rectangle_f::y, xtd::drawing::rectangle_f::width and xtd::drawing::rectangle_f::height values set to zero. More...
 

Constructors

 rectangle_f () noexcept=default
 Initializes a new instance of the xtd::drawing::rectagle_f class. More...
 
 rectangle_f (float x, float y, float width, float height) noexcept
 Initializes a new instance of the xtd::drawing::rectagle_f class with the specified location and size. More...
 
 rectangle_f (const point_f &location, const size_f &size) noexcept
 Initializes a new instance of the xtd::drawing::rectagle_f class with the specified location and size. More...
 

Properties

float bottom () const noexcept
 Gets the y-coordinate that is the sum of the xtd::drawing::rectangle_f::y and xtd::drawing::rectangle_f::height property values of this xtd::drawing::rectangle_f structure. More...
 
float height () const noexcept
 Gets the height of this xtd::drawing::rectangle_f structure. More...
 
void height (float height) noexcept
 Sets the height of this xtd::drawing::rectangle_f structure. More...
 
bool is_empty () const noexcept
 Tests whether all numeric properties of this xtd::drawing::rectangle_f have values of zero. More...
 
float left () const noexcept
 Gets the x-coordinate of the left edge of this xtd::drawing::rectangle_f structure. More...
 
point_f location () const noexcept
 Gets the coordinates of the upper-left corner of this xtd::drawing::rectangle_f structure. More...
 
void location (const point_f &location)
 Sets the coordinates of the upper-left corner of this xtd::drawing::rectangle_f structure. More...
 
float right () const noexcept
 Gets the x-coordinate that is the sum of xtd::drawing::rectangle_f::x and xtd::drawing::rectangle_f::width property values of this xtd::drawing::rectangle_f structure. More...
 
size_f size () const noexcept
 Gets the size of this xtd::drawing::rectangle_f. More...
 
void size (const size_f &size) noexcept
 Sets the size of this xtd::drawing::rectangle_f. More...
 
float top () const noexcept
 Gets the y-coordinate of the top edge of this xtd::drawing::rectangle_f structure. More...
 
float width () const noexcept
 Gets the width of this xtd::drawing::rectangle_f structure. More...
 
void width (float width) noexcept
 Sets the width of this xtd::drawing::rectangle_f structure. More...
 
float x () const noexcept
 Gets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. More...
 
void x (float x) noexcept
 Sets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. More...
 
float y () const noexcept
 Gets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. More...
 
void y (float y) noexcept
 Sets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. More...
 

Methods

void add (const drawing::size_f &sz) noexcept
 Adds this xtd::drawing::rectangle_f by the specified amount. More...
 
void add (float width, float height) noexcept
 Adds this xtd::drawing::rectangle_f by the specified amount. More...
 
bool contains (const point_f &pt) const noexcept
 Determines if the specified point is contained within this xtd::drawing::rectangle_f structure. More...
 
bool contains (const rectangle_f &rect) const noexcept
 Determines if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle_f structure. More...
 
bool contains (float x, float y) const noexcept
 Determines if the specified point is contained within this xtd::drawing::rectangle_f structure. More...
 
void inflate (const drawing::size_f &sz) noexcept
 Enlarges this xtd::drawing::rectangle_f by the specified amount. More...
 
void inflate (float width, float height) noexcept
 Enlarges this xtd::drawing::rectangle_f by the specified amount. More...
 
bool intersects_with (const rectangle_f &rect) const noexcept
 Determines if this rectangle intersects with rect. More...
 
void make_intersect (const rectangle_f &rect) noexcept
 Replaces this xtd::drawing::rectangle_f with the intersection of itself and the specified xtd::drawing::rectangle_f. More...
 
void make_union (const rectangle_f &rect) noexcept
 Replaces this xtd::drawing::rectangle_f with the union of itself and the specified xtd::drawing::rectangle_f. More...
 
void offset (const point_f &pos) noexcept
 Adjusts the location of this rectangle by the specified amount. More...
 
void offset (float x, float y) noexcept
 Adjusts the location of this rectangle by the specified amount. More...
 
xtd::ustring to_string () const noexcept override
 Converts the attributes of this xtd::drawing::rectangle_f to a human-readable string. More...
 
static rectangle_f add (const rectangle_f &rect, float x, float y) noexcept
 Creates and returns an added copy of the specified xtd::drawing::rectangle_f structure. The copy is added by the specified amount. The original xtd::drawing::rectangle_f structure remains unmodified. More...
 
static rectangle_f add (const rectangle_f &rect, const drawing::size_f &sz) noexcept
 Creates and returns an added copy of the specified xtd::drawing::rectangle_f structure. The copy is added by the specified amount. The original xtd::drawing::rectangle_f structure remains unmodified. More...
 
static rectangle_f from_ltrb (float left, float top, float right, float bottom) noexcept
 Creates a xtd::drawing::rectangle_f structure with the specified edge locations. More...
 
static rectangle_f inflate (const rectangle_f &rect, const drawing::size_f &sz) noexcept
 Creates and returns an enlarged copy of the specified xtd::drawing::rectangle_f structure. The copy is enlarged by the specified amount. The original xtd::drawing::rectangle_f structure remains unmodified. More...
 
static rectangle_f inflate (const rectangle_f &rect, float width, float height) noexcept
 Creates and returns an enlarged copy of the specified xtd::drawing::rectangle_f structure. The copy is enlarged by the specified amount. The original xtd::drawing::rectangle_f structure remains unmodified. More...
 
static rectangle_f make_intersect (const rectangle_f &a, const rectangle_f &b) noexcept
 Returns a third xtd::drawing::rectangle_f structure that represents the intersection of two other xtd::drawing::rectangle_f structures. If there is no intersection, an empty xtd::drawing::rectangle_f is returned. More...
 
static rectangle_f make_union (const rectangle_f &a, const rectangle_f &b) noexcept
 Gets a xtd::drawing::rectangle_f structure that contains the union of two xtd::drawing::rectangle_f structures. More...
 
static rectangle_f offset (const rectangle_f &rect, const point_f &pos) noexcept
 Creates and returns an offsetted copy of the specified xtd::drawing::rectangle_f structure. The copy is offsetted by the specified amount. The original xtd::drawing::rectangle_f structure remains unmodified. More...
 
static rectangle_f offset (const rectangle_f &rect, float x, float y) noexcept
 Creates and returns an offsetted copy of the specified xtd::drawing::rectangle_f structure. The copy is offsetted by the specified amount. The original xtd::drawing::rectangle_f structure remains unmodified. More...
 

Operators

bool operator== (const rectangle_f &value) const noexcept
 Tests whether two xtd::drawing::rectangle_f structures have equal location and size. More...
 
bool operator!= (const rectangle_f &value) const noexcept
 Tests whether two xtd::drawing::rectangle_f structures differ in location or size. More...
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ rectangle_f() [1/3]

xtd::drawing::rectangle_f::rectangle_f ( )
defaultnoexcept

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

Remarks
xtd::drawing::rectagle_f::x, xtd::drawing::rectagle_f::y, xtd::drawing::rectagle_f::width and xtd::drawing::rectagle_f::height values are set to zero.

◆ rectangle_f() [2/3]

xtd::drawing::rectangle_f::rectangle_f ( float  x,
float  y,
float  width,
float  height 
)
noexcept

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

Parameters
xThe x-coordinate of the upper-left corner of the rectangle.
yThe y-coordinate of the upper-left corner of the rectangle.
widthThe width of the rectangle.
heightThe height of the rectangle.

◆ rectangle_f() [3/3]

xtd::drawing::rectangle_f::rectangle_f ( const point_f location,
const size_f size 
)
noexcept

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

Parameters
locationA xtd::drawing::point_f that represents the upper-left corner of the rectangular region.
sizeA xtd::drawing::size_f that represents the width and height of the rectangular region.

Member Function Documentation

◆ add() [1/4]

void xtd::drawing::rectangle_f::add ( const drawing::size_f sz)
noexcept

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

Parameters
szThe amount to add this rectangle.
Remarks
This method adds this rectangle, not a copy of it.

◆ add() [2/4]

void xtd::drawing::rectangle_f::add ( float  width,
float  height 
)
noexcept

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

Parameters
widthThe amount to add this xtd::drawing::rectangle_f horizontally.
heightThe amount to add this xtd::drawing::rectangle_f verticaly.
Remarks
This method adds this rectangle, not a copy of it.

◆ add() [3/4]

static rectangle_f xtd::drawing::rectangle_f::add ( const rectangle_f rect,
float  x,
float  y 
)
staticnoexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
xThe amount to add the specified rectangle horizontally.
yThe amount to add the specified rectangle vertically.
Returns
The added xtd::drawing::rectangle_f.
Remarks
This method makes a copy of rect, adds the copy, and then returns the added copy.

◆ add() [4/4]

static rectangle_f xtd::drawing::rectangle_f::add ( const rectangle_f rect,
const drawing::size_f sz 
)
staticnoexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
szThe amount to add the specified rectangle.
Returns
The added xtd::drawing::rectangle_f.
Remarks
This method makes a copy of rect, adds the copy, and then returns the added copy.

◆ bottom()

float xtd::drawing::rectangle_f::bottom ( ) const
noexcept

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

Returns
The y-coordinate that is the sum of xtd::drawing::rectangle_f::y and xtd::drawing::rectangle_f::height of this xtd::drawing::rectangle_f.
Remarks
The value of the xtd::drawing::rectangle_f::bottom property represents the y-coordinate of the first point at the bottom edge of the xtd::drawing::rectangle_f that is not contained in the xtd::drawing::rectangle_f.

◆ contains() [1/3]

bool xtd::drawing::rectangle_f::contains ( const point_f pt) const
noexcept

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

Parameters
ptThe xtd::drawing::point_f to test.
Returns
This method returns true if the point represented by pt is contained within this xtd::drawing::rectangle_f structure; otherwise false.
Remarks
The containing rectangle must be normalized for this method to return accurate results.

◆ contains() [2/3]

bool xtd::drawing::rectangle_f::contains ( const rectangle_f rect) const
noexcept

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

Parameters
rectThe xtd::drawing::rectangle_f to test.
Returns
This method returns true if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle_f structure; otherwise false.
Remarks
The containing rectangle must be normalized for this method to return accurate results.

◆ contains() [3/3]

bool xtd::drawing::rectangle_f::contains ( float  x,
float  y 
) const
noexcept

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

Parameters
xThe x-coordinate of the point to test.
yThe 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_f structure; otherwise false.
Remarks
The containing rectangle must be normalized for this method to return accurate results.

◆ from_ltrb()

static rectangle_f xtd::drawing::rectangle_f::from_ltrb ( float  left,
float  top,
float  right,
float  bottom 
)
staticnoexcept

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

Parameters
leftThe x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure.
topThe y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure.
rightThe x-coordinate of the lower-right corner of this xtd::drawing::rectangle_f structure.
bottomThe y-coordinate of the lower-right corner of this xtd::drawing::rectangle_f structure.
Returns
The new xtd::drawing::rectangle_f that this method creates.
Remarks
This method creates a xtd::drawing::rectangle_f with the specified upper-left and lower-right corners.

◆ height() [1/2]

float xtd::drawing::rectangle_f::height ( ) const
noexcept

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

Returns
The height of this Rectangle structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::height property will also cause a change in the xtd::drawing::rectangle_f::bottom property of the xtd::drawing::rectangle_f. 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.

◆ height() [2/2]

void xtd::drawing::rectangle_f::height ( float  height)
noexcept

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

Parameters
valueThe height of this Rectangle structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::height property will also cause a change in the xtd::drawing::rectangle_f::bottom property of the xtd::drawing::rectangle_f. 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.

◆ inflate() [1/4]

void xtd::drawing::rectangle_f::inflate ( const drawing::size_f sz)
noexcept

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

Parameters
szThe 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_f::inflate ( float  width,
float  height 
)
noexcept

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

Parameters
widthThe amount to inflate this xtd::drawing::rectangle_f horizontally.
heightThe amount to inflate this xtd::drawing::rectangle_f 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_f structure is deflated in the corresponding direction.

◆ inflate() [3/4]

static rectangle_f xtd::drawing::rectangle_f::inflate ( const rectangle_f rect,
const drawing::size_f sz 
)
staticnoexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
xThe amount to inflate the specified rectangle horizontally.
yThe amount to inflate the specified rectangle vertically.
Returns
The enlarged xtd::drawing::rectangle_f.
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_f xtd::drawing::rectangle_f::inflate ( const rectangle_f rect,
float  width,
float  height 
)
staticnoexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
szThe amount to inflate the specified rectangle.
Returns
The enlarged xtd::drawing::rectangle_f.
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.

◆ intersects_with()

bool xtd::drawing::rectangle_f::intersects_with ( const rectangle_f rect) const
noexcept

Determines if this rectangle intersects with rect.

Parameters
rectThe rectangle to test.
Returns
This method returns true if there is any intersection, otherwise false.

◆ is_empty()

bool xtd::drawing::rectangle_f::is_empty ( ) const
noexcept

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

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

◆ left()

float xtd::drawing::rectangle_f::left ( ) const
noexcept

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

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

◆ location() [1/2]

point_f xtd::drawing::rectangle_f::location ( ) const
noexcept

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

Returns
A xtd::drawing::point_f that represents the upper-left corner of this xtd::drawing::rectangle_f structure.

◆ location() [2/2]

void xtd::drawing::rectangle_f::location ( const point_f location)

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

Parameters
valueA xtd::drawing::point_f that represents the upper-left corner of this xtd::drawing::rectangle_f structure.

◆ make_intersect() [1/2]

static rectangle_f xtd::drawing::rectangle_f::make_intersect ( const rectangle_f a,
const rectangle_f b 
)
staticnoexcept

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

Parameters
aA rectangle to intersect.
bA rectangle to intersect.
Returns
A xtd::drawing::rectangle_f that represents the intersection of a and b.

◆ make_intersect() [2/2]

void xtd::drawing::rectangle_f::make_intersect ( const rectangle_f rect)
noexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to intersect.

◆ make_union() [1/2]

static rectangle_f xtd::drawing::rectangle_f::make_union ( const rectangle_f a,
const rectangle_f b 
)
staticnoexcept

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

Parameters
aA rectangle to union.
bA rectangle to union.
Returns
A xtd::drawing::rectangle_f structure that bounds the union of the two xtd::drawing::rectangle_f structures.

◆ make_union() [2/2]

void xtd::drawing::rectangle_f::make_union ( const rectangle_f rect)
noexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to union.

◆ offset() [1/4]

void xtd::drawing::rectangle_f::offset ( const point_f pos)
noexcept

Adjusts the location of this rectangle by the specified amount.

Parameters
posAmount 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_f::offset ( float  x,
float  y 
)
noexcept

Adjusts the location of this rectangle by the specified amount.

Parameters
xThe horizontal offset.
yThe vertical offset.

◆ offset() [3/4]

static rectangle_f xtd::drawing::rectangle_f::offset ( const rectangle_f rect,
const point_f pos 
)
staticnoexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
posThe amount to offset the specified rectangle.
Returns
The offsetted xtd::drawing::rectangle_f.
Remarks
This method makes a copy of rect, offsets the copy, and then returns the offsetted copy.

◆ offset() [4/4]

static rectangle_f xtd::drawing::rectangle_f::offset ( const rectangle_f rect,
float  x,
float  y 
)
staticnoexcept

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

Parameters
rectThe xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
xThe amount to offset the specified rectangle horizontally.
yThe amount to offset the specified rectangle vertically.
Returns
The offsetted xtd::drawing::rectangle_f.
Remarks
This method makes a copy of rect, offsets the copy, and then returns the offsetted copy.

◆ operator!=()

bool xtd::drawing::rectangle_f::operator!= ( const rectangle_f value) const
noexcept

Tests whether two xtd::drawing::rectangle_f structures differ in location or size.

Parameters
valueThe xtd::drawing::rectangle_f structure that is to the right of the inequality operator.
Returns
This operator returns true if any of the xtd::drawing::rectangle_f::x, xtd::drawing::rectangle_f::y, xtd::drawing::rectangle_f::width or xtd::drawing::rectangle_f::height properties of the two xtd::drawing::rectangle_f structures are unequal; otherwise false.

◆ operator==()

bool xtd::drawing::rectangle_f::operator== ( const rectangle_f value) const
noexcept

Tests whether two xtd::drawing::rectangle_f structures have equal location and size.

Parameters
valueThe xtd::drawing::rectangle_f structure that is to the right of the equality operator.
Returns
This operator returns true if the two xtd::drawing::rectangle_f structures have equal xtd::drawing::rectangle_f::x, xtd::drawing::rectangle_f::y, xtd::drawing::rectangle_f::width, and xtd::drawing::rectangle_f::height properties.

◆ right()

float xtd::drawing::rectangle_f::right ( ) const
noexcept

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

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

◆ size() [1/2]

size_f xtd::drawing::rectangle_f::size ( ) const
noexcept

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

Returns
A xtd::drawing::size_f that represents the width and height of this xtd::drawing::rectangle_f structure.

◆ size() [2/2]

void xtd::drawing::rectangle_f::size ( const size_f size)
noexcept

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

Parameters
valueA xtd::drawing::size_f that represents the width and height of this xtd::drawing::rectangle_f structure.

◆ to_string()

xtd::ustring xtd::drawing::rectangle_f::to_string ( ) const
overridevirtualnoexcept

Converts the attributes of this xtd::drawing::rectangle_f 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.

◆ top()

float xtd::drawing::rectangle_f::top ( ) const
noexcept

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

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

◆ width() [1/2]

float xtd::drawing::rectangle_f::width ( ) const
noexcept

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

Returns
The width of this xtd::drawing::rectangle_f structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::width property will also cause a change in the xtd::drawing::rectangle_f::bottom property of the xtd::drawing::rectangle_f. 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.

◆ width() [2/2]

void xtd::drawing::rectangle_f::width ( float  width)
noexcept

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

Parameters
valueThe width of this xtd::drawing::rectangle_f structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::width property will also cause a change in the xtd::drawing::rectangle_f::bottom property of the xtd::drawing::rectangle_f. 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]

float xtd::drawing::rectangle_f::x ( ) const
noexcept

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

Returns
The x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::x property will also cause a change in the xtd::drawing::rectangle_f::right property of the xtd::drawing::rectangle_f.

◆ x() [2/2]

void xtd::drawing::rectangle_f::x ( float  x)
noexcept

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

Parameters
valueThe x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::x property will also cause a change in the xtd::drawing::rectangle_f::right property of the xtd::drawing::rectangle_f.

◆ y() [1/2]

float xtd::drawing::rectangle_f::y ( ) const
noexcept

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

Returns
The y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::y property will also cause a change in the xtd::drawing::rectangle_f::bottom property of the xtd::drawing::rectangle_f.

◆ y() [2/2]

void xtd::drawing::rectangle_f::y ( float  y)
noexcept

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

Parameters
valueThe y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure. The default is 0.
Remarks
Changing the xtd::drawing::rectangle_f::y property will also cause a change in the xtd::drawing::rectangle_f::bottom property of the xtd::drawing::rectangle_f.

Member Data Documentation

◆ empty

const rectangle_f xtd::drawing::rectangle_f::empty
static

Represents a xtd::drawing::rectangle_F that has xtd::drawing::rectagle_f::x, xtd::drawing::rectangle_f::y, xtd::drawing::rectangle_f::width and xtd::drawing::rectangle_f::height values set to zero.


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