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 ()
 
void SetInteractor (vtkRenderWindowInteractor *interactor)
 Set the interactor for the key event. More...
 
vtkRenderWindowInteractorGetInteractor () const
 Get the interactor for the key event. More...
 
void SetPosition (const vtkVector2i &position)
 Set the position of the mouse when the key was pressed. More...
 
vtkVector2i GetPosition () const
 Get the position of the mouse when the key was pressed. More...
 
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 34 of file vtkContextKeyEvent.h.

Constructor & Destructor Documentation

vtkContextKeyEvent::vtkContextKeyEvent ( )

Member Function Documentation

void vtkContextKeyEvent::SetInteractor ( vtkRenderWindowInteractor interactor)

Set the interactor for the key event.

vtkRenderWindowInteractor* vtkContextKeyEvent::GetInteractor ( ) const

Get the interactor for the key event.

This can be null, and is provided only for convenience.

void vtkContextKeyEvent::SetPosition ( const vtkVector2i position)
inline

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

Definition at line 53 of file vtkContextKeyEvent.h.

vtkVector2i vtkContextKeyEvent::GetPosition ( ) const
inline

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

Definition at line 58 of file vtkContextKeyEvent.h.

char vtkContextKeyEvent::GetKeyCode ( ) const

Member Data Documentation

vtkWeakPointer<vtkRenderWindowInteractor> vtkContextKeyEvent::Interactor
protected

Definition at line 63 of file vtkContextKeyEvent.h.

vtkVector2i vtkContextKeyEvent::Position
protected

Definition at line 64 of file vtkContextKeyEvent.h.


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