Public Member Functions | Private Attributes | Friends | List of all members
karto::Size2< T > Class Template Reference

#include <Geometry.h>

Public Member Functions

const T GetHeight () const
 
const T GetWidth () const
 
kt_bool operator!= (const Size2 &rOther) const
 
Size2operator= (const Size2 &rOther)
 
kt_bool operator== (const Size2 &rOther) const
 
void SetHeight (T height)
 
void SetWidth (T width)
 
 Size2 ()
 
 Size2 (T width, T height)
 
 Size2 (const Size2 &rOther)
 
const karto::String ToString () const
 

Private Attributes

m_Height
 
m_Width
 

Friends

KARTO_FORCEINLINE std::ostream & operator<< (std::ostream &rStream, const Size2 &rSize)
 

Detailed Description

template<typename T>
class karto::Size2< T >

A 2-dimensional size (width, height)

Definition at line 43 of file Geometry.h.

Constructor & Destructor Documentation

template<typename T>
karto::Size2< T >::Size2 ( )
inline

A size with a width and height of 0

Definition at line 49 of file Geometry.h.

template<typename T>
karto::Size2< T >::Size2 ( width,
height 
)
inline

A size with the given width and height

Parameters
widthwidth
heightheight

Definition at line 60 of file Geometry.h.

template<typename T>
karto::Size2< T >::Size2 ( const Size2< T > &  rOther)
inline

Copy constructor

Definition at line 69 of file Geometry.h.

Member Function Documentation

template<typename T>
const T karto::Size2< T >::GetHeight ( ) const
inline

Gets the height

Returns
the height

Definition at line 98 of file Geometry.h.

template<typename T>
const T karto::Size2< T >::GetWidth ( ) const
inline

Gets the width

Returns
the width

Definition at line 80 of file Geometry.h.

template<typename T>
kt_bool karto::Size2< T >::operator!= ( const Size2< T > &  rOther) const
inline

Inequality operator

Definition at line 148 of file Geometry.h.

template<typename T>
Size2& karto::Size2< T >::operator= ( const Size2< T > &  rOther)
inline

Assignment operator

Definition at line 129 of file Geometry.h.

template<typename T>
kt_bool karto::Size2< T >::operator== ( const Size2< T > &  rOther) const
inline

Equality operator

Definition at line 140 of file Geometry.h.

template<typename T>
void karto::Size2< T >::SetHeight ( height)
inline

Sets the height

Parameters
height

Definition at line 107 of file Geometry.h.

template<typename T>
void karto::Size2< T >::SetWidth ( width)
inline

Sets the width

Parameters
width

Definition at line 89 of file Geometry.h.

template<typename T>
const karto::String karto::Size2< T >::ToString ( ) const
inline

Returns a string representation of this size

Returns
string representation of this size

Definition at line 116 of file Geometry.h.

Friends And Related Function Documentation

template<typename T>
KARTO_FORCEINLINE std::ostream& operator<< ( std::ostream &  rStream,
const Size2< T > &  rSize 
)
friend

Write size onto output stream

Definition at line 156 of file Geometry.h.

Member Data Documentation

template<typename T>
T karto::Size2< T >::m_Height
private

Definition at line 164 of file Geometry.h.

template<typename T>
T karto::Size2< T >::m_Width
private

Definition at line 163 of file Geometry.h.


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


nav2d_karto
Author(s): Sebastian Kasperski
autogenerated on Thu Jun 6 2019 19:20:25