#include <vgui_blackbox_tableau.h>
Inheritance diagram for vgui_blackbox_tableau:
The user can control event recording and playback by pressing the following keys inside the rendering area:
Definition at line 37 of file vgui_blackbox_tableau.h.
Public Member Functions | |
| vgui_blackbox_tableau (vgui_tableau_sptr const &) | |
| Constructor - don't use this, use vgui_blackbox_tableau_new. | |
| virtual bool | handle (const vgui_event &event) |
| Handle all events used by this tableau. | |
| virtual vcl_string | type_name () const |
| Return the name of this tableau ('vgui_blackbox_tableau'). | |
| bool | add_child (vgui_tableau_sptr const &) |
| Adds given tableau as child if none exists, else causes error. | |
| bool | remove_child (vgui_tableau_sptr const &) |
| The child tableau is removed if it is the same as the given tableau. | |
| vcl_string | file_name () const |
| Returns the child's file_name if it exists. | |
| vcl_string | pretty_name () const |
| Returns nice version of the name which also includes details of the child. | |
| bool | get_bounding_box (float low[3], float high[3]) const |
| Get the bounding box for this tableau. | |
| virtual vcl_string | name () const |
| Return the name of the tableau. | |
| 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 | 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 | draw () |
| Called by default handle when it receives a draw event. | |
| virtual bool | mouse_down (int x, int y, vgui_button, vgui_modifier) |
| Called by default handle when it receives a mouse down 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 | motion (int x, int y) |
| Called by handle when it receives a mouse motion event. | |
| virtual bool | key_press (int x, int y, vgui_key, vgui_modifier) |
| Called by default handle when it receives a key-press event. | |
| virtual bool | help () |
| Called by default handle when it receives a '?' pressed 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_parent_child_link | child |
| The single child of this tableau. | |
Protected Member Functions | |
| ~vgui_blackbox_tableau () | |
| Destructor - called by smart-pointer vgui_blackbox_tableau_sprt. | |
Protected Attributes | |
| bool | recording |
| True if events are being recorded. | |
| vcl_vector< vgui_event > | events |
| List of recorded events. | |
|
|
Constructor - don't use this, use vgui_blackbox_tableau_new.
Definition at line 26 of file vgui_blackbox_tableau.cxx. |
|
|
Destructor - called by smart-pointer vgui_blackbox_tableau_sprt.
Definition at line 32 of file vgui_blackbox_tableau.cxx. |
|
|
Adds given tableau as child if none exists, else causes error.
Reimplemented from vgui_tableau. Definition at line 42 of file vgui_wrapper_tableau.cxx. |
|
|
Add the given menu to the popup menu for the tableau. 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 315 of file vgui_tableau.cxx. |
|
|
Called by default handle when it receives a draw event.
Reimplemented in vgui_function_tableau. Definition at line 175 of file vgui_tableau.cxx. |
|
|
Returns true if the given address points to a valid tableau.
Definition at line 384 of file vgui_tableau.cxx. |
|
|
Returns the child's file_name if it exists.
Reimplemented from vgui_tableau. Definition at line 37 of file vgui_wrapper_tableau.cxx. |
|
|
Push all tableaux onto the given vector.
Definition at line 375 of file vgui_tableau.cxx. |
|
||||||||||||
|
Get the bounding box for this tableau. Defaults to getting the bounding box of the child. Reimplemented from vgui_tableau. Definition at line 71 of file vgui_wrapper_tableau.cxx. |
|
|
Get the ith child or return 0.
Definition at line 273 of file vgui_tableau.cxx. |
|
|
Get the child tableaux for this tableau.
Definition at line 266 of file vgui_tableau.cxx. |
|
|
Get the parent tableaux for this tableau.
Definition at line 259 of file vgui_tableau.cxx. |
|
||||||||||||
|
Get the default popup menu for the 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 326 of file vgui_tableau.cxx. |
|
|
Handle all events used by this tableau. In particular, this tableau uses the key-strokes ',' (start/stop record), '.' (playback), 's' (playback w. dump), '/' (print events), '#' (clear events). Other events are passed to the child tableau. Reimplemented from vgui_wrapper_tableau. Definition at line 53 of file vgui_blackbox_tableau.cxx. |
|
|
Called by default handle when it receives a '?' pressed event.
Reimplemented in vgui_composite_tableau, vgui_deck_tableau, vgui_function_tableau, vgui_listmanager2D_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau. Definition at line 165 of file vgui_tableau.cxx. |
|
|
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 184 of file vgui_tableau.cxx. |
|
||||||||||||||||||||
|
Called by default handle when it receives a key-press event.
Reimplemented in vgui_deck_tableau, vgui_function_tableau, vgui_listmanager2D_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau. Definition at line 155 of file vgui_tableau.cxx. |
|
||||||||||||
|
Called by handle when it receives a mouse motion event.
Reimplemented in vgui_displaylist2D_tableau, vgui_function_tableau, and vgui_listmanager2D_tableau. Definition at line 145 of file vgui_tableau.cxx. |
|
||||||||||||||||||||
|
Called by default handle when it receives a mouse down event.
Reimplemented in vgui_displaylist2D_tableau, vgui_displaylist3D_tableau, vgui_function_tableau, vgui_listmanager2D_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau. Definition at line 125 of file vgui_tableau.cxx. |
|
||||||||||||||||||||
|
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 135 of file vgui_tableau.cxx. |
|
|
Return the name of the tableau.
Reimplemented in vgui_easy2D_tableau. Definition at line 89 of file vgui_tableau.h. |
|
||||||||||||
|
Called whenever a child of this tableau is about to be 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 301 of file vgui_tableau.cxx. |
|
|
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 234 of file vgui_tableau.cxx. |
|
||||||||||||
|
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 204 of file vgui_tableau.cxx. |
|
|
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 224 of file vgui_tableau.cxx. |
|
|
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 214 of file vgui_tableau.cxx. |
|
|
Returns nice version of the name which also includes details of the child.
Reimplemented from vgui_tableau. Definition at line 32 of file vgui_wrapper_tableau.cxx. |
|
|
Increase the reference count by one (for smart pointers). "const" is for convenience, it is cast away internally. Definition at line 78 of file vgui_tableau.cxx. |
|
|
The child tableau is removed if it is the same as the given tableau.
Reimplemented from vgui_tableau. Definition at line 54 of file vgui_wrapper_tableau.cxx. |
|
|
Return the name of this tableau ('vgui_blackbox_tableau').
Reimplemented from vgui_wrapper_tableau. Definition at line 36 of file vgui_blackbox_tableau.cxx. |
|
|
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. Definition at line 86 of file vgui_tableau.cxx. |
|
|
The single child of this tableau.
Definition at line 65 of file vgui_wrapper_tableau.h. |
|
|
List of recorded events.
Definition at line 61 of file vgui_blackbox_tableau.h. |
|
|
True if events are being recorded.
Definition at line 58 of file vgui_blackbox_tableau.h. |
1.4.4