VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
vtkWin32RenderWindowInteractor Class Reference

implements Win32 specific functions required by vtkRenderWindowInteractor. More...

#include <vtkWin32RenderWindowInteractor.h>

Inheritance diagram for vtkWin32RenderWindowInteractor:
[legend]
Collaboration diagram for vtkWin32RenderWindowInteractor:
[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. More...
 
vtkWin32RenderWindowInteractorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Initialize () override
 Initialize the event handler. More...
 
virtual void Enable () override
 Enable/Disable interactions. More...
 
virtual void Disable () override
 
void ProcessEvents () override
 Run the event loop and return. More...
 
virtual void SetInstallMessageProc (int)
 By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. More...
 
virtual int GetInstallMessageProc ()
 
virtual void InstallMessageProcOn ()
 
virtual void InstallMessageProcOff ()
 
void TerminateApp (void) override
 Win32 specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminate the application. More...
 
virtual int OnMouseMove (HWND wnd, UINT nFlags, int X, int Y)
 Various methods that a Win32 window can redirect to this class to be handled. More...
 
virtual int OnNCMouseMove (HWND wnd, UINT nFlags, int X, int Y)
 
virtual int OnRButtonDown (HWND wnd, UINT nFlags, int X, int Y, int repeat=0)
 
virtual int OnRButtonUp (HWND wnd, UINT nFlags, int X, int Y)
 
virtual int OnMButtonDown (HWND wnd, UINT nFlags, int X, int Y, int repeat=0)
 
virtual int OnMButtonUp (HWND wnd, UINT nFlags, int X, int Y)
 
virtual int OnLButtonDown (HWND wnd, UINT nFlags, int X, int Y, int repeat=0)
 
virtual int OnLButtonUp (HWND wnd, UINT nFlags, int X, int Y)
 
virtual int OnSize (HWND wnd, UINT nType, int X, int Y)
 
virtual int OnTimer (HWND wnd, UINT nIDEvent)
 
virtual int OnKeyDown (HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags)
 
virtual int OnKeyUp (HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags)
 
virtual int OnChar (HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags)
 
virtual int OnMouseWheelForward (HWND wnd, UINT nFlags, int X, int Y)
 
virtual int OnMouseWheelBackward (HWND wnd, UINT nFlags, int X, int Y)
 
virtual int OnFocus (HWND wnd, UINT nFlags)
 
virtual int OnKillFocus (HWND wnd, UINT nFlags)
 
virtual int OnTouch (HWND wnd, UINT wParam, UINT lParam)
 
void ExitCallback () override
 These methods correspond to the Exit, User and Pick callbacks. More...
 
- Public Member Functions inherited from vtkRenderWindowInteractor
vtkRenderWindowInteractorNewInstance () const
 
void ReInitialize ()
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow-Interactor, so objects are freed properly. More...
 
virtual void Start ()
 Start the event loop. More...
 
virtual bool GetDone ()
 Is the interactor loop done. More...
 
virtual void SetDone (bool)
 
virtual int GetEnabled ()
 
virtual void EnableRenderOn ()
 Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render(). More...
 
virtual void EnableRenderOff ()
 
virtual void SetEnableRender (bool)
 
virtual bool GetEnableRender ()
 
void SetRenderWindow (vtkRenderWindow *aren)
 Set/Get the rendering window being controlled by this object. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 
virtual void UpdateSize (int x, int y)
 Event loop notification member for window size change. More...
 
virtual int CreateTimer (int timerType)
 This class provides two groups of methods for manipulating timers. More...
 
virtual int DestroyTimer ()
 
int CreateRepeatingTimer (unsigned long duration)
 Create a repeating timer, with the specified duration (in milliseconds). More...
 
int CreateOneShotTimer (unsigned long duration)
 Create a one shot timer, with the specified duretion (in milliseconds). More...
 
int IsOneShotTimer (int timerId)
 Query whether the specified timerId is a one shot timer. More...
 
unsigned long GetTimerDuration (int timerId)
 Get the duration (in milliseconds) for the specified timerId. More...
 
int ResetTimer (int timerId)
 Reset the specified timer. More...
 
int DestroyTimer (int timerId)
 Destroy the timer specified by timerId. More...
 
virtual int GetVTKTimerId (int platformTimerId)
 Get the VTK timer ID that corresponds to the supplied platform ID. More...
 
virtual void SetTimerDuration (unsigned long)
 Specify the default timer interval (in milliseconds). More...
 
virtual unsigned long GetTimerDuration ()
 
virtual void SetTimerEventId (int)
 These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...
 
virtual int GetTimerEventId ()
 
virtual void SetTimerEventType (int)
 
virtual int GetTimerEventType ()
 
virtual void SetTimerEventDuration (int)
 
virtual int GetTimerEventDuration ()
 
virtual void SetTimerEventPlatformId (int)
 
virtual int GetTimerEventPlatformId ()
 
virtual void SetInteractorStyle (vtkInteractorObserver *)
 External switching between joystick/trackball/new? modes. More...
 
virtual vtkInteractorObserverGetInteractorStyle ()
 
virtual void SetLightFollowCamera (vtkTypeBool)
 Turn on/off the automatic repositioning of lights as the camera moves. More...
 
virtual vtkTypeBool GetLightFollowCamera ()
 
virtual void LightFollowCameraOn ()
 
virtual void LightFollowCameraOff ()
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate. More...
 
virtual double GetDesiredUpdateRate ()
 
virtual void SetStillUpdateRate (double)
 Set/Get the desired update rate when movement has stopped. More...
 
virtual double GetStillUpdateRate ()
 
virtual int GetInitialized ()
 See whether interactor has been initialized yet. More...
 
virtual void SetPicker (vtkAbstractPicker *)
 Set/Get the object used to perform pick operations. More...
 
virtual vtkAbstractPickerGetPicker ()
 
virtual vtkAbstractPropPickerCreateDefaultPicker ()
 Create default picker. More...
 
virtual void SetPickingManager (vtkPickingManager *)
 Set the picking manager. More...
 
virtual vtkPickingManagerGetPickingManager ()
 
virtual void UserCallback ()
 
virtual void StartPickCallback ()
 
virtual void EndPickCallback ()
 
virtual void GetMousePosition (int *x, int *y)
 Get the current position of the mouse. More...
 
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. More...
 
void ShowCursor ()
 
virtual void Render ()
 Render the scene. More...
 
void FlyTo (vtkRenderer *ren, double x, double y, double z)
 Given a position x, move the current camera's focal point to x. More...
 
void FlyTo (vtkRenderer *ren, double *x)
 
void FlyToImage (vtkRenderer *ren, double x, double y)
 
void FlyToImage (vtkRenderer *ren, double *x)
 
virtual void SetNumberOfFlyFrames (int)
 Set the number of frames to fly to when FlyTo is invoked. More...
 
virtual int GetNumberOfFlyFrames ()
 
virtual void SetDolly (double)
 Set the total Dolly value to use when flying to (FlyTo()) a specified point. More...
 
virtual double GetDolly ()
 
virtual intGetEventPosition ()
 Set/Get information about the current event. More...
 
virtual void GetEventPosition (int &, int &)
 
virtual void GetEventPosition (int[2])
 
virtual intGetLastEventPosition ()
 
virtual void GetLastEventPosition (int &, int &)
 
virtual void GetLastEventPosition (int[2])
 
virtual void SetLastEventPosition (int, int)
 
void SetLastEventPosition (int[2])
 
virtual void SetEventPosition (int x, int y)
 
virtual void SetEventPosition (int pos[2])
 
virtual void SetEventPositionFlipY (int x, int y)
 
virtual void SetEventPositionFlipY (int pos[2])
 
virtual intGetEventPositions (int pointerIndex)
 
virtual intGetLastEventPositions (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 void SetAltKey (int)
 Set/get whether alt modifier key was pressed. More...
 
virtual int GetAltKey ()
 
virtual void SetControlKey (int)
 Set/get whether control modifier key was pressed. More...
 
virtual int GetControlKey ()
 
virtual void SetShiftKey (int)
 Set/get whether shift modifier key was pressed. More...
 
virtual int GetShiftKey ()
 
virtual void SetKeyCode (char)
 Set/get the key code for the key that was pressed. More...
 
virtual char GetKeyCode ()
 
virtual void SetRepeatCount (int)
 Set/get the repear count for the key or mouse event. More...
 
virtual int GetRepeatCount ()
 
virtual void SetKeySym (const char *)
 Set/get the key symbol for the key that was pressed. More...
 
virtual char * GetKeySym ()
 
virtual void SetPointerIndex (int)
 Set/get the index of the most recent pointer to have an event. More...
 
virtual int GetPointerIndex ()
 
void SetRotation (double val)
 Set/get the rotation for the gesture in degrees, update LastRotation. More...
 
virtual double GetRotation ()
 
virtual double GetLastRotation ()
 
void SetScale (double val)
 Set/get the scale for the gesture, updates LastScale. More...
 
virtual double GetScale ()
 
virtual double GetLastScale ()
 
void SetTranslation (double val[2])
 Set/get the translation for pan/swipe gestures, update LastTranslation. More...
 
virtual doubleGetTranslation ()
 
virtual void GetTranslation (double &, double &)
 
virtual void GetTranslation (double[2])
 
virtual doubleGetLastTranslation ()
 
virtual void GetLastTranslation (double &, double &)
 
virtual void GetLastTranslation (double[2])
 
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. More...
 
void SetEventInformation (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=nullptr)
 
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. More...
 
void SetEventInformationFlipY (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=nullptr)
 
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. More...
 
virtual void SetSize (int, int)
 This methods sets the Size ivar of the interactor without actually changing the size of the window. More...
 
void SetSize (int[2])
 
virtual intGetSize ()
 
virtual void GetSize (int &, int &)
 
virtual void GetSize (int[2])
 
virtual void SetEventSize (int, int)
 
void SetEventSize (int[2])
 
virtual intGetEventSize ()
 
virtual void GetEventSize (int &, int &)
 
virtual void GetEventSize (int[2])
 
virtual vtkRendererFindPokedRenderer (int, int)
 When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers. More...
 
vtkObserverMediatorGetObserverMediator ()
 Return the object used to mediate between vtkInteractorObservers contending for resources. More...
 
virtual void SetUseTDx (bool)
 Use a 3DConnexion device. More...
 
virtual bool GetUseTDx ()
 
virtual void MouseMoveEvent ()
 Fire various events. More...
 
virtual void RightButtonPressEvent ()
 
virtual void RightButtonReleaseEvent ()
 
virtual void LeftButtonPressEvent ()
 
virtual void LeftButtonReleaseEvent ()
 
virtual void MiddleButtonPressEvent ()
 
virtual void MiddleButtonReleaseEvent ()
 
virtual void MouseWheelForwardEvent ()
 
virtual void MouseWheelBackwardEvent ()
 
virtual void ExposeEvent ()
 
virtual void ConfigureEvent ()
 
virtual void EnterEvent ()
 
virtual void LeaveEvent ()
 
virtual void KeyPressEvent ()
 
virtual void KeyReleaseEvent ()
 
virtual void CharEvent ()
 
virtual void ExitEvent ()
 
virtual void FourthButtonPressEvent ()
 
virtual void FourthButtonReleaseEvent ()
 
virtual void FifthButtonPressEvent ()
 
virtual void FifthButtonReleaseEvent ()
 
virtual void StartPinchEvent ()
 Fire various gesture based events. More...
 
virtual void PinchEvent ()
 
virtual void EndPinchEvent ()
 
virtual void StartRotateEvent ()
 
virtual void RotateEvent ()
 
virtual void EndRotateEvent ()
 
virtual void StartPanEvent ()
 
virtual void PanEvent ()
 
virtual void EndPanEvent ()
 
virtual void TapEvent ()
 
virtual void LongTapEvent ()
 
virtual void SwipeEvent ()
 
virtual void SetRecognizeGestures (bool)
 Convert multitouch events into gestures. More...
 
virtual bool GetRecognizeGestures ()
 
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. More...
 
void ClearContact (size_t contactID)
 Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events. More...
 
int GetPointerIndexForContact (size_t contactID)
 
int GetPointerIndexForExistingContact (size_t contactID)
 
bool IsPointerIndexSet (int i)
 
void ClearPointerIndex (int i)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkWin32RenderWindowInteractorNew ()
 Construct object so that light follows camera motion. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWin32RenderWindowInteractorSafeDownCast (vtkObjectBase *o)
 
static void SetClassExitMethod (void(*f)(void *), void *arg)
 Methods to set the default exit method for the class. More...
 
static void SetClassExitMethodArgDelete (void(*f)(void *))
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWin32RenderWindowInteractor ()
 
 ~vtkWin32RenderWindowInteractor ()
 
int InternalCreateTimer (int timerId, int timerType, unsigned long duration) override
 Win32-specific internal timer methods. More...
 
int InternalDestroyTimer (int platformTimerId) override
 
void StartEventLoop () override
 This will start up the event loop and never return. More...
 
- Protected Member Functions inherited from vtkRenderWindowInteractor
 vtkRenderWindowInteractor ()
 
 ~vtkRenderWindowInteractor () override
 
virtual vtkPickingManagerCreateDefaultPickingManager ()
 Create default pickingManager. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 
void ReleaseFocus ()
 
int GetCurrentTimerId ()
 
virtual void RecognizeGesture (vtkCommand::EventIds)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

HWND WindowId
 
WNDPROC OldProc
 
int InstallMessageProc
 
int MouseInWindow
 
int StartedMessageLoop
 
- Protected Attributes inherited from vtkRenderWindowInteractor
vtkRenderWindowRenderWindow
 
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. More...
 
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static void(* ClassExitMethod )(void *)
 Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. More...
 
static void(* ClassExitMethodArgDelete )(void *)
 
static void * ClassExitMethodArg
 

Friends

VTKRENDERINGOPENGL2_EXPORT LRESULT CALLBACK vtkHandleMessage (HWND hwnd, UINT uMsg, WPARAM w, LPARAM l)
 
VTKRENDERINGOPENGL2_EXPORT LRESULT CALLBACK vtkHandleMessage2 (HWND hwnd, UINT uMsg, WPARAM w, LPARAM l, vtkWin32RenderWindowInteractor *me)
 

Detailed Description

implements Win32 specific functions required by vtkRenderWindowInteractor.

By default the interactor installs a MessageProc callback which intercepts windows' messages to the window and controls interactions by routing them to the InteractoStyle classes. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessageProc to false. This provides a minimal "Mapped" mode of interaction

Tests:
vtkWin32RenderWindowInteractor (Tests)

Definition at line 45 of file vtkWin32RenderWindowInteractor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkWin32RenderWindowInteractor.h.

Constructor & Destructor Documentation

◆ vtkWin32RenderWindowInteractor()

vtkWin32RenderWindowInteractor::vtkWin32RenderWindowInteractor ( )
protected

◆ ~vtkWin32RenderWindowInteractor()

vtkWin32RenderWindowInteractor::~vtkWin32RenderWindowInteractor ( )
protected

Member Function Documentation

◆ New()

static vtkWin32RenderWindowInteractor* vtkWin32RenderWindowInteractor::New ( )
static

Construct object so that light follows camera motion.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWin32RenderWindowInteractor::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 vtkWin32RenderWindowInteractor* vtkWin32RenderWindowInteractor::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWin32RenderWindowInteractor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderWindowInteractor.

◆ NewInstance()

vtkWin32RenderWindowInteractor* vtkWin32RenderWindowInteractor::NewInstance ( ) const

◆ PrintSelf()

void vtkWin32RenderWindowInteractor::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.

◆ Initialize()

virtual void vtkWin32RenderWindowInteractor::Initialize ( )
overridevirtual

Initialize the event handler.

Reimplemented from vtkRenderWindowInteractor.

◆ Enable()

virtual void vtkWin32RenderWindowInteractor::Enable ( )
overridevirtual

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 from vtkRenderWindowInteractor.

◆ Disable()

virtual void vtkWin32RenderWindowInteractor::Disable ( )
overridevirtual

Reimplemented from vtkRenderWindowInteractor.

◆ ProcessEvents()

void vtkWin32RenderWindowInteractor::ProcessEvents ( )
overridevirtual

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 from vtkRenderWindowInteractor.

◆ SetInstallMessageProc()

virtual void vtkWin32RenderWindowInteractor::SetInstallMessageProc ( int  )
virtual

By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions.

MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.

◆ GetInstallMessageProc()

virtual int vtkWin32RenderWindowInteractor::GetInstallMessageProc ( )
virtual

◆ InstallMessageProcOn()

virtual void vtkWin32RenderWindowInteractor::InstallMessageProcOn ( )
virtual

◆ InstallMessageProcOff()

virtual void vtkWin32RenderWindowInteractor::InstallMessageProcOff ( )
virtual

◆ TerminateApp()

void vtkWin32RenderWindowInteractor::TerminateApp ( void  )
overridevirtual

Win32 specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminate the application.

An application can Specify ExitMethod for alternative behavior (i.e. suppression of keyboard exit)

Reimplemented from vtkRenderWindowInteractor.

◆ OnMouseMove()

virtual int vtkWin32RenderWindowInteractor::OnMouseMove ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

Various methods that a Win32 window can redirect to this class to be handled.

◆ OnNCMouseMove()

virtual int vtkWin32RenderWindowInteractor::OnNCMouseMove ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

◆ OnRButtonDown()

virtual int vtkWin32RenderWindowInteractor::OnRButtonDown ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y,
int  repeat = 0 
)
virtual

◆ OnRButtonUp()

virtual int vtkWin32RenderWindowInteractor::OnRButtonUp ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

◆ OnMButtonDown()

virtual int vtkWin32RenderWindowInteractor::OnMButtonDown ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y,
int  repeat = 0 
)
virtual

