VTK
Public Member Functions | Protected Attributes | List of all members
vtkContextKeyEvent Class Reference

data structure to represent key events. More...

#include <vtkContextKeyEvent.h>

Collaboration diagram for vtkContextKeyEvent:
[legend]

Public Member Functions

 vtkContextKeyEvent ()
 
 ~vtkContextKeyEvent ()
 
void SetInteractor (vtkRenderWindowInteractor *interactor)
 
vtkRenderWindowInteractorGetInteractor () const
 
void SetPosition (const vtkVector2i &position)
 
vtkVector2i GetPosition () const
 
char GetKeyCode () const
 

Protected Attributes

vtkWeakPointer< vtkRenderWindowInteractorInteractor
 
vtkVector2i Position
 

Detailed Description

data structure to represent key events.

Provides a convenient data structure to represent key events in the vtkContextScene. Passed to vtkAbstractContextItem objects.

Definition at line 33 of file vtkContextKeyEvent.h.

Constructor & Destructor Documentation

§ vtkContextKeyEvent()

vtkContextKeyEvent::vtkContextKeyEvent ( )

§ ~vtkContextKeyEvent()

vtkContextKeyEvent::~vtkContextKeyEvent ( )

Member Function Documentation

§ SetInteractor()

void vtkContextKeyEvent::SetInteractor ( vtkRenderWindowInteractor interactor)

Set the interactor for the key event.

§ GetInteractor()

vtkRenderWindowInteractor* vtkContextKeyEvent::GetInteractor ( ) const

Get the interactor for the key event. This can be null, and is provided only for convenience.

§ SetPosition()

void vtkContextKeyEvent::SetPosition ( const vtkVector2i position)
inline

Set the position of the mouse when the key was pressed.

Definition at line 47 of file vtkContextKeyEvent.h.

§ GetPosition()

vtkVector2i vtkContextKeyEvent::GetPosition ( ) const
inline

Get the position of the mouse when the key was pressed.

Definition at line 50 of file vtkContextKeyEvent.h.

§ GetKeyCode()

char vtkContextKeyEvent::GetKeyCode ( ) const

Member Data Documentation

§ Interactor

vtkWeakPointer<vtkRenderWindowInteractor> vtkContextKeyEvent::Interactor
protected

Definition at line 55 of file vtkContextKeyEvent.h.

§ Position

vtkVector2i vtkContextKeyEvent::Position
protected

Definition at line 56 of file vtkContextKeyEvent.h.


The documentation for this class was generated from the following file: