doxygen/html/vtkWin32RenderWindowInteractor_8h_source.html

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen

// SPDX-License-Identifier: BSD-3-Clause


#ifndef vtkWin32RenderWindowInteractor_h

#define vtkWin32RenderWindowInteractor_h


#include "vtkRenderWindowInteractor.h"

#include "vtkRenderingUIModule.h" // For export macro

#include "vtkWindows.h"           // For windows API.

#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO


#include <memory> // for std::unique_ptr


#include "vtkTDxConfigure.h" // defines VTK_USE_TDX

#ifdef VTK_USE_TDX

VTK_ABI_NAMESPACE_BEGIN

class vtkTDxWinDevice;

VTK_ABI_NAMESPACE_END

#endif


VTK_ABI_NAMESPACE_BEGIN


class VTKRENDERINGUI_EXPORT VTK_MARSHALAUTO vtkWin32RenderWindowInteractor

  : public vtkRenderWindowInteractor

{

public:

  static vtkWin32RenderWindowInteractor* New();


  vtkTypeMacro(vtkWin32RenderWindowInteractor, vtkRenderWindowInteractor);

  void PrintSelf(ostream& os, vtkIndent indent) override;


  void Initialize() override;


  void Enable() override;

  void Disable() override;


  void ProcessEvents() override;


  vtkSetMacro(InstallMessageProc, int);

  vtkGetMacro(InstallMessageProc, int);

  vtkBooleanMacro(InstallMessageProc, int);


  void TerminateApp() override;


  friend VTKRENDERINGUI_EXPORT LRESULT CALLBACK vtkHandleMessage(

    HWND hwnd, UINT uMsg, WPARAM w, LPARAM l);

  friend VTKRENDERINGUI_EXPORT LRESULT CALLBACK vtkHandleMessage2(

    HWND hwnd, UINT uMsg, WPARAM w, LPARAM l, vtkWin32RenderWindowInteractor* me);


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

  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);

  virtual int OnDropFiles(HWND wnd, WPARAM wParam);


  static void SetClassExitMethod(void (*f)(void*), void* arg);

  static void SetClassExitMethodArgDelete(void (*f)(void*));


  void ExitCallback() override;


protected:

  vtkWin32RenderWindowInteractor();

  ~vtkWin32RenderWindowInteractor() override;


  HWND WindowId;

  WNDPROC OldProc;

  int InstallMessageProc;

  int MouseInWindow;

  int StartedMessageLoop;


  static void (*ClassExitMethod)(void*);

  static void (*ClassExitMethodArgDelete)(void*);

  static void* ClassExitMethodArg;


  int InternalCreateTimer(int timerId, int timerType, unsigned long duration) override;

  int InternalDestroyTimer(int platformTimerId) override;


  void StartEventLoop() override;


#ifdef VTK_USE_TDX

  vtkTDxWinDevice* Device;

#endif


private:

  vtkWin32RenderWindowInteractor(const vtkWin32RenderWindowInteractor&) = delete;

  void operator=(const vtkWin32RenderWindowInteractor&) = delete;


  class vtkInternals;

  std::unique_ptr<vtkInternals> Internals;

};


VTK_ABI_NAMESPACE_END

#endif

vtkIndent
a simple class to control print indentation
Definition vtkIndent.h:29

vtkRenderWindowInteractor::vtkRenderWindowInteractor
vtkRenderWindowInteractor()

