region.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the papyrus library.                             *
 *                                                                         *
 *   papyrus is free software; you can redistribute it and/or modify       *
 *   it under the terms of the GNU Lesser General Public License           *
 *   version 3.0 as published by the Free Software Foundation.             *
 *                                                                         *
 *   papyrus 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 version 3.0 for more details.       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with the papyrus library. If not, see                   *
 *   <http://www.gnu.org/licenses/>.                                       *
 ***************************************************************************/
#ifndef PAPYRUSREGION_H
#define PAPYRUSREGION_H

#include <cairomm/cairomm.h>

#include <papyrus/object.h>
#include <papyrus/matrix.h>

namespace Papyrus
{

  class Region: public sigc::trackable
  {
    public:

      Region ( double x=NAN, double y=NAN, double w=NAN, double h=NAN );

      virtual ~Region();

      double x() const;
      double y() const;
      double width() const;
      double height() const;

      void xywh ( double& x, double& y, double& w, double& h ) const;

      double left() const;
      double right() const;
      double top() const;
      double bottom() const;
      void lrtb ( double& l, double& r, double& t, double& b ) const;
      void set_lrtb( double l, double r, double t, double b );

      void center ( double& x, double& y ) const;


      void set_x ( double x );
      void set_y ( double y );
      void set_width ( double w );
      void set_height ( double h );
      void set_xywh ( double x, double y, double w, double h );

      void invalidate();

      bool include ( const Region& other );

      bool include ( double x, double y );

      bool include_x ( double x );

      bool include_y ( double y );

      void left_bottom ( double& l, double& b ) const;
      void right_top ( double& r, double& t ) const;

      Region& operator= ( const Region& other );

      bool operator== ( const Region& other ) const;

      bool operator!= ( const Region& other ) const;

      bool operator< ( const Region& other ) const;

      bool operator<= ( const Region& other ) const;

      bool operator> ( const Region& other ) const;

      bool operator>= ( const Region& other ) const;

      operator bool() const;

      bool is_inside ( double x, double y ) const ;

      bool is_interior ( double x, double y ) const ;

      bool is_boundary ( double x, double y ) const ;

      bool overlaps( const Region& other ) const;

      void transform ( const Matrix& matrix );

      sigc::signal<void>& signal_changed();

    protected:
      double m_x, m_y, m_w, m_h;
      bool m_suppress_change_signal;
      sigc::signal<void> m_signal_changed;

      bool include_point(double x, double y);

      
  };

}

#endif