extent.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2020 by the OpenStructure authors
// Copyright (C) 2003-2010 by the IPLT authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 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 Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
 
/*
  Extent
 
  Author: Ansgar Philippsen
*/
 
#ifndef IMG_EXTENT_H
#define IMG_EXTENT_H
 
#include <ost/message.hh>
#include <iosfwd>
#include <ost/message.hh>
 
#include "point.hh"
#include "size.hh"
 
/*
  TODO:
 
  add CenterOrigin() -> return extent who's (0,0,0) is in the center
  add TLFOrigin()    -> return extent with start=(0,0,0)
  add operators      -> add/sub with point and extent
*/
 
namespace ost { namespace img {
 
struct DLLEXPORT InvalidExtentException: public Error
{
  InvalidExtentException(const String& m= String("") ):
    Error(String("an invalid extent occurred ("+m+String(")")))
  {}
};
 
 
class DLLEXPORT_OST_IMG_BASE Extent {
 public:
  Extent();
 
  Extent(const Extent &r);
 
  Extent(const Point& p1, const Point& p2);
 
 
  Extent(const Size& s);
 
  /*
    The given point will be the in the center of the
    extent, with the size according to the even/odd rule
    as described for Extent(const Size& s)
  */
  Extent(const Size& size, const Point& center);
 
  /*
    The extent will go from start to (size-1)+start
  */
  Extent(const Point& start, const Size& size);
 
  const Point& GetStart() const;
  const Point& GetEnd() const;
 
  void SetStart(const Point& o);
  void SetEnd(const Point& e);
 
  bool Contains(const Point& p) const;
  bool Contains(const Extent& e) const;
 
  Point GetCenter() const;
 
  Size GetSize() const;
  int GetWidth() const;
  int GetHeight() const;
  int GetDepth() const;
  int GetVolume() const;
 
  int GetDim() const;
 
  /* 
     Ensures that the given point lies within Extent, 
     using wrap around if necessary
   */
  Point WrapAround(const Point& p);  
 
  Extent Mirror(int planes);
 
  unsigned int Point2Offset(const Point& p);
 
  // operators
  bool operator==(const Extent& b) const {return equal(b);}
  bool operator!=(const Extent& b) const {return !equal(b);}
  
  void Shift(const Point& p);
 
 private:
  Point start_,end_;
 
  void set(const Point& p1, const Point& p2);
  bool equal(const Extent& b) const;
 
};
 
// 'global' functions using extent
 
DLLEXPORT_OST_IMG_BASE bool HasOverlap(const Extent& e1, const Extent& e2);
DLLEXPORT_OST_IMG_BASE Extent Overlap(const Extent& e1, const Extent& e2);
 
DLLEXPORT_OST_IMG_BASE std::ostream& operator<<(std::ostream& os, const img::Extent &b);
 
}} // namespace img
 
 
#endif