Inheritance diagram for xtd::drawing::rectangle_f:

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

xtd::object

Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....

Definition object.hpp:45

drawing_export_

#define drawing_export_

Define shared library export.

Definition drawing_export.hpp:13

xtd::drawing::rectangle_f::rectangle_f

rectangle_f() noexcept=default

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

Inheritance: xtd::object → xtd::drawing::rectangle_f

Namespace: xtd::drawing

Library: xtd.drawing

Remarks: A rectangle is defined by its width, height, and upper-left corner.

Examples: form_paint.cpp, and graphics.cpp.

Public 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.

Public Properties
float	x
	Gets or sets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure.
float	y
	Gets or sets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure.
float	width
	Gets or sets the width of this xtd::drawing::rectangle_f structure.
float	height
	Gets or sets the height of this xtd::drawing::rectangle_f structure. @pram height The height of this Rectangle structure. The default is 0.
auto	bottom () const noexcept -> float
	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.
auto	center () const noexcept -> xtd::drawing::point_f
	Gets the center property values of this xtd::drawing::rectangle structure.
auto	is_empty () const noexcept -> bool
	Tests whether all numeric properties of this xtd::drawing::rectangle_f have values of zero.
auto	left () const noexcept -> float
	Gets the x-coordinate of the left edge of this xtd::drawing::rectangle_f structure.
auto	location () const noexcept -> xtd::drawing::point_f
	Gets the coordinates of the upper-left corner of this xtd::drawing::rectangle_f structure.
auto	location (const xtd::drawing::point_f &location) -> void
	Sets the coordinates of the upper-left corner of this xtd::drawing::rectangle_f structure.
auto	right () const noexcept -> float
	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.
auto	size () const noexcept -> xtd::drawing::size_f
	Gets the size of this xtd::drawing::rectangle_f.
auto	size (const xtd::drawing::size_f &size) noexcept -> void
	Sets the size of this xtd::drawing::rectangle_f.
auto	top () const noexcept -> float
	Gets the y-coordinate of the top edge of this xtd::drawing::rectangle_f structure.

Public Constructors
	rectangle_f () noexcept=default
	Initializes a new instance of the xtd::drawing::rectagle_f class.
	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.
	rectangle_f (const xtd::drawing::point_f &location, const xtd::drawing::size_f &size) noexcept
	Initializes a new instance of the xtd::drawing::rectagle_f class with the specified location and size.

Public Methods
auto	add (const xtd::drawing::size_f &sz) noexcept -> void
	Adds this xtd::drawing::rectangle_f by the specified amount.
auto	add (float width, float height) noexcept -> void
	Adds this xtd::drawing::rectangle_f by the specified amount.
auto	contains (const xtd::drawing::point_f &pt) const noexcept -> bool
	Determines if the specified point is contained within this xtd::drawing::rectangle_f structure.
auto	contains (const rectangle_f &rect) const noexcept -> bool
	Determines if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle_f structure.
auto	contains (float x, float y) const noexcept -> bool
	Determines if the specified point is contained within this xtd::drawing::rectangle_f structure.
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const rectangle_f &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	inflate (const xtd::drawing::size_f &sz) noexcept -> void
	Enlarges this xtd::drawing::rectangle_f by the specified amount.
auto	inflate (float width, float height) noexcept -> void
	Enlarges this xtd::drawing::rectangle_f by the specified amount.
auto	intersects_with (const rectangle_f &rect) const noexcept -> bool
	Determines if this rectangle intersects with rect.
auto	make_intersect (const rectangle_f &rect) noexcept -> void
	Replaces this xtd::drawing::rectangle_f with the intersection of itself and the specified xtd::drawing::rectangle_f.
auto	make_union (const rectangle_f &rect) noexcept -> void
	Replaces this xtd::drawing::rectangle_f with the union of itself and the specified xtd::drawing::rectangle_f.
auto	offset (const xtd::drawing::point_f &pos) noexcept -> void
	Adjusts the location of this rectangle by the specified amount.
auto	offset (float dx, float dy) noexcept -> void
	Adjusts the location of this rectangle by the specified amount.
auto	to_string () const noexcept -> xtd::string override
	Converts the attributes of this xtd::drawing::rectangle_f to a human-readable string.

Public Static Methods
static auto	add (const rectangle_f &rect, float x, float y) noexcept -> rectangle_f
	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.
static auto	add (const rectangle_f &rect, const xtd::drawing::size_f &sz) noexcept -> rectangle_f
	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.
static auto	from_ltrb (float left, float top, float right, float bottom) noexcept -> rectangle_f
	Creates a xtd::drawing::rectangle_f structure with the specified edge locations.
