core/vgui/vgui_listmanager2D_tableau.h

Go to the documentation of this file.

// This is core/vgui/vgui_listmanager2D_tableau.h
#ifndef vgui_listmanager2D_tableau_h_
#define vgui_listmanager2D_tableau_h_
#ifdef VCL_NEEDS_PRAGMA_INTERFACE
#pragma interface
#endif
//:
// \file
// \brief  Tableau which manages a set of vgui_displaylist2D_tableau children
// \author Philip C. Pritchett, Robotics Research Group, University of Oxford
// \date   21 Oct 99
//
//  Contains classes vgui_listmanager2D_tableau  vgui_listmanager2D_tableau_new
//
// \verbatim
//  Modifications
//   21-OCT-1999 P.Pritchett - Initial version.
//   16-SEP-2002 K.Y.McGaul - Changed to and added Doxygen style documentation.
//   01-OCT-2002 K.Y.McGaul - Moved listmanager2D to listmanager2D_tableau.
// \endverbatim

#include <vgui/vgui_observable.h>
#include <vgui/vgui_tableau.h>
#include <vgui/vgui_parent_child_link.h>
#include <vgui/vgui_event.h>
#include <vgui/vgui_displaylist2D_tableau.h>
#include <vgui/vgui_listmanager2D_tableau_sptr.h>

class vgui_event;
class vgui_displaylist2D_tableau;
class vgui_soview2D;

//: Tableau which manages a set of vgui_displaylist2D_tableau children
//
//  It behaves like an acetate, but is more efficient.
class vgui_listmanager2D_tableau : public vgui_tableau
{
 public:
  //: Constructor - don't use this, use vgui_listmanager2D_tableau_new.
  //  Creates an empty vgui_listmanager2D_tableau.
  vgui_listmanager2D_tableau();

  //: Destructor.
 ~vgui_listmanager2D_tableau();

  //: Returns the type of this tableau ('vgui_listmanager2D_tableau').
  vcl_string type_name() const;

  //: Add given vgui_displaylist2D_tableau to the end of the list of children.
  void add(vgui_displaylist2D_tableau_sptr const&);

  //: Remove the given vgui_displaylist2D_tableau from the list of children.
  void remove(vgui_displaylist2D_tableau_sptr const&);

  //: Observers to be notified when a child is added or removed.
  vgui_observable observers;

  //: Make child at given index position active/inactive.
  void set_active(int, bool);

  //: Make child at given index position visible/invisible.
  void set_visible(int, bool);

  //: Return true if the child at the given index is active.
  bool is_active(int);

  //: Return true if the child at the given index is visible.
  bool is_visible(int);

  //: Handle all events sent to this tableau.
  //  In particular, use draw events to draw the child tableaux.
  bool handle(const vgui_event&);

  //: Print info on this tableau on cerr.
  bool help();

  //: Called when a key is pressed inside the rendering area.
  //  Uses key presses '1' to '9' to toggle the child tableau.
  bool key_press(int /*x*/, int /*y*/, vgui_key key, vgui_modifier);

  //: Called when the mouse is pressed inside the rendering area.
  bool mouse_down(int x, int y, vgui_button button, vgui_modifier modifier);

  //: Called when the mouse is moved inside the rendering area.
  bool motion(int x, int y);

 protected:

  // helper
  bool index_ok(int);

  // data
  vcl_vector<vgui_parent_child_link> children;
  vcl_vector<bool> active;
  vcl_vector<bool> visible;

  vgui_displaylist2D_tableau_sptr highlight_list;
  vgui_soview2D *highlight_so;
  vgui_event saved_event_;

  vgui_displaylist2D_tableau_sptr contains_hit(vcl_vector<unsigned> const& names);
  void get_hits(float x, float y, vcl_vector<vcl_vector<unsigned> >* hits);
  void find_closest(float x, float y, vcl_vector<vcl_vector<unsigned> >* hits,
                    vgui_soview2D** closest_so,
                    vgui_displaylist2D_tableau_sptr * closest_display);
};

//: Creates a smart-pointer to a new vgui_listmanager2D_tableau.
struct vgui_listmanager2D_tableau_new : public vgui_listmanager2D_tableau_sptr
{
  //: Creates a smart-pointer to a new empty vgui_listmanager2D_tableau.
  vgui_listmanager2D_tableau_new() :
    vgui_listmanager2D_tableau_sptr(new vgui_listmanager2D_tableau) { }
};

#endif // vgui_listmanager2D_tableau_h_