Documentation/4.0/Developers/Tutorials/ModuleWriting - Revision history

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

2013-06-14T07:29:32Z

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

JChris.FillionR at 03:57, 9 March 2012

2012-03-09T03:57:08Z

Finetjul: Add dependency

2012-02-22T16:09:46Z

Add dependency

Finetjul: /* Consider also reading */

2012-01-29T21:30:05Z

Consider also reading

Finetjul: /* 1) Create the module directory */

2012-01-29T21:27:40Z

1) Create the module directory

Finetjul: /* 4) Check the module */

2012-01-29T21:21:34Z

4) Check the module

Finetjul: /* 3) Compile */

2012-01-29T21:19:28Z

3) Compile

Pieper: /* 1) Create the module directory */

2012-01-07T22:04:58Z

1) Create the module directory

Finetjul at 22:57, 27 December 2011

2011-12-27T22:57:54Z

Finetjul: /* 5) Open the designer using the launcher */

2011-12-23T17:38:13Z

5) Open the designer using the launcher

← Older revision		Revision as of 07:29, 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]]

← Older revision		Revision as of 03:57, 9 March 2012
Line 1:		Line 1:
−	~~Back to [[Documentation/{{documentation/version}}/Developers\|Developers Information]]←~~
−
	=Consider also reading=		=Consider also reading=
	*[[Media:QtPortInSlicer.ppt\|QtPortInSlicer - How to write a module]]		*[[Media:QtPortInSlicer.ppt\|QtPortInSlicer - How to write a module]]

← Older revision		Revision as of 16:09, 22 February 2012
Line 89:		Line 89:
	** Edit the resource file by adding the line		** Edit the resource file by adding the line
	*** "<file>Icons/MyIcon.png</file>"		*** "<file>Icons/MyIcon.png</file>"
		+
		+	= Dependency between modules =
		+	It is possible that your module needs to access information from another module. Typically the logic 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(qt_module_include_directories
		+	${CMAKE_CURRENT_SOURCE_DIR}/Widgets
		+	${CMAKE_CURRENT_BINARY_DIR}/Widgets
		+	${vtkSlicerVolumesModuleLogic_SOURCE_DIR}
		+	${vtkSlicerVolumesModuleLogic_BINARY_DIR}
		+	)
		+	...
		+	set(qt_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 will be setup before your module is setup.
		+
		+	Follow the same pattern in CMakeLists.txt to add dependency on a module widgets:
		+	set(qt_module_include_directories
		+	...
		+	${qSlicerVolumesModuleWidgets_SOURCE_DIR}
		+	${qSlicerVolumesModuleWidgets_BINARY_DIR}
		+	...
		+	)
		+	...
		+	set(qt_module_target_libraries
		+	...
		+	qSlicerVolumesModuleWidgets
		+	)

@@ Line 3: / Line 3: @@
 =Consider also reading=
 *[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
 = Initialization =
 === 1) Create the module directory ===

@@ Line 5: / Line 5: @@
 = Initialization =
 === 1) Create the module directory ===
-Use the [[Documentation/4.0/Developers/ModuleWizard|ModuleWizard.py]] script to generate files and directory based on a template.
+Use the [[Documentation/4.0/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
 {|
 ! style="border-bottom: 1px solid darkgrey;"| <small>Linux</small>
@@ Line 18: / Line 18: @@
 Start -> Microsoft Visual Studio 2008 -> Visual Studio Tools -> Visual Studio 2008 Command Prompt<br>
 Then type in the terminal:<br>
-  $ cd here\is\the\path\of\Slicer4\source\directory
+  $ cd path\to\Slicer4
   $ ..\Slicer4-Superbuild\python-build\PCBuild\python.exe Utilities\Scripts\ModuleWizard.py MY_MODULE_NAME
 |}

@@ Line 57: / Line 57: @@
 To change the module title that shows up in Slicer, edit the file ''Slicer4/Modules/Loadable/MY_MODULE_NAME/CMakeLists.txt''
   set(qt_module_title "Your title")
-Other [http://slicer.org/doc/html/classqSlicerAbstractCoreModule.html#properties properties] for the module such as help and acknowledgment can be re-implemented directly in C++ by editing ''Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.cxx''.
+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 ''Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.cxx''.
 <br><br>

@@ Line 36: / Line 36: @@
 <br><br>
 === 3) Compile ===
 {|
 ! style="border-bottom: 1px solid darkgrey;"| <small>Linux</small>
@@ Line 50: / Line 51: @@
 |}
 <br><br>
 === 4) Check the module ===
 Start Slicer and make sure the module is present (listed under "Module Template")

@@ Line 56: / Line 56: @@
 <br><br>
-=== 5) Open the designer using the launcher ===
+=== 5) Open Qt Designer using the launcher ===
-The launcher ensures all the environment variables are correctly set for Qt Designer
+''Slicer'' (the launcher) searches Qt Designer on your machine (using QT_QMAKE_EXECUTABLE set at configure time). It starts the designer after setting the correct environment variables (QT_PLUGIN_PATH for the widgets designer plugins and PATH/LD_LIBRARY_PATH for the libraries).
   $ ./Slicer --designer
 <br><br>