Documentation/Nightly/Developers/ModuleWizard - Revision history

Finetjul: /* Step by Step */

2014-08-26T20:49:59Z

Step by Step

2014-03-14T20:34:17Z

mark as deprecated, direct to Extension Wizard instead

2013-06-14T07:54:35Z

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

2013-06-12T13:56:28Z

Background

2013-06-12T13:54:50Z

2013-06-07T18:14:17Z

Concepts

2013-06-07T17:58:57Z

Examples

2013-06-07T17:25:31Z

Examples

2013-06-07T17:21:45Z

Creating and Testing a Loadable Module

2013-06-07T17:20:27Z

Creating and Testing a Loadable Module

← Older revision		Revision as of 20:49, 26 August 2014
Line 39:		Line 39:

	Running this wizard will create the module in the specified target directory and will give it the name you specify on the command line.		Running this wizard will create the module in the specified target directory and will give it the name you specify on the command line.
		+
		+	On Windows, you can execute the wizard by running the command as a parameter of python:
		+	../Slicer-Superbuild/python-install/bin/python.exe ./Utilities/Scripts/ModuleWizard.py --template [...]

	=== Creating an Extension ===		=== Creating an Extension ===

← Older revision		Revision as of 20:34, 14 March 2014
Line 1:		Line 1:
	<noinclude>{{documentation/versioncheck}}</noinclude>		<noinclude>{{documentation/versioncheck}}</noinclude>
		+
		+	{{ambox
		+	\| type = warning
		+	\| text = '''Deprecated'''<p>This page describes a utility which has been deprecated. If you are using Slicer 4.4 or later, it is recommended to use the [[Documentation/{{documentation/version}}/Developers/ExtensionWizard\|Extension Wizard]] instead.</p>
		+	}}
		+
		+	<br/>
		+
	== Background ==		== Background ==

← Older revision		Revision as of 07:54, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	== Background ==		== Background ==

@@ Line 7: / Line 7: @@
 Also, it is not uncommon to want to use one module as the starting point for implementing similar functionality.
-For development, we suggest starting with the structure of an Extension that can contains one or more modules.  The modules can be of different types, such as python scripted module or pure C++ modules or a combination.
+For development, we suggest starting with the structure of an Extension that can contains one or more modules.  The [[Documentation/{{documentation/version}}/Developers/Modules|modules]] can be of different types, such as python scripted module or pure C++ modules or a combination.
 The ModuleWizard will do most of the copying and renaming for you, but you will also need to manually configure some steps (specifically, you need to edit the CMakeLists.txt file when you add a module to an extension).

@@ Line 37: / Line 37: @@
   ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/ScriptedLoadableExtensionTemplate --target ../MyExtension MyExtension
-should be done from within the slicer source directory, so that the ModuleWizard.py script is found, and so that the template path points to the correct spot.  This command relies on your machine having an installed python interpreter to run the wizard (any version of python should work, you don't need to use the one that gets built with slicer).
+should be done from within the slicer source directory, so that the <code>ModuleWizard.py</code> script is found, and so that the template path points to the correct spot.  This command relies on your machine having an installed python interpreter to run the wizard (any version of python should work, you don't need to use the one that gets built with slicer).
 This command will create a new directory parallel to the Slicer source directory, in this case called MyExtension.

@@ Line 25: / Line 25: @@
    --target default ./Modules/Loadable/<moduleName>
-== Concepts ==
+== Step by Step ==
 The idea of the wizard is to create a new self-contained directory that is a working module from the slicer perspective.  This means that for C++ extensions, you only need to compile the extension and it will work with slicer.  For scripted (python) extensions, you don't even need to compile.
@@ Line 43: / Line 43: @@
 The resulting extension will include a sample module in a directory called "ScriptedLoadableModuleTemplate" -- ''you should delete this directory since we will replace it in the next step.''
-Edit the MyExtension/CMakeLists.txt file to customize it for your work.  For example, list yourself and your colleagues as contributors and add the proper links to your project pages and icons.
+Edit the MyExtension/CMakeLists.txt file to customize it for your work.  For example, list yourself and your colleagues as contributors and add the proper links to your project pages and icons.  You should also make a custom icon for extension, that will represent it in the ExtensionManager.
 === Adding a Module ===

← Older revision		Revision as of 17:58, 7 June 2013
Line 90:		Line 90:
	./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/EditorExtensionTemplate/EditorEffectTemplate --target ../MyExtension/MyEditorEffect MyEditorEffect		./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/EditorExtensionTemplate/EditorEffectTemplate --target ../MyExtension/MyEditorEffect MyEditorEffect

		+
		+	For reference, an extension directory that results from the steps above can be found [https://github.com/pieper/MyExtension in this git repository].

	=== Creating and Testing a Loadable Module ===		=== Creating and Testing a Loadable Module ===

← Older revision		Revision as of 17:25, 7 June 2013
Line 79:		Line 79:
	To create a [[Documentation/{{documentation/version}}/Developers/Tutorials/CreateLoadableModule\|Loadable]] Module:		To create a [[Documentation/{{documentation/version}}/Developers/Tutorials/CreateLoadableModule\|Loadable]] Module:

−	./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/LoadableExtensionTemplate/LoadableModuleTemplate --target ../MyExtension/~~MyLodableModule~~ MyLoadableModule	+	./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/LoadableExtensionTemplate/LoadableModuleTemplate --target ../MyExtension/MyLoadableModule MyLoadableModule

← Older revision		Revision as of 17:21, 7 June 2013
Line 107:		Line 107:


−	Slicer will start, and you will find ~~NewModule~~ in the modules menu under Examples. In the python interpreter, you can access the wrapped logic with:	+	After running this command, Slicer will start, and you will find the default LoadableModuleTempate in the modules menu under Examples. In the python interpreter, you can access the wrapped logic with:

	logic = slicer.modules.loadablemoduletemplate.logic()		logic = slicer.modules.loadablemoduletemplate.logic()

@@ Line 109: / Line 109: @@
 Slicer will start, and you will find NewModule in the modules menu under Examples.  In the python interpreter, you can access the wrapped logic with:
-  logic = slicer.modules.newmodule.logic()
+  logic = slicer.modules.loadablemoduletemplate.logic()
 From here, you can add additional methods to the logic and develop the GUI.
 ''Note: use the latest version of CMake (2.8.11) on mac''