VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGenericRenderWindowInteractor Class Reference

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

#include <vtkGenericRenderWindowInteractor.h>

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

Public Types

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

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkGenericRenderWindowInteractorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void TimerEvent ()
 Fire TimerEvent.
 
virtual void SetTimerEventResetsTimer (vtkTypeBool)
 Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers.
 
virtual vtkTypeBool GetTimerEventResetsTimer ()
 Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers.
 
virtual void TimerEventResetsTimerOn ()
 Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers.
 
virtual void TimerEventResetsTimerOff ()
 Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers.
 
- Public Member Functions inherited from vtkRenderWindowInteractor
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRenderWindowInteractorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow-Interactor, so objects are freed properly.
 
virtual void Start ()
 Start the event loop.
 
virtual void ProcessEvents ()
 Run the event loop and return.
 
virtual bool GetDone ()
 Is the interactor loop done.
 
virtual void SetDone (bool)
 
virtual void Enable ()
 Enable/Disable interactions.
 
virtual void Disable ()
 
virtual int GetEnabled ()
 
virtual void UpdateSize (int x, int y)
 Event loop notification member for window size change.
 
virtual int CreateTimer (int timerType)
 This class provides two groups of methods for manipulating timers.
 
virtual int DestroyTimer ()
 
int CreateRepeatingTimer (unsigned long duration)
 Create a repeating timer, with the specified duration (in milliseconds).
 
int CreateOneShotTimer (unsigned long duration)
 Create a one shot timer, with the specified duration (in milliseconds).
 
int IsOneShotTimer (int timerId)
 Query whether the specified timerId is a one shot timer.
 
unsigned long GetTimerDuration (int timerId)
 Get the duration (in milliseconds) for the specified timerId.
 
int ResetTimer (int timerId)
 Reset the specified timer.
 
int DestroyTimer (int timerId)
 Destroy the timer specified by timerId.
 
virtual int GetVTKTimerId (int platformTimerId)
 Get the VTK timer ID that corresponds to the supplied platform ID.
 
virtual void TerminateApp (void)
 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 vtkAbstractPropPickerCreateDefaultPicker ()
 Create default picker.
 
virtual void GetMousePosition (int *x, int *y)
 Get the current position of the mouse.
 
virtual void Render ()
 Render the scene.
 
virtual int * GetEventPositions (int pointerIndex)
 
virtual int * GetLastEventPositions (int pointerIndex)
 
virtual void SetEventPosition (int x, int y, int pointerIndex)
 
virtual void SetEventPosition (int pos[2], int pointerIndex)
 
virtual void SetEventPositionFlipY (int x, int y, int pointerIndex)
 
virtual void SetEventPositionFlipY (int pos[2], int pointerIndex)
 
virtual vtkRendererFindPokedRenderer (int, int)
 When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers.
 
vtkObserverMediatorGetObserverMediator ()
 Return the object used to mediate between vtkInteractorObservers contending for resources.
 
virtual void Initialize ()
 Prepare for handling events and set the Enabled flag to true.
 
void ReInitialize ()
 Prepare for handling events and set the Enabled flag to true.
 
virtual void EnableRenderOn ()
 Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
 
virtual void EnableRenderOff ()
 Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
 
virtual void SetEnableRender (bool)
 Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
 
virtual bool GetEnableRender ()
 Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
 
void SetRenderWindow (vtkRenderWindow *aren)
 Set/Get the rendering window being controlled by this object.
 
virtual vtkRenderWindowGetRenderWindow ()
 Set/Get the rendering window being controlled by this object.
 
void SetHardwareWindow (vtkHardwareWindow *aren)
 Set/Get the hardware window being controlled by this object.
 
virtual vtkHardwareWindowGetHardwareWindow ()
 Set/Get the hardware window being controlled by this object.
 
virtual void SetTimerDuration (unsigned long)
 Specify the default timer interval (in milliseconds).
 
virtual unsigned long GetTimerDuration ()
 Specify the default timer interval (in milliseconds).
 
virtual void SetTimerEventId (int)
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual int GetTimerEventId ()
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual void SetTimerEventType (int)
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual int GetTimerEventType ()
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual void SetTimerEventDuration (int)
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual int GetTimerEventDuration ()
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual void SetTimerEventPlatformId (int)
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual int GetTimerEventPlatformId ()
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent.
 
virtual void SetInteractorStyle (vtkInteractorObserver *)
 External switching between joystick/trackball/new? modes.
 
virtual vtkInteractorObserverGetInteractorStyle ()
 External switching between joystick/trackball/new? modes.
 
virtual void SetLightFollowCamera (vtkTypeBool)
 Turn on/off the automatic repositioning of lights as the camera moves.
 
virtual vtkTypeBool GetLightFollowCamera ()
 Turn on/off the automatic repositioning of lights as the camera moves.
 
