xtd::drawing::point_f Class Reference

Inheritance diagram for xtd::drawing::point_f:

Definition

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

class drawing_export_ point_f : public xtd::object

Inheritance

xtd::object → xtd::drawing::point_f

Namespace

xtd::drawing

Library

xtd.drawing

Examples

animation.cpp.

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

Public Constructors
	point_f () noexcept=default
	Initializes a new instance of the xtd::drawing::point_f class.
	point_f (float x, float y) noexcept
	Initializes a new instance of the xtd::drawing::point_f class with the specified coordinates.
	point_f (const size_f &sz) noexcept
	Initializes a new instance of the xtd::drawing::point_t class from a xtd::drawing::size_f.

Public Properties
bool	is_empty () const noexcept
	Gets a value indicating whether this xtd::drawing::point_f is empty.
float	x () const noexcept
	Gets the x-coordinate of this xtd::drawing::point_f.
void	x (float x) noexcept
	Sets the x-coordinate of this xtd::drawing::point_f.
float	y () const noexcept
	Gets the y-coordinate of this xtd::drawing::point_f.
void	y (float y) noexcept
	Sets the y-coordinate of this xtd::drawing::point_f.

Public Methods
bool	equals (const point_f &value) const noexcept override
void	offset (float dx, float dy) noexcept
	Translates this xtd::drawing::point_f by the specified amount.
void	offset (const point_f &pt) noexcept
	Translates this xtd::drawing::point_f by the specified xtd::drawing::point_f.
xtd::ustring	to_string () const noexcept override
	Converts this point to a human-readable string.
static point_f	add (const point_f &pt, const size &sz) noexcept
	Adds the specified xtd::drawing::size to the specified xtd::drawing::point_f.
static point_f	add (const point_f &pt, const size_f &sz) noexcept
	Adds the specified xtd::drawing::size_f to the specified xtd::drawing::point_f.
static point_f	add (const point_f &pt1, const point &pt2) noexcept
	Adds the specified xtd::drawing::point to the specified xtd::drawing::point_f.
static point_f	add (const point_f &pt1, const point_f &pt2) noexcept
	Adds the specified xtd::drawing::point_f to the specified xtd::drawing::point_f.
static point_f	subtract (const point_f &pt, const size &sz) noexcept
	Returns the result of subtracting specified xtd::drawing::size from the specified xtd::drawing::point_f.
static point_f	subtract (const point_f &pt, const size_f &sz) noexcept
	Returns the result of subtracting specified xtd::drawing::size_f from the specified xtd::drawing::point_f.
static point_f	subtract (const point_f &pt1, const point &pt2) noexcept
	Returns the result of subtracting specified xtd::drawing::point from the specified xtd::drawing::point.
static point_f	subtract (const point_f &pt1, const point_f &pt2) noexcept
	Returns the result of subtracting specified xtd::drawing::point from the specified xtd::drawing::point.

Operators
point_f	operator+ (const size &sz) const noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::size.
point_f	operator+ (const size_f &sz) const noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::size_f.
point_f	operator+ (const point &pt) const noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::point.
point_f	operator+ (const point_f &pt) const noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::point_f.
point_f &	operator+= (const size &sz) noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::size.
point_f &	operator+= (const size_f &sz) noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::size_f.
point_f &	operator+= (const point &pt) noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::point.
point_f &	operator+= (const point_f &pt) noexcept
	Translates a xtd::drawing::point_f by a given xtd::drawing::point_f.
point_f	operator- (const size &sz) const noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::size.
point_f	operator- (const size_f &sz) const noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::size_f.
point_f	operator- (const point &pt) const noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::point.
point_f	operator- (const point_f &pt) const noexcept
	Translates a xtd::drawing::point by the negative of a given xtd::drawing::point.
point_f &	operator-= (const size &sz) noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::size.
point_f &	operator-= (const size_f &sz) noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::size_f.
point_f &	operator-= (const point &pt) noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::point.
point_f &	operator-= (const point_f &pt) noexcept
	Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::point_f.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< point_f >