static auto	inflate (const rectangle_f &rect, const xtd::drawing::size_f &sz) noexcept -> rectangle_f
	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.
static auto	inflate (const rectangle_f &rect, float width, float height) noexcept -> rectangle_f
	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.
static auto	make_intersect (const rectangle_f &a, const rectangle_f &b) noexcept -> rectangle_f
	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.
static auto	make_union (const rectangle_f &a, const rectangle_f &b) noexcept -> rectangle_f
	Gets a xtd::drawing::rectangle_f structure that contains the union of two xtd::drawing::rectangle_f structures.
static auto	offset (const rectangle_f &rect, const xtd::drawing::point_f &pos) noexcept -> rectangle_f
	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.
static auto	offset (const rectangle_f &rect, float x, float y) noexcept -> rectangle_f
	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.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	equals (const rectangle_f &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

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

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_f() [3/3]

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

noexcept

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

Parameters

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

Member Function Documentation

◆ bottom()

auto xtd::drawing::rectangle_f::bottom ( ) const -> float

nodiscardnoexcept

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.

◆ center()

auto xtd::drawing::rectangle_f::center ( ) const -> xtd::drawing::point_f

nodiscardnoexcept

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

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

◆ is_empty()

auto xtd::drawing::rectangle_f::is_empty ( ) const -> bool

nodiscardnoexcept

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()

auto xtd::drawing::rectangle_f::left ( ) const -> float

nodiscardnoexcept

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]

auto xtd::drawing::rectangle_f::location ( ) const -> xtd::drawing::point_f

nodiscardnoexcept

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]

auto xtd::drawing::rectangle_f::location ( const xtd::drawing::point_f & location ) -> void

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

Parameters

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

◆ right()

auto xtd::drawing::rectangle_f::right ( ) const -> float

nodiscardnoexcept

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]

auto xtd::drawing::rectangle_f::size ( ) const -> xtd::drawing::size_f

nodiscardnoexcept

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]

auto xtd::drawing::rectangle_f::size ( const xtd::drawing::size_f & size ) -> void

noexcept

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

Parameters

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

◆ top()

auto xtd::drawing::rectangle_f::top ( ) const -> float

nodiscardnoexcept

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.

◆ add() [1/4]

auto xtd::drawing::rectangle_f::add ( const xtd::drawing::size_f & sz ) -> void

noexcept

Adds this xtd::drawing::rectangle_f 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]

auto xtd::drawing::rectangle_f::add	(	float	width,
		float	height ) -> void

noexcept

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

Parameters

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

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

◆ contains() [1/3]

auto xtd::drawing::rectangle_f::contains ( const xtd::drawing::point_f & pt ) const -> bool

nodiscardnoexcept

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

Parameters

pt	The 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]

auto xtd::drawing::rectangle_f::contains ( const rectangle_f & rect ) const -> bool

nodiscardnoexcept

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

Parameters

rect	The 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]

auto xtd::drawing::rectangle_f::contains	(	float	x,
		float	y ) const -> bool

nodiscardnoexcept

Determines if the specified point is contained within this xtd::drawing::rectangle_f 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_f structure; otherwise false.

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

◆ equals() [1/2]

auto xtd::drawing::rectangle_f::equals ( const xtd::object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

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.

Reimplemented from xtd::object.

◆ equals() [2/2]

auto xtd::drawing::rectangle_f::equals ( const rectangle_f & other ) const -> bool

nodiscardoverridenoexcept

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

Parameters

other The object to compare with the current object.

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

◆ get_hash_code()

auto xtd::drawing::rectangle_f::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

◆ inflate() [1/4]

auto xtd::drawing::rectangle_f::inflate ( const xtd::drawing::size_f & sz ) -> void

noexcept

Enlarges this xtd::drawing::rectangle_f 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]

auto xtd::drawing::rectangle_f::inflate	(	float	width,
		float	height ) -> void

noexcept

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

Parameters

width	The amount to inflate this xtd::drawing::rectangle_f horizontally.
height	The 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.

◆ intersects_with()

auto xtd::drawing::rectangle_f::intersects_with ( const rectangle_f & rect ) const -> bool

nodiscardnoexcept

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]

auto xtd::drawing::rectangle_f::make_intersect ( const rectangle_f & rect ) -> void

noexcept

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

Parameters

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

◆ make_union() [1/2]

auto xtd::drawing::rectangle_f::make_union ( const rectangle_f & rect ) -> void

noexcept

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

Parameters

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

◆ offset() [1/4]