virtual void LightFollowCameraOn ()
 Turn on/off the automatic repositioning of lights as the camera moves.
 
virtual void LightFollowCameraOff ()
 Turn on/off the automatic repositioning of lights as the camera moves.
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate.
 
virtual double GetDesiredUpdateRate ()
 Set/Get the desired update rate.
 
virtual void SetStillUpdateRate (double)
 Set/Get the desired update rate when movement has stopped.
 
virtual double GetStillUpdateRate ()
 Set/Get the desired update rate when movement has stopped.
 
virtual int GetInitialized ()
 See whether interactor has been initialized yet.
 
virtual void SetPicker (vtkAbstractPicker *)
 Set/Get the object used to perform pick operations.
 
virtual vtkAbstractPickerGetPicker ()
 Set/Get the object used to perform pick operations.
 
virtual void SetPickingManager (vtkPickingManager *)
 Set the picking manager.
 
virtual vtkPickingManagerGetPickingManager ()
 Set the picking manager.
 
virtual void ExitCallback ()
 These methods correspond to the Exit, User and Pick callbacks.
 
virtual void UserCallback ()
 These methods correspond to the Exit, User and Pick callbacks.
 
virtual void StartPickCallback ()
 These methods correspond to the Exit, User and Pick callbacks.
 
virtual void EndPickCallback ()
 These methods correspond to the Exit, User and Pick callbacks.
 
void 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 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.
 
void FlyTo (vtkRenderer *ren, double x, double y, double z)
 Given a position x, move the current camera's focal point to x.
 
void FlyTo (vtkRenderer *ren, double *x)
 Given a position x, move the current camera's focal point to x.
 
void FlyToImage (vtkRenderer *ren, double x, double y)
 Given a position x, move the current camera's focal point to x.
 
void FlyToImage (vtkRenderer *ren, double *x)
 Given a position x, move the current camera's focal point to x.
 
virtual void SetNumberOfFlyFrames (int)
 Set the number of frames to fly to when FlyTo is invoked.
 
virtual int GetNumberOfFlyFrames ()
 Set the number of frames to fly to when FlyTo is invoked.
 
virtual void SetDolly (double)
 Set the total Dolly value to use when flying to (FlyTo()) a specified point.
 
virtual double GetDolly ()
 Set the total Dolly value to use when flying to (FlyTo()) a specified point.
 
virtual int * GetEventPosition ()
 Set/Get information about the current event.
 
virtual void GetEventPosition (int &, int &)
 Set/Get information about the current event.
 
virtual void GetEventPosition (int[2])
 Set/Get information about the current event.
 
virtual int * GetLastEventPosition ()
 Set/Get information about the current event.
 
virtual void GetLastEventPosition (int &, int &)
 Set/Get information about the current event.
 
virtual void GetLastEventPosition (int[2])
 Set/Get information about the current event.
 
virtual void SetLastEventPosition (int, int)
 Set/Get information about the current event.
 
void SetLastEventPosition (int[2])
 Set/Get information about the current event.
 
virtual void SetEventPosition (int x, int y)
 Set/Get information about the current event.
 
virtual void SetEventPosition (int pos[2])
 Set/Get information about the current event.
 
virtual void SetEventPositionFlipY (int x, int y)
 Set/Get information about the current event.
 
virtual void SetEventPositionFlipY (int pos[2])
 Set/Get information about the current event.
 
virtual void SetAltKey (int)
 Set/get whether alt modifier key was pressed.
 
virtual int GetAltKey ()
 Set/get whether alt modifier key was pressed.
 
virtual void SetControlKey (int)
 Set/get whether control modifier key was pressed.
 
virtual int GetControlKey ()
 Set/get whether control modifier key was pressed.
 
virtual void SetShiftKey (int)
 Set/get whether shift modifier key was pressed.
 
virtual int GetShiftKey ()
 Set/get whether shift modifier key was pressed.
 
virtual void SetKeyCode (char)
 Set/get the key code for the key that was pressed.
 
virtual char GetKeyCode ()
 Set/get the key code for the key that was pressed.
 
virtual void SetRepeatCount (int)
 Set/get the repear count for the key or mouse event.
 
virtual int GetRepeatCount ()
 Set/get the repear count for the key or mouse event.
 
virtual void SetKeySym (const char *)
 Set/get the key symbol for the key that was pressed.
 
virtual char * GetKeySym ()
 Set/get the key symbol for the key that was pressed.
 
virtual void SetPointerIndex (int)
 Set/get the index of the most recent pointer to have an event.
 
virtual int GetPointerIndex ()
 Set/get the index of the most recent pointer to have an event.
 
void SetRotation (double rotation)
 Set/get the rotation for the gesture in degrees, update LastRotation.
 
virtual double GetRotation ()
 Set/get the rotation for the gesture in degrees, update LastRotation.
 
