Definition

Stores an ordered pair of floating-point, which specify a height and width.

class drawing_export_ size_f : public xtd::object

Inheritance: xtd::object → xtd::drawing::size_f

Namespace: xtd::drawing

Library: xtd.drawing

Fields
static const xtd::drawing::size_f	empty
	Gets a Size class that has a Height and Width value of 0. This field is constant. More...

Constructors
	size_f () noexcept=default
	Initializes a new instance of the Size class that has a Height and Width value of 0. More...

	size_f (const xtd::drawing::point_f &point) noexcept
	Initializes a new instance of the xtd::drawing::size_f class from the specified xtd::drawing::point_f class. More...

	size_f (float width, float height) noexcept
	Initializes a new instance of the xtd::drawing::size_f class from the specified dimensions. More...

Properties
float	height () const noexcept
	Gets he vertical component of this xtd::drawing::size_f class. More...

void	height (float value) noexcept
	Sets the vertical component of this xtd::drawing::size_f Class. More...

bool	is_empty () const noexcept
	Tests whether this Size class has xtd::drawing::size_f::width and xtd::drawing::size_f::height of 0. More...

float	width () const noexcept
	Gets the horizontal component of this xtd::drawing::size_f class. More...

void	width (float value) noexcept
	Sets the horizontal component of this xtd::drawing::size_f class. More...

Methods
bool	equals (const xtd::drawing::size_f &value) const noexcept override

xtd::ustring	to_string () const noexcept override
	Creates a human-readable string that represents this xtd::drawing::size_f class. More...

static xtd::drawing::size_f	add (const xtd::drawing::size_f &size1, const xtd::drawing::size_f &size2) noexcept
	Adds the width and height of one xtd::drawing::size_f class to the width and height of another xtd::drawing::size_f class. More...

static xtd::drawing::size_f	subtract (const xtd::drawing::size_f &sz1, const xtd::drawing::size_f &sz2) noexcept
	Returns the result of subtracting specified xtd::drawing::size_f from the specified xtd::drawing::size_f. More...

Operators
size_f	operator+ (const xtd::drawing::size_f &size) const noexcept
	Increases a xtd::drawing::size_f with a given xtd::drawing::size_f. More...

size_f	operator+ (const xtd::drawing::size &size) const noexcept
	Increases a xtd::drawing::size_f with a given xtd::drawing::size. More...

size_f &	operator+= (const xtd::drawing::size_f &size) noexcept
	Increases a xtd::drawing::size_f wuth a given xtd::drawing::size_f. More...

size_f &	operator+= (const xtd::drawing::size &size) noexcept
	Increases a xtd::drawing::size_f wuth a given xtd::drawing::size. More...

size_f	operator- (const xtd::drawing::size_f &size) const noexcept
	Decreases a xtd::drawing::size_f with the a given xtd::drawing::size_f. More...

size_f	operator- (const xtd::drawing::size &size) const noexcept
	Decreases a xtd::drawing::size_f with the a given xtd::drawing::size. More...

size_f &	operator-= (const xtd::drawing::size_f &size) noexcept
	Decreases a xtd::drawing::size_f with the a given xtd::drawing::size_f. More...

size_f &	operator-= (const xtd::drawing::size &size) noexcept
	Decreases a xtd::drawing::size_f with the a given xtd::drawing::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...

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< size_f >
virtual bool	equals (const size_f &) 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

◆ size_f() [1/3]

xtd::drawing::size_f::size_f ( )

defaultnoexcept

Initializes a new instance of the Size class that has a Height and Width value of 0.

◆ size_f() [2/3]

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

explicitnoexcept

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

Parameters

point The xtd::drawing::point_f class from which to initialize this xtd::drawing::size_f class

◆ size_f() [3/3]

xtd::drawing::size_f::size_f	(	float	width,
		float	height
	)

noexcept

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

Parameters

width	The width component of the new xtd::drawing::size_f.
height	The height component of the new xtd::drawing::size_f.

Member Function Documentation

◆ add()

static xtd::drawing::size_f xtd::drawing::size_f::add	(	const xtd::drawing::size_f &	size1,
		const xtd::drawing::size_f &	size2
	)

staticnoexcept

Adds the width and height of one xtd::drawing::size_f class to the width and height of another xtd::drawing::size_f class.

Parameters

size1	The first xtd::drawing::size_f class to add.
size2	The second xtd::drawing::size_f class to add.

Returns: A xtd::drawing::size_f class that is the result of the addition operation.

◆ height() [1/2]

float xtd::drawing::size_f::height ( ) const

noexcept

Gets he vertical component of this xtd::drawing::size_f class.

Returns: The vertical component of this xtd::drawing::size_f class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size_f::height and xtd::drawing::size_f::width of the xtd::drawing::size_f class depend on the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::graphics object that is used to draw.

Examples:: minesweeper.cpp, user_control.cpp, and wiggly.cpp.

◆ height() [2/2]

void xtd::drawing::size_f::height ( float value )

noexcept

Sets the vertical component of this xtd::drawing::size_f Class.

Parameters

value The vertical component of this xtd::drawing::size_f class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size_f::height and xtd::drawing::size_f::width of the xtd::drawing::size_f class depend on the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::graphics object that is used to draw.

