casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
MWCETRegion.h
Go to the documentation of this file.
00001 //# MWCETRegion.h: WorldCanvas event-based circle region drawer
00002 //# Copyright (C) 1999,2000,2001,2002
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id$
00027 
00028 #ifndef TRIALDISPLAY_MWCETREGION_H
00029 #define TRIALDISPLAY_MWCETREGION_H
00030 
00031 //# aips includes
00032 #include <casa/aips.h>
00033 #include <casa/Arrays/Vector.h>
00034 
00035 //# trial includes
00036 
00037 //# display library includes
00038 #include <display/DisplayEvents/MWCEllipseTool.h>
00039 
00040 namespace casa { //# NAMESPACE CASA - BEGIN
00041 
00042 // <summary>
00043 // WorldCanvas event-based elliptical region drawer
00044 // </summary>
00045 
00046 // <use visibility=export>
00047 
00048 // <reviewed reviewer="" data="yyyy/mm/dd" tests="" demos="">
00049 // </reviewed>
00050 
00051 // <prerequisites>
00052 //   <li> MWCEllipseTool
00053 // </prerequisites>
00054 
00055 // <etymology>
00056 // MWCETRegion stands for MultiWorldCanvas Ellipse Tool Region
00057 // </etymology>
00058 
00059 // <synopsis> 
00060 // This class finalises the functionality in MWCEllipseTool to
00061 // implement event-based drawing of elliptical regions on a
00062 // WorldCanvas.  Double clicking inside the constructed ellipse
00063 // emits the region, whilst pressing Escape cancels the region. 
00064 // </synopsis>
00065 
00066 // <example>
00067 // </example>
00068 
00069 // <motivation>
00070 // Elliptical regions are very common regions, and constructing
00071 // them visually can be very efficient.
00072 // </motivation>
00073 
00074 // <todo asof="1999/02/10">
00075 //   <li> Nothing known
00076 // </todo>
00077 
00078 class MWCETRegion : public MWCEllipseTool {
00079 
00080  public:
00081 
00082   // Constructor
00083   MWCETRegion(Display::KeySym keysym = Display::K_Pointer_Button2);
00084 
00085   // Destructor
00086   virtual ~MWCETRegion();
00087 
00088   // handle events, via new-style interface.  Currently just for reset event.
00089   virtual void handleEvent(DisplayEvent& ev);
00090 
00091  protected:
00092 
00093   // Handle double-click inside the rectangle.  Invokes regionReady().
00094   virtual void doubleInside();
00095 
00096   // This function is called when a region is deliberately "finished"
00097   // by the user.  It can be implemented to do further actions, such
00098   // as report the region to the application
00099   virtual void regionReady() { };
00100 
00101   // get the world coords of the current rectangular region
00102   void getWorldCoords(Vector<Double> &x, Vector<Double> &y);
00103   
00104   // get the linear coords of the current rectangular region
00105   void getLinearCoords(Vector<Double> &x, Vector<Double> &y);
00106 
00107 };
00108 
00109 
00110 } //# NAMESPACE CASA - END
00111 
00112 #endif