Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkRenderWindowInteractor Class Reference

#include <vtkRenderWindowInteractor.h>

Inheritance diagram for vtkRenderWindowInteractor:

Inheritance graph
[legend]
Collaboration diagram for vtkRenderWindowInteractor:

Collaboration graph
[legend]
List of all members.

Detailed Description

platform-independent render window interaction including picking and frame rate control.

vtkRenderWindowInteractor provides a platform-independent interaction mechanism for mouse/key/time events. It serves as a base class for platform-dependent implementations that handle routing of mouse/key/timer messages to vtkInteractorStyle and its subclasses. vtkRenderWindowInteractor also provides controls for picking, rendering frame rate, and headlights.

vtkRenderWindowInteractor has changed from previous implementations and now serves only as a shell to hold user preferences and route messages to vtkInteractorStyle. Callbacks are available for many Events. Platform specific subclasses should provide methods for CreateTimer/DestroyTimer, TerminateApp, and an event loop if required via Initialize/Start/Enable/Disable.

Events:
vtkCommand::RenderEvent vtkCommand::UserEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent vtkCommand::ExitEvent
Examples:
vtkRenderWindowInteractor (Examples)
Tests:
vtkRenderWindowInteractor (Tests)

Definition at line 59 of file vtkRenderWindowInteractor.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void UnRegister (vtkObjectBase *o)
virtual vtkRendererFindPokedRenderer (int, int)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Initialize ()
void ReInitialize ()
virtual void Start ()
virtual void Enable ()
virtual void Disable ()
virtual int GetEnabled ()
void SetRenderWindow (vtkRenderWindow *aren)
virtual vtkRenderWindowGetRenderWindow ()
virtual void UpdateSize (int x, int y)
virtual int CreateTimer (int)
virtual int DestroyTimer ()
virtual void TerminateApp (void)
virtual void SetInteractorStyle (vtkInteractorObserver *)
virtual vtkInteractorObserverGetInteractorStyle ()
virtual void SetLightFollowCamera (int)
virtual int GetLightFollowCamera ()
virtual void LightFollowCameraOn ()
virtual void LightFollowCameraOff ()
virtual void SetDesiredUpdateRate (double)
virtual double GetDesiredUpdateRate ()
virtual void SetStillUpdateRate (double)
virtual double GetStillUpdateRate ()
virtual int GetInitialized ()
virtual void SetPicker (vtkAbstractPicker *)
virtual vtkAbstractPickerGetPicker ()
virtual vtkAbstractPropPickerCreateDefaultPicker ()
virtual void ExitCallback ()
virtual void UserCallback ()
virtual void StartPickCallback ()
virtual void EndPickCallback ()
virtual void GetMousePosition (int *x, int *y)
void HideCursor ()
void ShowCursor ()
virtual void Render ()
void FlyTo (vtkRenderer *ren, double x, double y, double z)
void FlyTo (vtkRenderer *ren, double *x)
void FlyToImage (vtkRenderer *ren, double x, double y)
void FlyToImage (vtkRenderer *ren, double *x)
virtual void SetNumberOfFlyFrames (int)
virtual int GetNumberOfFlyFrames ()
virtual void SetDolly (double)
virtual double GetDolly ()
virtual int * GetEventPosition ()
virtual void GetEventPosition (int &, int &)
virtual void GetEventPosition (int[2])
virtual int * GetLastEventPosition ()
virtual void GetLastEventPosition (int &, int &)
virtual void GetLastEventPosition (int[2])
virtual void SetLastEventPosition (int, int)
void SetLastEventPosition (int[2])
virtual void SetEventPosition (int x, int y)
virtual void SetEventPosition (int pos[2])
virtual void SetEventPositionFlipY (int x, int y)
virtual void SetEventPositionFlipY (int pos[2])
virtual void SetControlKey (int)
virtual int GetControlKey ()
virtual void SetShiftKey (int)
virtual int GetShiftKey ()
virtual void SetKeyCode (char)
virtual char GetKeyCode ()
virtual void SetRepeatCount (int)
virtual int GetRepeatCount ()
virtual void SetKeySym (const char *)
virtual char * GetKeySym ()
void SetEventInformation (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
void SetEventInformationFlipY (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
void SetKeyEventInformation (int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
virtual void SetSize (int, int)
void SetSize (int[2])
virtual int * GetSize ()
virtual void GetSize (int &, int &)
virtual void GetSize (int[2])
virtual void SetEventSize (int, int)
void SetEventSize (int[2])
virtual int * GetEventSize ()
virtual void GetEventSize (int &, int &)
virtual void GetEventSize (int[2])

Static Public Member Functions

static vtkRenderWindowInteractorNew ()
static int IsTypeOf (const char *type)
static vtkRenderWindowInteractorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkRenderWindowInteractor ()
 ~vtkRenderWindowInteractor ()

Protected Attributes

vtkRenderWindowRenderWindow
vtkInteractorObserverInteractorStyle
vtkAbstractPickerPicker
int Initialized
int Enabled
int Style
int LightFollowCamera
int ActorMode
double DesiredUpdateRate
double StillUpdateRate
int ControlKey
int ShiftKey
char KeyCode
int RepeatCount
char * KeySym
int EventPosition [2]
int LastEventPosition [2]
int EventSize [2]
int Size [2]
int NumberOfFlyFrames
double Dolly


Member Typedef Documentation

typedef vtkObject vtkRenderWindowInteractor::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 63 of file vtkRenderWindowInteractor.h.


Constructor & Destructor Documentation

vtkRenderWindowInteractor::vtkRenderWindowInteractor  )  [protected]
 

vtkRenderWindowInteractor::~vtkRenderWindowInteractor  )  [protected]
 


Member Function Documentation

static vtkRenderWindowInteractor* vtkRenderWindowInteractor::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

virtual const char* vtkRenderWindowInteractor::GetClassName  )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

static int vtkRenderWindowInteractor::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

virtual int vtkRenderWindowInteractor::IsA const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

static vtkRenderWindowInteractor* vtkRenderWindowInteractor::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

void vtkRenderWindowInteractor::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

virtual void vtkRenderWindowInteractor::Initialize  )  [virtual]
 

Prepare for handling events. This must be called before the interactor will work.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

void vtkRenderWindowInteractor::ReInitialize  )  [inline]
 

Definition at line 70 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::UnRegister vtkObjectBase o  )  [virtual]
 

This Method detects loops of RenderWindow-Interactor, so objects are freed properly.

Reimplemented from vtkObjectBase.

virtual void vtkRenderWindowInteractor::Start void   )  [inline, virtual]
 

Start the event loop. This is provided so that you do not have to implement your own event loop. You still can use your own event loop if you want. Initialize should be called before Start.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 81 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::Enable  )  [inline, virtual]
 

Enable/Disable interactions. By default interactors are enabled when initialized. Initialize() must be called prior to enabling/disabling interaction. These methods are used when a window/widget is being shared by multiple renderers and interactors. This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 91 of file vtkRenderWindowInteractor.h.

References vtkObject::Modified().

virtual void vtkRenderWindowInteractor::Disable  )  [inline, virtual]
 

Start the event loop. This is provided so that you do not have to implement your own event loop. You still can use your own event loop if you want. Initialize should be called before Start.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 92 of file vtkRenderWindowInteractor.h.

References vtkObject::Modified().

virtual int vtkRenderWindowInteractor::GetEnabled  )  [virtual]
 

Start the event loop. This is provided so that you do not have to implement your own event loop. You still can use your own event loop if you want. Initialize should be called before Start.

void vtkRenderWindowInteractor::SetRenderWindow vtkRenderWindow aren  ) 
 

Set/Get the rendering window being controlled by this object.

virtual vtkRenderWindow* vtkRenderWindowInteractor::GetRenderWindow  )  [virtual]
 

Set/Get the rendering window being controlled by this object.

virtual void vtkRenderWindowInteractor::UpdateSize int  x,
int  y
[virtual]
 

Event loop notification member for Window size change

Reimplemented in vtkXRenderWindowTclInteractor.

virtual int vtkRenderWindowInteractor::CreateTimer int   )  [inline, virtual]
 

Timer methods must be overridden by platform dependent subclasses. flag is passed to indicate if this is first timer set or an update as Win32 uses repeating timers, whereas X uses One shot more timer if flag==VTKXI_TIMER_FIRST Win32 and X should createtimer otherwise Win32 should exit and X should perform AddTimeOut()

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 111 of file vtkRenderWindowInteractor.h.

