vtkRenderWindowInteractor Class Reference

#include <vtkRenderWindowInteractor.h>

Inheritance diagram for vtkRenderWindowInteractor:

[legend]

Collaboration diagram for vtkRenderWindowInteractor:

[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 vtkInteractorObserver 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 manipulating timers, TerminateApp, and an event loop if required via Initialize/Start/Enable/Disable.

Warning:: vtkRenderWindowInteractor routes events through VTK's command/observer design pattern. That is, when vtkRenderWindowInteractor (actually, one of its subclasses) sees a platform-dependent event, it translates this into a VTK event using the InvokeEvent() method. Then any vtkInteractorObservers registered for that event are expected to respond as appropriate.

See also:: vtkInteractorObserver

Events:: vtkCommand::RenderEvent vtkCommand::UserEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent vtkCommand::ExitEvent

Examples:: vtkRenderWindowInteractor (Examples)

Tests:: vtkRenderWindowInteractor (Tests)

Definition at line 72 of file vtkRenderWindowInteractor.h.


class	vtkInteractorObserver
void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	ReleaseFocus ()
Public Types
enum	{ OneShotTimer = 1, RepeatingTimer }
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	Start ()
virtual void	UpdateSize (int x, int y)
virtual void	TerminateApp (void)
virtual vtkAbstractPropPicker *	CreateDefaultPicker ()
virtual void	GetMousePosition (int x, int y)
virtual void	Render ()
virtual vtkRenderer *	FindPokedRenderer (int, int)
vtkObserverMediator *	GetObserverMediator ()

virtual void	Initialize ()
void	ReInitialize ()

virtual void	Enable ()
virtual void	Disable ()
virtual int	GetEnabled ()

void	SetRenderWindow (vtkRenderWindow *aren)
virtual vtkRenderWindow *	GetRenderWindow ()

virtual int	CreateTimer (int timerType)
virtual int	DestroyTimer ()
int	CreateRepeatingTimer (unsigned long duration)
int	CreateOneShotTimer (unsigned long duration)
int	IsOneShotTimer (int timerId)
unsigned long	GetTimerDuration (int timerId)
int	ResetTimer (int timerId)
int	DestroyTimer (int timerId)
virtual int	GetVTKTimerId (int platformTimerId)

virtual void	SetTimerDuration (unsigned long)
virtual unsigned long	GetTimerDuration ()

virtual void	SetTimerEventId (int)
virtual int	GetTimerEventId ()
virtual void	SetTimerEventType (int)
virtual int	GetTimerEventType ()
virtual void	SetTimerEventDuration (int)
virtual int	GetTimerEventDuration ()
virtual void	SetTimerEventPlatformId (int)
virtual int	GetTimerEventPlatformId ()

virtual void	SetInteractorStyle (vtkInteractorObserver *)
virtual vtkInteractorObserver *	GetInteractorStyle ()

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 vtkAbstractPicker *	GetPicker ()

virtual void	ExitCallback ()
virtual void	UserCallback ()
virtual void	StartPickCallback ()
virtual void	EndPickCallback ()

void	HideCursor ()
void	ShowCursor ()

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	SetAltKey (int)
virtual int	GetAltKey ()
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 vtkRenderWindowInteractor *	New ()
static int	IsTypeOf (const char *type)
static vtkRenderWindowInteractor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkRenderWindowInteractor ()
	~vtkRenderWindowInteractor ()

virtual int	InternalCreateTimer (int timerId, int timerType, unsigned long duration)
virtual int	InternalDestroyTimer (int platformTimerId)
int	GetCurrentTimerId ()
Protected Attributes
vtkRenderWindow *	RenderWindow
vtkInteractorObserver *	InteractorStyle
vtkAbstractPicker *	Picker
int	Initialized
int	Enabled
int	Style
int	LightFollowCamera
int	ActorMode
double	DesiredUpdateRate
double	StillUpdateRate
int	AltKey
int	ControlKey
int	ShiftKey
char	KeyCode
int	RepeatCount
char *	KeySym
int	EventPosition [2]
int	LastEventPosition [2]
int	EventSize [2]
int	Size [2]
int	TimerEventId
int	TimerEventType
int	TimerEventDuration
int	TimerEventPlatformId
int	NumberOfFlyFrames
double	Dolly
vtkObserverMediator *	ObserverMediator
vtkTimerIdMap *	TimerMap
unsigned long	TimerDuration
int	HandleEventLoop
Friends
class	vtkInteractorEventRecorder
struct	vtkTimerStruct

Member Typedef Documentation

typedef vtkObject vtkRenderWindowInteractor::Superclass

Reimplemented from vtkObject.

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

Definition at line 79 of file vtkRenderWindowInteractor.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

OneShotTimer
RepeatingTimer

Definition at line 152 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 * name ) [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 * name ) [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]

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

