Dimensions.hh

Go to the documentation of this file.

/*  Dimensions

HiROC CVS ID: Dimensions.hh,v 1.7 2010/11/24 03:32:14 castalia Exp

Copyright (C) 2007  Arizona Board of Regents on behalf of the
Planetary Image Research Laboratory, Lunar and Planetary Laboratory at
the University of Arizona.

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License, version 2.1,
as published by the Free Software Foundation.

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
*/

#ifndef _Dimensions_
#define _Dimensions_

#include    <iosfwd>


namespace UA
{
namespace HiRISE
{
//******************************************************************************
struct Point_2D
{
int
    X;
int
    Y;

/*==============================================================================
    Constructors:
*/
Point_2D ();

Point_2D (const int& x,const int& y);

Point_2D (const Point_2D& point);

Point_2D& operator= (const Point_2D& point);

/*==============================================================================
    Accessors:
*/
inline int x () const
    {return X;}

inline Point_2D& x (const int& x_position)
    {X = x_position; return *this;}

inline int y () const
    {return Y;}

inline Point_2D& y (const int& y_position)
    {Y = y_position; return *this;}

};  //  End of Point_2D class.

std::ostream& operator<< (std::ostream& stream, const Point_2D& point);

//******************************************************************************
struct Size_2D
{
unsigned int
    Width;
unsigned int
    Height;

/*==============================================================================
    Constructors:
*/
Size_2D ();

Size_2D (const unsigned int& width, const unsigned int& height);

Size_2D (const unsigned int& side);

Size_2D (const Size_2D& size);

Size_2D& operator= (const Size_2D& size);

/*==============================================================================
    Accessors:
*/
inline unsigned int width () const
    {return Width;}

inline Size_2D& width (const unsigned int& width)
    {Width = width; return *this;}

inline unsigned int height () const
    {return Height;}

inline Size_2D& height (const unsigned int& height)
    {Height = height; return *this;}

inline unsigned long area () const
    {return Width * Height;}

};  //  End of Size_2D class.

std::ostream& operator<< (std::ostream& stream, const Size_2D& size);

//******************************************************************************
struct Rectangle
:   public Point_2D,
    public Size_2D
{
/*==============================================================================
    Constructors:
*/
Rectangle ();

Rectangle (const Point_2D& position, const Size_2D& size);

Rectangle (const Size_2D& size);

Rectangle
    (
    const int           x,
    const int           y,
    const unsigned int  width = 0,
    const unsigned int  height = 0
    );

Rectangle (const Rectangle& rectangle);

Rectangle& operator= (const Rectangle& rectangle);

/*==============================================================================
    Accessors:
*/
inline Point_2D position () const
    {return Point_2D (X, Y);}

inline Rectangle& position
    (
    const Point_2D& point
    )
{
X = point.X;
Y = point.Y;
return *this;
}

inline Rectangle& position
    (
    const int   x,
    const int   y
    )
{
X = x;
Y = y;
return *this;
}

inline Size_2D size () const
    {return Size_2D (Width, Height);}

inline Rectangle& size
    (
    const Size_2D&  size
    )
{
Width  = size.Width;
Height = size.Height;
return *this;
}

inline Rectangle& size
    (
    const unsigned int  width,
    const unsigned int  height
    )
{
Width = width;
Height = height;
return *this;
}

/*==============================================================================
    Manipulators:
*/
Rectangle& operator&= (const Rectangle& rectangle);

};  //  End of Rectangle class.

std::ostream& operator<< (std::ostream& stream, const Rectangle& rectangle);

}   //  namespace HiRISE
}   //  namespace UA
#endif