Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
107 lines (83 sloc) 2.77 KB
/*=========================================================================
Program: Visualization Toolkit
Module: vtkEvent.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.
=========================================================================*/
// .NAME vtkEvent - a complete specification of a VTK event including all modifiers
// .SECTION Description
// vtkEvent is a class that fully describes a VTK event. It is used by the
// widgets to help specify the mapping between VTK events and widget events.
#ifndef __vtkEvent_h
#define __vtkEvent_h
#include "vtkObject.h"
class vtkRenderWindowInteractor;
class VTK_WIDGETS_EXPORT vtkEvent : public vtkObject
{
public:
// Description:
// The object factory constructor.
static vtkEvent *New();
// Description:
// Standard macros.
vtkTypeMacro(vtkEvent,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
//BTX
// Description:
// Ways to specify modifiers to VTK events. These can be logical OR'd to
// produce combinations of modifiers.
enum EventModifiers {
AnyModifier = -1,
NoModifier = 0,
ShiftModifier = 1,
ControlModifier = 2,
AltModifier = 4
};
//ETX
// Description:
// Set the modifier for the event.
vtkSetMacro(EventId,unsigned long);
vtkGetMacro(EventId,unsigned long);
// Description:
// Set the modifier for the event.
vtkSetMacro(Modifier,int);
vtkGetMacro(Modifier,int);
// Description:
// Set the KeyCode for the event.
vtkSetMacro(KeyCode,char);
vtkGetMacro(KeyCode,char);
// Description:
// Set the repease count for the event.
vtkSetMacro(RepeatCount,int);
vtkGetMacro(RepeatCount,int);
// Description:
// Set the complex key symbol (compound key strokes) for the event.
vtkSetStringMacro(KeySym);
vtkGetStringMacro(KeySym);
// Description:
// Convenience method computes the event modifier from an interactor.
static int GetModifier(vtkRenderWindowInteractor*);
//BTX
// Description:
// Used to compare whether two events are equal. Takes into account
// the EventId as well as the various modifiers.
int operator==(vtkEvent*);
int operator==(unsigned long VTKEvent); //event with no modifiers
//ETX
protected:
vtkEvent();
virtual ~vtkEvent();
unsigned long EventId;
int Modifier;
char KeyCode;
int RepeatCount;
char* KeySym;
private:
vtkEvent(const vtkEvent&); //Not implemented
void operator=(const vtkEvent&); //Not implemented
};
#endif