virtual int vtkRenderWindowInteractor::DestroyTimer void   )  [inline, virtual]
 

Event loop notification member for Window size change

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 112 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::TerminateApp void   )  [inline, virtual]
 

This function is called on 'q','e' keypress if exitmethod is not specified and should be overridden by platform dependent subclasses to provide a termination procedure if one is required.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkWin32RenderWindowInteractor, vtkXRenderWindowInteractor, and vtkXRenderWindowTclInteractor.

Definition at line 118 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetInteractorStyle vtkInteractorObserver  )  [virtual]
 

External switching between joystick/trackball/new? modes.

virtual vtkInteractorObserver* vtkRenderWindowInteractor::GetInteractorStyle  )  [virtual]
 

This function is called on 'q','e' keypress if exitmethod is not specified and should be overridden by platform dependent subclasses to provide a termination procedure if one is required.

virtual void vtkRenderWindowInteractor::SetLightFollowCamera int   )  [virtual]
 

Turn on/off the automatic repositioning of lights as the camera moves.

virtual int vtkRenderWindowInteractor::GetLightFollowCamera  )  [virtual]
 

Turn on/off the automatic repositioning of lights as the camera moves.

virtual void vtkRenderWindowInteractor::LightFollowCameraOn  )  [virtual]
 

Turn on/off the automatic repositioning of lights as the camera moves.

virtual void vtkRenderWindowInteractor::LightFollowCameraOff  )  [virtual]
 

Turn on/off the automatic repositioning of lights as the camera moves.

virtual void vtkRenderWindowInteractor::SetDesiredUpdateRate double   )  [virtual]
 

Set/Get the desired update rate. This is used by vtkLODActor's to tell them how quickly they need to render. This update is in effect only when the camera is being rotated, or zoomed. When the interactor is still, the StillUpdateRate is used instead.

virtual double vtkRenderWindowInteractor::GetDesiredUpdateRate  )  [virtual]
 

Set/Get the desired update rate. This is used by vtkLODActor's to tell them how quickly they need to render. This update is in effect only when the camera is being rotated, or zoomed. When the interactor is still, the StillUpdateRate is used instead.

virtual void vtkRenderWindowInteractor::SetStillUpdateRate double   )  [virtual]
 

Set/Get the desired update rate when movement has stopped. See the SetDesiredUpdateRate method.

virtual double vtkRenderWindowInteractor::GetStillUpdateRate  )  [virtual]
 

Set/Get the desired update rate when movement has stopped. See the SetDesiredUpdateRate method.

virtual int vtkRenderWindowInteractor::GetInitialized  )  [virtual]
 

See whether interactor has been initialized yet.

virtual void vtkRenderWindowInteractor::SetPicker vtkAbstractPicker  )  [virtual]
 

Set/Get the object used to perform pick operations. In order to pick instances of vtkProp, the picker must be a subclass of vtkAbstractPropPicker, meaning that it can identify a particular instance of vtkProp.

virtual vtkAbstractPicker* vtkRenderWindowInteractor::GetPicker  )  [virtual]
 

Set/Get the object used to perform pick operations. In order to pick instances of vtkProp, the picker must be a subclass of vtkAbstractPropPicker, meaning that it can identify a particular instance of vtkProp.

virtual vtkAbstractPropPicker* vtkRenderWindowInteractor::CreateDefaultPicker  )  [virtual]
 

Create default picker. Used to create one when none is specified. Default is an instance of vtkPropPicker.

virtual void vtkRenderWindowInteractor::ExitCallback  )  [virtual]
 

These methods correspond to the the Exit, User and Pick callbacks. They allow for the Style to invoke them.

Reimplemented in vtkCarbonRenderWindowInteractor, vtkCocoaRenderWindowInteractor, and vtkWin32RenderWindowInteractor.

virtual void vtkRenderWindowInteractor::UserCallback  )  [virtual]
 

Create default picker. Used to create one when none is specified. Default is an instance of vtkPropPicker.

virtual void vtkRenderWindowInteractor::StartPickCallback  )  [virtual]
 

Create default picker. Used to create one when none is specified. Default is an instance of vtkPropPicker.