virtual bool	equals (const point_f &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
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.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

point_f() [1/3]

xtd::drawing::point_f::point_f ( )

defaultnoexcept

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

Remarks

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

point_f() [2/3]

xtd::drawing::point_f::point_f ( float  x, float  y  )

noexcept

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

Parameters

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

point_f() [3/3]

xtd::drawing::point_f::point_f ( const size_f &  sz )

explicitnoexcept

Initializes a new instance of the xtd::drawing::point_t class from a xtd::drawing::size_f.

Parameters

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

Member Function Documentation

add() [1/4]

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

staticnoexcept

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

Parameters

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

Returns

The xtd::drawing::point_f 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_f::x and xtd::drawing::point_f::y values of the specified xtd::drawing::point_f.

add() [2/4]

static point_f xtd::drawing::point_f::add ( const point_f &  pt, const size_f &  sz  )

staticnoexcept

Adds the specified xtd::drawing::size_f to the specified xtd::drawing::point_f.

Parameters

pt	The xtd::drawing::point_f to add.
sz	The xtd::drawing::size_f to add.

Returns

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

Remarks

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

add() [3/4]

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

staticnoexcept

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

Parameters

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

Returns

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

add() [4/4]

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

staticnoexcept

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

Parameters

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

Returns

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

is_empty()

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

noexcept

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

Returns

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

offset() [1/2]

void xtd::drawing::point_f::offset ( const point_f &  pt )

noexcept

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

Parameters

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

Remarks

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

offset() [2/2]

void xtd::drawing::point_f::offset ( float  dx, float  dy  )

noexcept

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

Parameters

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

operator+() [1/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

The translated xtd::drawing::point_f.

operator+() [2/4]

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

noexcept

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

Parameters

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

Returns

The translated xtd::drawing::point_f.

operator+() [3/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

The translated xtd::drawing::point_f.

operator+() [4/4]

point_f xtd::drawing::point_f::operator+ ( const size_f &  sz ) const

noexcept

Translates a xtd::drawing::point_f by a given xtd::drawing::size_f.

Parameters

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

Returns

The translated xtd::drawing::point_f.

operator+=() [1/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

The translated xtd::drawing::point_f.

operator+=() [2/4]

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

noexcept

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

Parameters

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

Returns

The translated xtd::drawing::point_f.

operator+=() [3/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

The translated xtd::drawing::point_f.

operator+=() [4/4]

point_f & xtd::drawing::point_f::operator+= ( const size_f &  sz )

noexcept

Translates a xtd::drawing::point_f by a given xtd::drawing::size_f.

Parameters

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

Returns

The translated xtd::drawing::point_f.

operator-() [1/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f structure that is translated by the negative of a given xtd::drawing::point structure.

operator-() [2/4]

point_f xtd::drawing::point_f::operator- ( const point_f &  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::point structure.

operator-() [3/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

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

operator-() [4/4]

point_f xtd::drawing::point_f::operator- ( const size_f &  sz ) const

noexcept

Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::size_f.

Parameters

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

Returns

A xtd::drawing::point_f structure that is translated by the negative of a given xtd::drawing::size_f structure.

operator-=() [1/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

The translated xtd::drawing::point_f.

operator-=() [2/4]

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

noexcept

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

Parameters

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

Returns

The translated xtd::drawing::point_f.

operator-=() [3/4]

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

noexcept

Translates a xtd::drawing::point_f 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_f.

Returns

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

operator-=() [4/4]

point_f & xtd::drawing::point_f::operator-= ( const size_f &  sz )

noexcept

Translates a xtd::drawing::point_f by the negative of a given xtd::drawing::size_f.

Parameters

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

Returns

A xtd::drawing::point_f structure that is translated by the negative of a given xtd::drawing::size_f structure.

subtract() [1/4]

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

staticnoexcept

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

Parameters

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

Returns

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

Remarks

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

subtract() [2/4]

static point_f xtd::drawing::point_f::subtract ( const point_f &  pt, const size_f &  sz  )

staticnoexcept

Returns the result of subtracting specified xtd::drawing::size_f from the specified xtd::drawing::point_f.

Parameters

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

Returns

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

Remarks

The xtd::drawing::point_f::subtract subtracts the xtd::drawing::size_f::width and xtd::drawing::size_F::height of the specified xtd::drawing::size_f from the xtd::drawing::point_f::x and xtd::drawing::point_f::y values of the specified xtd::drawing::poin_ft.

subtract() [3/4]

static point_f xtd::drawing::point_f::subtract ( const point_f &  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_f to be subtracted from.
pt2	The xtd::drawing::point to subtract from the xtd::drawing::point_f.

Returns

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

subtract() [4/4]

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

staticnoexcept

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

Parameters

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

Returns

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

to_string()

xtd::ustring xtd::drawing::point_f::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.

x() [1/2]

float xtd::drawing::point_f::x ( ) const

noexcept

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

Returns

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

x() [2/2]

void xtd::drawing::point_f::x ( float  x )

noexcept

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

Parameters

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

y() [1/2]

float xtd::drawing::point_f::y ( ) const

noexcept

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

Returns

The y-coordinate of this xtd::drawing::point_f.

y() [2/2]

void xtd::drawing::point_f::y ( float  y )

noexcept

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

Parameters

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

Member Data Documentation

empty

const point_f xtd::drawing::point_f::empty

static

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

---

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

• xtd.drawing/include/xtd/drawing/point_f.h