ENH:Reworked API for requesting focus and cursor

Rendering/CMakeLists.txt

@@ -79,6 +79,7 @@ vtkMapper.cxx
 vtkMapperCollection.cxx
 vtkMultiGroupPolyDataMapper.cxx
 vtkOBJExporter.cxx
+vtkObserverMediator.cxx
 vtkOOGLExporter.cxx
 vtkPainter.cxx
 vtkPainterDeviceAdapter.cxx

Rendering/vtkInteractorObserver.cxx

@@ -20,7 +20,7 @@
 #include "vtkRenderWindow.h"
 #include "vtkRenderWindowInteractor.h"
 
-vtkCxxRevisionMacro(vtkInteractorObserver, "1.32");
+vtkCxxRevisionMacro(vtkInteractorObserver, "1.33");
 
 vtkCxxSetObjectMacro(vtkInteractorObserver,DefaultRenderer,vtkRenderer);
 
@@ -50,6 +50,8 @@ vtkInteractorObserver::vtkInteractorObserver()
 
   this->CharObserverTag = 0;
   this->DeleteObserverTag = 0;
+
+  this->ObserverMediator = 0;
 }
 
 //----------------------------------------------------------------------------
@@ -279,6 +281,25 @@ void vtkInteractorObserver::OnChar()
     }//if activation enabled
 }
 
+//----------------------------------------------------------------------------
+void vtkInteractorObserver::GrabFocus(vtkCommand *mouseEvents, vtkCommand *keypressEvents)
+{
+  if ( this->Interactor )
+    {
+    this->Interactor->GrabFocus(mouseEvents,keypressEvents);
+    }
+}
+
+
+//----------------------------------------------------------------------------
+void vtkInteractorObserver::ReleaseFocus()
+{
+  if ( this->Interactor )
+    {
+    this->Interactor->ReleaseFocus();
+    }
+}
+
 //----------------------------------------------------------------------------
 void vtkInteractorObserver::PrintSelf(ostream& os, vtkIndent indent)
 {

Rendering/vtkInteractorObserver.h

@@ -42,11 +42,13 @@
 #define __vtkInteractorObserver_h
 
 #include "vtkObject.h"
+#include "vtkObserverMediator.h" //to do an inline method invocation on this class
 
 class vtkRenderWindowInteractor;
 class vtkRenderer;
 class vtkCallbackCommand;
 
+
 class VTK_RENDERING_EXPORT vtkInteractorObserver : public vtkObject
 {
 public:
@@ -141,6 +143,20 @@ public:
   static void ComputeWorldToDisplay(vtkRenderer *ren, double x, double y, 
                                     double z, double displayPt[3]);
 
+  // Description:
+  // These methods enable an interactor observer to exclusively grab all
+  // events invoked by its associated vtkRenderWindowInteractor. (This method
+  // is typically used by widgets to grab events once an event sequence
+  // begins.) The GrabFocus() signature takes up to two vtkCommands
+  // corresponding to mouse events and keypress events. (These two commands
+  // are separated so that the widget can listen for its activation keypress,
+  // as well as listening for DeleteEvents, without actually having to process
+  // mouse events.)
+  //BTX
+  void GrabFocus(vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL);
+  void ReleaseFocus();
+  //ETX
+
 protected:
   vtkInteractorObserver();
   ~vtkInteractorObserver();
@@ -190,6 +206,13 @@ protected:
   unsigned long CharObserverTag;
   unsigned long DeleteObserverTag;
 
+  // The mediator used to request resources from the interactor.
+  vtkObserverMediator *ObserverMediator;
+  int RequestCursorShape(int requestedShape)
+    {
+      return this->ObserverMediator->RequestCursorShape(this,requestedShape);
+    }
+
 private:
   vtkInteractorObserver(const vtkInteractorObserver&);  // Not implemented.
   void operator=(const vtkInteractorObserver&);  // Not implemented.

Rendering/vtkInteractorStyleFlight.cxx

@@ -23,7 +23,7 @@
 #include "vtkCallbackCommand.h"
 #include "vtkWindows.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleFlight, "1.31");
+vtkCxxRevisionMacro(vtkInteractorStyleFlight, "1.32");
 vtkStandardNewMacro(vtkInteractorStyleFlight);
 
 class CPIDControl
@@ -254,7 +254,7 @@ void vtkInteractorStyleFlight::OnLeftButtonDown()
     }
 
   //
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   vtkCamera* cam = this->CurrentRenderer->GetActiveCamera();
   switch (this->State)
     {
@@ -281,7 +281,7 @@ void vtkInteractorStyleFlight::OnLeftButtonUp()
     }
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -307,7 +307,7 @@ void vtkInteractorStyleFlight::OnRightButtonDown()
     }
 
   //
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   vtkCamera* cam = this->CurrentRenderer->GetActiveCamera();
   switch (this->State)
     {
@@ -334,7 +334,7 @@ void vtkInteractorStyleFlight::OnRightButtonUp()
     }
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 

