vtkVRMenuWidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkVRMenuWidget_h
#define vtkVRMenuWidget_h

#include "vtkAbstractWidget.h"
#include "vtkRenderingVRModule.h" // For export macro
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO
#include <deque>                  // for ivar

VTK_ABI_NAMESPACE_BEGIN
class vtkEventData;
class vtkVRMenuRepresentation;

class VTKRENDERINGVR_EXPORT VTK_MARSHALAUTO vtkVRMenuWidget : public vtkAbstractWidget
{
public:
  static vtkVRMenuWidget* New();


  vtkTypeMacro(vtkVRMenuWidget, vtkAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetRepresentation(vtkVRMenuRepresentation* rep);

  void CreateDefaultRepresentation() override;


  vtkGetMacro(WidgetState, int);

  // Manage the state of the widget
  enum WidgetStateType
  {
    Start = 0,
    Active
  };


  void PushFrontMenuItem(const char* name, const char* text, vtkCommand* cmd);
  void RenameMenuItem(const char* name, const char* text);
  void RemoveMenuItem(const char* name);
  void RemoveAllMenuItems();

  void Show(vtkEventData* ed);
  void ShowSubMenu(vtkVRMenuWidget*);

protected:
  vtkVRMenuWidget();
  ~vtkVRMenuWidget() override;

  int WidgetState;

  class InternalElement;
  std::deque<InternalElement*> Menus;

  // These are the callbacks for this widget
  static void StartMenuAction(vtkAbstractWidget*);
  static void SelectMenuAction(vtkAbstractWidget*);
  static void MoveAction(vtkAbstractWidget*);

  vtkCallbackCommand* EventCommand;
  static void EventCallback(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);

  static void Update(vtkAbstractWidget*);

private:
  vtkVRMenuWidget(const vtkVRMenuWidget&) = delete;
  void operator=(const vtkVRMenuWidget&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif