vtkGenericRenderWindowInteractor Class Reference

#include <vtkGenericRenderWindowInteractor.h>

Inheritance diagram for vtkGenericRenderWindowInteractor:

[legend]

Collaboration diagram for vtkGenericRenderWindowInteractor:

[legend]

List of all members.

Detailed Description

platform-independent programmable render window interactor.

vtkGenericRenderWindowInteractor provides a way to translate native mouse and keyboard events into vtk Events. By calling the methods on this class, vtk events will be invoked. This will allow scripting languages to use vtkInteractorStyles and 3D widgets.

Events:: vtkCommand::DestroyTimerEvent vtkCommand::TimerEvent vtkCommand::CreateTimerEvent

Definition at line 33 of file vtkGenericRenderWindowInteractor.h.


Public Types
typedef vtkRenderWindowInteractor	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	TimerEvent ()

virtual void	SetTimerEventResetsTimer (int)
virtual int	GetTimerEventResetsTimer ()
virtual void	TimerEventResetsTimerOn ()
virtual void	TimerEventResetsTimerOff ()
Static Public Member Functions
static vtkGenericRenderWindowInteractor *	New ()
static int	IsTypeOf (const char *type)
static vtkGenericRenderWindowInteractor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkGenericRenderWindowInteractor ()
	~vtkGenericRenderWindowInteractor ()

virtual int	InternalCreateTimer (int timerId, int timerType, unsigned long duration)
virtual int	InternalDestroyTimer (int platformTimerId)
Protected Attributes
int	TimerEventResetsTimer

Member Typedef Documentation

typedef vtkRenderWindowInteractor vtkGenericRenderWindowInteractor::Superclass

Reimplemented from vtkRenderWindowInteractor.

Definition at line 37 of file vtkGenericRenderWindowInteractor.h.

Constructor & Destructor Documentation

vtkGenericRenderWindowInteractor::vtkGenericRenderWindowInteractor ( ) [protected]

vtkGenericRenderWindowInteractor::~vtkGenericRenderWindowInteractor ( ) [protected]

Member Function Documentation

static vtkGenericRenderWindowInteractor* vtkGenericRenderWindowInteractor::New ( ) [static]

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

Reimplemented from vtkRenderWindowInteractor.

virtual const char* vtkGenericRenderWindowInteractor::GetClassName ( ) [virtual]

Reimplemented from vtkRenderWindowInteractor.

static int vtkGenericRenderWindowInteractor::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRenderWindowInteractor.

virtual int vtkGenericRenderWindowInteractor::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRenderWindowInteractor.

static vtkGenericRenderWindowInteractor* vtkGenericRenderWindowInteractor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkRenderWindowInteractor.

void vtkGenericRenderWindowInteractor::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 vtkRenderWindowInteractor.

virtual void vtkGenericRenderWindowInteractor::TimerEvent ( ) [virtual]

Fire TimerEvent. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.

virtual void vtkGenericRenderWindowInteractor::SetTimerEventResetsTimer ( int ) [virtual]

Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.

virtual int vtkGenericRenderWindowInteractor::GetTimerEventResetsTimer ( ) [virtual]

Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.

virtual void vtkGenericRenderWindowInteractor::TimerEventResetsTimerOn ( ) [virtual]

Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.

virtual void vtkGenericRenderWindowInteractor::TimerEventResetsTimerOff ( ) [virtual]

Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.