Definition

Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.

class drawing_export_ point : public xtd::object

Inheritance: xtd::object → xtd::drawing::point

Namespace: xtd::drawing

Library: xtd.drawing

Remarks: To convert a point to a point_f, use Implicit cast operator.

Examples

void create_points_and_sizes(paint_event_args& e) {
  // Create the starting point.
  point start_point = subtract_button.size();
  // Use the addition operator to get the end point.
  point end_point = start_point + size(140, 150);
  // Draw a line between the points.
  e.graphics().draw_line(system_pens::highlight, start_point, end_point);
  // Convert the starting point to a size and compare it to the subtractButton size.
  size button_size(start_point);
  if (button_size == subtract_button.size()) {
    // If the sizes are equal, tell the user.
    e.graphics().draw_string("The sizes are equal.", font(font, font_style.italic), brushes::indigo, 10.0F, 65.0F);
  }
}

Examples:: animation.cpp, buttons.cpp, circular_form.cpp, colored_forms.cpp, docked_panels.cpp, draw_point.cpp, fill_ellipse.cpp, fill_rectangle.cpp, fill_rounded_rectangle.cpp, form_paint.cpp, graphics.cpp, labels_and_unicode_text.cpp, lcd_label3.cpp, minesweeper.cpp, point.cpp, settings_example2.cpp, tutorial_button.cpp, user_control.cpp, and wiggly.cpp.

Fields
static const point	empty
	Represents a xtd::drawing::point that has xtd::drawing::point::x and xtd::drawing::point::y values set to zero. More...

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

	point (int32 dw) noexcept
	Initializes a new instance of the xtd::drawing::point class using coordinates specified by an integer value. More...

	point (int32 x, int32 y) noexcept
	Initializes a new instance of the xtd::drawing::point class with the specified coordinates. More...

	point (const size &sz) noexcept
	Initializes a new instance of the xtd::drawing::point class from a xtd::drawing::size. More...

Properties
bool	is_empty () const noexcept
	Gets a value indicating whether this xtd::drawing::point is empty. More...

int32	x () const noexcept
	Gets the x-coordinate of this xtd::drawing::point. More...

void	x (int32 x) noexcept
	Sets the x-coordinate of this xtd::drawing::point. More...

int32	y () const noexcept
	Gets the y-coordinate of this xtd::drawing::point. More...

void	y (int32 y) noexcept
	Sets the y-coordinate of this xtd::drawing::point. More...

Methods
bool	equals (const point &value) const noexcept override

void	offset (int32 dx, int32 dy) noexcept
	Translates this xtd::drawing::point by the specified amount. More...

void	offset (const point &p) noexcept
	Translates this xtd::drawing::point by the specified xtd::drawing::point. More...

xtd::ustring	to_string () const noexcept override
	Converts this point to a human-readable string. More...

static point	add (const point &pt, const size &sz) noexcept
	Adds the specified xtd::drawing::size to the specified xtd::drawing::point. More...

static point	add (const point &pt1, const point &pt2) noexcept
	Adds the specified xtd::drawing::point to the specified xtd::drawing::point. More...

static point	ceiling (const point_f &value) noexcept
	Converts the specified xtd::drawing::point_f to a point by rounding the values of the xtd::drawing::point_f to the next higher integer values. More...

static point	round (const point_f &value) noexcept
	Converts the specified xtd::drawing::point_f to a point object by rounding the xtd::drawing::point_f values to the nearest integer. More...

static point	subtract (const point &pt, const size &sz) noexcept
	Returns the result of subtracting specified xtd::drawing::size from the specified xtd::drawing::point. More...

static point	subtract (const point &pt1, const point &pt2) noexcept
	Returns the result of subtracting specified xtd::drawing::point from the specified xtd::drawing::point. More...

static point	truncate (const point_f &value) noexcept
	Converts the specified xtd::drawing::point_f to a point by truncating the values of the xtd::drawing::point_f. More...

Operators
point	operator+ (const size &sz) const noexcept
	Translates a xtd::drawing::point by a given xtd::drawing::size. More...

point	operator+ (const point &pt) const noexcept
	Translates a xtd::drawing::point by a given xtd::drawing::point. More...

point &	operator+= (const size &sz) noexcept
	Translates a xtd::drawing::point by a given xtd::drawing::size. More...

point &	operator+= (const point &pt) noexcept
	Translates a xtd::drawing::point by a given xtd::drawing::point. More...

