VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkGenericRenderWindowInteractor Class Reference

platform-independent programmable render window interactor. More...

#include <vtkGenericRenderWindowInteractor.h>

Inheritance diagram for vtkGenericRenderWindowInteractor:
[legend]
Collaboration diagram for vtkGenericRenderWindowInteractor:
[legend]

List of all members.

Public Types

typedef vtkRenderWindowInteractor Superclass
- Public Types inherited from vtkRenderWindowInteractor
enum  { OneShotTimer = 1, RepeatingTimer }
- Public Types inherited from vtkObject

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 ()
- Public Member Functions inherited from vtkRenderWindowInteractor
virtual void UnRegister (vtkObjectBase *o)
virtual void Start ()
virtual void UpdateSize (int x, int y)
virtual void TerminateApp (void)
virtual vtkAbstractPropPickerCreateDefaultPicker ()
virtual void GetMousePosition (int *x, int *y)
virtual void Render ()
virtual vtkRendererFindPokedRenderer (int, int)
vtkObserverMediatorGetObserverMediator ()
virtual void Initialize ()
void ReInitialize ()
virtual void Enable ()
virtual void Disable ()
virtual int GetEnabled ()
virtual void EnableRenderOn ()
virtual void EnableRenderOff ()
virtual void SetEnableRender (bool)
virtual bool GetEnableRender ()
void SetRenderWindow (vtkRenderWindow *aren)
virtual vtkRenderWindowGetRenderWindow ()
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 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 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])
virtual void SetUseTDx (bool)
virtual bool GetUseTDx ()
virtual void MouseMoveEvent ()
virtual void RightButtonPressEvent ()
virtual void RightButtonReleaseEvent ()
virtual void LeftButtonPressEvent ()
virtual void LeftButtonReleaseEvent ()
virtual void MiddleButtonPressEvent ()
virtual void MiddleButtonReleaseEvent ()
virtual void MouseWheelForwardEvent ()
virtual void MouseWheelBackwardEvent ()
virtual void ExposeEvent ()
virtual void ConfigureEvent ()
virtual void EnterEvent ()
virtual void LeaveEvent ()
virtual void KeyPressEvent ()
virtual void KeyReleaseEvent ()
virtual void CharEvent ()
virtual void ExitEvent ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

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 Member Functions inherited from vtkRenderWindowInteractor
 vtkRenderWindowInteractor ()
 ~vtkRenderWindowInteractor ()
int GetCurrentTimerId ()
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void ReleaseFocus ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int TimerEventResetsTimer
- Protected Attributes inherited from vtkRenderWindowInteractor
vtkRenderWindowRenderWindow
vtkInteractorObserverInteractorStyle
vtkAbstractPickerPicker
int Initialized
int Enabled
bool EnableRender
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
vtkObserverMediatorObserverMediator
vtkTimerIdMap * TimerMap
unsigned long TimerDuration
int HandleEventLoop
bool UseTDx
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.


Member Typedef Documentation

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.

virtual int vtkGenericRenderWindowInteractor::InternalCreateTimer ( int  timerId,
int  timerType,
unsigned long  duration 
)
protectedvirtual

Generic internal timer methods. See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

virtual int vtkGenericRenderWindowInteractor::InternalDestroyTimer ( int  platformTimerId)
protectedvirtual

Generic internal timer methods. See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.


Member Data Documentation

int vtkGenericRenderWindowInteractor::TimerEventResetsTimer
protected

Definition at line 73 of file vtkGenericRenderWindowInteractor.h.


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