Join modifications from branch OCC_debug_for_3_2_0b1

[modules/gui.git] / src / SVTK / SVTK_RenderWindowInteractor.cxx

diff --git a/src/SVTK/SVTK_RenderWindowInteractor.cxx b/src/SVTK/SVTK_RenderWindowInteractor.cxx
index 0d4142995bf1cf8e4cf13dbd2cc3832621e7dac0..4921f63f91ddc18db502c26b2970c206d585714b 100644 (file)
--- a/src/SVTK/SVTK_RenderWindowInteractor.cxx
+++ b/src/SVTK/SVTK_RenderWindowInteractor.cxx
@@ -61,7 +61,9 @@ static bool GENERATE_SUIT_EVENTS = false;
 static bool FOCUS_UNDER_MOUSE = false;
 
 
-//----------------------------------------------------------------------------
+/*!
+  Constructor
+*/
 QVTK_RenderWindowInteractor
 ::QVTK_RenderWindowInteractor(QWidget* theParent, 
                              const char* theName):
@@ -79,7 +81,9 @@ QVTK_RenderWindowInteractor
   myRenderWindow->SetWindowId((void*)winId());
 }
 
-
+/*!
+  To initialize by vtkGenericRenderWindowInteractor instance
+*/
 void 
 QVTK_RenderWindowInteractor
 ::Initialize(vtkGenericRenderWindowInteractor* theDevice)
@@ -93,7 +97,9 @@ QVTK_RenderWindowInteractor
     theDevice->SetRenderWindow(getRenderWindow());
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Destructor
+*/
 QVTK_RenderWindowInteractor
 ::~QVTK_RenderWindowInteractor() 
 {
@@ -103,7 +109,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  \return corresponding render window interactor
+*/
 vtkGenericRenderWindowInteractor* 
 QVTK_RenderWindowInteractor
 ::GetDevice()
@@ -111,7 +119,9 @@ QVTK_RenderWindowInteractor
   return myDevice.GetPointer();
 }
 
-//----------------------------------------------------------------------------
+/*!
+  \return corresponding render window
+*/
 vtkRenderWindow*
 QVTK_RenderWindowInteractor
 ::getRenderWindow()
@@ -119,7 +129,9 @@ QVTK_RenderWindowInteractor
   return myRenderWindow.GetPointer();
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Just to simplify usage of its device (vtkGenericRenderWindowInteractor)
+*/
 void
 QVTK_RenderWindowInteractor
 ::InvokeEvent(unsigned long theEvent, void* theCallData)
@@ -127,7 +139,9 @@ QVTK_RenderWindowInteractor
   GetDevice()->InvokeEvent(theEvent,theCallData);
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Need for initial contents display on Win32
+*/
 void
 QVTK_RenderWindowInteractor
 ::show()
@@ -136,7 +150,9 @@ QVTK_RenderWindowInteractor
   update(); // needed for initial contents display on Win32
 }
 
-//----------------------------------------------------------------------------
+/*!
+  To implement final initialization, just before the widget is displayed
+*/
 void
 QVTK_RenderWindowInteractor
 ::polish()
@@ -149,7 +165,9 @@ QVTK_RenderWindowInteractor
   }
 }
 
-//----------------------------------------------------------------------------
+/*!
+  To adjust widget and vtkRenderWindow size
+*/
 void
 QVTK_RenderWindowInteractor
 ::resize(int w, int h) 
