vtkInteractorEventRecorder.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 vtkInteractorEventRecorder_h
#define vtkInteractorEventRecorder_h

#include "vtkInteractorObserver.h"
#include "vtkRenderingCoreModule.h" // For export macro

#include "vtkNew.h" // vtkNew

VTK_ABI_NAMESPACE_BEGIN

class vtkActor2D;
class vtkStringArray;

// The superclass that all commands should be subclasses of
class VTKRENDERINGCORE_EXPORT vtkInteractorEventRecorder : public vtkInteractorObserver
{
public:
  static vtkInteractorEventRecorder* New();
  vtkTypeMacro(vtkInteractorEventRecorder, vtkInteractorObserver);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  // enumeration of data type
  enum class vtkEventDataType : int
  {
    None = 0,
    StringArray
  };

  // Satisfy the superclass API. Enable/disable listening for events.
  void SetEnabled(int) override;
  void SetInteractor(vtkRenderWindowInteractor* iren) override;


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);

  void Record();

  void Play();

  void Stop();

  void Clear();

  void Rewind();


  vtkSetMacro(ReadFromInputString, vtkTypeBool);
  vtkGetMacro(ReadFromInputString, vtkTypeBool);
  vtkBooleanMacro(ReadFromInputString, vtkTypeBool);


  vtkSetStringMacro(InputString);
  vtkGetStringMacro(InputString);


  vtkSetMacro(ShowCursor, bool);
  vtkGetMacro(ShowCursor, bool);
  vtkBooleanMacro(ShowCursor, bool);

protected:
  vtkInteractorEventRecorder();
  ~vtkInteractorEventRecorder() override;

  // file to read/write from
  char* FileName;

  // listens to delete events
  vtkCallbackCommand* DeleteEventCallbackCommand;

  // control whether to read from string
  vtkTypeBool ReadFromInputString;
  char* InputString;

  // for reading and writing
  istream* InputStream;
  ostream* OutputStream;

  // methods for processing events
  static void ProcessCharEvent(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);
  static void ProcessDeleteEvent(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);
  static void ProcessEvents(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);

  virtual void WriteEvent(const char* event, int pos[2], int modifiers, int keyCode,
    int repeatCount, char* keySym, void* callData = nullptr);

  virtual void ReadEvent(const std::string& line);

  // Manage the state of the recorder
  int State;
  enum WidgetState
  {
    Start = 0,
    Playing,
    Recording
  };

  // Associate a modifier with a bit
  enum ModifierKey
  {
    ShiftKey = 1,
    ControlKey = 2,
    AltKey = 4
  };

  static float StreamVersion;
  float CurrentStreamVersion;

private:
  vtkInteractorEventRecorder(const vtkInteractorEventRecorder&) = delete;
  void operator=(const vtkInteractorEventRecorder&) = delete;

  bool ShowCursor = false;
  vtkNew<vtkActor2D> CursorActor;
};

VTK_ABI_NAMESPACE_END
#endif /* vtkInteractorEventRecorder_h */