auto xtd::drawing::rectangle_f::offset ( const xtd::drawing::point_f & pos ) -> void

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]

auto xtd::drawing::rectangle_f::offset	(	float	dx,
		float	dy ) -> void

noexcept

Adjusts the location of this rectangle by the specified amount.

Parameters

dx	The horizontal offset.
dy	The vertical offset.

◆ to_string()

auto xtd::drawing::rectangle_f::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

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.

◆ add() [3/4]

auto xtd::drawing::rectangle_f::add	(	const rectangle_f &	rect,
		float	x,
		float	y ) -> rectangle_f

staticnodiscardnoexcept

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

rect	The xtd::drawing::rectangle_f 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_f.

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

◆ add() [4/4]

auto xtd::drawing::rectangle_f::add	(	const rectangle_f &	rect,
		const xtd::drawing::size_f &	sz ) -> rectangle_f

staticnodiscardnoexcept

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

rect	The xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
sz	The 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.

◆ from_ltrb()

auto xtd::drawing::rectangle_f::from_ltrb	(	float	left,
		float	top,
		float	right,
		float	bottom ) -> rectangle_f

staticnodiscardnoexcept

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

Parameters

left	The x-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure.
top	The y-coordinate of the upper-left corner of this xtd::drawing::rectangle_f structure.
right	The x-coordinate of the lower-right corner of this xtd::drawing::rectangle_f structure.
bottom	The 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.

◆ inflate() [3/4]

auto xtd::drawing::rectangle_f::inflate	(	const rectangle_f &	rect,
		const xtd::drawing::size_f &	sz ) -> rectangle_f

staticnodiscardnoexcept

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

rect	The xtd::drawing::rectangle_f 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_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]

auto xtd::drawing::rectangle_f::inflate	(	const rectangle_f &	rect,
		float	width,
		float	height ) -> rectangle_f

staticnodiscardnoexcept

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

rect	The xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
sz	The 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.

◆ make_intersect() [2/2]

auto xtd::drawing::rectangle_f::make_intersect	(	const rectangle_f &	a,
		const rectangle_f &	b ) -> rectangle_f

staticnodiscardnoexcept

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

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

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

◆ make_union() [2/2]

auto xtd::drawing::rectangle_f::make_union	(	const rectangle_f &	a,
		const rectangle_f &	b ) -> rectangle_f

staticnodiscardnoexcept

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

Parameters

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

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

◆ offset() [3/4]

auto xtd::drawing::rectangle_f::offset	(	const rectangle_f &	rect,
		const xtd::drawing::point_f &	pos ) -> rectangle_f

staticnodiscardnoexcept

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

rect	The xtd::drawing::rectangle_f with which to start. This rectangle is not modified.
pos	The 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]

auto xtd::drawing::rectangle_f::offset	(	const rectangle_f &	rect,
		float	x,
		float	y ) -> rectangle_f

staticnodiscardnoexcept

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

rect	The xtd::drawing::rectangle_f 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_f.

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

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.

◆ x

float xtd::drawing::rectangle_f::x

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

Parameters

x	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.

◆ y

float xtd::drawing::rectangle_f::y

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

Parameters

y	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.

◆ width

float xtd::drawing::rectangle_f::width

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

Parameters

width 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.

◆ height

float xtd::drawing::rectangle_f::height

Gets or sets the height of this xtd::drawing::rectangle_f structure. @pram height 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.

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

xtd.drawing/include/xtd/drawing/rectangle_f.hpp

Definition

Public Fields

Public Properties

Public Constructors

Public Methods

Public Static Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ rectangle_f() [1/3]

◆ rectangle_f() [2/3]

◆ rectangle_f() [3/3]

Member Function Documentation

◆ bottom()

◆ center()

◆ is_empty()

◆ left()

◆ location() [1/2]

◆ location() [2/2]

◆ right()

◆ size() [1/2]

◆ size() [2/2]

◆ top()

◆ add() [1/4]

◆ add() [2/4]

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ inflate() [1/4]

◆ inflate() [2/4]

◆ intersects_with()

◆ make_intersect() [1/2]

◆ make_union() [1/2]

◆ offset() [1/4]

◆ offset() [2/4]

◆ to_string()

◆ add() [3/4]

◆ add() [4/4]

◆ from_ltrb()

◆ inflate() [3/4]

◆ inflate() [4/4]

◆ make_intersect() [2/2]

◆ make_union() [2/2]

◆ offset() [3/4]

◆ offset() [4/4]

Member Data Documentation

◆ empty

◆ x

◆ y

◆ width

◆ height