Rendering/vtkInteractorStyleImage.cxx

@@ -21,7 +21,7 @@
 #include "vtkObjectFactory.h"
 #include "vtkRenderWindowInteractor.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleImage, "1.26");
+vtkCxxRevisionMacro(vtkInteractorStyleImage, "1.27");
 vtkStandardNewMacro(vtkInteractorStyleImage);
 
 //----------------------------------------------------------------------------
@@ -122,7 +122,7 @@ void vtkInteractorStyleImage::OnLeftButtonDown()
     }
   
   // Redefine this button to handle window/level
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (!this->Interactor->GetShiftKey() && !this->Interactor->GetControlKey()) 
     {
     this->WindowLevelStartPosition[0] = x;
@@ -147,7 +147,7 @@ void vtkInteractorStyleImage::OnLeftButtonUp()
       this->EndWindowLevel();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }
@@ -170,7 +170,7 @@ void vtkInteractorStyleImage::OnRightButtonDown()
     }
 
   // Redefine this button + shift to handle pick
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetShiftKey())
     {
     this->StartPick();
@@ -193,7 +193,7 @@ void vtkInteractorStyleImage::OnRightButtonUp()
       this->EndPick();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }

Rendering/vtkInteractorStyleJoystickActor.cxx

@@ -25,7 +25,7 @@
 #include "vtkTransform.h"
 #include "vtkMatrix4x4.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleJoystickActor, "1.32");
+vtkCxxRevisionMacro(vtkInteractorStyleJoystickActor, "1.33");
 vtkStandardNewMacro(vtkInteractorStyleJoystickActor);
 
 //----------------------------------------------------------------------------
@@ -78,7 +78,7 @@ void vtkInteractorStyleJoystickActor::OnLeftButtonDown()
     return;
     }
 
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetShiftKey())
     {
     this->StartPan();
@@ -112,7 +112,7 @@ void vtkInteractorStyleJoystickActor::OnLeftButtonUp()
     }
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -130,7 +130,7 @@ void vtkInteractorStyleJoystickActor::OnMiddleButtonDown()
     return;
     }
 
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetControlKey())
     {
     this->StartDolly();
@@ -157,7 +157,7 @@ void vtkInteractorStyleJoystickActor::OnMiddleButtonUp()
 
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -174,7 +174,7 @@ void vtkInteractorStyleJoystickActor::OnRightButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartUniformScale();
 }
 
@@ -187,7 +187,7 @@ void vtkInteractorStyleJoystickActor::OnRightButtonUp()
       this->EndUniformScale();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }

Rendering/vtkInteractorStyleJoystickCamera.cxx

@@ -21,7 +21,7 @@
 #include "vtkRenderer.h"
 #include "vtkRenderWindowInteractor.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleJoystickCamera, "1.31");
+vtkCxxRevisionMacro(vtkInteractorStyleJoystickCamera, "1.32");
 vtkStandardNewMacro(vtkInteractorStyleJoystickCamera);
 
 //----------------------------------------------------------------------------
@@ -67,7 +67,7 @@ void vtkInteractorStyleJoystickCamera::OnLeftButtonDown()
     return;
     }
 
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetShiftKey()) 
     {
     if (this->Interactor->GetControlKey()) 
@@ -115,7 +115,7 @@ void vtkInteractorStyleJoystickCamera::OnLeftButtonUp()
     }
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -129,7 +129,7 @@ void vtkInteractorStyleJoystickCamera::OnMiddleButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartPan();
 }
 
@@ -144,7 +144,7 @@ void vtkInteractorStyleJoystickCamera::OnMiddleButtonUp()
     }
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -158,7 +158,7 @@ void vtkInteractorStyleJoystickCamera::OnRightButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
 }
 
@@ -173,7 +173,7 @@ void vtkInteractorStyleJoystickCamera::OnRightButtonUp()
     }
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -187,12 +187,12 @@ void vtkInteractorStyleJoystickCamera::OnMouseWheelForward()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
   double factor = 10.0 * 0.2 * this->MouseWheelMotionFactor;
   this->Dolly(pow((double)1.1, factor));
   this->EndDolly();
-  this->Interactor->ReleaseFocus();
+  this->ReleaseFocus();
 }
 
 //----------------------------------------------------------------------------