@@ -157,7 +175,9 @@ QVTK_RenderWindowInteractor
   GetDevice()->UpdateSize(w,h);
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Custom paint event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::paintEvent( QPaintEvent* theEvent ) 
@@ -166,7 +186,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom resize event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::resizeEvent( QResizeEvent* theEvent )
@@ -198,14 +220,18 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+
+/*!
+  Custom context menu event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::contextMenuEvent( QContextMenuEvent* event )
 {}
 
-
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse move event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::mouseMoveEvent( QMouseEvent* event ) 
@@ -218,7 +244,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse press event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::mousePressEvent( QMouseEvent* event ) 
@@ -236,7 +264,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse release event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::mouseReleaseEvent( QMouseEvent *event )
@@ -255,14 +285,18 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse double click event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::mouseDoubleClickEvent( QMouseEvent* event )
 {}
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse wheel event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::wheelEvent( QWheelEvent* event )
@@ -272,7 +306,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom key press event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::keyPressEvent( QKeyEvent* event ) 
@@ -284,7 +320,9 @@ QVTK_RenderWindowInteractor
   GetDevice()->CharEvent();
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Custom key release event handler
+*/
 void
 QVTK_RenderWindowInteractor
 ::keyReleaseEvent( QKeyEvent * event ) 
@@ -296,7 +334,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom enter event handler
+*/
 void  
 QVTK_RenderWindowInteractor
 ::enterEvent( QEvent* event )
@@ -308,7 +348,9 @@ QVTK_RenderWindowInteractor
   GetDevice()->EnterEvent();
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Custom leave event handler
+*/
 void  
 QVTK_RenderWindowInteractor
 ::leaveEvent( QEvent * )
@@ -316,8 +358,10 @@ QVTK_RenderWindowInteractor
   GetDevice()->LeaveEvent();
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  Reimplemented from QWidget in order to set window - receiver
+  of space mouse events. 
+*/
 void  
 QVTK_RenderWindowInteractor
 ::focusInEvent( QFocusEvent* event )
@@ -334,7 +378,10 @@ QVTK_RenderWindowInteractor
   }
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Reimplemented from QWidget in order to set window - receiver
+  of space mouse events. 
+*/
 void  
 QVTK_RenderWindowInteractor
 ::focusOutEvent ( QFocusEvent* event )
@@ -349,7 +396,9 @@ QVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  To handle native X11 events (from such devices as SpaceMouse)
+*/
 bool 
 QVTK_RenderWindowInteractor
 ::x11Event( XEvent *xEvent )
@@ -376,8 +425,9 @@ QVTK_RenderWindowInteractor
   return QWidget::x11Event( xEvent );
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  Constructor
+*/
 SVTK_RenderWindowInteractor
 ::SVTK_RenderWindowInteractor(QWidget* theParent, 
                               const char* theName):
@@ -392,6 +442,9 @@ SVTK_RenderWindowInteractor
   myEventCallbackCommand->SetCallback(SVTK_RenderWindowInteractor::ProcessEvents);
 }
 
+/*!
+  To initialize properly the class
+*/
 void
 SVTK_RenderWindowInteractor
 ::Initialize(vtkGenericRenderWindowInteractor* theDevice,
@@ -403,7 +456,9 @@ SVTK_RenderWindowInteractor
   SetSelector(theSelector);
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Destructor
+*/
 SVTK_RenderWindowInteractor
 ::~SVTK_RenderWindowInteractor() 
 {
@@ -421,7 +476,9 @@ SVTK_RenderWindowInteractor
   GetDevice()->SetRenderWindow(NULL);
 }
 
-//----------------------------------------------------------------------------
+/*!
+  To get corresponding SVTK_Renderer instance
+*/
 SVTK_Renderer* 
 SVTK_RenderWindowInteractor
 ::GetRenderer()
@@ -429,6 +486,9 @@ SVTK_RenderWindowInteractor
   return myRenderer.GetPointer();
 }
 
+/*!
+  To get corresponding SVTK_Renderer device (just to simplify collobaration with SVTK_Renderer)
+*/
 vtkRenderer* 
 SVTK_RenderWindowInteractor
 ::getRenderer()
@@ -436,6 +496,10 @@ SVTK_RenderWindowInteractor
   return GetRenderer()->GetDevice();
 }
 
+/*!
+  Changes renderer
+  \param theRenderer - new renderer
+*/
 void
 SVTK_RenderWindowInteractor
 ::SetRenderer(SVTK_Renderer* theRenderer)
@@ -453,7 +517,10 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Changes interactor style
+  \param theStyle - new interactor style
+*/
 void
 SVTK_RenderWindowInteractor
 ::InitInteractorStyle(vtkInteractorStyle* theStyle)
