reference_guides/latest/rectangle_8hpp_source.html

#pragma once

#include "../drawing_export.hpp"

#include "point.hpp"

#include "size.hpp"

#include "rectangle_f.hpp"

#include <xtd/iequatable>

#include <xtd/object>

#include <xtd/string>

#include <cstdint>

#include <ostream>


namespace xtd {

  namespace drawing {


    struct drawing_export_ rectangle : xtd::object, xtd::iequatable<rectangle> {


      static const rectangle empty;


      rectangle() noexcept = default;

      rectangle(xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height) noexcept;

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


      operator xtd::drawing::rectangle_f() const noexcept;


      xtd::int32 x = 0;


      xtd::int32 y = 0;


      xtd::int32 width = 0;


      xtd::int32 height = 0;


      [[nodiscard]] auto bottom() const noexcept -> xtd::int32;


      [[nodiscard]] auto center() const noexcept -> xtd::drawing::point;


      [[nodiscard]] bool is_empty() const noexcept;


      [[nodiscard]] auto left() const noexcept -> xtd::int32;


      [[nodiscard]] auto location() const noexcept -> xtd::drawing::point;

      auto location(const xtd::drawing::point& value) noexcept -> void;


      [[nodiscard]] auto right() const noexcept -> xtd::int32;


      auto size() const noexcept -> xtd::drawing::size;

      auto size(const xtd::drawing::size& value) noexcept -> void;


      [[nodiscard]] auto top() const noexcept -> xtd::int32;


      auto add(const xtd::drawing::size& sz) noexcept -> void;

      auto add(xtd::int32 width, xtd::int32 height) noexcept -> void;


      [[nodiscard]] auto contains(const xtd::drawing::point& pt) const noexcept -> bool;

      [[nodiscard]] auto contains(const xtd::drawing::rectangle& rect) const noexcept -> bool;

      [[nodiscard]] auto contains(xtd::int32 x, xtd::int32 y) const noexcept -> bool;


      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;

      [[nodiscard]] auto equals(const rectangle& other) const noexcept -> bool override;


      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;


      auto inflate(const xtd::drawing::size& sz) noexcept -> void;

      auto inflate(xtd::int32 width, xtd::int32 height) noexcept -> void;


      [[nodiscard]] auto intersects_with(const rectangle& rect) const noexcept -> bool;


      auto make_intersect(const rectangle& rect) noexcept -> void;


      auto make_union(const rectangle& rect) noexcept -> void;


      auto offset(const xtd::drawing::point& pos) noexcept -> void;

      auto offset(xtd::int32 dx, xtd::int32 dy) noexcept -> void;


      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;


      [[nodiscard]] static auto add(const rectangle& rect, xtd::int32 x, xtd::int32 y) noexcept -> rectangle;

      [[nodiscard]] static auto add(const rectangle& rect, const xtd::drawing::size& sz) noexcept -> rectangle;


      [[nodiscard]] static auto ceiling(const xtd::drawing::rectangle_f& rect) noexcept -> rectangle;


      [[nodiscard]] static auto from_ltrb(xtd::int32 left, xtd::int32 top, xtd::int32 right, xtd::int32 bottom) noexcept -> rectangle;


      [[nodiscard]] static auto inflate(const rectangle& rect, xtd::int32 x, xtd::int32 y) noexcept -> rectangle;

      [[nodiscard]] static auto inflate(const rectangle& rect, const xtd::drawing::size& sz) noexcept -> rectangle;


      [[nodiscard]] static auto make_intersect(const rectangle& a, const rectangle& b) noexcept -> rectangle;


      [[nodiscard]] static auto make_union(const rectangle& a, const rectangle& b) noexcept -> rectangle;


      [[nodiscard]] static auto offset(const rectangle& rect, const xtd::drawing::point& pos) noexcept -> rectangle;

      [[nodiscard]] static auto offset(const rectangle& rect, xtd::int32 x, xtd::int32 y) noexcept -> rectangle;


      [[nodiscard]] static auto round(const rectangle_f& rect) noexcept -> rectangle;


      [[nodiscard]] static auto truncate(const xtd::drawing::rectangle_f& rect) noexcept -> rectangle;

    };


  }

}

xtd::iequatable
Defines a generalized method that a value type or class implements to create a type-specific method f...
Definition iequatable.hpp:23

xtd::object
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.hpp:45

drawing_export.hpp
Contains drawing_export_ keyword.

drawing_export_
#define drawing_export_
Define shared library export.
Definition drawing_export.hpp:13

xtd::int32
std::int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:25

xtd::usize
std::size_t usize
Represents an unsigned size of any object in bytes.
Definition usize.hpp:22

xtd::drawing
The xtd::drawing namespace provides access to GDI+ basic graphics functionality. More advanced functi...
Definition actions_system_images.hpp:10

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

point.hpp
Contains xtd::drawing::point struct.

rectangle_f.hpp
Contains xtd::drawing::rectangle_f struct.

size.hpp
Contains xtd::drawing::size struct.

xtd::drawing::point
Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional ...
Definition point.hpp:54

xtd::drawing::rectangle_f
Stores a set of four floating-point numbers that represent the location and size of a rectangle....
Definition rectangle_f.hpp:34

