karto::Size2< T > Class Template Reference

#include <Karto.h>

List of all members.

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 (const Size2 &rOther)
 Size2 (T width, T height)
 Size2 ()

Private Attributes

m_Height
m_Width

Friends

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

Detailed Description

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

Represents a point (x, y) in 2-dimensional real space.

Definition at line 745 of file Karto.h.


Constructor & Destructor Documentation

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

Default constructor

Definition at line 751 of file Karto.h.

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

Constructor initializing point location

Parameters:
width 
height 

Definition at line 762 of file Karto.h.

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

Copy constructor

Parameters:
rOther 

Definition at line 772 of file Karto.h.


Member Function Documentation

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

Gets the height

Returns:
the height

Definition at line 801 of file Karto.h.

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

Gets the width

Returns:
the width

Definition at line 783 of file Karto.h.

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

Inequality operator

Definition at line 837 of file Karto.h.

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

Assignment operator

Definition at line 818 of file Karto.h.

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

Equality operator

Definition at line 829 of file Karto.h.

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

Sets the height

Parameters:
height 

Definition at line 810 of file Karto.h.

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

Sets the width

Parameters:
width 

Definition at line 792 of file Karto.h.


Friends And Related Function Documentation

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

Write Size2 onto output stream

Parameters:
rStream output stream
rSize to write

Definition at line 847 of file Karto.h.


Member Data Documentation

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

Definition at line 855 of file Karto.h.

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

Definition at line 854 of file Karto.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


karto
Author(s): SRI International (package maintained by Brian Gerkey)
autogenerated on Fri Jan 11 10:07:06 2013