@@ -461,8 +528,9 @@ SVTK_RenderWindowInteractor
   GetDevice()->SetInteractorStyle(theStyle); 
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  To change current interactor style by pushing the new one into the container
+*/
 void
 SVTK_RenderWindowInteractor
 ::PushInteractorStyle(vtkInteractorStyle* theStyle)
@@ -471,8 +539,9 @@ SVTK_RenderWindowInteractor
   InitInteractorStyle(theStyle);
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  To restore previous interactor style
+*/
 void
 SVTK_RenderWindowInteractor
 ::PopInteractorStyle()
@@ -484,8 +553,9 @@ SVTK_RenderWindowInteractor
     InitInteractorStyle(GetInteractorStyle());
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  To get current interactor style
+*/
 vtkInteractorStyle* 
 SVTK_RenderWindowInteractor
 ::GetInteractorStyle()
@@ -494,7 +564,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  To get current selector
+*/
 SVTK_Selector* 
 SVTK_RenderWindowInteractor
 ::GetSelector() 
@@ -503,6 +575,10 @@ SVTK_RenderWindowInteractor
 }
 
 
+/*!
+  Changes selector
+  \param theSelector - new selector
+*/
 void
 SVTK_RenderWindowInteractor
 ::SetSelector(SVTK_Selector* theSelector)
@@ -518,8 +594,9 @@ SVTK_RenderWindowInteractor
                            myPriority);
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  Main process VTK event method
+*/
 void 
 SVTK_RenderWindowInteractor
 ::ProcessEvents(vtkObject* vtkNotUsed(theObject), 
@@ -536,8 +613,9 @@ SVTK_RenderWindowInteractor
   }
 }
 
-
-//----------------------------------------------------------------
+/*!
+  To change selection mode (just to simplify collobaration with SVTK_Selector)
+*/
 void
 SVTK_RenderWindowInteractor
 ::SetSelectionMode(Selection_Mode theMode)
@@ -545,8 +623,9 @@ SVTK_RenderWindowInteractor
   mySelector->SetSelectionMode(theMode);
 }
 
-
-//----------------------------------------------------------------
+/*!
+  To get current selection mode (just to simplify collobaration with SVTK_Selector)
+*/
 Selection_Mode
 SVTK_RenderWindowInteractor
 ::SelectionMode() const
@@ -555,7 +634,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------
+/*!
+  Emits signal selectionChanged()
+*/
 void
 SVTK_RenderWindowInteractor
 ::onEmitSelectionChanged()
@@ -564,7 +645,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse move event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::mouseMoveEvent( QMouseEvent* event ) 
@@ -576,7 +659,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse press event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::mousePressEvent( QMouseEvent* event ) 
@@ -588,7 +673,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse release event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::mouseReleaseEvent( QMouseEvent *event )
@@ -600,7 +687,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse double click event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::mouseDoubleClickEvent( QMouseEvent* event )
@@ -612,7 +701,9 @@ SVTK_RenderWindowInteractor
 }
 
 
-//----------------------------------------------------------------------------
+/*!
+  Custom mouse wheel event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::wheelEvent( QWheelEvent* event )
@@ -628,8 +719,9 @@ SVTK_RenderWindowInteractor
     emit WheelMoved( event );
 }
 
-
-//----------------------------------------------------------------------------
+/*!
+  Custom key press event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::keyPressEvent( QKeyEvent* event ) 
@@ -640,7 +732,9 @@ SVTK_RenderWindowInteractor
     emit KeyPressed( event );
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Custom key release event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::keyReleaseEvent( QKeyEvent * event ) 
@@ -651,7 +745,9 @@ SVTK_RenderWindowInteractor
     emit KeyReleased( event );
 }
 
-//----------------------------------------------------------------------------
+/*!
+  Custom context menu event handler
+*/
 void
 SVTK_RenderWindowInteractor
 ::contextMenuEvent( QContextMenuEvent* event )