VTK  9.3.20231203
vtkVRMenuWidget.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
11 #ifndef vtkVRMenuWidget_h
12 #define vtkVRMenuWidget_h
13 
14 #include "vtkAbstractWidget.h"
15 #include "vtkRenderingVRModule.h" // For export macro
16 #include <deque> // for ivar
17 
18 VTK_ABI_NAMESPACE_BEGIN
19 class vtkEventData;
21 
22 class VTKRENDERINGVR_EXPORT vtkVRMenuWidget : public vtkAbstractWidget
23 {
24 public:
28  static vtkVRMenuWidget* New();
29 
31 
35  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
44 
48  void CreateDefaultRepresentation() override;
49 
51 
54  vtkGetMacro(WidgetState, int);
56 
57  // Manage the state of the widget
59  {
60  Start = 0,
61  Active
62  };
63 
65 
68  void PushFrontMenuItem(const char* name, const char* text, vtkCommand* cmd);
69  void RenameMenuItem(const char* name, const char* text);
70  void RemoveMenuItem(const char* name);
73 
74  void Show(vtkEventData* ed);
76 
77 protected:
79  ~vtkVRMenuWidget() override;
80 
82 
83  class InternalElement;
84  std::deque<InternalElement*> Menus;
85 
86  // These are the callbacks for this widget
90 
92  static void EventCallback(
93  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
94 
98  static void Update(vtkAbstractWidget*);
99 
100 private:
101  vtkVRMenuWidget(const vtkVRMenuWidget&) = delete;
102  void operator=(const vtkVRMenuWidget&) = delete;
103 };
104 VTK_ABI_NAMESPACE_END
105 #endif
define the API for widget / widget representation
supports function callbacks
superclass for callback/observer methods
Definition: vtkCommand.h:384
a simple class to control print indentation
Definition: vtkIndent.h:108
abstract base class for most VTK objects
Definition: vtkObject.h:161
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:219