base::Array2D< T, BASE > Class Template Reference

2D array that clamps indexs. More...

#include <base_types_array.hh>

List of all members.

Public Member Functions

 Array2D (void)
 Array2D (int sx, int sy)
 (sx,sy) defines 2D size.
 ~Array2D ()
void clear (void)
void resize (int sx, int sy)
uint size (void) const
uint GetIdx (int x, int y) const
 
Returns:
Flat index into array from (x,y).

T & Get (int x, int y)
const T & Get (int x, int y) const
T & operator[] (uint i)
const T & operator[] (uint i) const

Public Attributes

int mSx
 size of X dimension
int mSy
 size of Y dimension
vector< T > mVec


Detailed Description

template<typename T, typename BASE = Void>
class base::Array2D< T, BASE >

2D array that clamps indexs.

Indexs are signed, rather than unsigned, to clamp negatives at 0.


Constructor & Destructor Documentation

template<typename T, typename BASE = Void>
base::Array2D< T, BASE >::Array2D ( void   )  [inline]

template<typename T, typename BASE = Void>
base::Array2D< T, BASE >::Array2D ( int  sx,
int  sy 
) [inline]

(sx,sy) defines 2D size.

template<typename T, typename BASE = Void>
base::Array2D< T, BASE >::~Array2D (  )  [inline]


Member Function Documentation

template<typename T, typename BASE = Void>
void base::Array2D< T, BASE >::clear ( void   )  [inline]

template<typename T, typename BASE = Void>
void base::Array2D< T, BASE >::resize ( int  sx,
int  sy 
) [inline]

template<typename T, typename BASE = Void>
uint base::Array2D< T, BASE >::size ( void   )  const [inline]

template<typename T, typename BASE = Void>
uint base::Array2D< T, BASE >::GetIdx ( int  x,
int  y 
) const [inline]

Returns:
Flat index into array from (x,y).

template<typename T, typename BASE = Void>
T& base::Array2D< T, BASE >::Get ( int  x,
int  y 
) [inline]

template<typename T, typename BASE = Void>
const T& base::Array2D< T, BASE >::Get ( int  x,
int  y 
) const [inline]

template<typename T, typename BASE = Void>
T& base::Array2D< T, BASE >::operator[] ( uint  i  )  [inline]

template<typename T, typename BASE = Void>
const T& base::Array2D< T, BASE >::operator[] ( uint  i  )  const [inline]


Member Data Documentation

template<typename T, typename BASE = Void>
int base::Array2D< T, BASE >::mSx

size of X dimension

template<typename T, typename BASE = Void>
int base::Array2D< T, BASE >::mSy

size of Y dimension

template<typename T, typename BASE = Void>
vector<T> base::Array2D< T, BASE >::mVec


The documentation for this class was generated from the following file: Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:20 2007