vtkWin32RenderWindowInteractor::OnKillFocus
virtual int OnKillFocus(HWND wnd, UINT nFlags)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::ClassExitMethod
static void(* ClassExitMethod)(void *)
Class variables so an exit method can be defined for this class (used to set different exit methods f...
Definition vtkWin32RenderWindowInteractor.h:156

vtkWin32RenderWindowInteractor::OnMouseWheelForward
virtual int OnMouseWheelForward(HWND wnd, UINT nFlags, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.

vtkWin32RenderWindowInteractor::InternalDestroyTimer
int InternalDestroyTimer(int platformTimerId) override
Win32-specific internal timer methods.

vtkWin32RenderWindowInteractor::WindowId
HWND WindowId
Definition vtkWin32RenderWindowInteractor.h:144

vtkWin32RenderWindowInteractor::OnChar
virtual int OnChar(HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::OnMButtonDown
virtual int OnMButtonDown(HWND wnd, UINT nFlags, int X, int Y, int repeat=0)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::OnRButtonUp
virtual int OnRButtonUp(HWND wnd, UINT nFlags, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::OnDropFiles
virtual int OnDropFiles(HWND wnd, WPARAM wParam)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::InstallMessageProc
int InstallMessageProc
Definition vtkWin32RenderWindowInteractor.h:146

vtkWin32RenderWindowInteractor::OnTouch
virtual int OnTouch(HWND wnd, UINT wParam, UINT lParam)
Various methods that a Win32 window can redirect to this class to be handled.

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

vtkWin32RenderWindowInteractor::ClassExitMethodArg
static void * ClassExitMethodArg
Class variables so an exit method can be defined for this class (used to set different exit methods f...
Definition vtkWin32RenderWindowInteractor.h:158

vtkWin32RenderWindowInteractor::Enable
void Enable() override
Enable/Disable interactions.

vtkWin32RenderWindowInteractor::SetClassExitMethodArgDelete
static void SetClassExitMethodArgDelete(void(*f)(void *))
Methods to set the default exit method for the class.

vtkWin32RenderWindowInteractor::OnTimer
virtual int OnTimer(HWND wnd, UINT nIDEvent)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::Disable
void Disable() override
Enable/Disable interactions.

vtkWin32RenderWindowInteractor::OnRButtonDown
virtual int OnRButtonDown(HWND wnd, UINT nFlags, int X, int Y, int repeat=0)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::OnFocus
virtual int OnFocus(HWND wnd, UINT nFlags)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::InternalCreateTimer
int InternalCreateTimer(int timerId, int timerType, unsigned long duration) override
Win32-specific internal timer methods.

vtkWin32RenderWindowInteractor::OnKeyDown
virtual int OnKeyDown(HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::StartEventLoop
void StartEventLoop() override
This will start up the event loop and never return.

vtkWin32RenderWindowInteractor::TerminateApp
void TerminateApp() override
Win32 specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminat...

vtkWin32RenderWindowInteractor::OnKeyUp
virtual int OnKeyUp(HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::~vtkWin32RenderWindowInteractor
~vtkWin32RenderWindowInteractor() override

vtkWin32RenderWindowInteractor::Initialize
void Initialize() override
Initialize the event handler.

vtkWin32RenderWindowInteractor::vtkWin32RenderWindowInteractor
vtkWin32RenderWindowInteractor()

vtkWin32RenderWindowInteractor::SetClassExitMethod
static void SetClassExitMethod(void(*f)(void *), void *arg)
Methods to set the default exit method for the class.

vtkWin32RenderWindowInteractor::OldProc
WNDPROC OldProc
Definition vtkWin32RenderWindowInteractor.h:145

vtkWin32RenderWindowInteractor::OnMouseWheelBackward
virtual int OnMouseWheelBackward(HWND wnd, UINT nFlags, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::ClassExitMethodArgDelete
static void(* ClassExitMethodArgDelete)(void *)
Class variables so an exit method can be defined for this class (used to set different exit methods f...
Definition vtkWin32RenderWindowInteractor.h:157

vtkWin32RenderWindowInteractor::New
static vtkWin32RenderWindowInteractor * New()
Construct object so that light follows camera motion.

vtkWin32RenderWindowInteractor::ProcessEvents
void ProcessEvents() override
Process all user-interaction, timer events and return.

vtkWin32RenderWindowInteractor::MouseInWindow
int MouseInWindow
Definition vtkWin32RenderWindowInteractor.h:147

vtkWin32RenderWindowInteractor::OnLButtonDown
virtual int OnLButtonDown(HWND wnd, UINT nFlags, int X, int Y, int repeat=0)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::ExitCallback
void ExitCallback() override
These methods correspond to the Exit, User and Pick callbacks.

vtkWin32RenderWindowInteractor::vtkHandleMessage
friend VTKRENDERINGUI_EXPORT LRESULT CALLBACK vtkHandleMessage(HWND hwnd, UINT uMsg, WPARAM w, LPARAM l)

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

vtkWin32RenderWindowInteractor::OnMButtonUp
virtual int OnMButtonUp(HWND wnd, UINT nFlags, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::OnSize
virtual int OnSize(HWND wnd, UINT nType, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::OnLButtonUp
virtual int OnLButtonUp(HWND wnd, UINT nFlags, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkWin32RenderWindowInteractor::StartedMessageLoop
int StartedMessageLoop
Definition vtkWin32RenderWindowInteractor.h:148

vtkWin32RenderWindowInteractor::OnNCMouseMove
virtual int OnNCMouseMove(HWND wnd, UINT nFlags, int X, int Y)
Various methods that a Win32 window can redirect to this class to be handled.

vtkRenderWindowInteractor.h

vtkWrappingHints.h

VTK_MARSHALAUTO
#define VTK_MARSHALAUTO
Definition vtkWrappingHints.h:53