1 // Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SALOME VTKViewer : build VTK viewer into Salome desktop
27 #include "SVTK_RenderWindowInteractor.h"
29 #include "SVTK_InteractorStyle.h"
30 #include "SVTK_Renderer.h"
31 #include "SVTK_Functor.h"
32 #include "SALOME_Actor.h"
35 // Put Qt includes before the X11 includes which #define the symbol None
36 // (see SVTK_SpaceMouse.h) to avoid the compilation error.
38 #if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
43 #include <QMouseEvent>
45 #include "SVTK_SpaceMouse.h"
46 #include "SVTK_Event.h"
48 #include "VTKViewer_Algorithm.h"
51 #include <vtkObjectFactory.h>
52 #include <vtkRendererCollection.h>
53 #include <vtkRenderWindow.h>
54 #include <vtkGenericRenderWindowInteractor.h>
55 #include <vtkCallbackCommand.h>
56 #include <vtkCommand.h>
57 #include <vtkPicker.h>
58 #include <vtkCamera.h>
60 static bool GENERATE_SUIT_EVENTS = true;
61 static bool FOCUS_UNDER_MOUSE = false;
63 // workaround about the bug in vtkImplicitPlaneWidget class
64 // that eats mouse button release event
65 // causing clipping plane preview in SMESH sticking up
66 #define Fix_Of_vtkImplicitPlaneWidget_bug
71 QVTK_RenderWindowInteractor
72 ::QVTK_RenderWindowInteractor(QWidget* theParent,
75 myRenderWindow(vtkRenderWindow::New())
77 setAttribute( Qt::WA_PaintOnScreen );
78 setAttribute( Qt::WA_NoSystemBackground );
80 setObjectName(theName);
82 setMouseTracking(true);
84 myRenderWindow->Delete();
85 myRenderWindow->DoubleBufferOn();
88 myRenderWindow->SetDisplayId((void*)QX11Info::display());
90 myRenderWindow->SetWindowId((void*)winId());
94 To initialize by vtkGenericRenderWindowInteractor instance
97 QVTK_RenderWindowInteractor
98 ::Initialize(vtkGenericRenderWindowInteractor* theDevice)
101 myDevice->SetRenderWindow( NULL );
103 myDevice = theDevice;
106 theDevice->SetRenderWindow( getRenderWindow() );
112 QVTK_RenderWindowInteractor
113 ::~QVTK_RenderWindowInteractor()
116 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
117 SVTK_SpaceMouseX* aSpaceMouse = SVTK_SpaceMouseX::getInstance();
118 if ( aSpaceMouse && aSpaceMouse->isSpaceMouseOn() )
119 aSpaceMouse->close( QX11Info::display() );
121 SVTK_SpaceMouseXCB* aSpaceMouse = SVTK_SpaceMouseXCB::getInstance();
122 if ( aSpaceMouse && aSpaceMouse->isSpaceMouseOn() )
123 aSpaceMouse->close( QX11Info::connection() );
130 \return corresponding render window interactor
132 vtkGenericRenderWindowInteractor*
133 QVTK_RenderWindowInteractor
136 return myDevice.GetPointer();
140 \return corresponding render window
143 QVTK_RenderWindowInteractor
146 return myRenderWindow.GetPointer();
150 Just to simplify usage of its device (vtkGenericRenderWindowInteractor)
153 QVTK_RenderWindowInteractor
154 ::InvokeEvent(unsigned long theEvent, void* theCallData)
156 GetDevice()->InvokeEvent(theEvent,theCallData);
160 Get paint engine for the scene
162 QPaintEngine* QVTK_RenderWindowInteractor::paintEngine() const
168 Need for initial contents display on Win32
171 QVTK_RenderWindowInteractor
175 update(); // needed for initial contents display on Win32
179 To implement final initialization, just before the widget is displayed
182 QVTK_RenderWindowInteractor
185 // Final initialization just before the widget is displayed
186 GetDevice()->SetSize(width(),height());
187 if(!GetDevice()->GetInitialized() && GetDevice()->GetRenderWindow()){
188 GetDevice()->Initialize();
189 GetDevice()->ConfigureEvent();
194 To adjust widget and vtkRenderWindow size
197 QVTK_RenderWindowInteractor
198 ::resize(int w, int h)
200 GetDevice()->UpdateSize(w,h);
204 Custom paint event handler
207 QVTK_RenderWindowInteractor
208 ::paintEvent( QPaintEvent* theEvent )
210 GetDevice()->CreateTimer(VTKI_TIMER_FIRST);
215 Custom resize event handler
218 QVTK_RenderWindowInteractor
219 ::resizeEvent( QResizeEvent* theEvent )
221 int* aSize = getRenderWindow()->GetSize();
222 int aWidth = aSize[0];
223 int aHeight = aSize[1];
225 GetDevice()->UpdateSize(width(),height());
227 if(isVisible() && aWidth && aHeight){
228 if( aWidth != width() || aHeight != height() ) {
229 vtkRendererCollection * aRenderers = getRenderWindow()->GetRenderers();
230 aRenderers->InitTraversal();
232 if(vtkRenderer *aRenderer = aRenderers->GetNextItem()) {
233 vtkCamera *aCamera = aRenderer->GetActiveCamera();
234 double aScale = aCamera->GetParallelScale();
235 if((aWidth - width())*(aHeight - height()) > 0)
236 aCoeff = sqrt(double(aWidth)/double(width())*double(height())/double(aHeight));
238 aCoeff = double(aWidth)/double(width());
239 aCamera->SetParallelScale(aScale*aCoeff);
250 Custom context menu event handler
253 QVTK_RenderWindowInteractor
254 ::contextMenuEvent( QContextMenuEvent* event )
258 Custom mouse move event handler
261 QVTK_RenderWindowInteractor
262 ::mouseMoveEvent( QMouseEvent* event )
264 GetDevice()->SetEventInformationFlipY(event->x(),
266 event->modifiers() & Qt::ControlModifier,
267 event->modifiers() & Qt::ShiftModifier);
268 GetDevice()->MouseMoveEvent();
273 Custom mouse press event handler
276 QVTK_RenderWindowInteractor
277 ::mousePressEvent( QMouseEvent* event )
279 GetDevice()->SetEventInformationFlipY(event->x(),
281 event->modifiers() & Qt::ControlModifier,
282 event->modifiers() & Qt::ShiftModifier);
283 if( event->button() & Qt::LeftButton )
284 GetDevice()->LeftButtonPressEvent();
285 else if( event->button() & Qt::MidButton )
286 GetDevice()->MiddleButtonPressEvent();
287 else if( event->button() & Qt::RightButton )
288 GetDevice()->RightButtonPressEvent();
293 Custom mouse release event handler
296 QVTK_RenderWindowInteractor
297 ::mouseReleaseEvent( QMouseEvent *event )
299 GetDevice()->SetEventInformationFlipY(event->x(),
301 event->modifiers() & Qt::ControlModifier,
302 event->modifiers() & Qt::ShiftModifier);
304 if( event->button() & Qt::LeftButton )
305 GetDevice()->LeftButtonReleaseEvent();
306 else if( event->button() & Qt::MidButton )
307 GetDevice()->MiddleButtonReleaseEvent();
308 else if( event->button() & Qt::RightButton ) {
309 #if defined(Fix_Of_vtkImplicitPlaneWidget_bug)
310 GetDevice()->SetEventInformationFlipY( -99999, -99999,
311 event->modifiers() & Qt::ControlModifier,
312 event->modifiers() & Qt::ShiftModifier);
313 bool blocked = blockSignals( true );
314 GetDevice()->LeftButtonPressEvent();
315 GetDevice()->LeftButtonReleaseEvent();
316 blockSignals( blocked );
317 GetDevice()->SetEventInformationFlipY(event->x(),
319 event->modifiers() & Qt::ControlModifier,
320 event->modifiers() & Qt::ShiftModifier);
322 GetDevice()->RightButtonReleaseEvent();
328 Custom mouse double click event handler
331 QVTK_RenderWindowInteractor
332 ::mouseDoubleClickEvent( QMouseEvent* event )
337 Custom mouse wheel event handler
340 QVTK_RenderWindowInteractor
341 ::wheelEvent( QWheelEvent* event )
345 GetDevice()->SetEventInformationFlipY(event->x(),
347 event->modifiers() & Qt::ControlModifier,
348 event->modifiers() & Qt::ShiftModifier);
349 if ( event->delta()>0)
350 GetDevice()->MouseWheelForwardEvent();
352 GetDevice()->MouseWheelBackwardEvent();
357 Custom key press event handler
360 QVTK_RenderWindowInteractor
361 ::keyPressEvent( QKeyEvent* event )
363 GetDevice()->SetKeyEventInformation(event->modifiers() & Qt::ControlModifier,
364 event->modifiers() & Qt::ShiftModifier,
366 GetDevice()->KeyPressEvent();
367 GetDevice()->CharEvent();
371 Custom key release event handler
374 QVTK_RenderWindowInteractor
375 ::keyReleaseEvent( QKeyEvent * event )
377 GetDevice()->SetKeyEventInformation(event->modifiers() & Qt::ControlModifier,
378 event->modifiers() & Qt::ShiftModifier,
380 GetDevice()->KeyReleaseEvent();
385 Custom enter event handler
388 QVTK_RenderWindowInteractor
389 ::enterEvent( QEvent* event )
391 if(FOCUS_UNDER_MOUSE){
395 GetDevice()->EnterEvent();
399 Custom leave event handler
402 QVTK_RenderWindowInteractor
403 ::leaveEvent( QEvent * )
405 GetDevice()->LeaveEvent();
409 Reimplemented from QWidget in order to set window - receiver
410 of space mouse events.
413 QVTK_RenderWindowInteractor
414 ::focusInEvent( QFocusEvent* event )
416 QWidget::focusInEvent( event );
419 // register set space mouse events receiver
420 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
421 SVTK_SpaceMouseX* aSpaceMouse = SVTK_SpaceMouseX::getInstance();
424 if ( !aSpaceMouse->isSpaceMouseOn() )
425 // initialize 3D space mouse driver
426 aSpaceMouse->initialize( QX11Info::display(), winId() );
428 aSpaceMouse->setWindow( QX11Info::display(), winId() );
431 SVTK_SpaceMouseXCB* aSpaceMouse = SVTK_SpaceMouseXCB::getInstance();
434 if ( !aSpaceMouse->isSpaceMouseOn() )
435 // initialize 3D space mouse driver
436 aSpaceMouse->initialize( QX11Info::connection(), winId() );
438 aSpaceMouse->setWindow( QX11Info::connection(), winId() );
445 Reimplemented from QWidget in order to set window - receiver
446 of space mouse events.
449 QVTK_RenderWindowInteractor
450 ::focusOutEvent ( QFocusEvent* event )
452 QWidget::focusOutEvent( event );
455 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
456 // unregister set space mouse events receiver
457 SVTK_SpaceMouseX* aSpaceMouse = SVTK_SpaceMouseX::getInstance();
458 if ( aSpaceMouse && aSpaceMouse->isSpaceMouseOn() )
459 aSpaceMouse->setWindow( QX11Info::display(), 0 );
461 SVTK_SpaceMouseXCB* aSpaceMouse = SVTK_SpaceMouseXCB::getInstance();
462 if ( aSpaceMouse && aSpaceMouse->isSpaceMouseOn() )
463 aSpaceMouse->setWindow( QX11Info::connection(), 0 );
468 // TODO (QT5 PORTING) Below is a temporary solution, to allow compiling with Qt 5
469 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
473 To handle native Win32 events (from such devices as SpaceMouse)
475 bool QVTK_RenderWindowInteractor::winEvent( MSG* msg, long* result )
477 // TODO: Implement event handling for SpaceMouse
478 return QWidget::winEvent( msg, result);
484 To handle native X11 events (from such devices as SpaceMouse)
487 QVTK_RenderWindowInteractor
488 ::x11Event( XEvent *xEvent )
490 // handle 3d space mouse events
491 if ( SVTK_SpaceMouseX* aSpaceMouse = SVTK_SpaceMouseX::getInstance() )
493 if ( aSpaceMouse->isSpaceMouseOn() && xEvent->type == ClientMessage )
495 SVTK_SpaceMouse::MoveEvent anEvent;
496 int type = aSpaceMouse->translateEvent( QX11Info::display(), xEvent, &anEvent, 1.0, 1.0 );
499 case SVTK_SpaceMouse::SpaceMouseMove:
500 GetDevice()->InvokeEvent( SVTK::SpaceMouseMoveEvent, anEvent.data );
502 case SVTK_SpaceMouse::SpaceButtonPress:
503 GetDevice()->InvokeEvent( SVTK::SpaceMouseButtonEvent, &anEvent.button );
505 case SVTK_SpaceMouse::SpaceButtonRelease:
508 return true; // stop handling the event
512 return QWidget::x11Event( xEvent );
517 bool QVTK_RenderWindowInteractor
518 ::nativeEvent(const QByteArray& eventType, void* message, long* result)
520 if ( eventType == "xcb_generic_event_t" )
522 xcb_generic_event_t* ev = static_cast<xcb_generic_event_t *>(message);
523 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
524 if ( SVTK_SpaceMouseX* aSpaceMouse = SVTK_SpaceMouseX::getInstance() )
526 if ( SVTK_SpaceMouseXCB* aSpaceMouse = SVTK_SpaceMouseXCB::getInstance() )
529 if ( aSpaceMouse->isSpaceMouseOn() && ev->response_type == XCB_CLIENT_MESSAGE )
531 SVTK_SpaceMouse::MoveEvent anEvent;
532 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
533 int type = aSpaceMouse->translateEvent( QX11Info::display(), xEvent, &anEvent, 1.0, 1.0 );
535 int type = aSpaceMouse->translateEvent( QX11Info::connection(), (xcb_client_message_event_t*)ev, &anEvent, 1.0, 1.0 );
539 case SVTK_SpaceMouse::SpaceMouseMove:
540 GetDevice()->InvokeEvent( SVTK::SpaceMouseMoveEvent, anEvent.data );
542 case SVTK_SpaceMouse::SpaceButtonPress:
543 GetDevice()->InvokeEvent( SVTK::SpaceMouseButtonEvent, &anEvent.button );
545 case SVTK_SpaceMouse::SpaceButtonRelease:
548 return true; // stop handling the event
553 return QWidget::nativeEvent( eventType, message, result );
559 SVTK_RenderWindowInteractor
560 ::SVTK_RenderWindowInteractor(QWidget* theParent,
561 const char* theName):
562 QVTK_RenderWindowInteractor(theParent,theName),
563 myEventCallbackCommand(vtkCallbackCommand::New())
565 myEventCallbackCommand->Delete();
567 myEventCallbackCommand->SetClientData(this);
570 myEventCallbackCommand->SetCallback(SVTK_RenderWindowInteractor::ProcessEvents);
574 To initialize properly the class
577 SVTK_RenderWindowInteractor
578 ::Initialize(vtkGenericRenderWindowInteractor* theDevice,
579 SVTK_Renderer* theRenderer,
580 SVTK_Selector* theSelector)
582 QVTK_RenderWindowInteractor::Initialize(theDevice);
583 SetRenderer(theRenderer);
584 SetSelector(theSelector);
590 SVTK_RenderWindowInteractor
591 ::~SVTK_RenderWindowInteractor()
593 // Sequence of the destruction call are fixed and should be changed.
594 // vtkRenderWindow instance should be destroyed after all vtkRenderer's
595 GetDevice()->SetInteractorStyle(NULL);
596 while(!myInteractorStyles.empty()){
597 const PInteractorStyle& aStyle = myInteractorStyles.top();
598 aStyle->SetInteractor(NULL);
599 myInteractorStyles.pop();
604 GetDevice()->SetRenderWindow(NULL);
608 To get corresponding SVTK_Renderer instance
611 SVTK_RenderWindowInteractor
614 return myRenderer.GetPointer();
618 To get corresponding SVTK_Renderer device (just to simplify collobaration with SVTK_Renderer)
621 SVTK_RenderWindowInteractor
624 return GetRenderer()->GetDevice();
629 \param theRenderer - new renderer
632 SVTK_RenderWindowInteractor
633 ::SetRenderer(SVTK_Renderer* theRenderer)
635 if(theRenderer == myRenderer.GetPointer())
639 myRenderWindow->RemoveRenderer(getRenderer());
641 myRenderer = theRenderer;
644 myRenderWindow->AddRenderer(getRenderer());
649 Changes interactor style
650 \param theStyle - new interactor style
653 SVTK_RenderWindowInteractor
654 ::InitInteractorStyle(vtkInteractorStyle* theStyle)
656 GetDevice()->SetInteractorStyle(theStyle);
660 To change current interactor style by pushing the new one into the container
663 SVTK_RenderWindowInteractor
664 ::PushInteractorStyle(vtkInteractorStyle* theStyle)
666 myInteractorStyles.push(PInteractorStyle(theStyle));
667 InitInteractorStyle(theStyle);
671 To restore previous interactor style
674 SVTK_RenderWindowInteractor
675 ::PopInteractorStyle()
677 if(GetInteractorStyle())
678 myInteractorStyles.pop();
680 if(GetInteractorStyle())
681 InitInteractorStyle(GetInteractorStyle());
685 To get current interactor style
688 SVTK_RenderWindowInteractor
689 ::GetInteractorStyle()
691 return myInteractorStyles.empty() ? 0 : myInteractorStyles.top().GetPointer();
696 To get current selector
699 SVTK_RenderWindowInteractor
702 return mySelector.GetPointer();
708 \param theSelector - new selector
711 SVTK_RenderWindowInteractor
712 ::SetSelector(SVTK_Selector* theSelector)
714 if(mySelector.GetPointer())
715 mySelector->RemoveObserver(myEventCallbackCommand.GetPointer());
717 mySelector = theSelector;
719 if(mySelector.GetPointer())
720 mySelector->AddObserver(vtkCommand::EndPickEvent,
721 myEventCallbackCommand.GetPointer(),
726 Main process VTK event method
729 SVTK_RenderWindowInteractor
730 ::ProcessEvents(vtkObject* vtkNotUsed(theObject),
731 unsigned long theEvent,
733 void* vtkNotUsed(theCallData))
735 SVTK_RenderWindowInteractor* self = reinterpret_cast<SVTK_RenderWindowInteractor*>(theClientData);
738 case vtkCommand::EndPickEvent:
739 self->onEmitSelectionChanged();
745 To change selection mode (just to simplify collobaration with SVTK_Selector)
748 SVTK_RenderWindowInteractor
749 ::SetSelectionMode(Selection_Mode theMode)
751 mySelector->SetSelectionMode(theMode);
755 To get current selection mode (just to simplify collobaration with SVTK_Selector)
758 SVTK_RenderWindowInteractor
759 ::SelectionMode() const
761 return mySelector->SelectionMode();
766 Emits signal selectionChanged()
769 SVTK_RenderWindowInteractor
770 ::onEmitSelectionChanged()
772 return emit selectionChanged();
777 Custom mouse move event handler
780 SVTK_RenderWindowInteractor
781 ::mouseMoveEvent( QMouseEvent* event )
783 QVTK_RenderWindowInteractor::mouseMoveEvent(event);
785 if(GENERATE_SUIT_EVENTS)
786 emit MouseMove( event );
791 Custom mouse press event handler
794 SVTK_RenderWindowInteractor
795 ::mousePressEvent( QMouseEvent* event )
797 QVTK_RenderWindowInteractor::mousePressEvent(event);
799 if(GENERATE_SUIT_EVENTS)
800 emit MouseButtonPressed( event );
805 Custom mouse release event handler
808 SVTK_RenderWindowInteractor
809 ::mouseReleaseEvent( QMouseEvent *event )
811 SVTK_InteractorStyle* style = 0;
812 bool aRightBtn = event->button() == Qt::RightButton;
813 bool isOperation = false;
814 bool isPolygonalSelection = false;
815 if( aRightBtn && GetInteractorStyle()) {
816 style = dynamic_cast<SVTK_InteractorStyle*>( GetInteractorStyle() );
818 isOperation = style->CurrentState() != VTK_INTERACTOR_STYLE_CAMERA_NONE;
821 QVTK_RenderWindowInteractor::mouseReleaseEvent(event);
824 isPolygonalSelection = style->GetPolygonState() == Finished;
825 style->SetPolygonState( Disable );
828 if ( aRightBtn && !isOperation && !isPolygonalSelection &&
829 !( event->modifiers() & Qt::ControlModifier ) &&
830 !( event->modifiers() & Qt::ShiftModifier ) ) {
831 QContextMenuEvent aEvent( QContextMenuEvent::Mouse,
832 event->pos(), event->globalPos() );
833 emit contextMenuRequested( &aEvent );
835 if(GENERATE_SUIT_EVENTS)
836 emit MouseButtonReleased( event );
841 Custom mouse double click event handler
844 SVTK_RenderWindowInteractor
845 ::mouseDoubleClickEvent( QMouseEvent* event )
847 if( GetInteractorStyle() && event->button() == Qt::LeftButton ) {
848 SVTK_InteractorStyle* style = dynamic_cast<SVTK_InteractorStyle*>( GetInteractorStyle() );
850 style->OnMouseButtonDoubleClick();
853 QVTK_RenderWindowInteractor::mouseDoubleClickEvent(event);
855 if(GENERATE_SUIT_EVENTS)
856 emit MouseDoubleClicked( event );
861 Custom mouse wheel event handler
864 SVTK_RenderWindowInteractor
865 ::wheelEvent( QWheelEvent* event )
867 QVTK_RenderWindowInteractor::wheelEvent(event);
869 if(event->delta() > 0)
870 GetDevice()->InvokeEvent(SVTK::ZoomInEvent,NULL);
872 GetDevice()->InvokeEvent(SVTK::ZoomOutEvent,NULL);
874 if(GENERATE_SUIT_EVENTS)
875 emit WheelMoved( event );
879 Custom key press event handler
882 SVTK_RenderWindowInteractor
883 ::keyPressEvent( QKeyEvent* event )
885 QVTK_RenderWindowInteractor::keyPressEvent(event);
887 if(GENERATE_SUIT_EVENTS)
888 emit KeyPressed( event );
892 Custom key release event handler
895 SVTK_RenderWindowInteractor
896 ::keyReleaseEvent( QKeyEvent * event )
898 QVTK_RenderWindowInteractor::keyReleaseEvent(event);
900 if(GENERATE_SUIT_EVENTS)
901 emit KeyReleased( event );