◆ is_empty()

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

noexcept

Tests whether this Size class has xtd::drawing::size_f::width and xtd::drawing::size_f::height of 0.

Returns: Returns true when this xtd::drawing::size_f class has both a xtd::drawing::size_fwidth and xtd::drawing::size_fheight of 0; otherwise, false.

◆ operator+() [1/2]

size_f xtd::drawing::size_f::operator+ ( const xtd::drawing::size_f & size ) const

noexcept

Increases a xtd::drawing::size_f with a given xtd::drawing::size_f.

Parameters

size	A xtd::drawing::size_f that specifies the pair of numbers to add to the size of this xtd::drawing::size_f.

Returns: The increased xtd::drawing::size.

◆ operator+() [2/2]

size_f xtd::drawing::size_f::operator+ ( const xtd::drawing::size & size ) const

noexcept

Increases a xtd::drawing::size_f with a given xtd::drawing::size.

Parameters

size	A xtd::drawing::size that specifies the pair of numbers to add to the size of this xtd::drawing::size_f.

Returns: The increased xtd::drawing::size_f.

◆ operator+=() [1/2]

size_f& xtd::drawing::size_f::operator+= ( const xtd::drawing::size_f & size )

noexcept

Increases a xtd::drawing::size_f wuth a given xtd::drawing::size_f.

Parameters

size	A xtd::drawing::size_f that specifies the pair of numbers to add to the size of this xtd::drawing::size_f.

Returns: The increased xtd::drawing::size_f.

◆ operator+=() [2/2]

size_f& xtd::drawing::size_f::operator+= ( const xtd::drawing::size & size )

noexcept

Increases a xtd::drawing::size_f wuth a given xtd::drawing::size.

Parameters

size	A xtd::drawing::size that specifies the pair of numbers to add to the size of this xtd::drawing::size_f.

Returns: The increased xtd::drawing::size_f.

◆ operator-() [1/2]

size_f xtd::drawing::size_f::operator- ( const xtd::drawing::size_f & size ) const

noexcept

Decreases a xtd::drawing::size_f with the a given xtd::drawing::size_f.

Parameters

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

Returns: The decreased xtd::drawing::size_f.

◆ operator-() [2/2]

size_f xtd::drawing::size_f::operator- ( const xtd::drawing::size & size ) const

noexcept

Decreases a xtd::drawing::size_f with the a given xtd::drawing::size.

Parameters

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

Returns: The decreased xtd::drawing::size_f.

◆ operator-=() [1/2]

size_f& xtd::drawing::size_f::operator-= ( const xtd::drawing::size_f & size )

noexcept

Decreases a xtd::drawing::size_f with the a given xtd::drawing::size_f.

Parameters

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

Returns: The decreased xtd::drawing::size_f.

◆ operator-=() [2/2]

size_f& xtd::drawing::size_f::operator-= ( const xtd::drawing::size & size )

noexcept

Decreases a xtd::drawing::size_f with the a given xtd::drawing::size.

Parameters

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

Returns: The decreased xtd::drawing::size_f.

◆ subtract()

static xtd::drawing::size_f xtd::drawing::size_f::subtract	(	const xtd::drawing::size_f &	sz1,
		const xtd::drawing::size_f &	sz2
	)

staticnoexcept

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

Parameters

sz1	The xtd::drawing::size_f to be subtracted from.
sz2	The xtd::drawing::size_f to subtract from the Size.

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

◆ to_string()

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

overridevirtualnoexcept

Creates a human-readable string that represents this xtd::drawing::size_f class.

Returns: A xtd::ustring that represents this size.

Reimplemented from xtd::object.

◆ width() [1/2]

float xtd::drawing::size_f::width ( ) const

noexcept

Gets the horizontal component of this xtd::drawing::size_f class.

Returns: The horizontal component of this xtd::drawing::size_f class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size_f::height and xtd::drawing::size_f::width of the xtd::drawing::size_f class depend on the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::graphics object that is used to draw.

Examples:: minesweeper.cpp, and wiggly.cpp.

◆ width() [2/2]

void xtd::drawing::size_f::width ( float value )

noexcept

Sets the horizontal component of this xtd::drawing::size_f class.

Parameters

value The horizontal component of this xtd::drawing::size_f class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size_f::height and xtd::drawing::size_f::width of the xtd::drawing::size_f class depend on the xtd::drawing::graphics::page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::graphics object that is used to draw.

Member Data Documentation

◆ empty

const xtd::drawing::size_f xtd::drawing::size_f::empty

static

Gets a Size class that has a Height and Width value of 0. This field is constant.

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

xtd.drawing/include/xtd/drawing/size_f.h

Definition

Fields

Constructors

Properties

Methods

Operators

Additional Inherited Members

Constructor & Destructor Documentation

◆ size_f() [1/3]

◆ size_f() [2/3]

◆ size_f() [3/3]

Member Function Documentation

◆ add()

◆ height() [1/2]

◆ height() [2/2]

◆ is_empty()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ subtract()

◆ to_string()

◆ width() [1/2]

◆ width() [2/2]

Member Data Documentation

◆ empty