Documentation/Nightly/Developers/DisplayableManagers - Revision history

Finetjul at 18:42, 6 July 2013

2013-07-06T18:42:13Z

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T08:00:10Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Finetjul: /* Register */

2013-04-14T16:46:26Z

Finetjul: /* Displayable Managers */

2013-01-17T23:57:13Z

Displayable Managers

Finetjul: /* Displayable Managers */

2013-01-17T23:55:58Z

Displayable Managers

Finetjul: /* Displayable Managers */

2013-01-17T23:38:07Z

Displayable Managers

Finetjul at 16:25, 15 October 2012

2012-10-15T16:25:49Z

JChris.FillionR: 4.1 -> Nightly

2012-08-22T16:56:21Z

4.1 -> Nightly

New page

=Displayable Managers=
To be written.

=How a view is refreshed=
It's the 3D view (ctkVTKAbstractView) that controls WHEN the vtkRenderWindow::Render is called.
There are 2 ways to tell the view to re-render:
#<code>vtkRenderWindowInteractor::Render()</code> is called (by <code>vtkInteractorStyle</code> when the mouse is moved or by some vtkWidgets that call it internally). The request is blocked and <code>ctkAbstractView::scheduleRender()</code> is called on the view.
#or it is done by the <code>vtkMRMLDisplayableManager</code>s (e.g. <code>vtkMRMLVolumeRenderingDisplayableManager</code>) by the RequestRender() calls. They call vtkMRMLDisplayableManagerGroup::RequestRender() which fires a vtkCommand::UpdateEvent. The Qt view (e.g. <code>qMRMLThreeDView</code>) observes the <code>UpdateEvent</code> and calls <code>ctkVTKAbstractView::scheduleRender()</code>.

The CTK view compacts the render requests and ensure the FPS (<code>vtkRenderWindow::GetDesiredUpdateRate()</code>) is respected.
<pre>
vtkInteractorStyle ---------------------------\
vtkWidget -------------------------------------> vtkRenderWindowInteractor::Render() ------------------------------\
vtkMRML???DisplayableManager::RequestRender() -> vtkMRML???DisplayableManagerGroup::RequestRender() -> UpdateEvent -> ctkVTKAbstractView::scheduleRender()
</pre>

@@ Line 7: / Line 7: @@
 Theoretically the slice logics should be displayable managers ( however, it might be a huge effort for just the sake of being consistent ).
 ==Build==
 Displayable managers are instantiated from their class name by the displayable manager groups. An instantiator must be included in the library containing the displayable manager. To do so, add in your CMakeLists.txt:
@@ Line 49: / Line 51: @@
 Do not forget to include the Instantiator header file to make sure it is loaded with the module.
 =How a view is refreshed=

← Older revision		Revision as of 08:00, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	=Displayable Managers=		=Displayable Managers=
	Displayable managers automatically observe the scene and when a matching display node is added into the scene, they create corresponding VTK actors to add them in their VTK renderer. For example, the model displayable manager creates a vtkPolyDataActor and vtkPolyDataMapper when a vtkMRMLModelDisplayNode is added into the scene.		Displayable managers automatically observe the scene and when a matching display node is added into the scene, they create corresponding VTK actors to add them in their VTK renderer. For example, the model displayable manager creates a vtkPolyDataActor and vtkPolyDataMapper when a vtkMRMLModelDisplayNode is added into the scene.

@@ Line 32: / Line 32: @@
 Displayable managers must be registered as early as possible (before the first view is created.
 Therefore, displayable managers should be registered when modules are setup.
   void qSlicerXYZModule::setup()
+  {
@@ Line 43: / Line 46: @@
     ...
+   }
 =How a view is refreshed=

@@ Line 3: / Line 3: @@
 Displayable managers are registered into a view factory (e.g. 3D view displayable manager factory) and when a view is created, the factory instantiate each displayable manager and associate them to the view.
-There is 1 instance of each displayable manager per view/renderer. For example, in the conventional layout, the 2D model displayable manager (<code>vtkMRMLModelSliceDisplayableManager</code>) is instantiated 3 times, once for the red slice view, once for the yellow slice view and once for the green slice view.
+There is 1 instance of each displayable manager per view/renderer. For example, in the conventional layout, the 2D model displayable manager (<code>vtkMRMLModelSliceDisplayableManager</code>) is instantiated 3 times: once for the red slice view, once for the yellow slice view and once for the green slice view.
 Theoretically the slice logics should be displayable managers ( however, it might be a huge effort for just the sake of being consistent ).

@@ Line 2: / Line 2: @@
 Displayable managers automatically observe the scene and when a matching display node is added into the scene, they create corresponding VTK actors to add them in their VTK renderer. For example, the model displayable manager creates a vtkPolyDataActor and vtkPolyDataMapper when a vtkMRMLModelDisplayNode is added into the scene.
-Displayable managers are registered into a view factory (3D view displayable manager factory) and when a view is created, the factory instantiate each displayable manager and associate them to the view.
+Displayable managers are registered into a view factory (e.g. 3D view displayable manager factory) and when a view is created, the factory instantiate each displayable manager and associate them to the view.
-There is 1 instance of each displayable manager per view/renderer.
+There is 1 instance of each displayable manager per view/renderer. For example, in the conventional layout, the 2D model displayable manager (<code>vtkMRMLModelSliceDisplayableManager</code>) is instantiated 3 times, once for the red slice view, once for the yellow slice view and once for the green slice view.
 Theoretically the slice logics should be displayable managers ( however, it might be a huge effort for just the sake of being consistent ).

@@ Line 1: / Line 1: @@
 =Displayable Managers=
-To be written.
+Displayable managers automatically observe the scene and when a matching display node is added into the scene, they create corresponding VTK actors to add them in their VTK renderer. For example, the model displayable manager creates a vtkPolyDataActor and vtkPolyDataMapper when a vtkMRMLModelDisplayNode is added into the scene.
 ==Build==