virtual void vtkRenderWindowInteractor::EndPickCallback  )  [virtual]
 

Create default picker. Used to create one when none is specified. Default is an instance of vtkPropPicker.

virtual void vtkRenderWindowInteractor::GetMousePosition int *  x,
int *  y
[inline, virtual]
 

Get the current position of the mouse.

Reimplemented in vtkXRenderWindowInteractor.

Definition at line 178 of file vtkRenderWindowInteractor.h.

void vtkRenderWindowInteractor::HideCursor  ) 
 

Hide or show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.

void vtkRenderWindowInteractor::ShowCursor  ) 
 

Get the current position of the mouse.

virtual void vtkRenderWindowInteractor::Render  )  [virtual]
 

Render the scene. Just pass the render call on to the associated vtkRenderWindow.

void vtkRenderWindowInteractor::FlyTo vtkRenderer ren,
double  x,
double  y,
double  z
 

Given a position x, move the current camera's focal point to x. The movement is animated over the number of frames specified in NumberOfFlyFrames. The LOD desired frame rate is used.

void vtkRenderWindowInteractor::FlyTo vtkRenderer ren,
double *  x
[inline]
 

Render the scene. Just pass the render call on to the associated vtkRenderWindow.

Definition at line 196 of file vtkRenderWindowInteractor.h.

void vtkRenderWindowInteractor::FlyToImage vtkRenderer ren,
double  x,
double  y
 

Render the scene. Just pass the render call on to the associated vtkRenderWindow.

void vtkRenderWindowInteractor::FlyToImage vtkRenderer ren,
double *  x
[inline]
 

Render the scene. Just pass the render call on to the associated vtkRenderWindow.

Definition at line 199 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetNumberOfFlyFrames int   )  [virtual]
 

Set the number of frames to fly to when FlyTo is invoked.

virtual int vtkRenderWindowInteractor::GetNumberOfFlyFrames  )  [virtual]
 

Set the number of frames to fly to when FlyTo is invoked.

virtual void vtkRenderWindowInteractor::SetDolly double   )  [virtual]
 

Set the total Dolly value to use when flying to (FlyTo()) a specified point. Negative values fly away from the point.

virtual double vtkRenderWindowInteractor::GetDolly  )  [virtual]
 

Set the total Dolly value to use when flying to (FlyTo()) a specified point. Negative values fly away from the point.

virtual int* vtkRenderWindowInteractor::GetEventPosition  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::GetEventPosition int &  ,
int & 
[virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::GetEventPosition int  [2]  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual int* vtkRenderWindowInteractor::GetLastEventPosition  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::GetLastEventPosition int &  ,
int & 
[virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::GetLastEventPosition int  [2]  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::SetLastEventPosition int  ,
int 
[virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

void vtkRenderWindowInteractor::SetLastEventPosition int  [2]  ) 
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::SetEventPosition int  x,
int  y
[inline, virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

Definition at line 225 of file vtkRenderWindowInteractor.h.

References vtkObject::Modified().

virtual void vtkRenderWindowInteractor::SetEventPosition int  pos[2]  )  [inline, virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

Definition at line 238 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetEventPositionFlipY int  x,
int  y
[inline, virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

Definition at line 242 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetEventPositionFlipY int  pos[2]  )  [inline, virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

Definition at line 246 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetControlKey int   )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual int vtkRenderWindowInteractor::GetControlKey  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::SetShiftKey int   )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual int vtkRenderWindowInteractor::GetShiftKey  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::SetKeyCode char   )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual char vtkRenderWindowInteractor::GetKeyCode  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::SetRepeatCount int   )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual int vtkRenderWindowInteractor::GetRepeatCount  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual void vtkRenderWindowInteractor::SetKeySym const char *   )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

virtual char* vtkRenderWindowInteractor::GetKeySym  )  [virtual]
 

Set/Get information about the current event. The current x,y position is in the EventPosition, and the previous event position is in LastEventPosition, updated automatically each time EventPosition is set using its Set() method. The other information is about key board input.

void vtkRenderWindowInteractor::SetEventInformation int  x,
int  y,
int  ctrl = 0,
int  shift = 0,
char  keycode = 0,
int  repeatcount = 0,
const char *  keysym = 0
[inline]
 

Set all the event information in one call.

