xtd::drawing::size_f Class Reference

Inheritance diagram for xtd::drawing::size_f:

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

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

Public Constructors
	size_f () noexcept=default
	Initializes a new instance of the Size class that has a Height and Width value of 0.
	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.
	size_f (float width, float height) noexcept
	Initializes a new instance of the xtd::drawing::size_f class from the specified dimensions.

Public Properties
float	height () const noexcept
	Gets he vertical component of this xtd::drawing::size_f class.
void	height (float value) noexcept
	Sets the vertical component of this xtd::drawing::size_f Class.
bool	is_empty () const noexcept
	Tests whether this Size class has xtd::drawing::size_f::width and xtd::drawing::size_f::height of 0.
float	width () const noexcept
	Gets the horizontal component of this xtd::drawing::size_f class.
void	width (float value) noexcept
	Sets the horizontal component of this xtd::drawing::size_f class.

Public 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.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.

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

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

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class 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 >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< size_f >
virtual bool	equals (const size_f &) const noexcept=0
	Indicates wheth er the current object is equal to another object of the same type.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

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.

equals() [1/2]

virtual bool xtd::object::equals ( const object &  obj ) const

virtualnoexcept

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.

Examples

The following code example compares the current instance with another object.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output:
//
// false
// false
// true
// true

Reimplemented from xtd::object.

equals() [2/2]

template<typename object_a_t , typename object_b_t >

static bool xtd::object::equals ( const object_a_t &  object_a, const object_b_t &  object_b  )

inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters

object_a	The first object to compare.
object_b	The second object to compare.

Returns

true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.

Examples

The following code example compares different objects.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  ustring s1 = "Tom";
  ustring s2 = "Carol";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Tom";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Carol";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
}
 
// This code produces the following output:
//
// object::equals("Tom", "Carol") => false
// object::equals("Tom", "Tom") => true
// object::equals("", "Tom") => false
// object::equals("Carol", "") => false
// object::equals("", "") => true

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.

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 &  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+() [2/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+=() [1/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+=() [2/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-() [1/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-() [2/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-=() [1/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.

operator-=() [2/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.

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.

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