point	operator- (const size &sz) const noexcept
	Translates a xtd::drawing::point by the negative of a given xtd::drawing::size. More...

point	operator- (const point &pt) const noexcept
	Translates a xtd::drawing::point by the negative of a given xtd::drawing::point. More...

point &	operator-= (const size &sz) noexcept
	Translates a xtd::drawing::point by the negative of a given xtd::drawing::size. More...

point &	operator-= (const point &pt) noexcept
	Translates a xtd::drawing::point by the negative of a given xtd::drawing::point. More...

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

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

virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...

Public Member Functions inherited from xtd::iequatable< point >
virtual bool	equals (const point &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type. 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

◆ point() [1/4]

xtd::drawing::point::point ( )

defaultnoexcept

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

Remarks: xtd::drawing::point::x and xtd::drawing::point::y values are set to zero.

◆ point() [2/4]

xtd::drawing::point::point ( int32 dw )

explicitnoexcept

Initializes a new instance of the xtd::drawing::point class using coordinates specified by an integer value.

Parameters

dx	A 32-bit integer that specifies the coordinates for the new xtd::drawing::point.

Remarks: The low-order 16 bits of the dw parameter specify the horizontal x-coordinate and the higher 16 bits specify the vertical y-coordinate for the new point.

Examples: The following code example demonstrates how to use the point and size. size constructors and the xtd::drawing::content_alignment enumeration. To run this example, paste this code into a Windows Form (xtd::forms) that contains a label named label1, and call the initialize_label1 method in the form's constructor.
void initialize_label1() {
// Set a border.
label1.border_style = border_style::fixed_single;
// Set the size, constructing a size from two integers.
label1.size(drawing::size(100, 50));
// Set the location, constructing a point from a 32-bit integer
// (using hexadecimal).
label1.location(point(0x280028));
// Set and align the text on the lower-right side of the label.
label1.text_align = content_alignment::bottom_right;
label1.text = "Bottom Right Alignment";
}

◆ point() [3/4]

xtd::drawing::point::point	(	int32	x,
		int32	y
	)

noexcept

Initializes a new instance of the xtd::drawing::point class with the specified coordinates.

Parameters

x	The horizontal position of the point.
y	The vertical position of the point.

Examples: The following code example demonstrates how to use the Equality operator and how to construct a point from a size or two integers. It also demonstrates how to use the x and y properties. This example is designed to be used with Windows Forms (xtd.forms). Paste the code into a form that contains a button named button1, and associate the button1_click method with the button's click event.
void button1_click(object& sender, const event_args& e) {
// Construct a new point with integers.
point point1(100, 100);
// Create a Graphics object.
graphics form_graphics = create_graphics();
// Construct another point, this time using a xtd::drawing::size.
point point2(size(100, 100));
// Call the equality operator to see if the points are equal, and if so print out their x and y values.
if (point1 == point2) {
form_graphics.draw_string(ustring::format("point1.x: {}, point2.x: {}, point1.y: {}, point2.y {}", point1.x(), point2.x(), point1.y(), point2.y()), font(), brushes::black, point_f(10, 70));
}
}

◆ point() [4/4]

xtd::drawing::point::point ( const size & sz )

explicitnoexcept

Initializes a new instance of the xtd::drawing::point class from a xtd::drawing::size.

Parameters

sz	A size that specifies the coordinates for the new point.

Examples: The following code example demonstrates how to use the Equality operator and how to construct a point from a size or two integers. It also demonstrates how to use the x and y properties. This example is designed to be used with Windows Forms (xtd.forms). Paste the code into a form that contains a button named button1, and associate the button1_click method with the button's click event.
void button1_click(object& sender, const event_args& e) {
// Construct a new point with integers.
point point1(100, 100);
// Create a Graphics object.
graphics form_graphics = create_graphics();
// Construct another point, this time using a xtd::drawing::size.
point point2(size(100, 100));
// Call the equality operator to see if the points are equal, and if so print out their x and y values.
if (point1 == point2) {
form_graphics.draw_string(ustring::format("point1.x: {}, point2.x: {}, point1.y: {}, point2.y {}", point1.x(), point2.x(), point1.y(), point2.y()), font(), brushes::black, point_f(10, 70));
}
}

Member Function Documentation

◆ add() [1/2]

static point xtd::drawing::point::add	(	const point &	pt,
		const size &	sz
	)

staticnoexcept

Adds the specified xtd::drawing::size to the specified xtd::drawing::point.

Parameters

pt	The xtd::drawing::point to add.
sz	The xtd::drawing::size to add.

Returns: The xtd::drawing::point that is the result of the addition operation.

Remarks: The xtd::drawing::point::add adds the xtd::drawing::size::width and xtd::drawing::size::height of the specified size to the xtd::drawing::point::x and xtd::drawing::point::y values of the specified xtd::drawing::point.

Examples: The following example shows how to use the add method. To run this example, paste it into a Windows Form (xtd::forms. Handle the form's xtd::forms::control::paint event and call the add_point method from the paint event-handling method, passing e as paint_event_args.
void add_point(paint_event_args& e) {
point point1(10, 10);
point point2 = point::add(point1, drawing::size(250,0));
e.graphics().draw_line(pens::red, point1, point2);
}

◆ add() [2/2]

static point xtd::drawing::point::add	(	const point &	pt1,
		const point &	pt2
	)

staticnoexcept

Adds the specified xtd::drawing::point to the specified xtd::drawing::point.

Parameters

pt1	The xtd::drawing::point to add.
pt2	The xtd::drawing::point to add.

Returns: The xtd::drawing::point that is the result of the addition operation.

◆ ceiling()

static point xtd::drawing::point::ceiling ( const point_f & value )

staticnoexcept

Converts the specified xtd::drawing::point_f to a point by rounding the values of the xtd::drawing::point_f to the next higher integer values.

Parameters

value The xtd::drawing::point_f to convert.

Returns: The xtd::drawing::point this method converts to.

◆ is_empty()

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

noexcept

Gets a value indicating whether this xtd::drawing::point is empty.

Returns: true if both xtd::drawing::point::x and xtd::drawing::point::y are 0; otherwise, false.

◆ offset() [1/2]

void xtd::drawing::point::offset	(	int32	dx,
		int32	dy
	)

noexcept

Translates this xtd::drawing::point by the specified amount.

Parameters

dx	The amount to offset the x-coordinate.
dy	The amount to offset the y-coordinate.

◆ offset() [2/2]

void xtd::drawing::point::offset ( const point & p )

noexcept

Translates this xtd::drawing::point by the specified xtd::drawing::point.

Parameters

p	The xtd::drawing::point used offset this xtd::drawing::point.

Remarks: This method adjusts the xtd::drawing::point::x and xtd::drawing::point::y values of this xtd::drawing::point to the sum of the xtd::drawing::point::x and xtd::drawing::point::y values of this xtd::drawing::point and p.

Examples: The following example shows how to use the Offset method. To run this example, paste it into a Windows Form. Handle the form's xtd::forms::control::paint event and call the Offsetpoint method from the xtd::forms::control::paint event-handling method, passing e as xtd::forms::paint_event_args.
void offset_point(paint_event_args& e) {
point point1(10, 10);
point1.offset(50, 0);
point point2(250, 10);
e.graphics().draw_line(pens::red, point1, point2);
}

◆ operator+() [1/2]

point xtd::drawing::point::operator+ ( const size & sz ) const

noexcept

Translates a xtd::drawing::point by a given xtd::drawing::size.

Parameters

sz	A xtd::drawing::size that specifies the pair of numbers to add to the coordinates of this xtd::drawing::point.

Returns: The translated xtd::drawing::point.

◆ operator+() [2/2]

point xtd::drawing::point::operator+ ( const point & pt ) const

noexcept

Translates a xtd::drawing::point by a given xtd::drawing::point.

Parameters

pt	A xtd::drawing::point that specifies the pair of numbers to add to the coordinates of this xtd::drawing::point.

Returns: The translated xtd::drawing::point.

◆ operator+=() [1/2]

point& xtd::drawing::point::operator+= ( const size & sz )

noexcept

Translates a xtd::drawing::point by a given xtd::drawing::size.

Parameters

sz	A xtd::drawing::size that specifies the pair of numbers to add to the coordinates of this xtd::drawing::point.

Returns: The translated xtd::drawing::point.

◆ operator+=() [2/2]

point& xtd::drawing::point::operator+= ( const point & pt )

noexcept

Translates a xtd::drawing::point by a given xtd::drawing::point.

Parameters

pt	A xtd::drawing::point that specifies the pair of numbers to add to the coordinates of this xtd::drawing::point.

Returns: The translated xtd::drawing::point.

◆ operator-() [1/2]

point xtd::drawing::point::operator- ( const size & sz ) const

noexcept

Translates a xtd::drawing::point by the negative of a given xtd::drawing::size.

Parameters

sz	A xtd::drawing::size that specifies the pair of numbers to subtract from the coordinates of this xtd::drawing::point.

Returns: A xtd::drawing::point structure that is translated by the negative of a given xtd::drawing::size structure.

◆ operator-() [2/2]

point xtd::drawing::point::operator- ( const point & pt ) const

noexcept

Translates a xtd::drawing::point by the negative of a given xtd::drawing::point.

Parameters

pt	A xtd::drawing::point that specifies the pair of numbers to subtract from the coordinates of this xtd::drawing::point.

Returns: A xtd::drawing::point structure that is translated by the negative of a given xtd::drawing::size structure.

◆ operator-=() [1/2]

point& xtd::drawing::point::operator-= ( const size & sz )

noexcept

Translates a xtd::drawing::point by the negative of a given xtd::drawing::size.

Parameters

sz	A xtd::drawing::size that specifies the pair of numbers to subtract from the coordinates of this xtd::drawing::point.

Returns: The translated xtd::drawing::point.

◆ operator-=() [2/2]

point& xtd::drawing::point::operator-= ( const point & pt )

noexcept

Translates a xtd::drawing::point by the negative of a given xtd::drawing::point.

Parameters

pt	A xtd::drawing::point that specifies the pair of numbers to subtract from the coordinates of this xtd::drawing::point.

Returns: The translated xtd::drawing::point.

◆ round()

static point xtd::drawing::point::round ( const point_f & value )

staticnoexcept

Converts the specified xtd::drawing::point_f to a point object by rounding the xtd::drawing::point_f values to the nearest integer.

Parameters

value The xtd::drawing::point_f to convert.

Returns: The xtd::drawing::point this method converts to.

◆ subtract() [1/2]

static point xtd::drawing::point::subtract	(	const point &	pt,
		const size &	sz
	)

staticnoexcept

Returns the result of subtracting specified xtd::drawing::size from the specified xtd::drawing::point.

Parameters

pt	The xtd::drawing::point to be subtracted from.
sz	The xtd::drawing::size to subtract from the xtd::drawing::point.

Returns: The xtd::drawing::point that is the result of the subtraction operation.

Remarks: The xtd::drawing::point::subtract subtracts the xtd::drawing::size::width and xtd::drawing::size::height of the specified xtd::drawing::size from the xtd::drawing::point::x and xtd::drawing::point::y values of the specified xtd::drawing::point.

◆ subtract() [2/2]

static point xtd::drawing::point::subtract	(	const point &	pt1,
		const point &	pt2
	)

staticnoexcept

Returns the result of subtracting specified xtd::drawing::point from the specified xtd::drawing::point.

Parameters

pt1	The xtd::drawing::point to be subtracted from.
pt2	The xtd::drawing::point to subtract from the xtd::drawing::point.

Returns: The xtd::drawing::point that is the result of the subtraction operation.

◆ to_string()

xtd::ustring xtd::drawing::point::to_string ( ) const

overridevirtualnoexcept

Converts this point to a human-readable string.

Returns: An xtd::ustring that represents this xtd::drawing::point.

Reimplemented from xtd::object.

◆ truncate()

static point xtd::drawing::point::truncate ( const point_f & value )

staticnoexcept

Converts the specified xtd::drawing::point_f to a point by truncating the values of the xtd::drawing::point_f.

Parameters

value The xtd::drawing::point_f to convert.

Returns: The xtd::drawing::point this method converts to.

◆ x() [1/2]

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

noexcept

Gets the x-coordinate of this xtd::drawing::point.

Returns: The x-coordinate of this xtd::drawing::point.

Examples: The following code example demonstrates how to use the Equality operator and how to construct a point from a size or two integers. It also demonstrates how to use the x and y properties. This example is designed to be used with Windows Forms (xtd.forms). Paste the code into a form that contains a button named button1, and associate the button1_click method with the button's click event.
void button1_click(object& sender, const event_args& e) {
// Construct a new point with integers.
point point1(100, 100);
// Create a Graphics object.
graphics form_graphics = create_graphics();
// Construct another point, this time using a xtd::drawing::size.
point point2(size(100, 100));
// Call the equality operator to see if the points are equal, and if so print out their x and y values.
if (point1 == point2) {
form_graphics.draw_string(ustring::format("point1.x: {}, point2.x: {}, point1.y: {}, point2.y {}", point1.x(), point2.x(), point1.y(), point2.y()), font(), brushes::black, point_f(10, 70));
}
}

Examples:: minesweeper.cpp, and screen.cpp.

◆ x() [2/2]

void xtd::drawing::point::x ( int32 x )

noexcept

Sets the x-coordinate of this xtd::drawing::point.

Parameters

x	The x-coordinate of this xtd::drawing::point.

Examples: The following code example demonstrates how to use the Equality operator and how to construct a point from a size or two integers. It also demonstrates how to use the x and y properties. This example is designed to be used with Windows Forms (xtd.forms). Paste the code into a form that contains a button named button1, and associate the button1_click method with the button's click event.
void button1_click(object& sender, const event_args& e) {
// Construct a new point with integers.
point point1(100, 100);
// Create a Graphics object.
graphics form_graphics = create_graphics();
// Construct another point, this time using a xtd::drawing::size.
point point2(size(100, 100));
// Call the equality operator to see if the points are equal, and if so print out their x and y values.
if (point1 == point2) {
form_graphics.draw_string(ustring::format("point1.x: {}, point2.x: {}, point1.y: {}, point2.y {}", point1.x(), point2.x(), point1.y(), point2.y()), font(), brushes::black, point_f(10, 70));
}
}

◆ y() [1/2]

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

noexcept

Gets the y-coordinate of this xtd::drawing::point.

Returns: The y-coordinate of this xtd::drawing::point.

Examples: The following code example demonstrates how to use the Equality operator and how to construct a point from a size or two integers. It also demonstrates how to use the x and y properties. This example is designed to be used with Windows Forms (xtd.forms). Paste the code into a form that contains a button named button1, and associate the button1_click method with the button's click event.
void button1_Click(object& sender, const event_args& e) {
// Construct a new point with integers.
point point1(100, 100);
// Create a Graphics object.
graphics form_graphics = create_graphics();
// Construct another point, this time using a xtd::drawing::size.
point point2(size(100, 100));
// Call the equality operator to see if the points are equal, and if so print out their x and y values.
if (point1 == point2) {
form_graphics.draw_string(ustring::format("point1.x: {}, point2.x: {}, point1.y: {}, point2.y {}", point1.x(), point2.x(), point1.y(), point2.y()), font(), brushes::black, point_f(10, 70));
}
}

Examples:: minesweeper.cpp, and screen.cpp.

◆ y() [2/2]

void xtd::drawing::point::y ( int32 y )

noexcept

Sets the y-coordinate of this xtd::drawing::point.

Parameters

y	The x-coordinate of this xtd::drawing::point.

Examples: The following code example demonstrates how to use the Equality operator and how to construct a point from a size or two integers. It also demonstrates how to use the x and y properties. This example is designed to be used with Windows Forms (xtd.forms). Paste the code into a form that contains a button named button1, and associate the button1_click method with the button's click event.
void button1_Click(object& sender, const event_args& e) {
// Construct a new point with integers.
point point1(100, 100);
// Create a Graphics object.
graphics form_graphics = create_graphics();
// Construct another point, this time using a xtd::drawing::size.
point point2(size(100, 100));
// Call the equality operator to see if the points are equal, and if so print out their x and y values.
if (point1 == point2) {
form_graphics.draw_string(ustring::format("point1.x: {}, point2.x: {}, point1.y: {}, point2.y {}", point1.x(), point2.x(), point1.y(), point2.y()), font(), brushes::black, point_f(10, 70));
}
}

Member Data Documentation

◆ empty

const point xtd::drawing::point::empty

static

Represents a xtd::drawing::point that has xtd::drawing::point::x and xtd::drawing::point::y values set to zero.

Examples:: circular_form.cpp, lcd_label3.cpp, and move_form.cpp.

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

xtd.drawing/include/xtd/drawing/point.h

Definition

Fields

Constructors

Properties

Methods

Operators

Additional Inherited Members

Constructor & Destructor Documentation

◆ point() [1/4]

◆ point() [2/4]

◆ point() [3/4]

◆ point() [4/4]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ ceiling()

◆ is_empty()

◆ offset() [1/2]

◆ offset() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ round()

◆ subtract() [1/2]

◆ subtract() [2/2]

◆ to_string()

◆ truncate()

◆ x() [1/2]

◆ x() [2/2]

◆ y() [1/2]

◆ y() [2/2]

Member Data Documentation

◆ empty