VTK  9.2.6
vtkVRInteractorStyle.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkVRInteractorStyle.h
5
6Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7All rights reserved.
8See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10This software is distributed WITHOUT ANY WARRANTY; without even
11the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
25#ifndef vtkVRInteractorStyle_h
26#define vtkVRInteractorStyle_h
27
28#include "vtkEventData.h" // for enums
30#include "vtkNew.h" // for vtkNew
31#include "vtkRenderingVRModule.h" // For export macro
32#include "vtkSmartPointer.h" // for vtkSmartPointer
33
34#include <map> // for std::map
35#include <vector> // for std::vector
36
38class vtkCell;
39class vtkPlane;
41class vtkSelection;
42class vtkSphereSource;
43class vtkTextActor3D;
47class vtkVRMenuWidget;
48
49class VTKRENDERINGVR_EXPORT vtkVRInteractorStyle : public vtkInteractorStyle3D
50{
51public:
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
56
59 void OnSelect3D(vtkEventData* edata) override;
60 void OnNextPose3D(vtkEventData* edata) override;
61 void OnViewerMovement3D(vtkEventData* edata) override;
62 void OnMove3D(vtkEventData* edata) override;
63 void OnMenu3D(vtkEventData* edata) override;
64 void OnElevation3D(vtkEventData* edata) override;
66
68
79 void StartMovement3D(int interactionState, vtkEventDataDevice3D*);
82
84
87 void OnPan() override;
88 void OnPinch() override;
89 void OnRotate() override;
91
93
96 void ProbeData(vtkEventDataDevice controller);
97 void PositionProp(vtkEventData*, double* lwpos = nullptr, double* lwori = nullptr) override;
99 virtual void LoadNextCameraPose() = 0;
101
107
113
115
123
128 vtkEventDataDevice device, vtkEventDataDeviceInput input, const std::string& text = "");
129
134
136
141 vtkSetMacro(HoverPick, bool);
142 vtkGetMacro(HoverPick, bool);
143 vtkBooleanMacro(HoverPick, bool);
145
147
151 vtkSetMacro(GrabWithRay, bool);
152 vtkGetMacro(GrabWithRay, bool);
153 vtkBooleanMacro(GrabWithRay, bool);
155
157 {
159 GROUNDED_STYLE
160 };
161
163
167 vtkSetMacro(Style, MovementStyle);
168 vtkGetMacro(Style, MovementStyle);
170
175 {
176 return this->InteractionState[static_cast<int>(device)];
177 }
178
180
183 void ShowRay(vtkEventDataDevice controller);
184 void HideRay(vtkEventDataDevice controller);
186
188
191 void ShowBillboard(const std::string& text);
194
199 void ShowPickSphere(double* pos, double radius, vtkProp3D*);
200
207
212
214
218 void SetDrawControls(bool);
220
225
230
234 vtkVRMenuWidget* GetMenu() { return this->Menu.Get(); }
235
236protected:
239
244
246 static void MenuCallback(
247 vtkObject* object, unsigned long event, void* clientdata, void* calldata);
248
252 void StartAction(int VTKIS_STATE, vtkEventDataDevice3D* edata);
253 void EndAction(int VTKIS_STATE, vtkEventDataDevice3D* edata);
254
258 bool HardwareSelect(vtkEventDataDevice controller, bool actorPassOnly);
259
263 void Movement3D(int interactionState, vtkEventData* edata);
264
265 bool HoverPick = false;
266 bool GrabWithRay = true;
267
271
276
277 // Device input to interaction state mapping
278 std::map<std::tuple<vtkCommand::EventIds, vtkEventDataAction>, int> InputMap;
280
281 // Store required controllers information when performing action
282 int InteractionState[vtkEventDataNumberOfDevices];
283 std::vector<vtkSmartPointer<vtkProp3D>> InteractionProps;
284 std::vector<vtkSmartPointer<vtkPlane>> ClippingPlanes;
285
286 // Store headset world orientation
287 double HeadsetDir[3] = { 0, 0, 0 };
288
289 // Store movement style
291
292private:
294 void operator=(const vtkVRInteractorStyle&) = delete;
295};
296
297#endif
supports function callbacks
abstract class to specify cell behavior
Definition vtkCell.h:61
a simple class to control print indentation
Definition vtkIndent.h:40
extends interaction to support 3D input
Allocate and hold a VTK object.
Definition vtkNew.h:62
abstract base class for most VTK objects
Definition vtkObject.h:63
perform various plane computations
Definition vtkPlane.h:37
represents an 3D object for placement in a rendered scene
Definition vtkProp3D.h:50
platform-independent render window interaction including picking and frame rate control.
data object that represents a "selection" in VTK.
create a polygonal sphere centered at the origin
An actor that displays text.
Tooltip helper explaining controls Helper class to draw one tooltip per button around the controller.
pick an actor/prop given a controller position and orientation
Extended from vtkInteractorStyle3D to override command methods.
void ShowPickSphere(double *pos, double radius, vtkProp3D *)
Make the pick actor a sphere of given radius centered at given position, and show it.
void PositionProp(vtkEventData *, double *lwpos=nullptr, double *lwori=nullptr) override
Methods for interaction.
void ProbeData(vtkEventDataDevice controller)
Methods for interaction.
virtual void SetupActions(vtkRenderWindowInteractor *iren)=0
Setup default actions defined with an action path and a corresponding command.
vtkVRMenuWidget * GetMenu()
Return the menu to allow the user to add options to it.
void StartMovement3D(int interactionState, vtkEventDataDevice3D *)
Interaction mode entry points.
std::vector< vtkSmartPointer< vtkPlane > > ClippingPlanes
vtkNew< vtkTextActor3D > TextActor3D
void Clip(vtkEventDataDevice3D *)
Methods for interaction.
void ShowBillboard(const std::string &text)
Show/hide billboard with given text string.
void SetDrawControls(bool)
Control visibility of descriptive tooltips for controller/HMD models.
void OnNextPose3D(vtkEventData *edata) override
Override generic event bindings to call the corresponding action.
void EndAction(int VTKIS_STATE, vtkEventDataDevice3D *edata)
void OnSelect3D(vtkEventData *edata) override
Override generic event bindings to call the corresponding action.
virtual vtkVRControlsHelper * MakeControlsHelper()=0
Creates a new ControlsHelper suitable for use with the child class.
vtkNew< vtkCallbackCommand > MenuCommand
void Movement3D(int interactionState, vtkEventData *edata)
Update the 3D movement according to the given interaction state.
bool HardwareSelect(vtkEventDataDevice controller, bool actorPassOnly)
Pick using hardware selector.
void HidePickActor()
Hide the pick actor (sphere or polydata).
int GetInteractionState(vtkEventDataDevice device)
Return interaction state for the specified device (dolly, pick, none, etc...).
void StartPick(vtkEventDataDevice3D *)
Interaction mode entry points.
void OnMenu3D(vtkEventData *edata) override
Override generic event bindings to call the corresponding action.
void OnPinch() override
Multitouch events binding.
void StartAction(int VTKIS_STATE, vtkEventDataDevice3D *edata)
Utility routines.
void EndPick(vtkEventDataDevice3D *)
Interaction mode entry points.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void OnElevation3D(vtkEventData *edata) override
Override generic event bindings to call the corresponding action.
void StartClip(vtkEventDataDevice3D *)
Interaction mode entry points.
void EndPickCallback(vtkSelection *sel)
void MapInputToAction(vtkCommand::EventIds eid, vtkEventDataAction action, int state)
Map controller inputs to actions.
void EndClip(vtkEventDataDevice3D *)
Interaction mode entry points.
vtkNew< vtkVRMenuRepresentation > MenuRepresentation
void SetInteractor(vtkRenderWindowInteractor *iren) override
Set the Interactor wrapper being controlled by this object.
vtkNew< vtkVRHardwarePicker > HardwarePicker
void HideBillboard()
Show/hide billboard with given text string.
void ShowRay(vtkEventDataDevice controller)
Show/hide the ray for the specified controller.
~vtkVRInteractorStyle() override
void EndMovement3D(vtkEventDataDevice3D *)
Interaction mode entry points.
static void MenuCallback(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkNew< vtkVRMenuWidget > Menu
void EndPositionProp(vtkEventDataDevice3D *)
Interaction mode entry points.
void StartLoadCamPose(vtkEventDataDevice3D *)
Interaction mode entry points.
void OnViewerMovement3D(vtkEventData *edata) override
Override generic event bindings to call the corresponding action.
void HideRay(vtkEventDataDevice controller)
Show/hide the ray for the specified controller.
std::map< std::tuple< vtkCommand::EventIds, vtkEventDataAction >, int > InputMap
void ShowPickCell(vtkCell *cell, vtkProp3D *)
Make the pick actor a polydata built from the points and edges of the given cell, and show it.
void OnRotate() override
Multitouch events binding.
void OnPan() override
Multitouch events binding.
void OnMove3D(vtkEventData *edata) override
Override generic event bindings to call the corresponding action.
vtkNew< vtkActor > PickActor
std::vector< vtkSmartPointer< vtkProp3D > > InteractionProps
virtual void LoadNextCameraPose()=0
Methods for interaction.
void AddTooltipForInput(vtkEventDataDevice device, vtkEventDataDeviceInput input, const std::string &text="")
Define the helper text that goes with an input.
void ToggleDrawControls()
Control visibility of descriptive tooltips for controller/HMD models.
void GroundMovement3D(vtkEventDataDevice3D *)
Move the camera on the "XY" plan (ground) using the thumbstick/trackpad position (up/down and left/ri...
void UpdateRay(vtkEventDataDevice controller)
Update and draw the ray.
void MapInputToAction(vtkCommand::EventIds eid, int state)
Map controller inputs to actions.
void Elevation3D(vtkEventDataDevice3D *)
Move the camera following the "Z" axis (elevation) using the thumbstick/trackpad position (up/down).
void EndLoadCamPose(vtkEventDataDevice3D *)
Interaction mode entry points.
void StartPositionProp(vtkEventDataDevice3D *)
Interaction mode entry points.
vtkNew< vtkSphereSource > Sphere
Widget representation for vtkVRMenuWidget Implementation of the popup panel representation for the vt...
3D widget to display a menu in VR
vtkEventDataDevice
platform-independent event data structures
const int vtkEventDataNumberOfDevices
vtkEventDataAction
vtkEventDataDeviceInput
const int vtkEventDataNumberOfInputs