◆ OnMButtonUp()

virtual int vtkWin32RenderWindowInteractor::OnMButtonUp ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

◆ OnLButtonDown()

virtual int vtkWin32RenderWindowInteractor::OnLButtonDown ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y,
int  repeat = 0 
)
virtual

◆ OnLButtonUp()

virtual int vtkWin32RenderWindowInteractor::OnLButtonUp ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

◆ OnSize()

virtual int vtkWin32RenderWindowInteractor::OnSize ( HWND  wnd,
UINT  nType,
int  X,
int  Y 
)
virtual

◆ OnTimer()

virtual int vtkWin32RenderWindowInteractor::OnTimer ( HWND  wnd,
UINT  nIDEvent 
)
virtual

◆ OnKeyDown()

virtual int vtkWin32RenderWindowInteractor::OnKeyDown ( HWND  wnd,
UINT  nChar,
UINT  nRepCnt,
UINT  nFlags 
)
virtual

◆ OnKeyUp()

virtual int vtkWin32RenderWindowInteractor::OnKeyUp ( HWND  wnd,
UINT  nChar,
UINT  nRepCnt,
UINT  nFlags 
)
virtual

◆ OnChar()

virtual int vtkWin32RenderWindowInteractor::OnChar ( HWND  wnd,
UINT  nChar,
UINT  nRepCnt,
UINT  nFlags 
)
virtual

