vtkInteractorEventRecorder.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkInteractorEventRecorder.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkInteractorEventRecorder_h
#define vtkInteractorEventRecorder_h
 
#include "vtkInteractorObserver.h"
#include "vtkRenderingCoreModule.h" // For export macro
 
// 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;
 
  // 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 Rewind();
 
 
  vtkSetMacro(ReadFromInputString, vtkTypeBool);
  vtkGetMacro(ReadFromInputString, vtkTypeBool);
  vtkBooleanMacro(ReadFromInputString, vtkTypeBool);
 
 
  vtkSetStringMacro(InputString);
  vtkGetStringMacro(InputString);
 
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);
 
  virtual void ReadEvent();
 
  // 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;
 
private:
  vtkInteractorEventRecorder(const vtkInteractorEventRecorder&) = delete;
  void operator=(const vtkInteractorEventRecorder&) = delete;
};
 
#endif /* vtkInteractorEventRecorder_h */