vgui_listmanager2D_tableau Class Reference

#include <vgui_listmanager2D_tableau.h>

Inheritance diagram for vgui_listmanager2D_tableau:

Inheritance graph
[legend]

List of all members.


Detailed Description

Tableau which manages a set of vgui_displaylist2D_tableau children.

It behaves like an acetate, but is more efficient.

Definition at line 36 of file vgui_listmanager2D_tableau.h.


Public Member Functions

 vgui_listmanager2D_tableau ()
 Constructor - don't use this, use vgui_listmanager2D_tableau_new.
 ~vgui_listmanager2D_tableau ()
 Destructor.
vcl_string type_name () const
 Returns the type of this tableau ('vgui_listmanager2D_tableau').
void add (vgui_displaylist2D_tableau_sptr const &)
 Add given vgui_displaylist2D_tableau to the end of the list of children.
void remove (vgui_displaylist2D_tableau_sptr const &)
 Remove the given vgui_displaylist2D_tableau from the list of children.
void set_active (int, bool)
 Make child at given index position active/inactive.
void set_visible (int, bool)
 Make child at given index position visible/invisible.
bool is_active (int)
 Return true if the child at the given index is active.
bool is_visible (int)
 Return true if the child at the given index is visible.
bool handle (const vgui_event &)
 Handle all events sent to this tableau.
bool help ()
 Print info on this tableau on cerr.
bool key_press (int, int, vgui_key key, vgui_modifier)
 Called when a key is pressed inside the rendering area.
bool mouse_down (int x, int y, vgui_button button, vgui_modifier modifier)
 Called when the mouse is pressed inside the rendering area.
bool motion (int x, int y)
 Called when the mouse is moved inside the rendering area.
virtual vcl_string name () const
 Return the name of the tableau.
virtual vcl_string file_name () const
 Return the name of a file associated with some tableau below (if meaningful).
virtual vcl_string pretty_name () const
 Used to provide an informative name for printouts, debugging etc.
void get_parents (vcl_vector< vgui_tableau_sptr > *out) const
 Get the parent tableaux for this tableau.
void get_children (vcl_vector< vgui_tableau_sptr > *out) const
 Get the child tableaux for this tableau.
vgui_tableau_sptr get_child (unsigned i) const
 Get the ith child or return 0.
virtual bool add_child (vgui_tableau_sptr const &)
 Add the given tableau to the list of child tableaux.
virtual bool remove_child (vgui_tableau_sptr const &)
 Remove the given child from the list of child tableaux.
virtual bool notify_replaced_child (vgui_tableau_sptr const &old_child, vgui_tableau_sptr const &new_child)
 Called whenever a child of this tableau is about to be forcibly replaced.
virtual void add_popup (vgui_menu &)
 Add the given menu to the popup menu for the tableau.
virtual void get_popup (vgui_popup_params const &, vgui_menu &)
 Get the default popup menu for the tableau.
virtual void post_message (char const *, void const *)
 Post a message event.
virtual void post_redraw ()
 Post a draw event.
virtual void post_overlay_redraw ()
 Post a overlay-redraw event.
virtual void post_idle_request ()
 Post an idle request event.
virtual bool get_bounding_box (float low[3], float high[3]) const
 Get the bounding box of this tableau.
virtual bool draw ()
 Called by default handle when it receives a draw event.
virtual bool mouse_up (int x, int y, vgui_button, vgui_modifier)
 Called by default handle when it receives a mouse up event.
virtual bool idle ()
 Called when the application is otherwise idle.
void ref () const
 Increase the reference count by one (for smart pointers).
void unref () const
 Decrease the reference count by one (for smart pointers).

Static Public Member Functions

static void get_all (vcl_vector< vgui_tableau_sptr > *out)
 Push all tableaux onto the given vector.
static bool exists (vgui_tableau_sptr const &)
 Returns true if the given address points to a valid tableau.

Public Attributes

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

Protected Member Functions

bool index_ok (int)
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)

Protected Attributes

vcl_vector
< vgui_parent_child_link
children
vcl_vector< bool > active
vcl_vector< bool > visible
vgui_displaylist2D_tableau_sptr highlight_list
vgui_soview2Dhighlight_so
vgui_event saved_event_

Constructor & Destructor Documentation