xtd::drawing::rectangle::contains
auto contains(const xtd::drawing::point &pt) const noexcept -> bool
Determines if the specified point is contained within this xtd::drawing::rectangle structure.

xtd::drawing::rectangle::equals
auto equals(const xtd::object &obj) const noexcept -> bool override
Determines whether the specified object is equal to the current object.

xtd::drawing::rectangle::right
auto right() const noexcept -> xtd::int32
Gets the x-coordinate that is the sum of xtd::drawing::rectangle::x and xtd::drawing::rectangle::widt...

xtd::drawing::rectangle::center
auto center() const noexcept -> xtd::drawing::point
Gets the center property values of this xtd::drawing::rectangle structure.

xtd::drawing::rectangle::inflate
auto inflate(const xtd::drawing::size &sz) noexcept -> void
Enlarges this xtd::drawing::rectangle by the specified amount.

xtd::drawing::rectangle::size
auto size() const noexcept -> xtd::drawing::size
Gets the size of this xtd::drawing::rectangle.

xtd::drawing::rectangle::height
xtd::int32 height
Gets or sets the height of this xtd::drawing::rectangle structure.
Definition rectangle.hpp:95

xtd::drawing::rectangle::make_intersect
auto make_intersect(const rectangle &rect) noexcept -> void
Replaces this xtd::drawing::rectangle with the intersection of itself and the specified xtd::drawing:...

xtd::drawing::rectangle::top
auto top() const noexcept -> xtd::int32
Gets the y-coordinate of the top edge of this xtd::drawing::rectangle structure.

xtd::drawing::rectangle::rectangle
rectangle() noexcept=default
Initializes a new instance of the xtd::drawing::rectangle class.

xtd::drawing::rectangle::round
static auto round(const rectangle_f &rect) noexcept -> rectangle
Converts the specified xtd::drawing::rectangle_f to a xtd::drawing::rectangle by rounding the xtd::dr...

xtd::drawing::rectangle::intersects_with
auto intersects_with(const rectangle &rect) const noexcept -> bool
Determines if this rectangle intersects with rect.

xtd::drawing::rectangle::add
auto add(const xtd::drawing::size &sz) noexcept -> void
Adds this xtd::drawing::rectangle by the specified amount.

xtd::drawing::rectangle::bottom
auto bottom() const noexcept -> xtd::int32
Gets the y-coordinate that is the sum of the xtd::drawing::rectangle::y and xtd::drawing::rectangle::...

xtd::drawing::rectangle::get_hash_code
auto get_hash_code() const noexcept -> xtd::usize override
Serves as a hash function for a particular type.

xtd::drawing::rectangle::to_string
auto to_string() const noexcept -> xtd::string override
Converts the attributes of this xtd::drawing::rectangle to a human-readable string.

xtd::drawing::rectangle::width
xtd::int32 width
Gets or sets the width of this xtd::drawing::rectangle structure.
Definition rectangle.hpp:90

xtd::drawing::rectangle::offset
auto offset(const xtd::drawing::point &pos) noexcept -> void
Adjusts the location of this rectangle by the specified amount.

xtd::drawing::rectangle::is_empty
bool is_empty() const noexcept
Tests whether all numeric properties of this xtd::drawing::rectangle have values of zero.

xtd::drawing::rectangle::x
xtd::int32 x
Gets or sets the x-coordinate of the upper-left corner of this xtd::drawing::rectangle structure....
Definition rectangle.hpp:80

xtd::drawing::rectangle::empty
static const rectangle empty
Represents a xtd::drawing::rectangle that has xtd::drawing::rectagle::x, xtd::drawing::rectangle::y,...
Definition rectangle.hpp:49

xtd::drawing::rectangle::from_ltrb
static auto from_ltrb(xtd::int32 left, xtd::int32 top, xtd::int32 right, xtd::int32 bottom) noexcept -> rectangle
Creates a xtd::drawing::rectangle structure with the specified edge locations.

xtd::drawing::rectangle::ceiling
static auto ceiling(const xtd::drawing::rectangle_f &rect) noexcept -> rectangle
Converts the specified xtd::drawing::rectangle_f structure to a xtd::drawing::rectangle structure by ...

xtd::drawing::rectangle::make_union
auto make_union(const rectangle &rect) noexcept -> void
Replaces this xtd::drawing::rectangle with the union of itself and the specified xtd::drawing::rectan...

xtd::drawing::rectangle::left
auto left() const noexcept -> xtd::int32
Gets the x-coordinate of the left edge of this xtd::drawing::rectangle structure.

xtd::drawing::rectangle::y
xtd::int32 y
Gets or sets the y-coordinate of the upper-left corner of this xtd::drawing::rectangle structure.
Definition rectangle.hpp:85

xtd::drawing::rectangle::location
auto location() const noexcept -> xtd::drawing::point
Gets the coordinates of the upper-left corner of this xtd::drawing::rectangle structure.

xtd::drawing::rectangle::truncate
static auto truncate(const xtd::drawing::rectangle_f &rect) noexcept -> rectangle
Converts the specified xtd::drawing::rectangle_f to a xtd::drawing::rectangle by truncating the xtd::...