◆ OnMouseWheelForward()

virtual int vtkWin32RenderWindowInteractor::OnMouseWheelForward ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

◆ OnMouseWheelBackward()

virtual int vtkWin32RenderWindowInteractor::OnMouseWheelBackward ( HWND  wnd,
UINT  nFlags,
int  X,
int  Y 
)
virtual

◆ OnFocus()

virtual int vtkWin32RenderWindowInteractor::OnFocus ( HWND  wnd,
UINT  nFlags 
)
virtual

◆ OnKillFocus()

virtual int vtkWin32RenderWindowInteractor::OnKillFocus ( HWND  wnd,
UINT  nFlags 
)
virtual

◆ OnTouch()

virtual int vtkWin32RenderWindowInteractor::OnTouch ( HWND  wnd,
UINT  wParam,
UINT  lParam 
)
virtual

◆ SetClassExitMethod()

static void vtkWin32RenderWindowInteractor::SetClassExitMethod ( void(*)(void *)  f,
void *  arg 
)
static

Methods to set the default exit method for the class.

This method is only used if no instance level ExitMethod has been defined. It is provided as a means to control how an interactor is exited given the various language bindings (Win32, etc.).

◆ SetClassExitMethodArgDelete()

static void vtkWin32RenderWindowInteractor::SetClassExitMethodArgDelete ( void(*)(void *)  f)
static

