vtkWaylandRenderWindowInteractor.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 vtkWaylandRenderWindowInteractor_h
#define vtkWaylandRenderWindowInteractor_h
 
#include "vtkRenderWindowInteractor.h"
#include "vtkRenderingUIModule.h"     // For export macro
#include "vtkWaylandHardwareWindow.h" // The hardware window it depends on
#include "vtkWrappingHints.h"         // For VTK_MARSHALAUTO
 
// Forward declarations for Wayland and xkbcommon types.
struct wl_display;
struct wl_registry;
struct wl_surface;
struct wl_seat;
struct wl_pointer;
struct wl_keyboard;
struct wl_data_device_manager;
struct wl_data_device;
struct wl_data_offer;
struct xkb_context;
struct xkb_keymap;
struct xkb_state;
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkWaylandRenderWindowInteractorInternals;
 
class VTKRENDERINGUI_EXPORT VTK_MARSHALAUTO vtkWaylandRenderWindowInteractor
  : public vtkRenderWindowInteractor
{
public:
  static vtkWaylandRenderWindowInteractor* New();
  vtkTypeMacro(vtkWaylandRenderWindowInteractor, vtkRenderWindowInteractor);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize() override;

  void TerminateApp() override;

  void ProcessEvents() override;


  void Enable() override;
  void Disable() override;
 
  // These members are accessed by static C-style callbacks and must be public.
 
  // Input device objects
  struct wl_seat* Seat = nullptr;
  struct wl_pointer* Pointer = nullptr;
  struct wl_keyboard* Keyboard = nullptr;
  uint32_t PointerSerial = 0;
  uint32_t KeyboardSerial = 0;
 
  // Keyboard handling via xkbcommon
  struct xkb_context* XkbContext = nullptr;
  struct xkb_keymap* XkbKeymap = nullptr;
  struct xkb_state* XkbState = nullptr;
 
protected:
  vtkWaylandRenderWindowInteractor();
  ~vtkWaylandRenderWindowInteractor() override;
 
  // Wayland connection and window handles, obtained from HardwareWindow
  struct wl_display* DisplayId = nullptr;
  struct wl_surface* WindowId = nullptr;
  struct wl_registry* Registry = nullptr; // Own registry for finding input devices
 
  // Drag and drop related (placeholder for future implementation)
  struct wl_data_device_manager* DataDeviceManager = nullptr;
  struct wl_data_device* DataDevice = nullptr;
  struct wl_data_offer* DndDataOffer = nullptr;
 
  // Internal state
  vtkWaylandRenderWindowInteractorInternals* Internal;


  int InternalCreateTimer(int timerId, int timerType, unsigned long duration) override;
  int InternalDestroyTimer(int platformTimerId) override;
 
  void FireTimers();

  void StartEventLoop() override;

  void WaitForEvents();

  void Finalize();

  void Render() override;
 
  friend class vtkWaylandRenderWindowInteractorInternals;
 
private:
  vtkWaylandRenderWindowInteractor(const vtkWaylandRenderWindowInteractor&) = delete;
  void operator=(const vtkWaylandRenderWindowInteractor&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif