TFViewWidget.h

Go to the documentation of this file.

//------------------------------------------------------------------------
//
//   Joe Kniss
//     9-01-03
//                   ________    ____   ___ 
//                  |        \  /    | /  /
//                  +---+     \/     |/  /
//                  +--+|  |\    /|     < 
//                  |  ||  | \  / |  |\  \ 
//                  |      |  \/  |  | \  \ 
//                   \_____|      |__|  \__\
//                       Copyright  2003 
//                      Joe Michael Kniss
//                   <<< jmk@cs.utah.edu >>>
//               "All Your Base are Belong to Us"
//-------------------------------------------------------------------------

// TFViewWidget.h

// a base interface for transfer function views, ie 2D projections

#ifndef __TF_VIEW_WIDGET_DOT_H
#define __TF_VIEW_WIDGET_DOT_H

#include <widget/FrameWidget.h>
#include "TFSurfaceWidget.h"
#include <signalGutz.h>

/// TFViewWidget, a class for handling interaction in 2D projections of 
///   transfer function domain.  
class TFViewWidget : public FrameWidget {
public:
   
   /// must be constructed with a valid TFSurface proto and a factory!
   /// see TFSurfaceWidget and GLTFSurfaceWidget
   TFViewWidget(TFSurfaceWidget *const surfProto, 
                const WidgetFactory &wf, 
                WidgetItem          *parent = 0, 
                const gutz::vec3f   &ll = gutz::vec3f(-1,-1,0),
                const gutz::vec3f   &lr = gutz::vec3f(1,-1,0),
                const gutz::vec3f   &ul = gutz::vec3f(-1,1,0),
                const gutz::vec3f   &ur = gutz::vec3f(1,1,0));

   TFViewWidget &operator=(const TFViewWidget &tfv)
   {
      FrameWidget::operator =(tfv);
      return *this;
   }

   ///@name Axes
   ///   May not always be meaningfull, but it is very convenient for this 
   ///    widget to store this information, even though that exposes (some of)
   ///    the "symantics" of this widget, it is called TFViewWidget after all :). \n
   ///    Mostly done to save time and effort spent in keeping around a map from 
   ///    TFViewWidgets -> axies and visa-versa. \n
   ///    By Default axes == (0,1)
   ///@{
   gutz::vec2i getAxes() const                  { return _axes; }
   gutz::vec2i setAxes(const gutz::vec2i &axes) { _axes = axes; }
   ///@}

   HAS_SLOTS;

   ///@name Signals
   ///@{

   /// insertElementEvent(const gutz::vec2i axes, const vec2f& pos) signal. 
   ///   The surface of the transfer function was clicked,
   ///   and that event maps to the insert event.  The first parameter
   ///   is the axes idicies of the view that emmited the event, and
   ///   the last one is the (0,1) range position of that click within
   ///   the TFViewWidgets frame.
   gutz::Signal<const gutz::vec2i&, const gutz::vec2f&>  insertElementEvent;

   ///@}

   ///@name TFSurface set/get/del
   ///  The tf surface should be the same object as the SurfaceWidget
   ///   contained in the FrameWidget level of the hierarchy
   ///@{
   void               setTFSurface(TFSurfaceWidget *sw);
   TFSurfaceWidgetSP  getTFSurface() const { return _tfsurf; }
   void               delTFSurface();
   ///@}

   ///@name Behaviors
   ///@{

   /// draw just forwards event to children, this widget
   /// is a composite so we don't draw anything ourselves.
   virtual void drawDef(const gutz::RenderEvent &r)
   {
      FrameWidget::drawDef(r);
   }

   virtual bool mouseChild(WidgetItem *child, const gutz::MouseEvent &me);

   ///   override of FrameWidget::moveChild
   virtual bool moveChild(WidgetItem *child, const gutz::MouseMoveEvent &mme);
   
   ///@}


protected:
   TFViewWidget(); ///< not used
   /// copy
   TFViewWidget(const TFViewWidget &tfv)
      : FrameWidget(tfv), _tfsurf(0)
   {
      if(tfv._tfsurf)
         setTFSurface(tfv._tfsurf->cloneTFSurface());
   }

   /// the tf surface widget
   TFSurfaceWidgetSP _tfsurf;

   /// the axies we represent
   gutz::vec2i       _axes;
};
typedef gutz::SmartPtr<TFViewWidget> TFViewWidgetSP;

#endif

---

Send questions, comments, and bug reports to: