#line 1 "/user/cvsspst/ees1cg/RAVL/RAVL-0.7/Core/Base/SubIndexRange3dIter.hh"
// This file is part of RAVL, Recognition And Vision Library 
// Copyright (C) 2001, University of Surrey
// This code may be redistributed under the terms of the GNU Lesser
// General Public License (LGPL). See the lgpl.licence file for details or
// see http://www.gnu.org/copyleft/lesser.html
// file-header-ends-here
#ifndef RAVL_SUBINDEXRANGE3DITER_HEADER
#define RAVL_SUBINDEXRANGE3DITER_HEADER 1
//! author="Charles Galambos"
//! docentry="Ravl.Core.Indexing"
//! rcsid="$Id: SubIndexRange3dIter.hh,v 1.3 2002/08/08 16:03:10 craftit Exp $"
//! lib=RavlCore
//! file="Ravl/Core/Base/SubIndexRange3dIter.hh"

#include "Ravl/IndexRange3d.hh"

namespace RavlN {
  
  //! userlevel=Normal
  //: Slide a rectangular window over a larger rectangle.
  // Slide a window over all possible positions in a
  // larger rectangle.
  
  class SubIndexRange3dIterC 
  {
  public:
    SubIndexRange3dIterC(const IndexRange3dC &nImageRect,const IndexRange3dC &nwindow)
      : size2(nwindow.Range2().Size()),
	size3(nwindow.Range3().Size()),
	imageRect(nImageRect),
	window(nwindow)
    { First(); }
    //: Constructor.
    
    IndexRange3dC &Window()
    { return window; }
    //: Access current window.

    const IndexRange3dC &Window() const
    { return window; }
    //: Access current window.
    
    void First() { 
      UIntT size1 = window.Range1().Size();
      window.Range1().Min() = imageRect.Range1().Min();
      window.Range1().Max() = window.Range1().Min() + size1 - 1;
      window.Range2().Min() = imageRect.Range2().Min();
      window.Range2().Max() = window.Range2().Min() + size2 - 1;
      window.Range3().Min() = imageRect.Range3().Min();
      window.Range3().Max() = window.Range3().Min() + size3 - 1;
    }
    //: Goto first position.
    
    bool Next() {
      ++(window.Range3());
      if(window.Range3().Max() <= imageRect.Range3().Max())
	return true;
      window.Range3().Min() = imageRect.Range3().Min();
      window.Range3().Max() = window.Range3().Min() + size3 - 1;
      ++(window.Range2());
      if(window.Range2().Max() <= imageRect.Range2().Max())
	return true;
      window.Range2().Min() = imageRect.Range2().Min();
      window.Range2().Max() = window.Range2().Min() + size2 - 1;
      ++(window.Range1());
      return false;
    }
    //:Goto next position.
    
    bool operator++(int) 
    { return Next(); }
    //:Goto next position.
    // Returns true if window is on the same row.
    
    bool IsElm() const
    { return window.Range1().Max() <= imageRect.Range1().Max(); }
    //: At a valid position ?

    operator bool() const
    { return IsElm(); }
    //: At a valid position ?
    
  protected:
    UIntT size2;
    UIntT size3;
    IndexRange3dC imageRect;
    IndexRange3dC window;
  };
  
}

#endif