@@ -205,12 +205,12 @@ void vtkInteractorStyleJoystickCamera::OnMouseWheelBackward()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
   double factor = 10.0 * -0.2 * this->MouseWheelMotionFactor;
   this->Dolly(pow((double)1.1, factor));
   this->EndDolly();
-  this->Interactor->ReleaseFocus();
+  this->ReleaseFocus();
 }
 
 //----------------------------------------------------------------------------

Rendering/vtkInteractorStyleTerrain.cxx

@@ -27,7 +27,7 @@
 #include "vtkRenderer.h"
 #include "vtkSphereSource.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleTerrain, "1.10");
+vtkCxxRevisionMacro(vtkInteractorStyleTerrain, "1.11");
 vtkStandardNewMacro(vtkInteractorStyleTerrain);
 
 //----------------------------------------------------------------------------
@@ -105,7 +105,7 @@ void vtkInteractorStyleTerrain::OnLeftButtonDown ()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartRotate();
 }
 
@@ -118,7 +118,7 @@ void vtkInteractorStyleTerrain::OnLeftButtonUp ()
       this->EndRotate();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }
@@ -134,7 +134,7 @@ void vtkInteractorStyleTerrain::OnMiddleButtonDown ()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartPan();
 }
 
@@ -147,7 +147,7 @@ void vtkInteractorStyleTerrain::OnMiddleButtonUp ()
       this->EndPan();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }
@@ -163,7 +163,7 @@ void vtkInteractorStyleTerrain::OnRightButtonDown ()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
 }
 
@@ -176,7 +176,7 @@ void vtkInteractorStyleTerrain::OnRightButtonUp ()
       this->EndDolly();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }

Rendering/vtkInteractorStyleTrackballActor.cxx

@@ -25,7 +25,7 @@
 #include "vtkRenderer.h"
 #include "vtkTransform.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleTrackballActor, "1.34");
+vtkCxxRevisionMacro(vtkInteractorStyleTrackballActor, "1.35");
 vtkStandardNewMacro(vtkInteractorStyleTrackballActor);
 
 //----------------------------------------------------------------------------
@@ -96,7 +96,7 @@ void vtkInteractorStyleTrackballActor::OnLeftButtonDown()
     return;
     }
 
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetShiftKey())
     {
     this->StartPan();
@@ -131,7 +131,7 @@ void vtkInteractorStyleTrackballActor::OnLeftButtonUp()
 
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -148,7 +148,7 @@ void vtkInteractorStyleTrackballActor::OnMiddleButtonDown()
     return;
     }
 
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetControlKey())
     {
     this->StartDolly();
@@ -175,7 +175,7 @@ void vtkInteractorStyleTrackballActor::OnMiddleButtonUp()
 
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -192,7 +192,7 @@ void vtkInteractorStyleTrackballActor::OnRightButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartUniformScale();
 }
 
@@ -208,7 +208,7 @@ void vtkInteractorStyleTrackballActor::OnRightButtonUp()
 
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 

Rendering/vtkInteractorStyleTrackballCamera.cxx

@@ -22,7 +22,7 @@
 #include "vtkRenderWindowInteractor.h"
 #include "vtkRenderer.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleTrackballCamera, "1.33");
+vtkCxxRevisionMacro(vtkInteractorStyleTrackballCamera, "1.34");
 vtkStandardNewMacro(vtkInteractorStyleTrackballCamera);
 
 //----------------------------------------------------------------------------
@@ -80,7 +80,7 @@ void vtkInteractorStyleTrackballCamera::OnLeftButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   if (this->Interactor->GetShiftKey()) 
     {
     if (this->Interactor->GetControlKey()) 
@@ -129,7 +129,7 @@ void vtkInteractorStyleTrackballCamera::OnLeftButtonUp()
 
   if ( this->Interactor )
     {
-    this->Interactor->ReleaseFocus();
+    this->ReleaseFocus();
     }
 }
 
@@ -143,7 +143,7 @@ void vtkInteractorStyleTrackballCamera::OnMiddleButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartPan();
 }
 
@@ -156,7 +156,7 @@ void vtkInteractorStyleTrackballCamera::OnMiddleButtonUp()
       this->EndPan();
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }
@@ -172,7 +172,7 @@ void vtkInteractorStyleTrackballCamera::OnRightButtonDown()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
 }
 
@@ -186,7 +186,7 @@ void vtkInteractorStyleTrackballCamera::OnRightButtonUp()
 
       if ( this->Interactor )
         {
-        this->Interactor->ReleaseFocus();
+        this->ReleaseFocus();
         }
       break;
     }