vgui_listmanager2D_tableau::vgui_listmanager2D_tableau (  ) 

Constructor - don't use this, use vgui_listmanager2D_tableau_new.

Creates an empty vgui_listmanager2D_tableau.

Definition at line 29 of file vgui_listmanager2D_tableau.cxx.

vgui_listmanager2D_tableau::~vgui_listmanager2D_tableau (  ) 

Destructor.

Definition at line 35 of file vgui_listmanager2D_tableau.cxx.


Member Function Documentation

vcl_string vgui_listmanager2D_tableau::type_name (  )  const [virtual]

Returns the type of this tableau ('vgui_listmanager2D_tableau').

Reimplemented from vgui_tableau.

Definition at line 39 of file vgui_listmanager2D_tableau.cxx.

void vgui_listmanager2D_tableau::add ( vgui_displaylist2D_tableau_sptr const &  dl  ) 

Add given vgui_displaylist2D_tableau to the end of the list of children.

Add a child to the end of the vcl_list.

Definition at line 45 of file vgui_listmanager2D_tableau.cxx.

void vgui_listmanager2D_tableau::remove ( vgui_displaylist2D_tableau_sptr const &  t  ) 

Remove the given vgui_displaylist2D_tableau from the list of children.

Remove the given child from the vcl_list.

Definition at line 54 of file vgui_listmanager2D_tableau.cxx.

void vgui_listmanager2D_tableau::set_active ( int  v,
bool  b 
)

Make child at given index position active/inactive.

Definition at line 69 of file vgui_listmanager2D_tableau.cxx.

void vgui_listmanager2D_tableau::set_visible ( int  v,
bool  b 
)

Make child at given index position visible/invisible.

Definition at line 81 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::is_active ( int  v  ) 

Return true if the child at the given index is active.

Definition at line 75 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::is_visible ( int  v  ) 

Return true if the child at the given index is visible.

Definition at line 87 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::handle ( const vgui_event event  )  [virtual]

Handle all events sent to this tableau.

vgui_listmanager2D_tableau events are send to the child displaylist which holds the closest soview2d.

In particular, use draw events to draw the child tableaux.

Reimplemented from vgui_tableau.

Definition at line 201 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::help (  )  [virtual]

Print info on this tableau on cerr.

Reimplemented from vgui_tableau.

Definition at line 98 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::key_press ( int  ,
int  ,
vgui_key  key,
vgui_modifier   
) [virtual]

Called when a key is pressed inside the rendering area.

Uses key presses '1' to '9' to toggle the child tableau.

Reimplemented from vgui_tableau.

Definition at line 320 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::mouse_down ( int  x,
int  y,
vgui_button  button,
vgui_modifier  modifier 
) [virtual]

Called when the mouse is pressed inside the rendering area.

Reimplemented from vgui_tableau.

Definition at line 289 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::motion ( int  x,
int  y 
) [virtual]

Called when the mouse is moved inside the rendering area.

Reimplemented from vgui_tableau.

Definition at line 229 of file vgui_listmanager2D_tableau.cxx.

bool vgui_listmanager2D_tableau::index_ok ( int  v  )  [protected]

Definition at line 93 of file vgui_listmanager2D_tableau.cxx.

vgui_displaylist2D_tableau_sptr vgui_listmanager2D_tableau::contains_hit ( vcl_vector< unsigned > const &  names  )  [protected]

Definition at line 108 of file vgui_listmanager2D_tableau.cxx.

void vgui_listmanager2D_tableau::get_hits ( float  x,
float  y,
vcl_vector< vcl_vector< unsigned > > *  hits 
) [protected]

Definition at line 126 of file vgui_listmanager2D_tableau.cxx.

void vgui_listmanager2D_tableau::find_closest ( float  x,
float  y,
vcl_vector< vcl_vector< unsigned > > *  hits,
vgui_soview2D **  closest_so,
vgui_displaylist2D_tableau_sptr closest_display 
) [protected]

Definition at line 151 of file vgui_listmanager2D_tableau.cxx.

virtual vcl_string vgui_tableau::name ( void   )  const [inline, virtual, inherited]

Return the name of the tableau.

Reimplemented in vgui_easy2D_tableau.

Definition at line 90 of file vgui_tableau.h.

virtual vcl_string vgui_tableau::file_name (  )  const [inline, virtual, inherited]

