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

2013-06-14T07:45:19Z

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

Finetjul: /* Register */

2013-04-14T16:46:12Z

UpdateBot: Nightly -> 4.2

2012-10-31T21:59:19Z

Nightly -> 4.2

New page

=Displayable Managers=
To be written.

==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:
set(displayable_manager_SRCS
vtkMRMXYZDisplayableManager.cxx
)
set(VTK_USE_INSTANTIATOR_NEW 1)
VTK_MAKE_INSTANTIATOR3("${MODULE_NAME}Instantiator"
displayable_manager_instantiator_SRCS
"${displayable_manager_SRCS}"
"${${KIT}_EXPORT_DIRECTIVE}"
${CMAKE_CURRENT_BINARY_DIR}
"${KIT}Export.h"
)
set(${KIT}_SRCS
${displayable_manager_instantiator_SRCS}
${displayable_manager_SRCS}
...
)

==Register==
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()
{
...
// If the displayable manager is for 3D views:
vtkMRMLThreeDViewDisplayableManagerFactory::GetInstance()->RegisterDisplayableManager(
"vtkMRMLXYZDisplayableManager");
// If the displayable manager is for 2D views:
vtkMRMLSliceViewDisplayableManagerFactory::GetInstance()->RegisterDisplayableManager(
"vtkMRMLXYZDisplayableManager");
...
}

=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>

← Older revision		Revision as of 07:45, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	=Displayable Managers=		=Displayable Managers=
	To be written.		To be written.

@@ Line 24: / Line 24: @@
 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 35: / Line 38: @@
     ...
+   }
 =How a view is refreshed=

Documentation/4.2/Developers/DisplayableManagers - Revision history

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

Finetjul: /* Register */

UpdateBot: Nightly -> 4.2