h o m e

d o c u m e n t a t i o n

c l a s s h i e r a r c h y

---

ChainingIterators.h

//
//  Filename         : ChainingIterators
//  Author           : Stephane Grabli
//  Purpose          : Chaining iterators
//  Date of creation : 01/07/2003
//

//
//  Copyright (C) : Please refer to the COPYRIGHT file distributed 
//   with this source distribution. 
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 2
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//
#ifndef  CHAININGITERATORS_H
# define CHAININGITERATORS_H

# include <iostream>
# include "../view_map/ViewMap.h"
# include "../view_map/ViewMapIterators.h"
# include "../view_map/ViewMapAdvancedIterators.h"
# include "Predicates1D.h"

//using namespace ViewEdgeInternal;

//
// Adjacency iterator used in the chaining process
//
class LIB_STROKE_EXPORT AdjacencyIterator{
protected:
  ViewVertexInternal::orientedViewEdgeIterator _internalIterator;
  bool _restrictToSelection;
  bool _restrictToUnvisited;
public:
  AdjacencyIterator(){
    _restrictToSelection = true;
    _restrictToUnvisited = true;
  }
  AdjacencyIterator(ViewVertex *iVertex, bool iRestrictToSelection = true, bool iRestrictToUnvisited = true){
    _restrictToSelection = iRestrictToSelection;
    _restrictToUnvisited = iRestrictToUnvisited;
    _internalIterator = iVertex->edgesBegin();
    while((!_internalIterator.isEnd()) && (!isValid((*_internalIterator).first)))
      ++_internalIterator;
  }
  AdjacencyIterator(const AdjacencyIterator& iBrother){
    _internalIterator = iBrother._internalIterator;
    _restrictToSelection = iBrother._restrictToSelection;
    _restrictToUnvisited = iBrother._restrictToUnvisited;
  }
  AdjacencyIterator& operator=(const AdjacencyIterator& iBrother) {  
    _internalIterator = iBrother._internalIterator;
    _restrictToSelection = iBrother._restrictToSelection;
    _restrictToUnvisited = iBrother._restrictToUnvisited;  
    return *this;
  } 
  virtual ~AdjacencyIterator(){
  }
  
  inline bool isEnd(){
    return _internalIterator.isEnd();
  }
  inline bool isBegin(){
    return _internalIterator.isBegin();
  }
  bool isIncoming() const ;

  virtual ViewEdge* operator*() ;
  virtual ViewEdge* operator->() {return operator*();}
  virtual AdjacencyIterator& operator++() {
    increment();
    return *this;
  }
  virtual AdjacencyIterator operator++(int) {
    AdjacencyIterator tmp(*this);
    increment();
    return tmp;
  }
  void increment();
  
protected:
  bool isValid(ViewEdge* edge);
};

//
// Base class for Chaining Iterators
//

class LIB_STROKE_EXPORT ChainingIterator : public ViewEdgeInternal::ViewEdgeIterator{
protected:
  bool _restrictToSelection;
  bool _restrictToUnvisited;
  bool _increment; //true if we're currently incrementing, false when decrementing
  
public:
  ChainingIterator(bool iRestrictToSelection = true, bool iRestrictToUnvisited = true, ViewEdge* begin = 0, bool orientation = true)
    : ViewEdgeIterator(begin, orientation) {
    _restrictToSelection = iRestrictToSelection;
    _restrictToUnvisited = iRestrictToUnvisited;
    _increment = true;
  }

  ChainingIterator(const ChainingIterator& brother)
    : ViewEdgeIterator(brother) {
    _restrictToSelection = brother._restrictToSelection;
    _restrictToUnvisited = brother._restrictToUnvisited;
    _increment = brother._increment;
  }

  virtual string getExactTypeName() const {
    return "ChainingIterator";
  }

  virtual void init(){}
  
  virtual ViewEdge * traverse(const AdjacencyIterator &it){
    cerr << "Warning: the traverse method was not defined" << endl;
    return 0;
  }
  
  /* accessors */
  //inline bool getOrientation() const {}
  inline ViewVertex * getVertex() {
    if(_increment){
      if(_orientation){
        return _edge->B();
      }else{
        return _edge->A();
      }  
    }else{
      if(_orientation){
        return _edge->A();
      }else{
        return _edge->B();
      }
    }
  }

  inline bool isIncrementing() const{
    return _increment;
  }
  
  /* increments.*/
  virtual void increment() ;
  virtual void decrement() ;
};

//
// Chaining iterators definitions
//

class LIB_STROKE_EXPORT ChainSilhouetteIterator : public ChainingIterator
{
public:
  ChainSilhouetteIterator(bool iRestrictToSelection = true, ViewEdge* begin = NULL, bool orientation = true)
    : ChainingIterator(iRestrictToSelection, true, begin, orientation) {}

  ChainSilhouetteIterator(const ChainSilhouetteIterator& brother)
    : ChainingIterator(brother) {}

  virtual string getExactTypeName() const {
    return "ChainSilhouetteIterator";
  }

  virtual ViewEdge * traverse(const AdjacencyIterator& it);

};

//
// ChainPredicateIterator
//

class LIB_STROKE_EXPORT ChainPredicateIterator : public ChainingIterator
{
protected:
  BinaryPredicate1D *_binary_predicate; // the caller is responsible for the deletion of this object
  UnaryPredicate1D  *_unary_predicate;  // the caller is responsible for the deletion of this object
public:

  ChainPredicateIterator(bool iRestrictToSelection = true, bool iRestrictToUnvisited = true, ViewEdge* begin = NULL, bool orientation = true)
    : ChainingIterator(iRestrictToSelection, iRestrictToUnvisited, begin, orientation) {
    _binary_predicate = 0;
    _unary_predicate = 0;
  }

  ChainPredicateIterator(UnaryPredicate1D& upred, BinaryPredicate1D& bpred, bool iRestrictToSelection = true, bool iRestrictToUnvisited = true, ViewEdge* begin = NULL, bool orientation = true)
    : ChainingIterator(iRestrictToSelection, iRestrictToUnvisited, begin, orientation) {
    _unary_predicate = &upred;
    _binary_predicate = &bpred;
  }

  ChainPredicateIterator(const ChainPredicateIterator& brother)
    : ChainingIterator(brother){
    _unary_predicate = brother._unary_predicate;
    _binary_predicate = brother._binary_predicate;
  }

  virtual ~ChainPredicateIterator(){
    _unary_predicate = 0;
    _binary_predicate = 0;
  }

  virtual string getExactTypeName() const {
    return "ChainPredicateIterator";
  }

  virtual ViewEdge * traverse(const AdjacencyIterator &it); 
};

#endif // CHAININGITERATORS_H

---

Last modified 3 Mar 2008

© Stephane Grabli