◆ ExitCallback()

void vtkWin32RenderWindowInteractor::ExitCallback ( )
overridevirtual

These methods correspond to the Exit, User and Pick callbacks.

They allow for the Style to invoke them.

Reimplemented from vtkRenderWindowInteractor.

◆ InternalCreateTimer()

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

Win32-specific internal timer methods.

See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

◆ InternalDestroyTimer()

int vtkWin32RenderWindowInteractor::InternalDestroyTimer ( int  platformTimerId)
overrideprotectedvirtual

Reimplemented from vtkRenderWindowInteractor.

◆ StartEventLoop()

void vtkWin32RenderWindowInteractor::StartEventLoop ( )
overrideprotectedvirtual

This will start up the event loop and never return.

If you call this method it will loop processing events until the application is exited.

Reimplemented from vtkRenderWindowInteractor.

Friends And Related Function Documentation

◆ vtkHandleMessage

VTKRENDERINGOPENGL2_EXPORT LRESULT CALLBACK vtkHandleMessage ( HWND  hwnd,
UINT  uMsg,
WPARAM  w,
LPARAM  l 
)
friend

◆ vtkHandleMessage2

VTKRENDERINGOPENGL2_EXPORT LRESULT CALLBACK vtkHandleMessage2 ( HWND  hwnd,
UINT  uMsg,
WPARAM  w,
LPARAM  l,
vtkWin32RenderWindowInteractor me 
)
friend

