girl::direction Class Reference

4-connexe direction class. More...

#include <girl/girlDirection.hpp>


Public Member Functions

 direction (eDirection d=INVALID)
 Constructor.
 operator int () const
 int conversion operator.
girl::direction opposite () const
 Gives the opposite direction.
girl::direction previous () const
 Gives previous direction of d in positive order.
girl::direction next () const
 Gives next direction of d in positive order.
void write (girl::io::Writer &w, girl::io::Type ioType) const
 Write direction d with function fct.
bool read (girl::io::Reader &r, girl::io::Type ioType)
 Read direction d with function fct.


Detailed Description

4-connexe direction class.

Member Function Documentation

girl::direction girl::direction::next (  )  const [inline]

Gives next direction of d in positive order.

Warning:
direction d must not be INVALID

girl::direction girl::direction::opposite (  )  const [inline]

Gives the opposite direction.

Warning:
direction d must not be INVALID

girl::direction girl::direction::previous (  )  const [inline]

Gives previous direction of d in positive order.

Warning:
direction d must not be INVALID

bool girl::direction::read ( girl::io::Reader &  r,
girl::io::Type  ioType 
) [inline]

Read direction d with function fct.

user_data allows to pass a context to the function.

Returns:
true if read was ok, else false.

void girl::direction::write ( girl::io::Writer &  w,
girl::io::Type  ioType 
) const [inline]

Write direction d with function fct.

user_data allows to pass a context to the function.


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

Generated on Thu Jun 4 14:30:33 2009 for GIRL: General Image Representation Library by  doxygen 1.5.7.1