Definition at line 86 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 97 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 107 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::Disable ( ) [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 108 of file vtkRenderWindowInteractor.h.

virtual int vtkRenderWindowInteractor::GetEnabled ( ) [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.

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. Window size is measured in pixels.

Reimplemented in vtkXRenderWindowInteractor.

virtual int vtkRenderWindowInteractor::CreateTimer ( int timerType ) [virtual]

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

virtual int vtkRenderWindowInteractor::DestroyTimer ( ) [virtual]

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

int vtkRenderWindowInteractor::CreateRepeatingTimer ( unsigned long duration )

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

int vtkRenderWindowInteractor::CreateOneShotTimer ( unsigned long duration )

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

int vtkRenderWindowInteractor::IsOneShotTimer ( int timerId )

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

unsigned long vtkRenderWindowInteractor::GetTimerDuration ( int timerId )

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

int vtkRenderWindowInteractor::ResetTimer ( int timerId )

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

int vtkRenderWindowInteractor::DestroyTimer ( int timerId )

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

virtual int vtkRenderWindowInteractor::GetVTKTimerId ( int platformTimerId ) [virtual]

This class provides two groups of methods for manipulating timers. The first group (CreateTimer(timerType) and DestroyTimer()) implicitly use an internal timer id (and are present for backward compatibility). The second group (CreateRepeatingTimer(long),CreateOneShotTimer(long), ResetTimer(int),DestroyTimer(int)) use timer ids so multiple timers can be independently managed. In the first group, the CreateTimer() method takes an argument indicating whether the timer is created the first time (timerType==VTKI_TIMER_FIRST) or whether it is being reset (timerType==VTKI_TIMER_UPDATE). (In initial implementations of VTK this was how one shot and repeating timers were managed.) In the second group, the create methods take a timer duration argument (in milliseconds) and return a timer id. Thus the ResetTimer(timerId) and DestroyTimer(timerId) methods take this timer id and operate on the timer as appropriate. Methods are also available for determining

virtual void vtkRenderWindowInteractor::SetTimerDuration ( unsigned long ) [virtual]

Specify the default timer interval (in milliseconds). (This is used in conjunction with the timer methods described previously, e.g., CreateTimer() uses this value; and CreateRepeatingTimer(duration) and CreateOneShotTimer(duration) use the default value if the parameter "duration" is less than or equal to zero.) Care must be taken when adjusting the timer interval from the default value of 10 milliseconds--it may adversely affect the interactors.

virtual unsigned long vtkRenderWindowInteractor::GetTimerDuration ( ) [virtual]

Specify the default timer interval (in milliseconds). (This is used in conjunction with the timer methods described previously, e.g., CreateTimer() uses this value; and CreateRepeatingTimer(duration) and CreateOneShotTimer(duration) use the default value if the parameter "duration" is less than or equal to zero.) Care must be taken when adjusting the timer interval from the default value of 10 milliseconds--it may adversely affect the interactors.

virtual void vtkRenderWindowInteractor::SetTimerEventId ( int ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual int vtkRenderWindowInteractor::GetTimerEventId ( ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual void vtkRenderWindowInteractor::SetTimerEventType ( int ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual int vtkRenderWindowInteractor::GetTimerEventType ( ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual void vtkRenderWindowInteractor::SetTimerEventDuration ( int ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual int vtkRenderWindowInteractor::GetTimerEventDuration ( ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual void vtkRenderWindowInteractor::SetTimerEventPlatformId ( int ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

virtual int vtkRenderWindowInteractor::GetTimerEventPlatformId ( ) [virtual]

These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. The caller of CreateTimerEvent sets up TimerEventId, TimerEventType and TimerEventDuration. The observer of CreateTimerEvent should set up an appropriate platform specific timer based on those values and set the TimerEventPlatformId before returning. The caller of DestroyTimerEvent sets up TimerEventPlatformId. The observer of DestroyTimerEvent should simply destroy the platform specific timer created by CreateTimerEvent. See vtkGenericRenderWindowInteractor's InternalCreateTimer and InternalDestroyTimer for an example.

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, and vtkXRenderWindowInteractor.

Definition at line 191 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetInteractorStyle ( vtkInteractorObserver * ) [virtual]

External switching between joystick/trackball/new? modes. Initial value is a vtkInteractorStyleSwitch object.

virtual vtkInteractorObserver* vtkRenderWindowInteractor::GetInteractorStyle ( ) [virtual]

External switching between joystick/trackball/new? modes. Initial value is a vtkInteractorStyleSwitch object.

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]

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

virtual void vtkRenderWindowInteractor::StartPickCallback ( ) [virtual]

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

virtual void vtkRenderWindowInteractor::EndPickCallback ( ) [virtual]

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

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

Get the current position of the mouse.

Reimplemented in vtkXRenderWindowInteractor.

Definition at line 252 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 ( )

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.

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]`

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.

Definition at line 270 of file vtkRenderWindowInteractor.h.

void vtkRenderWindowInteractor::FlyToImage	(	vtkRenderer *	ren,
		double	x,
		double	y
	)

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::FlyToImage	(	vtkRenderer *	ren,
		double *	x
	)			`[inline]`

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.

Definition at line 273 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. The other information is about key board input.

Definition at line 299 of file vtkRenderWindowInteractor.h.

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. Mouse positions are measured in pixels. The other information is about key board input.

Definition at line 312 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. Mouse positions are measured in pixels. The other information is about key board input.

Definition at line 316 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. Mouse positions are measured in pixels. The other information is about key board input.

Definition at line 320 of file vtkRenderWindowInteractor.h.

virtual void vtkRenderWindowInteractor::SetAltKey ( 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. Mouse positions are measured in pixels. The other information is about key board input.

virtual int vtkRenderWindowInteractor::GetAltKey ( ) [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. Mouse positions are measured in pixels. The other information is about key board input.

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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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. Mouse positions are measured in pixels. 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 340 of file vtkRenderWindowInteractor.h.

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 367 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 387 of file vtkRenderWindowInteractor.h.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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). Window size is measured in pixels.

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.

vtkObserverMediator* vtkRenderWindowInteractor::GetObserverMediator ( )

Return the object used to mediate between vtkInteractorObservers contending for resources. Multiple interactor observers will often request different resources (e.g., cursor shape); the mediator uses a strategy to provide the resource based on priority of the observer plus the particular request (default versus non-default cursor shape).

void vtkRenderWindowInteractor::GrabFocus	(	vtkCommand *	mouseEvents,
		vtkCommand *	keypressEvents = `NULL`
	)			`[inline, protected]`

These methods allow the interactor to control which events are processed. When the GrabFocus() method is called, then only events that the supplied vtkCommands have registered are invoked. (This method is typically used by widgets, i.e., subclasses of vtkInteractorObserver, to grab events once an event sequence begins.) Note that the friend declaration is done here to avoid doing so in the superclass vtkObject. BTX

Definition at line 479 of file vtkRenderWindowInteractor.h.

void vtkRenderWindowInteractor::ReleaseFocus ( ) [inline, protected]

These methods allow the interactor to control which events are processed. When the GrabFocus() method is called, then only events that the supplied vtkCommands have registered are invoked. (This method is typically used by widgets, i.e., subclasses of vtkInteractorObserver, to grab events once an event sequence begins.) Note that the friend declaration is done here to avoid doing so in the superclass vtkObject. BTX

Definition at line 481 of file vtkRenderWindowInteractor.h.

virtual int vtkRenderWindowInteractor::InternalCreateTimer	(	int	timerId,
		int	timerType,
		unsigned long	duration
	)			`[protected, virtual]`

Internal methods for creating and destroying timers that must be implemented by subclasses. InternalCreateTimer() returns a platform-specific timerId and InternalDestroyTimer() returns non-zero value on success.

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

virtual int vtkRenderWindowInteractor::InternalDestroyTimer ( int platformTimerId ) [protected, virtual]

Internal methods for creating and destroying timers that must be implemented by subclasses. InternalCreateTimer() returns a platform-specific timerId and InternalDestroyTimer() returns non-zero value on success.

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

int vtkRenderWindowInteractor::GetCurrentTimerId ( ) [protected]

Internal methods for creating and destroying timers that must be implemented by subclasses. InternalCreateTimer() returns a platform-specific timerId and InternalDestroyTimer() returns non-zero value on success.

Friends And Related Function Documentation

friend class vtkInteractorEventRecorder [friend]

Definition at line 75 of file vtkRenderWindowInteractor.h.

friend class vtkInteractorObserver [friend]

These methods allow the interactor to control which events are processed. When the GrabFocus() method is called, then only events that the supplied vtkCommands have registered are invoked. (This method is typically used by widgets, i.e., subclasses of vtkInteractorObserver, to grab events once an event sequence begins.) Note that the friend declaration is done here to avoid doing so in the superclass vtkObject. BTX

Definition at line 478 of file vtkRenderWindowInteractor.h.

friend struct vtkTimerStruct [friend]

Definition at line 492 of file vtkRenderWindowInteractor.h.