Member Data Documentation

◆ WindowId

HWND vtkWin32RenderWindowInteractor::WindowId
protected

Definition at line 150 of file vtkWin32RenderWindowInteractor.h.

◆ OldProc

WNDPROC vtkWin32RenderWindowInteractor::OldProc
protected

Definition at line 151 of file vtkWin32RenderWindowInteractor.h.

◆ InstallMessageProc

int vtkWin32RenderWindowInteractor::InstallMessageProc
protected

Definition at line 152 of file vtkWin32RenderWindowInteractor.h.

◆ MouseInWindow

int vtkWin32RenderWindowInteractor::MouseInWindow
protected

Definition at line 153 of file vtkWin32RenderWindowInteractor.h.

◆ StartedMessageLoop

int vtkWin32RenderWindowInteractor::StartedMessageLoop
protected

Definition at line 154 of file vtkWin32RenderWindowInteractor.h.

◆ ClassExitMethod

void(* vtkWin32RenderWindowInteractor::ClassExitMethod) (void *)
staticprotected

Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e.

java, Win32)

Definition at line 162 of file vtkWin32RenderWindowInteractor.h.

◆ ClassExitMethodArgDelete

void(* vtkWin32RenderWindowInteractor::ClassExitMethodArgDelete) (void *)
staticprotected

Definition at line 163 of file vtkWin32RenderWindowInteractor.h.

◆ ClassExitMethodArg

void* vtkWin32RenderWindowInteractor::ClassExitMethodArg
staticprotected

Definition at line 164 of file vtkWin32RenderWindowInteractor.h.


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