This class defines the size of a two-dimensional object. More...

#include <Nimble/Size.hpp>

Public Member Functions
SizeT	boundedTo (const SizeT &size) const
	Returns a size holding the minimum width and height of this and the given size. More...

template<typename S >
Nimble::SizeT< S >	cast () const
	Cast the vector to another type.

template<typename S >
SizeT< S >	cast () const

SizeT	expandedTo (const SizeT &size) const
	Returns a size holding the maximum width and height of this and the given size. More...

void	fit (T width, T height, Qt::AspectRatioMode mode)
	Fits the size to the given size. More...

void	fit (const SizeT &size, Qt::AspectRatioMode mode)
	Fits the size to the given size. More...

T	height () const
	Get the height. More...

bool	isEmpty () const
	Check if the size is empty. More...

bool	isNull () const
	Check if the size is zero. More...

bool	isValid () const
	Check if the size is invalid. More...

void	make (T width, T height)
	Set the width and height of the size. More...

T	maximum () const

T	minimum () const

bool	operator!= (const SizeT< T > &o) const
	Compare if two sizes are not equal. More...

SizeT< T >	operator+ (const SizeT< T > &o) const
	Return the sum of two sizes. More...

SizeT< T > &	operator+= (const SizeT< T > &s)
	Add the given size to this size. More...

SizeT< T >	operator- (const SizeT< T > &o) const
	Return the subtraction of two sizes. More...

SizeT< T > &	operator-= (const SizeT< T > &s)
	Subtract the given size from this size. More...

bool	operator== (const SizeT< T > &o) const
	Compare if two sizes are equal. More...

T	operator[] (int index) const
	Index an element in the size object. More...

void	setHeight (T height)
	Set the height of the size. More...

void	setWidth (T width)
	Set the width of the size. More...

	SizeT ()
	Constructs a size with invalid width and height (i.e. isValid() returns false)

	SizeT (const Nimble::Vector2T< T > &v)
	Construct a size defined by a 2D vector. More...

	SizeT (T width, T height)
	Constructs a size with the given width and height. More...

	SizeT (const SizeT &other)
	Copy constructor.

Vector2T< T >	toVector () const
	Convert the size to a vector. More...

void	transpose ()
	Transpose the size, i.e. swap the width and height.

T	width () const
	Get the width. More...

Detailed Description

template<typename T>
class Nimble::SizeT< T >

This class defines the size of a two-dimensional object.

Examples:: AdvancedRenderingExample.cpp, AnimatorExample.cpp, BookExample.cpp, CustomInputWidgetExample.cpp, CustomRenderWidgetExample.cpp, DropHandlerExample.cpp, HelloImagesExample.cpp, HelloWorldExample.cpp, ImageMovieExample.cpp, PostProcessingExample.cpp, ViewExample.cpp, and Widget3DExample.cpp.

Constructor & Destructor Documentation

template<typename T >

Nimble::SizeT< T >::SizeT ( const Nimble::Vector2T< T > & v )

explicit

Construct a size defined by a 2D vector.

Parameters

v	vector whose components define the size

template<typename T >

Nimble::SizeT< T >::SizeT	(	T	width,
		T	height
	)

Constructs a size with the given width and height.

Parameters

width	width to initialize the size to
height	height to initialize the size to

Member Function Documentation

template<typename T >

SizeT< T > Nimble::SizeT< T >::boundedTo ( const SizeT< T > & size ) const

Returns a size holding the minimum width and height of this and the given size.

Parameters

size	size to compare to

Returns: bounded size

template<typename T >

SizeT< T > Nimble::SizeT< T >::expandedTo ( const SizeT< T > & size ) const

Returns a size holding the maximum width and height of this and the given size.

Parameters

size	size to compare to

Returns: expanded size

template<typename T >

void Nimble::SizeT< T >::fit	(	T	width,
		T	height,
		Qt::AspectRatioMode	mode
	)

Fits the size to the given size.

Parameters

width	width to fit to
height	height to fit to
mode	either Qt::IgnoreAspectRatio or Qt::KeepAspectRatio

template<typename T >

void Nimble::SizeT< T >::fit	(	const SizeT< T > &	size,
		Qt::AspectRatioMode	mode
	)

Fits the size to the given size.

Parameters

size	size to fit to
mode	either Qt::IgnoreAspectRatio or Qt::KeepAspectRatio

template<typename T >

T Nimble::SizeT< T >::height ( ) const

inline

Get the height.

Returns: height of the size

template<typename T >

bool Nimble::SizeT< T >::isEmpty ( ) const

Check if the size is empty.

Returns: true if either of the width and height is less than or equal to 0; otherwise false

template<typename T >

bool Nimble::SizeT< T >::isNull ( ) const

Check if the size is zero.

Returns: true if both the width and height is 0; otherwise false

template<typename T >

bool Nimble::SizeT< T >::isValid ( ) const

Check if the size is invalid.

Returns: true if both the width and height is equal to or greater than 0; otherwise false

template<typename T >

void Nimble::SizeT< T >::make	(	T	width,
		T	height
	)

Set the width and height of the size.

Parameters

width,height new width and height

template<typename T >

T Nimble::SizeT< T >::maximum ( ) const

Returns: the larger component

template<typename T >

T Nimble::SizeT< T >::minimum ( ) const

Returns: the smaller component

template<typename T >

bool Nimble::SizeT< T >::operator!= ( const SizeT< T > & o ) const

Compare if two sizes are not equal.

Parameters

o	size to compare

Returns: true if the sizes are not equal; otherwise false

template<typename T >

SizeT< T > Nimble::SizeT< T >::operator+ ( const SizeT< T > & o ) const

Return the sum of two sizes.

Each component is added separately.

Parameters

o	size to add

Returns: sum of sizes

template<typename T >

SizeT< T > & Nimble::SizeT< T >::operator+= ( const SizeT< T > & s )

Add the given size to this size.

Parameters

s	size to add

Returns: reference to this size

template<typename T >

SizeT< T > Nimble::SizeT< T >::operator- ( const SizeT< T > & o ) const

Return the subtraction of two sizes.

Each component is subtracted separately.

Parameters

o	size to add

Returns: subtraction of two sizes

template<typename T >

SizeT< T > & Nimble::SizeT< T >::operator-= ( const SizeT< T > & s )

Subtract the given size from this size.

Parameters

s	size to subtract

Returns: reference to this size

template<typename T >

bool Nimble::SizeT< T >::operator== ( const SizeT< T > & o ) const

Compare if two sizes are equal.

Parameters

o	size to compare

Returns: true if the sizes are equal; otherwise false

template<typename T >

T Nimble::SizeT< T >::operator[] ( int index ) const

inline

Index an element in the size object.

This method does not check that the argument value is valid

template<typename T >

void Nimble::SizeT< T >::setHeight ( T height )

Set the height of the size.

Parameters

height new height

template<typename T >

void Nimble::SizeT< T >::setWidth ( T width )

Set the width of the size.

Parameters

width new width

template<typename T >

Vector2T< T > Nimble::SizeT< T >::toVector ( ) const

Convert the size to a vector.

Returns: vector representing the size with the components set to width and height of the size

Examples:: DropHandlerExample.cpp, and PositionalSoundsExample.cpp.

template<typename T >

T Nimble::SizeT< T >::width ( ) const

inline

Get the width.

Returns: width of the size

Public Member Functions

Detailed Description

template<typename T> class Nimble::SizeT< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class Nimble::SizeT< T >