Definition at line 264 of file vtkRenderWindowInteractor.h.

References vtkObject::Modified().

void vtkRenderWindowInteractor::SetEventInformationFlipY int  x,
int  y,
int  ctrl = 0,
int  shift = 0,
char  keycode = 0,
int  repeatcount = 0,
const char *  keysym = 0
[inline]
 

Calls SetEventInformation, but flips the Y based on the current Size[1] value (i.e. y = this->Size[1] - y - 1).

Definition at line 291 of file vtkRenderWindowInteractor.h.

void vtkRenderWindowInteractor::SetKeyEventInformation int  ctrl = 0,
int  shift = 0,
char  keycode = 0,
int  repeatcount = 0,
const char *  keysym = 0
[inline]
 

Set all the keyboard-related event information in one call.

Definition at line 311 of file vtkRenderWindowInteractor.h.

References vtkObject::Modified().

virtual void vtkRenderWindowInteractor::SetSize int  ,
int 
[virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

void vtkRenderWindowInteractor::SetSize int  [2]  ) 
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual int* vtkRenderWindowInteractor::GetSize  )  [virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual void vtkRenderWindowInteractor::GetSize int &  ,
int & 
[virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual void vtkRenderWindowInteractor::GetSize int  [2]  )  [virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual void vtkRenderWindowInteractor::SetEventSize int  ,
int 
[virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

void vtkRenderWindowInteractor::SetEventSize int  [2]  ) 
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual int* vtkRenderWindowInteractor::GetEventSize  )  [virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual void vtkRenderWindowInteractor::GetEventSize int &  ,
int & 
[virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual void vtkRenderWindowInteractor::GetEventSize int  [2]  )  [virtual]
 

This methods sets the Size ivar of the interactor without actually changing the size of the window. Normally application programmers would use UpdateSize if anything. This is useful for letting someone else change the size of the rendering window and just letting the interactor know about the change. The current event width/height (if any) is in EventSize (Expose event, for example).

virtual vtkRenderer* vtkRenderWindowInteractor::FindPokedRenderer int  ,
int 
[virtual]
 

When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers.


Member Data Documentation

vtkRenderWindow* vtkRenderWindowInteractor::RenderWindow [protected]
 

Definition at line 351 of file vtkRenderWindowInteractor.h.

vtkInteractorObserver* vtkRenderWindowInteractor::InteractorStyle [protected]
 

Definition at line 352 of file vtkRenderWindowInteractor.h.

vtkAbstractPicker* vtkRenderWindowInteractor::Picker [protected]
 

Definition at line 355 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::Initialized [protected]
 

Definition at line 357 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::Enabled [protected]
 

Definition at line 358 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::Style [protected]
 

Definition at line 359 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::LightFollowCamera [protected]
 

Definition at line 360 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::ActorMode [protected]
 

Definition at line 361 of file vtkRenderWindowInteractor.h.

double vtkRenderWindowInteractor::DesiredUpdateRate [protected]
 

Definition at line 362 of file vtkRenderWindowInteractor.h.

double vtkRenderWindowInteractor::StillUpdateRate [protected]
 

Definition at line 363 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::ControlKey [protected]
 

Definition at line 366 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::ShiftKey [protected]
 

Definition at line 367 of file vtkRenderWindowInteractor.h.

char vtkRenderWindowInteractor::KeyCode [protected]
 

Definition at line 368 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::RepeatCount [protected]
 

Definition at line 369 of file vtkRenderWindowInteractor.h.

char* vtkRenderWindowInteractor::KeySym [protected]
 

Definition at line 370 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::EventPosition[2] [protected]
 

Definition at line 371 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::LastEventPosition[2] [protected]
 

Definition at line 372 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::EventSize[2] [protected]
 

Definition at line 373 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::Size[2] [protected]
 

Definition at line 374 of file vtkRenderWindowInteractor.h.

int vtkRenderWindowInteractor::NumberOfFlyFrames [protected]
 

Definition at line 377 of file vtkRenderWindowInteractor.h.

double vtkRenderWindowInteractor::Dolly [protected]
 

Definition at line 378 of file vtkRenderWindowInteractor.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:14:29 2008 for VTK by  doxygen 1.4.3-20050530