User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - 3D - Half Edge Mesh - HEMeshFaceIterC
 

  PUBLIC
HEMeshFaceIterC::HEMeshFaceIterC(void)
HEMeshFaceIterC::HEMeshFaceIterC(IntrDListC &)
HEMeshFaceIterC::Data(void)
HEMeshFaceIterC::Data(void) const
HEMeshFaceIterC::operator *(void)
HEMeshFaceIterC::operator *(void) const
HEMeshFaceIterC::CollapseEdge(HEMeshEdgeC)
IntrDLIterC::IsValid(void) const
IntrDLIterC::First(void)
IntrDLIterC::Last(void)
IntrDLIterC::operator bool(void) const
IntrDLIterC::IsElm(void) const
IntrDLIterC::IsFirst(void) const
IntrDLIterC::IsLast(void) const
IntrDLIterC::operator ++(void)
IntrDLIterC::operator ++(int)
IntrDLIterC::operator --(int)
IntrDLIterC::Next(void)
IntrDLIterC::Prev(void)
IntrDLIterC::NextCrc(void)
IntrDLIterC::PrevCrc(void)
IntrDLIterC::operator *(void)
IntrDLIterC::operator *(void) const
IntrDLIterC::operator ->(void)
IntrDLIterC::operator ->(void) const
IntrDLIterC::Data(void)
IntrDLIterC::Data(void) const
IntrDLIterC::Extract(void)
IntrDLIterC::Del(void)
IntrDLIterC::InsertBef(DataT &)
IntrDLIterC::InsertAft(DataT &)
IntrDLIterC::List(void)
IntrDLIterC::List(void) const
IntrDLIterC::Invalidate(void)

   HEMeshFaceIterC   
 
Mesh face iterator.
 
include "Ravl/3D/HEMeshFaceIter.hh"
Created:22/5/2002 
User Level:Normal
Library:Ravl3D
In Scope:Ravl3DN

Comments:
Note: It is the users responsibility to ensure the current face of the interator is NOT deleted until the iterator is moved to another element. Methods such as CollapseEdge() are provided to help ensure this.

Parent Classes: Methods:
HEMeshFaceIterC()
Default constructor.

HEMeshFaceIterC(IntrDListC<HEMeshFaceBodyC> & iter)
Constructor.

HEMeshFaceC Data()
Access Face.

const HEMeshFaceC Data() const
Access Face.

HEMeshFaceC operator *()
Access Face.

const HEMeshFaceC operator *() const
Access Face.

bool CollapseEdge(HEMeshEdgeC edge)
Collapse an edge on the current face.
If the face is deleted in the process the iterator is moved to the previous valid face. It will return true if the iterator has been changed.

#include "Ravl/InDLIter.hh"
bool IsValid() const
Is iterator valid ?
true is returned for a valid iterator.

void First()
Goto first element in the list.

void Last()
Goto the last element in the list.

operator bool() const
At a valid node ?

bool IsElm() const
At a valid element in the list ?
AMMA compatibilty function, use operator bool() instread.

bool IsFirst() const
At the first element in the list ?
AMMA compatibilty function.

bool IsLast() const
At the last element in the list ?
AMMA compatibilty function.

void operator ++()
Goto next element in list.

void operator ++(int)
Goto next element in list.

void operator --(int)
Goto previous element in list.

void Next()
Goto next element in list.
AMMA compatibilty function, use operator++() instread.

void Prev()
Goto previous element in list.
AMMA compatibilty function, use operator--() instread.

void NextCrc()
Goto next element in list, skip the head element.
AMMA compatibilty function.

void PrevCrc()
Goto previous element in list, skip the head element.
AMMA compatibilty function.

HEMeshFaceBodyC & operator *()
Access data.
NB. The iterator MUST be valid. check with 'operator bool()'.

const HEMeshFaceBodyC & operator *() const
Constant access to data.
NB. The iterator MUST be valid. check with 'operator bool()'.

HEMeshFaceBodyC * operator ->()
Access data.
NB. The iterator MUST be valid. check with 'operator bool()'.

const HEMeshFaceBodyC * operator ->() const
Constant access to data.
NB. The iterator MUST be valid. check with 'operator bool()'.

HEMeshFaceBodyC & Data()
Access data.
NB. The iterator MUST be valid. check with 'operator bool()'.

const HEMeshFaceBodyC & Data() const
Constant access to data.
NB. The iterator MUST be valid. check with 'operator bool()'.

HEMeshFaceBodyC & Extract()
Extract the current element from the list.
Do not delete it, the user is responsible for ensuring this happens at an approprate time. The iteration is left pointing at the element before the one extracted. The iterator must be valid.

void Del()
Delete the current element from the list.
actuall delete the element where appropriate. The iterator must be valid.

void InsertBef(HEMeshFaceBodyC & dat)
Insert data before current element.
if at the head of the list (i.e. operator bool() failes.) then add at end.

void InsertAft(HEMeshFaceBodyC & dat)
Insert data after current element.
if at the head of the list (i.e. operator bool() failes.) then add at begining.

IntrDListC<HEMeshFaceBodyC> & List()
Access the list we're iterating.

const IntrDListC<HEMeshFaceBodyC> & List() const
Access the list we're iterating.

bool Invalidate()
Point interator at an invalid element.


Maintainer:Charles Galambos, Created: 22/5/2002, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002