1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkCocoaRenderWindowInteractor.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkCocoaRenderWindowInteractor
* @brief implements Cocoa specific functions
* required by vtkRenderWindowInteractor.
*
*
* The interactor interfaces with vtkCocoaRenderWindow and vtkCocoaGLView
* to trap messages from the Cocoa window manager and send them to vtk.
* Since OS X applications typically use the Command key where UNIX and
* Windows applications would use the Ctrl key, this interactor maps the
* Command key to Ctrl. In versions of VTK prior to VTK 6.2, it was
* mapped to Alt. On OS X, the Option key can be used as Alt.
*
* IMPORTANT: This header must be in C++ only because it is included by .cxx
* files. That means no Objective C may be used. That's why some instance
* variables are void* instead of what they really should be.
*/
#ifndef vtkCocoaRenderWindowInteractor_h
#define vtkCocoaRenderWindowInteractor_h
#include "vtkRenderWindowInteractor.h"
#include "vtkRenderingUIModule.h" // For export macro
#include "vtkTDxConfigure.h" // defines VTK_USE_TDX
#ifdef VTK_USE_TDX
VTK_ABI_NAMESPACE_BEGIN
class vtkTDxMacDevice;
VTK_ABI_NAMESPACE_END
#endif
VTK_ABI_NAMESPACE_BEGIN
class VTKRENDERINGUI_EXPORT vtkCocoaRenderWindowInteractor : public vtkRenderWindowInteractor
{
public:
/**
* Construct object so that light follows camera motion.
*/
static vtkCocoaRenderWindowInteractor* New();
vtkTypeMacro(vtkCocoaRenderWindowInteractor, vtkRenderWindowInteractor);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Initialize the even handler
*/
void Initialize() override;
///@{
/**
* 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.
*/
void Enable() override;
void Disable() override;
///@}
/**
* Cocoa specific application terminate, calls ClassExitMethod then
* calls PostQuitMessage(0) to terminate app. An application can Specify
* ExitMethod for alternative behaviour (i.e. suppression of keyboard exit)
*/
void TerminateApp() override;
/**
* 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.
*/
void ProcessEvents() override;
///@{
/**
* 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 (Cocoa, etc.).
*/
static void SetClassExitMethod(void (*f)(void*), void* arg);
static void SetClassExitMethodArgDelete(void (*f)(void*));
///@}
/**
* These methods correspond to the Exit, User and Pick
* callbacks. They allow for the Style to invoke them.
*/
void ExitCallback() override;
// int GetButtonDown();
// void SetButtonDown(int button);
protected:
vtkCocoaRenderWindowInteractor();
~vtkCocoaRenderWindowInteractor() override;
/**
* Accessors for the Cocoa member variables. These should be used at all time, even
* by this class.
*/
void SetTimerDictionary(void* dictionary); // Really an NSMutableDictionary*
void* GetTimerDictionary();
///@{
/**
* 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, Cocoa)
*/
static void (*ClassExitMethod)(void*);
static void (*ClassExitMethodArgDelete)(void*);
static void* ClassExitMethodArg;
///@}
///@{
/**
* Cocoa-specific internal timer methods. See the superclass for detailed
* documentation.
*/
int InternalCreateTimer(int timerId, int timerType, unsigned long duration) override;
int InternalDestroyTimer(int platformTimerId) override;
///@}
/**
* 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.
*/
void StartEventLoop() override;
///@{
/**
* Accessors for the cocoa manager (Really an NSMutableDictionary*).
* It manages all Cocoa objects in this C++ class.
*/
void SetCocoaManager(void* manager);
void* GetCocoaManager();
///@}
#ifdef VTK_USE_TDX
vtkTDxMacDevice* Device;
#endif
private:
vtkCocoaRenderWindowInteractor(const vtkCocoaRenderWindowInteractor&) = delete;
void operator=(const vtkCocoaRenderWindowInteractor&) = delete;
// Important: this class cannot contain Objective-C instance
// variables for 2 reasons:
// 1) C++ files include this header
// 2) because of garbage collection
// Instead, use the CocoaManager dictionary to keep a collection
// of what would otherwise be Objective-C instance variables.
void* CocoaManager; // Really an NSMutableDictionary*
};
VTK_ABI_NAMESPACE_END
#endif
|