982f222235f8bfd1668d3a6858c5d91eb5e1986b
[occt.git] / src / AIS / AIS_ViewController.hxx
1 // Copyright (c) 2016-2019 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _AIS_ViewController_HeaderFile
15 #define _AIS_ViewController_HeaderFile
16
17 #include <Aspect_VKeySet.hxx>
18 #include <Aspect_TouchMap.hxx>
19 #include <Aspect_WindowInputListener.hxx>
20 #include <Aspect_XRHapticActionData.hxx>
21 #include <Aspect_XRTrackedDeviceRole.hxx>
22 #include <AIS_DragAction.hxx>
23 #include <AIS_MouseGesture.hxx>
24 #include <AIS_NavigationMode.hxx>
25 #include <AIS_ViewInputBuffer.hxx>
26 #include <AIS_RotationMode.hxx>
27 #include <AIS_WalkDelta.hxx>
28
29 #include <gp_Pnt.hxx>
30 #include <Graphic3d_Vec3.hxx>
31 #include <NCollection_Array1.hxx>
32 #include <OSD_Timer.hxx>
33 #include <Precision.hxx>
34 #include <Quantity_ColorRGBA.hxx>
35 #include <Standard_Mutex.hxx>
36
37 class AIS_AnimationCamera;
38 class AIS_InteractiveObject;
39 class AIS_InteractiveContext;
40 class AIS_Point;
41 class AIS_RubberBand;
42 class AIS_XRTrackedDevice;
43 class Graphic3d_Camera;
44 class SelectMgr_EntityOwner;
45 class V3d_View;
46 class WNT_HIDSpaceMouse;
47
48 //! Auxiliary structure for handling viewer events between GUI and Rendering threads.
49 //!
50 //! Class implements the following features:
51 //! - Buffers storing the state of user input (mouse, touches and keyboard).
52 //! - Mapping mouse/multi-touch input to View camera manipulations (panning/rotating/zooming).
53 //! - Input events are not applied immediately but queued for separate processing from two working threads
54 //!   UI thread receiving user input and Rendering thread for OCCT 3D Viewer drawing.
55 class AIS_ViewController : public Aspect_WindowInputListener
56 {
57 public:
58
59   //! Empty constructor.
60   Standard_EXPORT AIS_ViewController();
61
62   //! Destructor.
63   Standard_EXPORT virtual ~AIS_ViewController();
64
65   //! Return input buffer.
66   const AIS_ViewInputBuffer& InputBuffer (AIS_ViewInputBufferType theType) const { return theType == AIS_ViewInputBufferType_UI ? myUI : myGL; }
67
68   //! Return input buffer.
69   AIS_ViewInputBuffer& ChangeInputBuffer (AIS_ViewInputBufferType theType)       { return theType == AIS_ViewInputBufferType_UI ? myUI : myGL; }
70
71   //! Return view animation; empty (but not NULL) animation by default.
72   const Handle(AIS_AnimationCamera)& ViewAnimation() const { return myViewAnimation; }
73
74   //! Set view animation to be handled within handleViewRedraw().
75   void SetViewAnimation (const Handle(AIS_AnimationCamera)& theAnimation) { myViewAnimation = theAnimation; }
76
77   //! Interrupt active view animation.
78   Standard_EXPORT void AbortViewAnimation();
79
80 public: //! @name global parameters
81
82   //! Return camera rotation mode, AIS_RotationMode_BndBoxActive by default.
83   AIS_RotationMode RotationMode() const { return myRotationMode; }
84
85   //! Set camera rotation mode.
86   void SetRotationMode (AIS_RotationMode theMode) { myRotationMode = theMode; }
87
88   //! Return camera navigation mode; AIS_NavigationMode_Orbit by default.
89   AIS_NavigationMode NavigationMode() const { return myNavigationMode; }
90
91   //! Set camera navigation mode.
92   Standard_EXPORT void SetNavigationMode (AIS_NavigationMode theMode);
93
94   //! Return mouse input acceleration ratio in First Person mode; 1.0 by default.
95   float MouseAcceleration() const { return myMouseAccel; }
96
97   //! Set mouse input acceleration ratio.
98   void SetMouseAcceleration (float theRatio) { myMouseAccel = theRatio; }
99
100   //! Return orbit rotation acceleration ratio; 1.0 by default.
101   float OrbitAcceleration() const { return myOrbitAccel; }
102
103   //! Set orbit rotation acceleration ratio.
104   void SetOrbitAcceleration (float theRatio) { myOrbitAccel = theRatio; }
105
106   //! Return TRUE if panning anchor point within perspective projection should be displayed in 3D Viewer; TRUE by default.
107   bool ToShowPanAnchorPoint() const { return myToShowPanAnchorPoint; }
108
109   //! Set if panning anchor point within perspective projection should be displayed in 3D Viewer.
110   void SetShowPanAnchorPoint (bool theToShow) { myToShowPanAnchorPoint = theToShow; }
111
112   //! Return TRUE if rotation point should be displayed in 3D Viewer; TRUE by default.
113   bool ToShowRotateCenter() const { return myToShowRotateCenter; }
114
115   //! Set if rotation point should be displayed in 3D Viewer.
116   void SetShowRotateCenter (bool theToShow) { myToShowRotateCenter = theToShow; }
117
118   //! Return TRUE if camera up orientation within AIS_NavigationMode_Orbit rotation mode should be forced Z up; FALSE by default.
119   bool ToLockOrbitZUp() const { return myToLockOrbitZUp; }
120
121   //! Set if camera up orientation within AIS_NavigationMode_Orbit rotation mode should be forced Z up.
122   void SetLockOrbitZUp (bool theToForceUp) { myToLockOrbitZUp = theToForceUp; }
123
124   //! Return TRUE if z-rotation via two-touches gesture is enabled; FALSE by default.
125   bool ToAllowTouchZRotation() const { return myToAllowTouchZRotation; }
126
127   //! Set if z-rotation via two-touches gesture is enabled.
128   void SetAllowTouchZRotation (bool theToEnable) { myToAllowTouchZRotation = theToEnable; }
129
130   //! Return TRUE if camera rotation is allowed; TRUE by default.
131   bool ToAllowRotation() const { return myToAllowRotation; }
132
133   //! Set if camera rotation is allowed.
134   void SetAllowRotation (bool theToEnable) { myToAllowRotation = theToEnable; }
135
136   //! Return TRUE if panning is allowed; TRUE by default.
137   bool ToAllowPanning() const { return myToAllowPanning; }
138
139   //! Set if panning is allowed.
140   void SetAllowPanning (bool theToEnable) { myToAllowPanning = theToEnable; }
141
142   //! Return TRUE if zooming is allowed; TRUE by default.
143   bool ToAllowZooming() const { return myToAllowZooming; }
144
145   //! Set if zooming is allowed.
146   void SetAllowZooming (bool theToEnable) { myToAllowZooming = theToEnable; }
147
148   //! Return TRUE if ZFocus change is allowed; TRUE by default.
149   bool ToAllowZFocus() const { return myToAllowZFocus; }
150
151   //! Set if ZFocus change is allowed.
152   void SetAllowZFocus (bool theToEnable) { myToAllowZFocus = theToEnable; }
153
154   //! Return TRUE if dynamic highlight on mouse move is allowed; TRUE by default.
155   bool ToAllowHighlight() const { return myToAllowHighlight; }
156
157   //! Set if dragging object is allowed.
158   void SetAllowHighlight (bool theToEnable) { myToAllowHighlight = theToEnable; }
159
160   //! Return TRUE if dragging object is allowed; TRUE by default.
161   bool ToAllowDragging() const { return myToAllowDragging; }
162
163   //! Set if dynamic highlight on mouse move is allowed.
164   void SetAllowDragging (bool theToEnable) { myToAllowDragging = theToEnable; }
165
166   //! Return TRUE if picked point should be projected to picking ray on zooming at point; TRUE by default.
167   bool ToStickToRayOnZoom() const { return myToStickToRayOnZoom; }
168
169   //! Set if picked point should be projected to picking ray on zooming at point.
170   void SetStickToRayOnZoom (bool theToEnable) { myToStickToRayOnZoom = theToEnable; }
171
172   //! Return TRUE if picked point should be projected to picking ray on rotating around point; TRUE by default.
173   bool ToStickToRayOnRotation() const { return myToStickToRayOnRotation; }
174
175   //! Set if picked point should be projected to picking ray on rotating around point.
176   void SetStickToRayOnRotation (bool theToEnable) { myToStickToRayOnRotation = theToEnable; }
177
178   //! Return TRUE if pitch direction should be inverted while processing Aspect_VKey_NavLookUp/Aspect_VKey_NavLookDown; FALSE by default.
179   bool ToInvertPitch() const { return myToInvertPitch; }
180
181   //! Set flag inverting pitch direction.
182   void SetInvertPitch (bool theToInvert) { myToInvertPitch = theToInvert; }
183
184   //! Return normal walking speed, in m/s; 1.5 by default.
185   float WalkSpeedAbsolute() const { return myWalkSpeedAbsolute; }
186
187   //! Set normal walking speed, in m/s; 1.5 by default.
188   void SetWalkSpeedAbsolute (float theSpeed) { myWalkSpeedAbsolute = theSpeed; }
189
190   //! Return walking speed relative to scene bounding box; 0.1 by default.
191   float WalkSpeedRelative() const { return myWalkSpeedRelative; }
192
193   //! Set walking speed relative to scene bounding box.
194   void SetWalkSpeedRelative (float theFactor) { myWalkSpeedRelative = theFactor; }
195
196   //! Return active thrust value; 0.0f by default.
197   float ThrustSpeed() const { return myThrustSpeed; }
198
199   //! Set active thrust value.
200   void SetThrustSpeed (float theSpeed) { myThrustSpeed = theSpeed; }
201
202   //! Return TRUE if previous position of MoveTo has been defined.
203   bool HasPreviousMoveTo() const { return myPrevMoveTo != Graphic3d_Vec2i (-1); }
204
205   //! Return previous position of MoveTo event in 3D viewer.
206   const Graphic3d_Vec2i& PreviousMoveTo() const { return myPrevMoveTo; }
207
208   //! Reset previous position of MoveTo.
209   void ResetPreviousMoveTo() { myPrevMoveTo = Graphic3d_Vec2i (-1); }
210
211   //! Return TRUE to display auxiliary tracked XR devices (like tracking stations).
212   bool ToDisplayXRAuxDevices() const { return myToDisplayXRAuxDevices; }
213
214   //! Set if auxiliary tracked XR devices should be displayed.
215   void SetDisplayXRAuxDevices (bool theToDisplay) { myToDisplayXRAuxDevices = theToDisplay; }
216
217   //! Return TRUE to display XR hand controllers.
218   bool ToDisplayXRHands() const { return myToDisplayXRHands; }
219
220   //! Set if tracked XR hand controllers should be displayed.
221   void SetDisplayXRHands (bool theToDisplay) { myToDisplayXRHands = theToDisplay; }
222
223 public: //! @name keyboard input
224
225   using Aspect_WindowInputListener::Keys;
226   using Aspect_WindowInputListener::ChangeKeys;
227
228   //! Press key.
229   //! Default implementation updates internal cache.
230   //! @param theKey key pressed
231   //! @param theTime event timestamp
232   Standard_EXPORT virtual void KeyDown (Aspect_VKey theKey,
233                                         double theTime,
234                                         double thePressure = 1.0) Standard_OVERRIDE;
235
236   //! Release key.
237   //! Default implementation updates internal cache.
238   //! @param theKey key pressed
239   //! @param theTime event timestamp
240   Standard_EXPORT virtual void KeyUp (Aspect_VKey theKey,
241                                       double theTime) Standard_OVERRIDE;
242
243   //! Simulate key up/down events from axis value.
244   //! Default implementation updates internal cache.
245   Standard_EXPORT virtual void KeyFromAxis (Aspect_VKey theNegative,
246                                             Aspect_VKey thePositive,
247                                             double theTime,
248                                             double thePressure) Standard_OVERRIDE;
249
250   //! Fetch active navigation actions.
251   Standard_EXPORT AIS_WalkDelta FetchNavigationKeys (Standard_Real theCrouchRatio,
252                                                      Standard_Real theRunRatio);
253
254 public: //! @name mouse input
255
256   //! Return map defining mouse gestures.
257   const AIS_MouseGestureMap& MouseGestureMap() const { return myMouseGestureMap; }
258
259   //! Return map defining mouse gestures.
260   AIS_MouseGestureMap& ChangeMouseGestureMap() { return myMouseGestureMap; }
261
262   //! Return map defining mouse selection schemes.
263   const AIS_MouseSelectionSchemeMap& MouseSelectionSchemes() const { return myMouseSelectionSchemes; }
264
265   //! Return map defining mouse gestures.
266   AIS_MouseSelectionSchemeMap& ChangeMouseSelectionSchemes() { return myMouseSelectionSchemes; }
267
268   //! Return double click interval in seconds; 0.4 by default.
269   double MouseDoubleClickInterval() const { return myMouseDoubleClickInt; }
270
271   //! Set double click interval in seconds.
272   void SetMouseDoubleClickInterval (double theSeconds) { myMouseDoubleClickInt = theSeconds; }
273
274   //! Perform selection in 3D viewer.
275   //! This method is expected to be called from UI thread.
276   //! @param thePnt picking point
277   //! @param theScheme selection scheme
278   Standard_EXPORT virtual void SelectInViewer (const Graphic3d_Vec2i& thePnt,
279                                                const AIS_SelectionScheme theScheme = AIS_SelectionScheme_Replace);
280
281   //! Perform selection in 3D viewer.
282   //! This method is expected to be called from UI thread.
283   //! @param thePnts picking point
284   //! @param theScheme selection scheme
285   Standard_EXPORT virtual void SelectInViewer (const NCollection_Sequence<Graphic3d_Vec2i>& thePnts,
286                                                const AIS_SelectionScheme theScheme = AIS_SelectionScheme_Replace);
287
288   //! Update rectangle selection tool.
289   //! This method is expected to be called from UI thread.
290   //! @param thePntFrom rectangle first   corner
291   //! @param thePntTo   rectangle another corner
292   Standard_EXPORT virtual void UpdateRubberBand (const Graphic3d_Vec2i& thePntFrom,
293                                                  const Graphic3d_Vec2i& thePntTo);
294
295   //! Update polygonal selection tool.
296   //! This method is expected to be called from UI thread.
297   //! @param thePnt new point to add to polygon
298   //! @param theToAppend append new point or update the last point
299   Standard_EXPORT virtual void UpdatePolySelection (const Graphic3d_Vec2i& thePnt,
300                                                     bool theToAppend);
301
302   //! Update zoom event (e.g. from mouse scroll).
303   //! This method is expected to be called from UI thread.
304   //! @param theDelta mouse cursor position to zoom at and zoom delta
305   //! @return TRUE if new zoom event has been created or FALSE if existing one has been updated
306   Standard_EXPORT virtual bool UpdateZoom (const Aspect_ScrollDelta& theDelta);
307
308   //! Update Z rotation event.
309   //! @param theAngle rotation angle, in radians.
310   //! @return TRUE if new zoom event has been created or FALSE if existing one has been updated
311   Standard_EXPORT virtual bool UpdateZRotation (double theAngle);
312
313   //! Update mouse scroll event; redirects to UpdateZoom by default.
314   //! This method is expected to be called from UI thread.
315   //! @param theDelta mouse cursor position and delta
316   //! @return TRUE if new event has been created or FALSE if existing one has been updated
317   Standard_EXPORT virtual bool UpdateMouseScroll (const Aspect_ScrollDelta& theDelta) Standard_OVERRIDE;
318
319   //! Handle mouse button press/release event.
320   //! This method is expected to be called from UI thread.
321   //! @param thePoint      mouse cursor position
322   //! @param theButtons    pressed buttons
323   //! @param theModifiers  key modifiers
324   //! @param theIsEmulated if TRUE then mouse event comes NOT from real mouse
325   //!                      but emulated from non-precise input like touch on screen
326   //! @return TRUE if View should be redrawn
327   Standard_EXPORT virtual bool UpdateMouseButtons (const Graphic3d_Vec2i& thePoint,
328                                                    Aspect_VKeyMouse theButtons,
329                                                    Aspect_VKeyFlags theModifiers,
330                                                    bool theIsEmulated) Standard_OVERRIDE;
331
332   //! Handle mouse cursor movement event.
333   //! This method is expected to be called from UI thread.
334   //! @param thePoint      mouse cursor position
335   //! @param theButtons    pressed buttons
336   //! @param theModifiers  key modifiers
337   //! @param theIsEmulated if TRUE then mouse event comes NOT from real mouse
338   //!                      but emulated from non-precise input like touch on screen
339   //! @return TRUE if View should be redrawn
340   Standard_EXPORT virtual bool UpdateMousePosition (const Graphic3d_Vec2i& thePoint,
341                                                     Aspect_VKeyMouse theButtons,
342                                                     Aspect_VKeyFlags theModifiers,
343                                                     bool theIsEmulated) Standard_OVERRIDE;
344
345   //! Handle mouse button click event (emulated by UpdateMouseButtons() while releasing single button).
346   //! Note that as this method is called by UpdateMouseButtons(), it should be executed from UI thread.
347   //! Default implementation redirects to SelectInViewer().
348   //! This method is expected to be called from UI thread.
349   //! @param thePoint      mouse cursor position
350   //! @param theButton     clicked button
351   //! @param theModifiers  key modifiers
352   //! @param theIsDoubleClick flag indicating double mouse click
353   //! @return TRUE if View should be redrawn
354   Standard_EXPORT virtual bool UpdateMouseClick (const Graphic3d_Vec2i& thePoint,
355                                                  Aspect_VKeyMouse theButton,
356                                                  Aspect_VKeyFlags theModifiers,
357                                                  bool theIsDoubleClick);
358
359   using Aspect_WindowInputListener::PressMouseButton;
360   using Aspect_WindowInputListener::ReleaseMouseButton;
361
362   using Aspect_WindowInputListener::PressedMouseButtons;
363   using Aspect_WindowInputListener::LastMouseFlags;
364   using Aspect_WindowInputListener::LastMousePosition;
365
366 public: //! @name multi-touch input
367
368   //! Return scale factor for adjusting tolerances for starting multi-touch gestures; 1.0 by default
369   //! This scale factor is expected to be computed from touch screen resolution.
370   float TouchToleranceScale() const { return myTouchToleranceScale; }
371
372   //! Set scale factor for adjusting tolerances for starting multi-touch gestures.
373   void SetTouchToleranceScale (float theTolerance) { myTouchToleranceScale = theTolerance; }
374
375   //! Return TRUE if touches map is not empty.
376   bool HasTouchPoints() const { return !myTouchPoints.IsEmpty(); }
377
378   //! Add touch point with the given ID.
379   //! This method is expected to be called from UI thread.
380   //! @param theId touch unique identifier
381   //! @param thePnt touch coordinates
382   //! @param theClearBefore if TRUE previously registered touches will be removed
383   Standard_EXPORT virtual void AddTouchPoint (Standard_Size theId,
384                                               const Graphic3d_Vec2d& thePnt,
385                                               Standard_Boolean theClearBefore = false);
386
387   //! Remove touch point with the given ID.
388   //! This method is expected to be called from UI thread.
389   //! @param theId touch unique identifier
390   //! @param theClearSelectPnts if TRUE will initiate clearing of selection points
391   //! @return TRUE if point has been removed
392   Standard_EXPORT virtual bool RemoveTouchPoint (Standard_Size theId,
393                                                  Standard_Boolean theClearSelectPnts = false);
394
395   //! Update touch point with the given ID.
396   //! If point with specified ID was not registered before, it will be added.
397   //! This method is expected to be called from UI thread.
398   //! @param theId touch unique identifier
399   //! @param thePnt touch coordinates
400   Standard_EXPORT virtual void UpdateTouchPoint (Standard_Size theId,
401                                                  const Graphic3d_Vec2d& thePnt);
402
403 public: //! @name 3d mouse input
404
405   //! Process 3d mouse input event (redirects to translation, rotation and keys).
406   Standard_EXPORT virtual bool Update3dMouse (const WNT_HIDSpaceMouse& theEvent) Standard_OVERRIDE;
407
408 public: //! @name resize events
409
410   //! Handle expose event (window content has been invalidation and should be redrawn).
411   //! Default implementation does nothing.
412   virtual void ProcessExpose() Standard_OVERRIDE {}
413
414   //! Handle window resize event.
415   //! Default implementation does nothing.
416   virtual void ProcessConfigure (bool theIsResized) Standard_OVERRIDE
417   {
418     (void )theIsResized;
419   }
420
421   //! Handle window input event immediately.
422   //! Default implementation does nothing - input events are accumulated in internal buffer until explicit FlushViewEvents() call.
423   virtual void ProcessInput() Standard_OVERRIDE {}
424
425   //! Handle focus event.
426   //! Default implementation does nothing.
427   virtual void ProcessFocus (bool theIsActivated) Standard_OVERRIDE
428   {
429     (void )theIsActivated;
430   }
431
432   //! Handle window close event.
433   //! Default implementation does nothing.
434   virtual void ProcessClose() Standard_OVERRIDE {}
435
436 public:
437
438   using Aspect_WindowInputListener::EventTime;
439
440   //! Reset input state (pressed keys, mouse buttons, etc.) e.g. on window focus loss.
441   //! This method is expected to be called from UI thread.
442   Standard_EXPORT virtual void ResetViewInput();
443
444   //! Reset view orientation.
445   //! This method is expected to be called from UI thread.
446   Standard_EXPORT virtual void UpdateViewOrientation (V3d_TypeOfOrientation theOrientation,
447                                                       bool theToFitAll);
448
449   //! Update buffer for rendering thread.
450   //! This method is expected to be called within synchronization barrier between GUI
451   //! and Rendering threads (e.g. GUI thread should be locked beforehand to avoid data races).
452   //! @param theCtx interactive context
453   //! @param theView active view
454   //! @param theToHandle if TRUE, the HandleViewEvents() will be called
455   Standard_EXPORT virtual void FlushViewEvents (const Handle(AIS_InteractiveContext)& theCtx,
456                                                 const Handle(V3d_View)& theView,
457                                                 Standard_Boolean theToHandle = Standard_False);
458
459   //! Process events within rendering thread.
460   Standard_EXPORT virtual void HandleViewEvents (const Handle(AIS_InteractiveContext)& theCtx,
461                                                  const Handle(V3d_View)& theView);
462
463 public:
464
465   //! Callback called by handleMoveTo() on Selection in 3D Viewer.
466   //! This method is expected to be called from rendering thread.
467   Standard_EXPORT virtual void OnSelectionChanged (const Handle(AIS_InteractiveContext)& theCtx,
468                                                    const Handle(V3d_View)& theView);
469
470   //! Callback called by handleMoveTo() on dragging object in 3D Viewer.
471   //! This method is expected to be called from rendering thread.
472   Standard_EXPORT virtual void OnObjectDragged (const Handle(AIS_InteractiveContext)& theCtx,
473                                                 const Handle(V3d_View)& theView,
474                                                 AIS_DragAction theAction);
475
476   //! Pick closest point under mouse cursor.
477   //! This method is expected to be called from rendering thread.
478   //! @param thePnt   [out] result point
479   //! @param theCtx    [in] interactive context
480   //! @param theView   [in] active view
481   //! @param theCursor [in] mouse cursor
482   //! @param theToStickToPickRay [in] when TRUE, the result point will lie on picking ray
483   //! @return TRUE if result has been found
484   Standard_EXPORT virtual bool PickPoint (gp_Pnt& thePnt,
485                                           const Handle(AIS_InteractiveContext)& theCtx,
486                                           const Handle(V3d_View)& theView,
487                                           const Graphic3d_Vec2i& theCursor,
488                                           bool theToStickToPickRay);
489
490   //! Compute rotation gravity center point depending on rotation mode.
491   //! This method is expected to be called from rendering thread.
492   Standard_EXPORT virtual gp_Pnt GravityPoint (const Handle(AIS_InteractiveContext)& theCtx,
493                                                const Handle(V3d_View)& theView);
494
495   //! Modify view camera to fit all objects.
496   //! Default implementation fits either all visible and all selected objects (swapped on each call).
497   Standard_EXPORT virtual void FitAllAuto (const Handle(AIS_InteractiveContext)& theCtx,
498                                            const Handle(V3d_View)& theView);
499
500 public:
501
502   //! Handle hot-keys defining new camera orientation (Aspect_VKey_ViewTop and similar keys).
503   //! Default implementation starts an animated transaction from the current to the target camera orientation, when specific action key was pressed.
504   //! This method is expected to be called from rendering thread.
505   Standard_EXPORT virtual void handleViewOrientationKeys (const Handle(AIS_InteractiveContext)& theCtx,
506                                                           const Handle(V3d_View)& theView);
507
508   //! Perform navigation (Aspect_VKey_NavForward and similar keys).
509   //! This method is expected to be called from rendering thread.
510   Standard_EXPORT virtual AIS_WalkDelta handleNavigationKeys (const Handle(AIS_InteractiveContext)& theCtx,
511                                                               const Handle(V3d_View)& theView);
512
513   //! Perform immediate camera actions (rotate/zoom/pan) on gesture progress.
514   //! This method is expected to be called from rendering thread.
515   Standard_EXPORT virtual void handleCameraActions (const Handle(AIS_InteractiveContext)& theCtx,
516                                                     const Handle(V3d_View)& theView,
517                                                     const AIS_WalkDelta& theWalk);
518
519   //! Perform moveto/selection/dragging.
520   //! This method is expected to be called from rendering thread.
521   Standard_EXPORT virtual void handleMoveTo (const Handle(AIS_InteractiveContext)& theCtx,
522                                              const Handle(V3d_View)& theView);
523
524   //! Return TRUE if another frame should be drawn right after this one.
525   bool toAskNextFrame() const { return myToAskNextFrame; }
526
527   //! Set if another frame should be drawn right after this one.
528   void setAskNextFrame (bool theToDraw = true) { myToAskNextFrame = theToDraw; }
529
530   //! Return if panning anchor point has been defined.
531   bool hasPanningAnchorPoint() const { return !Precision::IsInfinite (myPanPnt3d.X()); }
532
533   //! Return active panning anchor point.
534   const gp_Pnt& panningAnchorPoint() const { return myPanPnt3d; }
535
536   //! Set active panning anchor point.
537   void setPanningAnchorPoint (const gp_Pnt& thePnt) { myPanPnt3d = thePnt; }
538
539   //! Handle panning event myGL.Panning.
540   Standard_EXPORT virtual void handlePanning (const Handle(V3d_View)& theView);
541
542   //! Handle Z rotation event myGL.ZRotate.
543   Standard_EXPORT virtual void handleZRotate (const Handle(V3d_View)& theView);
544
545   //! Return minimal camera distance for zoom operation.
546   double MinZoomDistance() const { return myMinCamDistance; }
547
548   //! Set minimal camera distance for zoom operation.
549   void SetMinZoomDistance (double theDist) { myMinCamDistance = theDist; }
550
551   //! Handle zoom event myGL.ZoomActions.
552   //! This method is expected to be called from rendering thread.
553   Standard_EXPORT virtual void handleZoom (const Handle(V3d_View)& theView,
554                                            const Aspect_ScrollDelta& theParams,
555                                            const gp_Pnt* thePnt);
556
557   //! Handle ZScroll event myGL.ZoomActions.
558   //! This method is expected to be called from rendering thread.
559   Standard_EXPORT virtual void handleZFocusScroll (const Handle(V3d_View)& theView,
560                                                    const Aspect_ScrollDelta& theParams);
561
562   //! Handle orbital rotation events myGL.OrbitRotation.
563   //! @param theView view to modify
564   //! @param thePnt 3D point to rotate around
565   //! @param theToLockZUp amend camera to exclude roll angle (put camera Up vector to plane containing global Z and view direction)
566   Standard_EXPORT virtual void handleOrbitRotation (const Handle(V3d_View)& theView,
567                                                     const gp_Pnt& thePnt,
568                                                     bool theToLockZUp);
569
570   //! Handle view direction rotation events myGL.ViewRotation.
571   //! This method is expected to be called from rendering thread.
572   //! @param theView       camera to modify
573   //! @param theYawExtra   extra yaw increment
574   //! @param thePitchExtra extra pitch increment
575   //! @param theRoll       roll value
576   //! @param theToRestartOnIncrement flag indicating flight mode
577   Standard_EXPORT virtual void handleViewRotation (const Handle(V3d_View)& theView,
578                                                    double theYawExtra,
579                                                    double thePitchExtra,
580                                                    double theRoll,
581                                                    bool theToRestartOnIncrement);
582
583   //! Handle view redraw.
584   //! This method is expected to be called from rendering thread.
585   Standard_EXPORT virtual void handleViewRedraw (const Handle(AIS_InteractiveContext)& theCtx,
586                                                  const Handle(V3d_View)& theView);
587
588 public:
589
590   //! Perform XR input.
591   //! This method is expected to be called from rendering thread.
592   Standard_EXPORT virtual void handleXRInput (const Handle(AIS_InteractiveContext)& theCtx,
593                                               const Handle(V3d_View)& theView,
594                                               const AIS_WalkDelta& theWalk);
595
596   //! Handle trackpad view turn action.
597   Standard_EXPORT virtual void handleXRTurnPad (const Handle(AIS_InteractiveContext)& theCtx,
598                                                 const Handle(V3d_View)& theView);
599
600   //! Handle trackpad teleportation action.
601   Standard_EXPORT virtual void handleXRTeleport (const Handle(AIS_InteractiveContext)& theCtx,
602                                                  const Handle(V3d_View)& theView);
603
604   //! Handle picking on trigger click.
605   Standard_EXPORT virtual void handleXRPicking (const Handle(AIS_InteractiveContext)& theCtx,
606                                                 const Handle(V3d_View)& theView);
607
608   //! Perform dynamic highlighting for active hand.
609   Standard_EXPORT virtual void handleXRHighlight (const Handle(AIS_InteractiveContext)& theCtx,
610                                                   const Handle(V3d_View)& theView);
611
612   //! Display auxiliary XR presentations.
613   Standard_EXPORT virtual void handleXRPresentations (const Handle(AIS_InteractiveContext)& theCtx,
614                                                       const Handle(V3d_View)& theView);
615
616   //! Perform picking with/without dynamic highlighting for XR pose.
617   Standard_EXPORT virtual Standard_Integer handleXRMoveTo (const Handle(AIS_InteractiveContext)& theCtx,
618                                                            const Handle(V3d_View)& theView,
619                                                            const gp_Trsf& thePose,
620                                                            const Standard_Boolean theToHighlight);
621
622 protected:
623
624   //! Flush buffers.
625   Standard_EXPORT virtual void flushBuffers (const Handle(AIS_InteractiveContext)& theCtx,
626                                              const Handle(V3d_View)& theView);
627
628   //! Flush touch gestures.
629   Standard_EXPORT virtual void flushGestures (const Handle(AIS_InteractiveContext)& theCtx,
630                                               const Handle(V3d_View)& theView);
631
632   //! Return current and previously fetched event times.
633   //! This callback is intended to compute delta between sequentially processed events.
634   //! @param thePrevTime [out] events time fetched previous time by this method
635   //! @param theCurrTime [out] actual events time
636   void updateEventsTime (double& thePrevTime,
637                          double& theCurrTime)
638   {
639     thePrevTime = myLastEventsTime;
640     myLastEventsTime = EventTime();
641     theCurrTime = myLastEventsTime;
642   }
643
644   //! Perform selection via mouse click.
645   //! This method is expected to be called from rendering thread.
646   Standard_EXPORT virtual void handleSelectionPick (const Handle(AIS_InteractiveContext)& theCtx,
647                                                     const Handle(V3d_View)& theView);
648
649   //! Perform dynamic highlight on mouse move.
650   //! This method is expected to be called from rendering thread.
651   Standard_EXPORT virtual void handleDynamicHighlight (const Handle(AIS_InteractiveContext)& theCtx,
652                                                        const Handle(V3d_View)& theView);
653
654   //! Perform rubber-band selection.
655   //! This method is expected to be called from rendering thread.
656   Standard_EXPORT virtual void handleSelectionPoly (const Handle(AIS_InteractiveContext)& theCtx,
657                                                     const Handle(V3d_View)& theView);
658
659   //! Lazy AIS_InteractiveContext::MoveTo() with myPrevMoveTo check.
660   Standard_EXPORT virtual void contextLazyMoveTo (const Handle(AIS_InteractiveContext)& theCtx,
661                                                   const Handle(V3d_View)& theView,
662                                                   const Graphic3d_Vec2i& thePnt);
663
664 protected:
665
666   AIS_ViewInputBuffer myUI;                       //!< buffer for UI thread
667   AIS_ViewInputBuffer myGL;                       //!< buffer for rendering thread
668
669   Standard_Real       myLastEventsTime;           //!< last fetched events timer value for computing delta/progress
670   Standard_Boolean    myToAskNextFrame;           //!< flag indicating that another frame should be drawn right after this one
671
672   Standard_Real       myMinCamDistance;           //!< minimal camera distance for zoom operation
673   AIS_RotationMode    myRotationMode;             //!< rotation mode
674   AIS_NavigationMode  myNavigationMode;           //!< navigation mode (orbit rotation / first person)
675   Standard_ShortReal  myMouseAccel;               //!< mouse input acceleration ratio in First Person mode
676   Standard_ShortReal  myOrbitAccel;               //!< Orbit rotation acceleration ratio
677   Standard_Boolean    myToShowPanAnchorPoint;     //!< option displaying panning  anchor point
678   Standard_Boolean    myToShowRotateCenter;       //!< option displaying rotation center point
679   Standard_Boolean    myToLockOrbitZUp;           //!< force camera up orientation within AIS_NavigationMode_Orbit rotation mode
680   Standard_Boolean    myToInvertPitch;            //!< flag inverting pitch direction while processing Aspect_VKey_NavLookUp/Aspect_VKey_NavLookDown
681   Standard_Boolean    myToAllowTouchZRotation;    //!< enable z-rotation two-touches gesture; FALSE by default
682   Standard_Boolean    myToAllowRotation;          //!< enable rotation; TRUE by default
683   Standard_Boolean    myToAllowPanning;           //!< enable panning; TRUE by default
684   Standard_Boolean    myToAllowZooming;           //!< enable zooming; TRUE by default
685   Standard_Boolean    myToAllowZFocus;            //!< enable ZFocus change; TRUE by default
686   Standard_Boolean    myToAllowHighlight;         //!< enable dynamic highlight on mouse move; TRUE by default
687   Standard_Boolean    myToAllowDragging;          //!< enable dragging object; TRUE by default
688   Standard_Boolean    myToStickToRayOnZoom;       //!< project picked point to ray while zooming at point, TRUE by default
689   Standard_Boolean    myToStickToRayOnRotation;   //!< project picked point to ray while rotating around point; TRUE by default
690
691   Standard_ShortReal  myWalkSpeedAbsolute;        //!< normal walking speed, in m/s; 1.5 by default
692   Standard_ShortReal  myWalkSpeedRelative;        //!< walking speed relative to scene bounding box; 0.1 by default
693   Standard_ShortReal  myThrustSpeed;              //!< active thrust value
694   Standard_Boolean    myHasThrust;                //!< flag indicating active thrust
695
696   Handle(AIS_AnimationCamera) myViewAnimation;    //!< view animation
697   Handle(AIS_RubberBand) myRubberBand;            //!< Rubber-band presentation
698   Handle(SelectMgr_EntityOwner) myDragOwner;      //!< detected owner of currently dragged object
699   Handle(AIS_InteractiveObject) myDragObject;     //!< currently dragged object
700   Graphic3d_Vec2i     myPrevMoveTo;               //!< previous position of MoveTo event in 3D viewer
701   Standard_Boolean    myHasHlrOnBeforeRotation;   //!< flag for restoring Computed mode after rotation
702
703 protected: //! @name XR input variables
704
705   NCollection_Array1<Handle(AIS_XRTrackedDevice)> myXRPrsDevices; //!< array of XR tracked devices presentations
706   Handle(Graphic3d_Camera)   myXRCameraTmp;       //!< temporary camera
707   Quantity_Color             myXRLaserTeleColor;  //!< color of teleport laser
708   Quantity_Color             myXRLaserPickColor;  //!< color of picking  laser
709   Aspect_XRTrackedDeviceRole myXRLastTeleportHand;//!< active hand for teleport
710   Aspect_XRTrackedDeviceRole myXRLastPickingHand; //!< active hand for picking objects
711   Aspect_XRHapticActionData  myXRTeleportHaptic;  //!< vibration on picking teleport destination
712   Aspect_XRHapticActionData  myXRPickingHaptic;   //!< vibration on dynamic highlighting
713   Aspect_XRHapticActionData  myXRSelectHaptic;    //!< vibration on selection
714   Standard_Real       myXRLastPickDepthLeft;      //!< last picking depth for left  hand
715   Standard_Real       myXRLastPickDepthRight;     //!< last picking depth for right hand
716   Standard_Real       myXRTurnAngle;              //!< discrete turn angle for XR trackpad
717   Standard_Boolean    myToDisplayXRAuxDevices;    //!< flag to display auxiliary tracked XR devices
718   Standard_Boolean    myToDisplayXRHands;         //!< flag to display XR hands
719
720 protected: //! @name mouse input variables
721
722   Standard_Real       myMouseClickThreshold;      //!< mouse click threshold in pixels; 3 by default
723   Standard_Real       myMouseDoubleClickInt;      //!< double click interval in seconds; 0.4 by default
724   Standard_ShortReal  myScrollZoomRatio;          //!< distance ratio for mapping mouse scroll event to zoom; 15.0 by default
725
726   AIS_MouseGestureMap myMouseGestureMap;          //!< map defining mouse gestures
727   AIS_MouseGesture    myMouseActiveGesture;       //!< initiated mouse gesture (by pressing mouse button)
728   AIS_MouseSelectionSchemeMap
729                       myMouseSelectionSchemes;    //!< map defining selection schemes bound to mouse + modifiers
730   Standard_Boolean    myMouseActiveIdleRotation;  //!< flag indicating view idle rotation state
731   Graphic3d_Vec2i     myMousePressPoint;          //!< mouse position where active gesture was been initiated
732   Graphic3d_Vec2i     myMouseProgressPoint;       //!< gesture progress
733   OSD_Timer           myMouseClickTimer;          //!< timer for handling double-click event
734   Standard_Integer    myMouseClickCounter;        //!< counter for handling double-click event
735   Standard_Integer    myMouseSingleButton;        //!< index of mouse button pressed alone (>0)
736   Standard_Boolean    myMouseStopDragOnUnclick;   //!< queue stop dragging even with at next mouse unclick
737
738 protected: //! @name multi-touch input variables
739
740   Standard_ShortReal  myTouchToleranceScale;      //!< tolerance scale factor; 1.0 by default
741   Standard_ShortReal  myTouchRotationThresholdPx; //!< threshold for starting one-touch rotation     gesture in pixels;  6 by default
742   Standard_ShortReal  myTouchZRotationThreshold;  //!< threshold for starting two-touch Z-rotation   gesture in radians; 2 degrees by default
743   Standard_ShortReal  myTouchPanThresholdPx;      //!< threshold for starting two-touch panning      gesture in pixels;  4 by default
744   Standard_ShortReal  myTouchZoomThresholdPx;     //!< threshold for starting two-touch zoom (pitch) gesture in pixels;  6 by default
745   Standard_ShortReal  myTouchZoomRatio;           //!< distance ratio for mapping two-touch zoom (pitch) gesture from pixels to zoom; 0.13 by default
746
747   Aspect_TouchMap     myTouchPoints;              //!< map of active touches
748   Graphic3d_Vec2d     myStartPanCoord;            //!< touch coordinates at the moment of starting panning  gesture
749   Graphic3d_Vec2d     myStartRotCoord;            //!< touch coordinates at the moment of starting rotating gesture
750   Standard_Integer    myNbTouchesLast;            //!< number of touches within previous gesture flush to track gesture changes
751   Standard_Boolean    myUpdateStartPointPan;      //!< flag indicating that new anchor  point should be picked for starting panning    gesture
752   Standard_Boolean    myUpdateStartPointRot;      //!< flag indicating that new gravity point should be picked for starting rotation   gesture
753   Standard_Boolean    myUpdateStartPointZRot;     //!< flag indicating that new gravity point should be picked for starting Z-rotation gesture
754
755 protected: //! @name rotation/panning transient state variables
756
757   Handle(AIS_Point)   myAnchorPointPrs1;          //!< anchor point presentation (Graphic3d_ZLayerId_Top)
758   Handle(AIS_Point)   myAnchorPointPrs2;          //!< anchor point presentation (Graphic3d_ZLayerId_Topmost)
759   gp_Pnt              myPanPnt3d;                 //!< active panning anchor point
760   gp_Pnt              myRotatePnt3d;              //!< active rotation center of gravity
761   gp_Dir              myCamStartOpUp;             //!< camera Up    direction at the beginning of rotation
762   gp_Dir              myCamStartOpDir;            //!< camera View  direction at the beginning of rotation
763   gp_Pnt              myCamStartOpEye;            //!< camera Eye    position at the beginning of rotation
764   gp_Pnt              myCamStartOpCenter;         //!< camera Center position at the beginning of rotation
765   gp_Vec              myCamStartOpToCenter;       //!< vector from rotation gravity point to camera Center at the beginning of rotation
766   gp_Vec              myCamStartOpToEye;          //!< vector from rotation gravity point to camera Eye    at the beginning of rotation
767   Graphic3d_Vec3d     myRotateStartYawPitchRoll;  //!< camera yaw pitch roll at the beginning of rotation
768
769 };
770
771 #endif // _AIS_ViewController_HeaderFile