Documentation/Nightly/Developers/Tutorials/CreateLoadableModule - Revision history

JChris.FillionR: /* Consider also reading */

2016-08-26T13:47:08Z

Consider also reading

JChris.FillionR: /* Initialization */

2014-10-17T13:34:53Z

Initialization

JChris.FillionR: /* Initialization */

2014-10-17T13:26:35Z

Initialization

JChris.FillionR at 13:25, 17 October 2014

2014-10-17T13:25:58Z

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

2013-06-14T07:56:21Z

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

Finetjul: /* 6) Change the UI */

2012-08-23T17:30:44Z

6) Change the UI

JChris.FillionR: 4.1 -> Nightly

2012-08-22T17:02:08Z

4.1 -> Nightly

New page

=Consider also reading=
*[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
*[[Documentation/{{documentation/version}}/Developers/Tutorials/ExternalModuleWriting|How to write an external module]]

= Initialization =
=== 1) Create the module directory ===

Use the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
Start terminal (<code>bash</code> or <code>Terminal.app</code>), then type the following: 
$ cd /path/to/Slicer4
$ python Utilities/Scripts/ModuleWizard.py MY_MODULE_NAME
| valign="top" |
Start <code>cmd.exe</code> terminal, then type the following (in 64-bit mode replace <code>PCbuild</code> with <code>PCbuild\amd64</code>): 
$ cd C:\path\to\Slicer4
$ ..\Slicer4-Superbuild\python-build\PCBuild\python.exe Utilities\Scripts\ModuleWizard.py MY_MODULE_NAME
|}
Replace <code>MY_MODULE_NAME</code> with the name of the module you want (e.g. <code>HelloWorld</code>) 
After running the script, a new directory <code>MY_MODULE_NAME</code> will be created in <code>Slicer4/Modules/Loadable</code>
 

=== 2) Add the module in CMake ===
Edit the file [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CMakeLists.txt?view=markup Slicer4/Modules/Loadable/CMakeLists.txt]:
Add the name of your module at the end of the qtmodules variable assignment:
...
set(qtmodules
...
MY_MODULE_NAME
)
...
 
=== 3) Compile ===
Compile the inner build (''Slicer-build'' inside the Superbuild directory).
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
$ cd ../Slicer4-Superbuild/Slicer-build;
$ make -j4
| valign="top" |
$ cd ..\Slicer4-Superbuild\Slicer-build;
$ .\Slicer.exe --VisualStudio Slicer.sln
In Visual Studio, go to Build -> Build Solution
|}
 

=== 4) Check the module ===
Start Slicer and make sure the module is present (listed under "Module Template")
$ ./Slicer
To change the module title that shows up in Slicer, edit the file <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/CMakeLists.txt</code>
set(MODULE_TITLE "Your title")
Other [http://slicer.org/doc/html/classqSlicerAbstractCoreModule.html#properties properties] for the module such as '''help''', '''acknowledgment''' or '''categories''' can be re-implemented directly in C++ by editing <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.cxx</code>.
 

=== 5) Open Qt Designer using the launcher ===
''Slicer'' (the launcher) searches Qt Designer on your machine (using <code>QT_QMAKE_EXECUTABLE</code> set at configure time). It starts the designer after setting the correct environment variables (<code>QT_PLUGIN_PATH</code> for the widgets designer plugins and PATH/LD_LIBRARY_PATH for the libraries).
$ ./Slicer --designer
 

=== 6) Change the UI ===
Using Qt Designer, edit the module UI file: <code>Modules/Loadable/MY_MODULE_NAME/Resources/UI/qSlicerMY_MODULE_NAMEModule.ui</code> 
[[Slicer4:Developers:Projects:QtSlicer/Tutorials/QtDesigner|More info on how to use the designer]]
 

=== 7) Edit the module files ===
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAMEWidget.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/Logic/vtkSlicerMY_MODULE_NAMELogic.[h|cxx]
...
 

= Qt Designer =
* How to set icons to widgets
** In the icon property entry of the widget (Property Editor), select a resource file
*** Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/qSlicerMY_MODULE_NAMEModule.qrc
*** Slicer4/Libs/MRML/Widgets/Resources/qMRMLWidget.qrc
*** Slicer4/Base/QTGUI/Resources/qSlicerBaseQTGUI.qrc
* How to add an icon in a resource file
** Add the icon in Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/Icon
** Edit the resource file by adding the line
*** "<file>Icons/MyIcon.png</file>"

= Dependency between modules =
It is possible that your module needs to access information from another module. Typically the logic or the custom MRML classes of a module.
The following code is an example of what can be done to make your module dependent to the Volumes module logic:

