E:/dev/eLynx/include/elx/image/PixelIterator.h

//============================================================================
//  PixelIterator.h                                    Image.Component package
//============================================================================
//  Usage : define image iterator class.
//----------------------------------------------------------------------------
//  Inheritance :
//    PixelIterator<Pixel>
//      +IPixelIterator
//----------------------------------------------------------------------------
//  Copyright (C) 2006 by eLynx project
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Library General Public
//  License as published by the Free Software Foundation; either
//  version 2 of the License, or (at your option) any later version.
//
//  This library 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 Library General Public License for more details.
//----------------------------------------------------------------------------
#ifndef __PixelIterator_h__
#define __PixelIterator_h__

#include "elx/core/CoreTypes.h"
#include "IPixelIterator.h"
#include <boost/iterator/iterator_facade.hpp>
#include <boost/shared_ptr.hpp>

namespace eLynx {
namespace Image {


template <class Pixel>
class PixelIterator : 
  public IPixelIterator, 
  public boost::iterator_facade< PixelIterator<Pixel>, Pixel, boost::random_access_traversal_tag >
{
public:
  friend class boost::iterator_core_access;


  explicit PixelIterator();

  template <class PixelU>
  PixelIterator(const PixelIterator<PixelU>& iOther);

  explicit PixelIterator(Pixel * iprPixel, uint32 iWidth);



  void increment();
  
  void decrement();

  bool equal(const PixelIterator& iOther) const;

  Pixel& dereference() const;

  void advance(int32 iDist);
  
  void advance(int32 iWidth, int32 iHeight);
  
  void moveto(int32 iWidth, int32 iHeight);
  
  uint32 distance_to(const PixelIterator& iOther) const; 
  
  Pixel& operator[](int32 iIndex); 

  uint32 getWidth() const;
  
  uint32 getHorizontal() const;
  
  uint32 getVertical() const;
  
  const Pixel * getData() const;
  
  const Pixel * getFirst() const;

  const void * getMap() const;
  
  void * getMap(); 
   
private:
  Pixel * _prPixel; 
  Pixel * _prBegin; 
  uint32  _width;   
};

template <class Pixel>
PixelIterator<Pixel> elxDowncast(
    boost::shared_ptr<IPixelIterator> ispPixelIter);

template <class Pixel>
PixelIterator<const Pixel> elxConstDowncast(
    boost::shared_ptr<IPixelIterator> ispPixelIter);

} // namespace Image
} // namespace eLynx

#include "inl/Pixel/PixelIterator.inl"

#endif // __PixelIterator_h__