vtkEvent.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 vtkEvent_h
#define vtkEvent_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkRenderWindowInteractor;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkEvent : public vtkObject
{
public:
  static vtkEvent* New();


  vtkTypeMacro(vtkEvent, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum EventModifiers
  {
    AnyModifier = -1,
    NoModifier = 0,
    ShiftModifier = 1,
    ControlModifier = 2,
    AltModifier = 4
  };


  vtkSetMacro(EventId, unsigned long);
  vtkGetMacro(EventId, unsigned long);


  vtkSetMacro(Modifier, int);
  vtkGetMacro(Modifier, int);


  vtkSetMacro(KeyCode, char);
  vtkGetMacro(KeyCode, char);


  vtkSetMacro(RepeatCount, int);
  vtkGetMacro(RepeatCount, int);


  vtkSetStringMacro(KeySym);
  vtkGetStringMacro(KeySym);

  static int GetModifier(vtkRenderWindowInteractor*);

  bool operator==(vtkEvent*) const;
  bool operator==(unsigned long VTKEvent) const; // event with no modifiers
 
protected:
  vtkEvent();
  ~vtkEvent() override;
 
  unsigned long EventId;
  int Modifier;
  char KeyCode;
  int RepeatCount;
  char* KeySym;
 
private:
  vtkEvent(const vtkEvent&) = delete;
  void operator=(const vtkEvent&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif