VTK  9.1.0
vtkVRMenuWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkVRMenuWidget.h
5 
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
23 #ifndef vtkVRMenuWidget_h
24 #define vtkVRMenuWidget_h
25 
26 #include "vtkAbstractWidget.h"
27 #include "vtkRenderingVRModule.h" // For export macro
28 #include <deque> // for ivar
29 
30 class vtkEventData;
32 class vtkPropMap;
33 class vtkProp;
34 
35 class VTKRENDERINGVR_EXPORT vtkVRMenuWidget : public vtkAbstractWidget
36 {
37 public:
41  static vtkVRMenuWidget* New();
42 
44 
48  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
57 
61  void CreateDefaultRepresentation() override;
62 
64 
67  vtkGetMacro(WidgetState, int);
69 
70  // Manage the state of the widget
72  {
73  Start = 0,
74  Active
75  };
76 
78 
81  void PushFrontMenuItem(const char* name, const char* text, vtkCommand* cmd);
82  void RenameMenuItem(const char* name, const char* text);
83  void RemoveMenuItem(const char* name);
86 
87  void Show(vtkEventData* ed);
89 
90 protected:
92  ~vtkVRMenuWidget() override;
93 
95 
96  class InternalElement;
97  std::deque<InternalElement*> Menus;
98 
99  // These are the callbacks for this widget
103 
105  static void EventCallback(
106  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
107 
111  static void Update(vtkAbstractWidget*);
112 
113 private:
114  vtkVRMenuWidget(const vtkVRMenuWidget&) = delete;
115  void operator=(const vtkVRMenuWidget&) = delete;
116 };
117 #endif
define the API for widget / widget representation
supports function callbacks
superclass for callback/observer methods
Definition: vtkCommand.h:394
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:57
Widget representation for vtkVRMenuWidget Implementation of the popup panel representation for the vt...
3D widget to display a menu in VR
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void Update(vtkAbstractWidget *)
Update callback to check for the hovered prop.
void SetRepresentation(vtkVRMenuRepresentation *rep)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
static void MoveAction(vtkAbstractWidget *)
static void SelectMenuAction(vtkAbstractWidget *)
void RemoveMenuItem(const char *name)
Methods to add/remove items to the menu, called by the menu widget.
~vtkVRMenuWidget() override
vtkCallbackCommand * EventCommand
static vtkVRMenuWidget * New()
Instantiate the object.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard vtkObject methods.
std::deque< InternalElement * > Menus
void RenameMenuItem(const char *name, const char *text)
Methods to add/remove items to the menu, called by the menu widget.
void ShowSubMenu(vtkVRMenuWidget *)
void PushFrontMenuItem(const char *name, const char *text, vtkCommand *cmd)
Methods to add/remove items to the menu, called by the menu widget.
static void EventCallback(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
void RemoveAllMenuItems()
Methods to add/remove items to the menu, called by the menu widget.
void Show(vtkEventData *ed)
static void StartMenuAction(vtkAbstractWidget *)
@ name
Definition: vtkX3D.h:225