VTK
9.1.0
|
platform-independent render window interaction including picking and frame rate control. More...
#include <vtkRenderWindowInteractor.h>
Public Types | |
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. | |
vtkRenderWindowInteractor * | NewInstance () 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 vtkAbstractPropPicker * | CreateDefaultPicker () |
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 vtkRenderer * | FindPokedRenderer (int, int) |
When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers. | |
vtkObserverMediator * | GetObserverMediator () |
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 vtkRenderWindow * | GetRenderWindow () |
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 vtkHardwareWindow * | GetHardwareWindow () |
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 vtkInteractorObserver * | GetInteractorStyle () |
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 vtkAbstractPicker * | GetPicker () |
Set/Get the object used to perform pick operations. | |
virtual void | SetPickingManager (vtkPickingManager *) |
Set the picking manager. | |
virtual vtkPickingManager * | GetPickingManager () |
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. | |
vtkCommand * | GetCommand (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 vtkRenderWindowInteractor * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkRenderWindowInteractor * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 vtkObjectBase * | New () |
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 vtkObjectBase * | NewInstanceInternal () const |
vtkRenderWindowInteractor () | |
~vtkRenderWindowInteractor () override | |
virtual vtkPickingManager * | CreateDefaultPickingManager () |
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) |
virtual int | InternalCreateTimer (int timerId, int timerType, unsigned long duration) |
Internal methods for creating and destroying timers that must be implemented by subclasses. | |
virtual int | InternalDestroyTimer (int platformTimerId) |
Internal methods for creating and destroying timers that must be implemented by subclasses. | |
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 &) |
Friends | |
class | vtkInteractorEventRecorder |
class | vtkInteractorObserver |
These methods allow the interactor to control which events are processed. | |
struct | vtkTimerStruct |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 191 of file vtkRenderWindowInteractor.h.
Definition at line 198 of file vtkRenderWindowInteractor.h.
anonymous enum |
Enumerator | |
---|---|
OneShotTimer | |
RepeatingTimer |
Definition at line 362 of file vtkRenderWindowInteractor.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkObjectBase.
Reimplemented in QVTKInteractor, vtkRenderWindowInteractor3D, vtkOpenVRRenderWindowInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
|
static |
|
protectedvirtual |
Reimplemented in QVTKInteractor, vtkRenderWindowInteractor3D, vtkOpenVRRenderWindowInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
vtkRenderWindowInteractor * vtkRenderWindowInteractor::NewInstance | ( | ) | const |
|
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 vtkObject.
Reimplemented in vtkOpenVRRenderWindowInteractor, vtkRenderWindowInteractor3D, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
|
virtual |
Prepare for handling events and set the Enabled flag to true.
This will be called automatically by Start() if the interactor is not initialized, but it can be called manually if you need to perform any operations between initialization and the start of the event loop.
Reimplemented in vtkOpenVRRenderWindowInteractor, QVTKInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
|
inline |
Prepare for handling events and set the Enabled flag to true.
This will be called automatically by Start() if the interactor is not initialized, but it can be called manually if you need to perform any operations between initialization and the start of the event loop.
Definition at line 210 of file vtkRenderWindowInteractor.h.
|
overridevirtual |
This Method detects loops of RenderWindow-Interactor, so objects are freed properly.
Reimplemented from vtkObjectBase.
|
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.
Reimplemented in QVTKInteractor.
|
inlinevirtual |
Run the event loop and return.
This is provided so that you can implement your own event loop but yet use the vtk event handling as well.
Reimplemented in vtkOpenVRRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
Definition at line 236 of file vtkRenderWindowInteractor.h.
|
virtual |
Is the interactor loop done.
|
virtual |
|
inlinevirtual |
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 vtkRenderWindowInteractor3D, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
Definition at line 253 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Reimplemented in vtkRenderWindowInteractor3D, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
Definition at line 258 of file vtkRenderWindowInteractor.h.
|
virtual |
|
virtual |
Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
|
virtual |
Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
|
virtual |
Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
|
virtual |
Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render().
void vtkRenderWindowInteractor::SetRenderWindow | ( | vtkRenderWindow * | aren | ) |
Set/Get the rendering window being controlled by this object.
|
virtual |
Set/Get the rendering window being controlled by this object.
void vtkRenderWindowInteractor::SetHardwareWindow | ( | vtkHardwareWindow * | aren | ) |
Set/Get the hardware window being controlled by this object.
For opengl the hardware window is not used as the opengl subclasses of RenderWindow provide the functionality.
|
virtual |
Set/Get the hardware window being controlled by this object.
For opengl the hardware window is not used as the opengl subclasses of RenderWindow provide the functionality.
|
virtual |
Event loop notification member for window size change.
Window size is measured in pixels.
If the size has changed, this method will fire vtkCommand::WindowResizeEvent.
Reimplemented in vtkXRenderWindowInteractor.
|
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::CreateRepeatingTimer | ( | unsigned long | duration | ) |
Create a repeating timer, with the specified duration (in milliseconds).
int vtkRenderWindowInteractor::CreateOneShotTimer | ( | unsigned long | duration | ) |
Create a one shot timer, with the specified duration (in milliseconds).
int vtkRenderWindowInteractor::IsOneShotTimer | ( | int | timerId | ) |
Query whether the specified timerId is a one shot timer.
unsigned long vtkRenderWindowInteractor::GetTimerDuration | ( | int | timerId | ) |
Get the duration (in milliseconds) for the specified timerId.
int vtkRenderWindowInteractor::ResetTimer | ( | int | timerId | ) |
Reset the specified timer.
int vtkRenderWindowInteractor::DestroyTimer | ( | int | timerId | ) |
Destroy the timer specified by timerId.
|
virtual |
Get the VTK timer ID that corresponds to the supplied platform ID.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
|
inlinevirtual |
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 QVTKInteractor, vtkCocoaRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkXRenderWindowInteractor, vtkAndroidRenderWindowInteractor, vtkSDL2RenderWindowInteractor, and vtkWin32RenderWindowInteractor.
Definition at line 410 of file vtkRenderWindowInteractor.h.
|
virtual |
External switching between joystick/trackball/new? modes.
Initial value is a vtkInteractorStyleSwitch object.
|
virtual |
External switching between joystick/trackball/new? modes.
Initial value is a vtkInteractorStyleSwitch object.
|
virtual |
Turn on/off the automatic repositioning of lights as the camera moves.
Default is On.
|
virtual |
Turn on/off the automatic repositioning of lights as the camera moves.
Default is On.
|
virtual |
Turn on/off the automatic repositioning of lights as the camera moves.
Default is On.
|
virtual |
Turn on/off the automatic repositioning of lights as the camera moves.
Default is On.
|
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. The default is 15.
|
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. The default is 15.
|
virtual |
Set/Get the desired update rate when movement has stopped.
For the non-still update rate, see the SetDesiredUpdateRate method. The default is 0.0001
|
virtual |
Set/Get the desired update rate when movement has stopped.
For the non-still update rate, see the SetDesiredUpdateRate method. The default is 0.0001
|
virtual |
See whether interactor has been initialized yet.
Default is 0.
|
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 |
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 |
Create default picker.
Used to create one when none is specified. Default is an instance of vtkPropPicker.
|
virtual |
Set the picking manager.
Set/Get the object used to perform operations through the interactor By default, a valid but disabled picking manager is instantiated.
|
virtual |
Set the picking manager.
Set/Get the object used to perform operations through the interactor By default, a valid but disabled picking manager is instantiated.
|
virtual |
These methods correspond to the Exit, User and Pick callbacks.
They allow for the Style to invoke them.
Reimplemented in vtkOpenVRRenderWindowInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, and vtkWin32RenderWindowInteractor.
|
virtual |
These methods correspond to the Exit, User and Pick callbacks.
They allow for the Style to invoke them.
|
virtual |
These methods correspond to the Exit, User and Pick callbacks.
They allow for the Style to invoke them.
|
virtual |
These methods correspond to the Exit, User and Pick callbacks.
They allow for the Style to invoke them.
|
inlinevirtual |
Get the current position of the mouse.
Reimplemented in vtkXRenderWindowInteractor.
Definition at line 502 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 |
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.
|
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 530 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.
|
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 532 of file vtkRenderWindowInteractor.h.
|
virtual |
Set the number of frames to fly to when FlyTo is invoked.
|
virtual |
Set the number of frames to fly to when FlyTo is invoked.
|
virtual |
Set the total Dolly value to use when flying to (FlyTo()) a specified point.
Negative values fly away from the point.
|
virtual |
Set the total Dolly value to use when flying to (FlyTo()) a specified point.
Negative values fly away from the point.
|
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 |
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 |
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 |
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 |
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 |
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 |
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.
|
inlinevirtual |
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 564 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
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 578 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
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 579 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
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 583 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Definition at line 586 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Definition at line 594 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Definition at line 602 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Definition at line 628 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Definition at line 632 of file vtkRenderWindowInteractor.h.
|
inlinevirtual |
Definition at line 636 of file vtkRenderWindowInteractor.h.
|
virtual |
Set/get whether alt modifier key was pressed.
|
virtual |
Set/get whether alt modifier key was pressed.
|
virtual |
Set/get whether control modifier key was pressed.
|
virtual |
Set/get whether control modifier key was pressed.
|
virtual |
Set/get whether shift modifier key was pressed.
|
virtual |
Set/get whether shift modifier key was pressed.
|
virtual |
Set/get the key code for the key that was pressed.
|
virtual |
Set/get the key code for the key that was pressed.
|
virtual |
Set/get the repear count for the key or mouse event.
This specifies how many times a key has been pressed.
|
virtual |
Set/get the repear count for the key or mouse event.
This specifies how many times a key has been pressed.
|
virtual |
Set/get the key symbol for the key that was pressed.
This is the key symbol as defined by the relevant X headers. On X based platforms this corresponds to the installed X server, whereas on other platforms the native key codes are translated into a string representation.
|
virtual |
Set/get the key symbol for the key that was pressed.
This is the key symbol as defined by the relevant X headers. On X based platforms this corresponds to the installed X server, whereas on other platforms the native key codes are translated into a string representation.
|
virtual |
Set/get the index of the most recent pointer to have an event.
|
virtual |
Set/get the index of the most recent pointer to have an event.
void vtkRenderWindowInteractor::SetRotation | ( | double | rotation | ) |
Set/get the rotation for the gesture in degrees, update LastRotation.
|
virtual |
Set/get the rotation for the gesture in degrees, update LastRotation.
|
virtual |
Set/get the rotation for the gesture in degrees, update LastRotation.
void vtkRenderWindowInteractor::SetScale | ( | double | scale | ) |
Set/get the scale for the gesture, updates LastScale.
|
virtual |
Set/get the scale for the gesture, updates LastScale.
|
virtual |
Set/get the scale for the gesture, updates LastScale.
void vtkRenderWindowInteractor::SetTranslation | ( | double | val[2] | ) |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
virtual |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
virtual |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
virtual |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
virtual |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
virtual |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
virtual |
Set/get the translation for pan/swipe gestures, update LastTranslation.
|
inline |
Set all the event information in one call.
Definition at line 732 of file vtkRenderWindowInteractor.h.
|
inline |
Set all the event information in one call.
Definition at line 747 of file vtkRenderWindowInteractor.h.
|
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 759 of file vtkRenderWindowInteractor.h.
|
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 765 of file vtkRenderWindowInteractor.h.
|
inline |
Set all the keyboard-related event information in one call.
Definition at line 776 of file vtkRenderWindowInteractor.h.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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).
|
virtual |
Use a 3DConnexion device.
Initial value is false. If VTK is not build with the TDx option, this is no-op. If VTK is build with the TDx option, and a device is not connected, a warning is emitted. It is must be called before the first Render to be effective, otherwise it is ignored.
|
virtual |
Use a 3DConnexion device.
Initial value is false. If VTK is not build with the TDx option, this is no-op. If VTK is build with the TDx option, and a device is not connected, a warning is emitted. It is must be called before the first Render to be effective, otherwise it is ignored.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
Reimplemented in vtkRenderWindowInteractor3D.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
Reimplemented in vtkRenderWindowInteractor3D.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
Reimplemented in vtkRenderWindowInteractor3D.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
Reimplemented in vtkRenderWindowInteractor3D.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various events.
SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Fire various gesture based events.
These methods will Invoke the corresponding vtk event.
|
virtual |
Convert multitouch events into gestures.
When this is on (its default) multitouch events received by this interactor will be converted into gestures by VTK. If turned off the raw multitouch events will be passed down.
|
virtual |
Convert multitouch events into gestures.
When this is on (its default) multitouch events received by this interactor will be converted into gestures by VTK. If turned off the raw multitouch events will be passed down.
|
virtual |
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 vtkRenderWindowInteractor::ClearContact | ( | size_t | contactID | ) |
Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
We keep an array that maps these system dependent contact ids to our pointer index These functions return -1 if the ID is not found or if there is no more room for contacts
int vtkRenderWindowInteractor::GetPointerIndexForContact | ( | size_t | contactID | ) |
Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
We keep an array that maps these system dependent contact ids to our pointer index These functions return -1 if the ID is not found or if there is no more room for contacts
int vtkRenderWindowInteractor::GetPointerIndexForExistingContact | ( | size_t | contactID | ) |
Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
We keep an array that maps these system dependent contact ids to our pointer index These functions return -1 if the ID is not found or if there is no more room for contacts
bool vtkRenderWindowInteractor::IsPointerIndexSet | ( | int | i | ) |
Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
We keep an array that maps these system dependent contact ids to our pointer index These functions return -1 if the ID is not found or if there is no more room for contacts
void vtkRenderWindowInteractor::ClearPointerIndex | ( | int | i | ) |
Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events.
We keep an array that maps these system dependent contact ids to our pointer index These functions return -1 if the ID is not found or if there is no more room for contacts
|
protectedvirtual |
Create default pickingManager.
Used to create one when none is specified. Default is an instance of vtkPickingManager.
|
inlineprotected |
Definition at line 993 of file vtkRenderWindowInteractor.h.
|
inlineprotected |
Definition at line 997 of file vtkRenderWindowInteractor.h.
|
protectedvirtual |
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 vtkOpenVRRenderWindowInteractor, QVTKInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
|
protectedvirtual |
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 vtkOpenVRRenderWindowInteractor, QVTKInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkGenericRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
|
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.
|
inlineprotectedvirtual |
Run the event loop (does not return until TerminateApp is called).
Reimplemented in vtkOpenVRRenderWindowInteractor, vtkAndroidRenderWindowInteractor, vtkCocoaRenderWindowInteractor, vtkIOSRenderWindowInteractor, vtkSDL2RenderWindowInteractor, vtkWin32RenderWindowInteractor, and vtkXRenderWindowInteractor.
Definition at line 1028 of file vtkRenderWindowInteractor.h.
|
protectedvirtual |
Reimplemented in vtkRenderWindowInteractor3D.
|
friend |
Definition at line 194 of file vtkRenderWindowInteractor.h.
|
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.
Definition at line 992 of file vtkRenderWindowInteractor.h.
|
friend |
Definition at line 1005 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 927 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 928 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 929 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 932 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 933 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 935 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 943 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 944 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 945 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 946 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 947 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 948 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 949 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 950 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 953 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 954 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 955 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 956 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 957 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 958 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 959 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 960 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 961 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 962 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 963 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 964 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 965 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 966 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 967 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 968 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 969 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 970 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 971 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 972 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 974 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 975 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 976 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 978 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 981 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 982 of file vtkRenderWindowInteractor.h.
|
protected |
Widget mediators are used to resolve contention for cursors and other resources.
Definition at line 1002 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1006 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1007 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1023 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1030 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1034 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1035 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1036 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1038 of file vtkRenderWindowInteractor.h.
|
protected |
Definition at line 1039 of file vtkRenderWindowInteractor.h.