In CMakeLists.txt:
set(MODULE_INCLUDE_DIRECTORIES
${CMAKE_CURRENT_SOURCE_DIR}/Widgets
${CMAKE_CURRENT_BINARY_DIR}/Widgets
${vtkSlicerVolumesModuleLogic_SOURCE_DIR}
${vtkSlicerVolumesModuleLogic_BINARY_DIR}
)
...
set(MODULE_TARGET_LIBRARIES
...
vtkSlicerVolumesModuleLogic
)

In qSlicerMY_MODULE_NAMEModule.cxx:

//-----------------------------------------------------------------------------
QStringList qSlicerMY_MODULE_NAMEModule::dependencies()const
{
return QStringList() << "Volumes";
}

//-----------------------------------------------------------------------------
void qSlicerMY_MODULE_NAMEModule::setup()
{
this->Superclass::setup();

vtkSlicerMY_MODULE_NAMELogic* moduleLogic =
vtkSlicerMY_MODULE_NAMELogic::SafeDownCast(this->logic());

qSlicerAbstractCoreModule* volumesModule =
qSlicerCoreApplication::application()->moduleManager()->module("Volumes");
if (volumesModule)
{
vtkSlicerVolumesLogic* volumesLogic =
vtkSlicerVolumesLogic::SafeDownCast(volumesModule->logic());
moduleLogic->SetVolumesLogic(volumesLogic);
}

By specifying the module as a dependency, you are insured that the dependency module will be setup before your module is setup.

Follow the same pattern in CMakeLists.txt to add dependency on a module widgets:

set(MODULE_INCLUDE_DIRECTORIES
...
${qSlicerVolumesModuleWidgets_SOURCE_DIR}
${qSlicerVolumesModuleWidgets_BINARY_DIR}
...
)
...
set(MODULE_TARGET_LIBRARIES
...
qSlicerVolumesModuleWidgets
)

It works the same if you want to access the custom MRML (''vtkSlicerDEPENDENT_MODULEModuleMRML_SOURCE_DIR'') or displayable manager (''vtkSlicerDEPENDENT_MODULEModuleDisplayableManager_SOURCE_DIR'') classes.

== Examples ==
# [[Documentation/{{documentation/version}}/Modules/CropVolume|Crop Volume]] module [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CropVolume/qSlicerCropVolumeModule.cxx?view=markup depends] on [[Documentation/{{documentation/version}}/Modules/Volumes|Volumes]] module

@@ Line 7: / Line 7: @@
 === 1) Create the module directory ===
 Use the [[Documentation/{{documentation/version}}/Developers/ExtensionWizard|extension wizard]] to generate files and directory based on a template.
 {|
 ! style="border-bottom: 1px solid darkgrey;"| <small>Linux</small>
@@ Line 25: / Line 27: @@
 After running the script, a new directory <code>MY_MODULE_NAME</code> will be created in <code>Slicer4/Modules/Loadable</code>
 <br><br>
 === 2) Add the module in CMake ===

@@ Line 7: / Line 7: @@
 === 1) Create the module directory ===
-Use the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
+Use the [[Documentation/{{documentation/version}}/Developers/ExtensionWizard|extension wizard]] to generate files and directory based on a template.
 {|
 ! style="border-bottom: 1px solid darkgrey;"| <small>Linux</small>

← Older revision		Revision as of 07:56, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	=Consider also reading=		=Consider also reading=
	*[[Media:QtPortInSlicer.ppt\|QtPortInSlicer - How to write a module]]		*[[Media:QtPortInSlicer.ppt\|QtPortInSlicer - How to write a module]]

@@ Line 67: / Line 67: @@
 === 6) Change the UI ===
 Using Qt Designer, edit the module UI file: <code>Modules/Loadable/MY_MODULE_NAME/Resources/UI/qSlicerMY_MODULE_NAMEModule.ui</code><br>
-[[Slicer4:Developers:Projects:QtSlicer/Tutorials/QtDesigner|More info on how to use the designer]]
+[[Documentation/{{documentation/version}}/Developers/Tutorials/QtDesigner|More info on how to use the designer]]
 <br><br>

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
 =Consider also reading=
 *[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
 *[[Documentation/{{documentation/version}}/Developers/Tutorials/ExternalModuleWriting|How to write an external module]]

@@ Line 29: / Line 29: @@
 -->
 === 2) Add the module in CMake ===
 Edit the file [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CMakeLists.txt?view=markup Slicer4/Modules/Loadable/CMakeLists.txt]:
@@ Line 55: / Line 65: @@
 |}
 <br><br>
 === 4) Check the module ===