Return the name of a file associated with some tableau below (if meaningful).

Reimplemented in vgui_blender_tableau, vgui_composite_tableau, vgui_deck_tableau, vgui_easy2D_tableau, vgui_enhance_tableau, vgui_image_tableau, vgui_roi_tableau, vgui_wrapper_tableau, and vgui_vrml_tableau.

Definition at line 93 of file vgui_tableau.h.

virtual vcl_string vgui_tableau::pretty_name (  )  const [inline, virtual, inherited]

Used to provide an informative name for printouts, debugging etc.

Often it's type_name() + some representation of the essential state.

Reimplemented in vgui_composite_tableau, vgui_deck_tableau, vgui_easy2D_tableau, vgui_image_tableau, vgui_roi_tableau, vgui_wrapper_tableau, and vgui_vrml_tableau.

Definition at line 97 of file vgui_tableau.h.

void vgui_tableau::get_parents ( vcl_vector< vgui_tableau_sptr > *  out  )  const [inherited]

Get the parent tableaux for this tableau.

Push parents onto the given vcl_vector.

Definition at line 260 of file vgui_tableau.cxx.

void vgui_tableau::get_children ( vcl_vector< vgui_tableau_sptr > *  out  )  const [inherited]

Get the child tableaux for this tableau.

Push children onto the given vcl_vector.

Definition at line 267 of file vgui_tableau.cxx.

vgui_tableau_sptr vgui_tableau::get_child ( unsigned  i  )  const [inherited]

Get the ith child or return 0.

Get the ith child, or return 0.

Definition at line 274 of file vgui_tableau.cxx.

bool vgui_tableau::add_child ( vgui_tableau_sptr const &   )  [virtual, inherited]

Add the given tableau to the list of child tableaux.

Virtual overridden by consenting parents.

Reimplemented in vgui_composite_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.

Definition at line 284 of file vgui_tableau.cxx.

bool vgui_tableau::remove_child ( vgui_tableau_sptr const &   )  [virtual, inherited]

Remove the given child from the list of child tableaux.

Remove the given tableau from the list of child tableaux.

Reimplemented in vgui_composite_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.

Definition at line 291 of file vgui_tableau.cxx.

void vgui_tableau::get_all ( vcl_vector< vgui_tableau_sptr > *  out  )  [static, inherited]

Push all tableaux onto the given vector.

Definition at line 376 of file vgui_tableau.cxx.

bool vgui_tableau::exists ( vgui_tableau_sptr const &  ptr  )  [static, inherited]

Returns true if the given address points to a valid tableau.

Definition at line 385 of file vgui_tableau.cxx.

bool vgui_tableau::notify_replaced_child ( vgui_tableau_sptr const &  old_child,
vgui_tableau_sptr const &  new_child 
) [virtual, inherited]

Called whenever a child of this tableau is about to be forcibly replaced.

Called when a child of this tableau is forcibly replaced.

This method is called when some part of the program (typically the parent_child_link mechanism) is about to forcibly replace a child of this tableau. The canonical reason to override this is in order to invalidate caches.

Definition at line 302 of file vgui_tableau.cxx.

void vgui_tableau::add_popup ( vgui_menu  )  [virtual, inherited]

Add the given menu to the popup menu for the tableau.

Add given menu to the tableau popup menu.

This method is for tableaux to implement if they want to _add_ some items to the popup menu. They can assign to or clear 'menu', but that is not recommended as it would remove what other tableaux put there. The recommended usage is to .add() items or to .include() another menu.

** This is an interface method. it abstracts a behaviour. **

Reimplemented in vgui_active_tableau, vgui_clear_tableau, and vgui_satellite_tableau_t< object, data >.

Definition at line 316 of file vgui_tableau.cxx.

void vgui_tableau::get_popup ( vgui_popup_params const &  params,
vgui_menu menu 
) [virtual, inherited]

Get the default popup menu for the tableau.

Gets popup menu for this tableau.

If recurse is, true, recursively add the popup menus for children and children's children etc.

** this is a mixin method. it does some work for you. **

Reimplemented in vgui_deck_tableau, vgui_image_tableau, vgui_poly_tableau, vgui_shell_tableau, vgui_tview_launcher_tableau, and vgui_tview_tableau.

Definition at line 327 of file vgui_tableau.cxx.