virtual double GetLastRotation ()
 Set/get the rotation for the gesture in degrees, update LastRotation.
 
void SetScale (double scale)
 Set/get the scale for the gesture, updates LastScale.
 
virtual double GetScale ()
 Set/get the scale for the gesture, updates LastScale.
 
virtual double GetLastScale ()
 Set/get the scale for the gesture, updates LastScale.
 
void SetTranslation (double val[2])
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
virtual double * GetTranslation ()
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
virtual void GetTranslation (double &, double &)
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
virtual void GetTranslation (double[2])
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
virtual double * GetLastTranslation ()
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
virtual void GetLastTranslation (double &, double &)
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
virtual void GetLastTranslation (double[2])
 Set/get the translation for pan/swipe gestures, update LastTranslation.
 
void SetEventInformation (int x, int y, int ctrl, int shift, char keycode, int repeatcount, const char *keysym, int pointerIndex)
 Set all the event information in one call.
 
void SetEventInformation (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=nullptr)
 Set all the event information in one call.
 
void SetEventInformationFlipY (int x, int y, int ctrl, int shift, char keycode, int repeatcount, const char *keysym, int pointerIndex)
 Calls SetEventInformation, but flips the Y based on the current Size[1] value (i.e.
 
void SetEventInformationFlipY (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=nullptr)
 Calls SetEventInformation, but flips the Y based on the current Size[1] value (i.e.
 
void SetKeyEventInformation (int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=nullptr)
 Set all the keyboard-related event information in one call.
 
virtual void SetSize (int, int)
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
void SetSize (int[2])
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual int * GetSize ()
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual void GetSize (int &, int &)
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual void GetSize (int[2])
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual void SetEventSize (int, int)
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
void SetEventSize (int[2])
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual int * GetEventSize ()
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual void GetEventSize (int &, int &)
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual void GetEventSize (int[2])
 This methods sets the Size ivar of the interactor without actually changing the size of the window.
 
virtual void SetUseTDx (bool)
 Use a 3DConnexion device.
 
virtual bool GetUseTDx ()
 Use a 3DConnexion device.
 
virtual void MouseMoveEvent ()
 Fire various events.
 
virtual void RightButtonPressEvent ()
 Fire various events.
 
virtual void RightButtonReleaseEvent ()
 Fire various events.
 
virtual void LeftButtonPressEvent ()
 Fire various events.
 
virtual void LeftButtonReleaseEvent ()
 Fire various events.
 
virtual void MiddleButtonPressEvent ()
 Fire various events.
 
virtual void MiddleButtonReleaseEvent ()
 Fire various events.
 
virtual void MouseWheelForwardEvent ()
 Fire various events.
 
virtual void MouseWheelBackwardEvent ()
 Fire various events.
 
virtual void MouseWheelLeftEvent ()
 Fire various events.
 
virtual void MouseWheelRightEvent ()
 Fire various events.
 
virtual void ExposeEvent ()
 Fire various events.
 
virtual void ConfigureEvent ()
 Fire various events.
 
virtual void EnterEvent ()
 Fire various events.
 
virtual void LeaveEvent ()
 Fire various events.
 
virtual void KeyPressEvent ()
 Fire various events.
 
virtual void KeyReleaseEvent ()
 Fire various events.
 
virtual void CharEvent ()
 Fire various events.
 
virtual void ExitEvent ()
 Fire various events.
 
virtual void FourthButtonPressEvent ()
 Fire various events.
 
virtual void FourthButtonReleaseEvent ()
 Fire various events.
 
virtual void FifthButtonPressEvent ()
 Fire various events.
 
virtual void FifthButtonReleaseEvent ()
 Fire various events.
 
virtual void StartPinchEvent ()
 Fire various gesture based events.
 
virtual void PinchEvent ()
 Fire various gesture based events.
 
virtual void EndPinchEvent ()
 Fire various gesture based events.
 
virtual void StartRotateEvent ()
 Fire various gesture based events.
 
virtual void RotateEvent ()
 Fire various gesture based events.
 
virtual void EndRotateEvent ()
 Fire various gesture based events.
 
virtual void StartPanEvent ()
 Fire various gesture based events.
 
virtual void PanEvent ()
 Fire various gesture based events.
 
virtual void EndPanEvent ()
 Fire various gesture based events.
 
virtual void TapEvent ()
 Fire various gesture based events.
 
virtual void LongTapEvent ()
 Fire various gesture based events.
 
virtual void SwipeEvent ()
 Fire various gesture based events.
 
virtual void SetRecognizeGestures (bool)
 Convert multitouch events into gestures.
 
virtual bool GetRecognizeGestures ()
 Convert multitouch events into gestures.
 
virtual int GetPointersDownCount ()
 When handling gestures you can query this value to determine how many pointers are down for the gesture this is useful for pan gestures for example.
 
void ClearContact (size_t contactID)
 Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
 
int GetPointerIndexForContact (size_t contactID)
 Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
 
int GetPointerIndexForExistingContact (size_t contactID)
 Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
 
bool IsPointerIndexSet (int i)
 Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
 
void ClearPointerIndex (int i)
 Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkGenericRenderWindowInteractorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGenericRenderWindowInteractorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderWindowInteractor
static vtkRenderWindowInteractorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderWindowInteractorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGenericRenderWindowInteractor ()
 
 ~vtkGenericRenderWindowInteractor () override
 
int InternalCreateTimer (int timerId, int timerType, unsigned long duration) override
 Generic internal timer methods.
 
int InternalDestroyTimer (int platformTimerId) override
 Generic internal timer methods.
 
- Protected Member Functions inherited from vtkRenderWindowInteractor
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderWindowInteractor ()
 
 ~vtkRenderWindowInteractor () override
 
virtual vtkPickingManagerCreateDefaultPickingManager ()
 Create default pickingManager.
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 
void ReleaseFocus ()
 
virtual void StartEventLoop ()
 Run the event loop (does not return until TerminateApp is called).
 
virtual void RecognizeGesture (vtkCommand::EventIds)
 
int GetCurrentTimerId ()
 Internal methods for creating and destroying timers that must be implemented by subclasses.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool TimerEventResetsTimer
 
- Protected Attributes inherited from vtkRenderWindowInteractor
vtkRenderWindowRenderWindow
 
vtkHardwareWindowHardwareWindow
 
vtkInteractorObserverInteractorStyle
 
vtkAbstractPickerPicker
 
vtkPickingManagerPickingManager
 
bool Done
 
int Initialized
 
int Enabled
 
bool EnableRender
 
int Style
 
vtkTypeBool LightFollowCamera
 
int ActorMode
 
double DesiredUpdateRate
 
double StillUpdateRate
 
int AltKey
 
int ControlKey
 
int ShiftKey
 
char KeyCode
 
double Rotation
 
double LastRotation
 
double Scale
 
double LastScale
 
double Translation [2]
 
double LastTranslation [2]
 
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 EventPositions [VTKI_MAX_POINTERS][2]
 
int LastEventPositions [VTKI_MAX_POINTERS][2]
 
int PointerIndex
 
size_t PointerIndexLookup [VTKI_MAX_POINTERS]
 
int NumberOfFlyFrames
 
double Dolly
 
vtkObserverMediatorObserverMediator
 Widget mediators are used to resolve contention for cursors and other resources.
 
vtkTimerIdMap * TimerMap
 
unsigned long TimerDuration
 
int HandleEventLoop
 
bool UseTDx
 
bool RecognizeGestures
 
int PointersDownCount
 
int PointersDown [VTKI_MAX_POINTERS]
 
int StartingEventPositions [VTKI_MAX_POINTERS][2]
 
vtkCommand::EventIds CurrentGesture
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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::CreateTimerEvent vtkCommand::DestroyTimerEvent vtkCommand::TimerEvent

Definition at line 35 of file vtkGenericRenderWindowInteractor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkGenericRenderWindowInteractor.h.

Constructor & Destructor Documentation

◆ vtkGenericRenderWindowInteractor()

vtkGenericRenderWindowInteractor::vtkGenericRenderWindowInteractor ( )
protected

◆ ~vtkGenericRenderWindowInteractor()

vtkGenericRenderWindowInteractor::~vtkGenericRenderWindowInteractor ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGenericRenderWindowInteractor * vtkGenericRenderWindowInteractor::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkGenericRenderWindowInteractor::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkGenericRenderWindowInteractor * vtkGenericRenderWindowInteractor::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGenericRenderWindowInteractor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderWindowInteractor.

◆ NewInstance()

vtkGenericRenderWindowInteractor * vtkGenericRenderWindowInteractor::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericRenderWindowInteractor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ TimerEvent()

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.

◆ SetTimerEventResetsTimer()

virtual void vtkGenericRenderWindowInteractor::SetTimerEventResetsTimer ( vtkTypeBool  )
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.

◆ GetTimerEventResetsTimer()

virtual vtkTypeBool 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.

◆ TimerEventResetsTimerOn()

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.

◆ TimerEventResetsTimerOff()

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.

◆ InternalCreateTimer()

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

Generic internal timer methods.

See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

◆ InternalDestroyTimer()

int vtkGenericRenderWindowInteractor::InternalDestroyTimer ( int  platformTimerId)
overrideprotectedvirtual

Generic internal timer methods.

See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

Member Data Documentation

◆ TimerEventResetsTimer

vtkTypeBool vtkGenericRenderWindowInteractor::TimerEventResetsTimer
protected

Definition at line 80 of file vtkGenericRenderWindowInteractor.h.


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