@@ -202,12 +202,12 @@ void vtkInteractorStyleTrackballCamera::OnMouseWheelForward()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
   double factor = this->MotionFactor * 0.2 * this->MouseWheelMotionFactor;
   this->Dolly(pow((double)1.1, factor));
   this->EndDolly();
-  this->Interactor->ReleaseFocus();
+  this->ReleaseFocus();
 }
 
 //----------------------------------------------------------------------------
@@ -220,12 +220,12 @@ void vtkInteractorStyleTrackballCamera::OnMouseWheelBackward()
     return;
     }
   
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
   this->StartDolly();
   double factor = this->MotionFactor * -0.2 * this->MouseWheelMotionFactor;
   this->Dolly(pow((double)1.1, factor));
   this->EndDolly();
-  this->Interactor->ReleaseFocus();
+  this->ReleaseFocus();
 }
 
 //----------------------------------------------------------------------------

Rendering/vtkInteractorStyleUnicam.cxx

@@ -36,7 +36,7 @@
 #include "vtkWorldPointPicker.h"
 #include "vtkCallbackCommand.h"
 
-vtkCxxRevisionMacro(vtkInteractorStyleUnicam, "1.37");
+vtkCxxRevisionMacro(vtkInteractorStyleUnicam, "1.38");
 vtkStandardNewMacro(vtkInteractorStyleUnicam);
 
 // define 'TheTime()' function-- returns time in elapsed seconds
@@ -125,7 +125,7 @@ void vtkInteractorStyleUnicam::SetWorldUpVector(double x, double y, double z)
 //----------------------------------------------------------------------------
 void vtkInteractorStyleUnicam::OnLeftButtonDown() 
 {
-  this->Interactor->GrabFocus(this->EventCallbackCommand);
+  this->GrabFocus(this->EventCallbackCommand);
 
   int x = this->Interactor->GetEventPosition()[0];
   int y = this->Interactor->GetEventPosition()[1];
@@ -286,7 +286,7 @@ void vtkInteractorStyleUnicam::OnLeftButtonUp()
     rwi->DestroyTimer();
     }
 
-  this->Interactor->ReleaseFocus();
+  this->ReleaseFocus();
 }
 
 //----------------------------------------------------------------------------

Rendering/vtkRenderWindow.cxx

@@ -23,7 +23,7 @@
 #include "vtkRendererCollection.h"
 #include "vtkTransform.h"
 
-vtkCxxRevisionMacro(vtkRenderWindow, "1.145");
+vtkCxxRevisionMacro(vtkRenderWindow, "1.146");
 
 //----------------------------------------------------------------------------
 // Needed when we don't use the vtkStandardNewMacro.
@@ -73,6 +73,7 @@ vtkRenderWindow::vtkRenderWindow()
   this->PainterDeviceAdapter = vtkPainterDeviceAdapter::New();
 }
 
+//----------------------------------------------------------------------------
 vtkRenderWindow::~vtkRenderWindow()
 {
   this->SetInteractor(NULL);
@@ -93,6 +94,7 @@ vtkRenderWindow::~vtkRenderWindow()
   this->PainterDeviceAdapter->Delete();
 }
 
+//----------------------------------------------------------------------------
 // return the correct type of RenderWindow 
 vtkRenderWindow *vtkRenderWindow::New()
 {
@@ -101,6 +103,7 @@ vtkRenderWindow *vtkRenderWindow::New()
   return (vtkRenderWindow*)ret;
 }
 
+//----------------------------------------------------------------------------
 // Create an interactor that will work with this renderer.
 vtkRenderWindowInteractor *vtkRenderWindow::MakeRenderWindowInteractor()
 {
@@ -109,6 +112,7 @@ vtkRenderWindowInteractor *vtkRenderWindow::MakeRenderWindowInteractor()
   return this->Interactor;
 }
 
+//----------------------------------------------------------------------------
 // Set the interactor that will work with this renderer.
 void vtkRenderWindow::SetInteractor(vtkRenderWindowInteractor *rwi)
 {
@@ -129,6 +133,7 @@ void vtkRenderWindow::SetInteractor(vtkRenderWindowInteractor *rwi)
     }
 }
 
+//----------------------------------------------------------------------------
 void vtkRenderWindow::SetSubFrames(int subFrames)
 {
   if (this->SubFrames != subFrames)
@@ -143,6 +148,7 @@ void vtkRenderWindow::SetSubFrames(int subFrames)
     }
 }
 
+//----------------------------------------------------------------------------
 void vtkRenderWindow::SetDesiredUpdateRate(double rate)