void vgui_tableau::post_message ( char const *  msg,
void const *  data 
) [virtual, inherited]

Post a message event.

The fact that this is virtual does not imply that you should go and override it.

Reimplemented in vgui_adaptor_tableau.

Definition at line 205 of file vgui_tableau.cxx.

void vgui_tableau::post_redraw ( void   )  [virtual, inherited]

Post a draw event.

The fact that this is virtual does not imply that you should go and override it.

Reimplemented in vgui_adaptor_tableau.

Definition at line 215 of file vgui_tableau.cxx.

void vgui_tableau::post_overlay_redraw ( void   )  [virtual, inherited]

Post a overlay-redraw event.

Post a overlay redraw event.

The fact that this is virtual does not imply that you should go and override it.

Reimplemented in vgui_adaptor_tableau.

Definition at line 225 of file vgui_tableau.cxx.

void vgui_tableau::post_idle_request ( void   )  [virtual, inherited]

Post an idle request event.

The fact that this is virtual does not imply that you should go and override it.

Posting an idle event request means that your tableau has some idle processing that it'd like to do. This means that your tableau will continue to receive vgui_IDLE events until the event handler returns false (i.e. all idle processing is complete). The idle event handler should return false when it has no idle processing, or has completed its idle processing. It may return true if has only partially completed its idle processing; in this case, it will receive more idle event to allow it to complete processing.

Reimplemented in vgui_adaptor_tableau.

Definition at line 235 of file vgui_tableau.cxx.

bool vgui_tableau::get_bounding_box ( float  low[3],
float  high[3] 
) const [virtual, inherited]

Get the bounding box of this tableau.

Return the bounding box of this tableau.

If infinite in extent, or nothing is drawn, or you can't be bothered to implement it, return false. const. if you need to cache, cast away const.

If infinite in extent, or nothing is drawn, or you can't be bothered to implement it, return false.

Reimplemented in vgui_composite_tableau, vgui_image_tableau, vgui_roi_tableau, and vgui_wrapper_tableau.

Definition at line 198 of file vgui_tableau.cxx.

bool vgui_tableau::draw (  )  [virtual, inherited]

Called by default handle when it receives a draw event.

Reimplemented in vgui_function_tableau.

Definition at line 176 of file vgui_tableau.cxx.

bool vgui_tableau::mouse_up ( int  x,
int  y,
vgui_button  ,
vgui_modifier   
) [virtual, inherited]

Called by default handle when it receives a mouse up event.

Reimplemented in vgui_function_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau.

Definition at line 136 of file vgui_tableau.cxx.

bool vgui_tableau::idle (  )  [virtual, inherited]

Called when the application is otherwise idle.

Override if you want to do idle processing. Return false once your idle processing is complete, or if you have no need for more idle processing. Return true if you need more idle processing time.

Definition at line 185 of file vgui_tableau.cxx.

void vgui_tableau::ref (  )  const [inherited]

Increase the reference count by one (for smart pointers).

Increase the reference count by one (for smart-pointers).

"const" is for convenience, it is cast away internally.

Definition at line 79 of file vgui_tableau.cxx.

void vgui_tableau::unref (  )  const [inherited]

Decrease the reference count by one (for smart pointers).

Decrease the reference count by one (for smart-pointers).

"const" is for convenience, it is cast away internally. If the reference count reaches zero then delete the object.

If the reference count reaches zero then delete the object.

Definition at line 87 of file vgui_tableau.cxx.


Member Data Documentation

Observers to be notified when a child is added or removed.

Definition at line 56 of file vgui_listmanager2D_tableau.h.

Definition at line 93 of file vgui_listmanager2D_tableau.h.

vcl_vector<bool> vgui_listmanager2D_tableau::active [protected]

Definition at line 94 of file vgui_listmanager2D_tableau.h.

vcl_vector<bool> vgui_listmanager2D_tableau::visible [protected]

Definition at line 95 of file vgui_listmanager2D_tableau.h.

Definition at line 97 of file vgui_listmanager2D_tableau.h.

Definition at line 98 of file vgui_listmanager2D_tableau.h.

Definition at line 99 of file vgui_listmanager2D_tableau.h.


The documentation for this class was generated from the following files:

Generated on Sun Nov 22 06:22:02 2009 for core/vgui by  doxygen 1.5.5