Documentation/4.0/EditorExtension - Revision history

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

2013-06-14T07:29:57Z

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

2012-06-15T06:54:14Z

Prerequisites

2012-01-07T22:01:09Z

Prerequisites

2012-01-07T21:49:54Z

A More Complete Example

2012-01-07T21:42:28Z

The Code

2012-01-07T21:33:50Z

Creating the Extension from a Template

2012-01-07T21:32:48Z

Creating the Extension from a Template

2012-01-07T21:32:31Z

Creating the Extension from a Template

2012-01-07T21:19:13Z

A More Complete Example

2012-01-07T21:14:26Z

Next Steps

← Older revision		Revision as of 07:29, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	== Goal ==		== Goal ==
	This page will show you how to build your own editor effect as an extension to slicer4. An 'editor effect' is an entry in the [[Documentation/4.0/Modules/Editor\|Editor]] tool palette that consists of:		This page will show you how to build your own editor effect as an extension to slicer4. An 'editor effect' is an entry in the [[Documentation/4.0/Modules/Editor\|Editor]] tool palette that consists of:

@@ Line 17: / Line 17: @@
 Interfaces are build with [http://pythonqt.sourceforge.net/ PythonQt] which exposes most of the [http://qt.nokia.com Qt] interface so that sophisticated interfaces can be easily created.
-It is possible to implement the logic of the effect using [http://www.vtk.org/Wiki/VTK/Python_Wrapping_FAQ VTK Python binding].  You can get ideas of what is possible from [http://www.itk.org/Wiki/VTK/Tutorials the VTK tutorials].
+It is possible to implement the logic of the effect using [http://www.vtk.org/Wiki/VTK/Python_Wrapping_FAQ VTK Python binding].  You can get ideas of what is possible from the [http://www.itk.org/Wiki/VTK/Tutorials VTK tutorials].
 Slicer also comes bundled with [http://numpy.scipy.org/ numpy] so many interesting array operations are easy to perform on image data.

@@ Line 11: / Line 11: @@
 == Prerequisites ==
-First you need to [[Documentation/4.0/Developers/Build_Instructions|Build Slicer4]].  Be sure to build the svn trunk to get the latest features.  The examples here were made using the 4.0.1 version (January 2012), so things may have improved by the time you try it.
+First you need to [[Documentation/4.0/Developers/Build_Instructions|Build Slicer4]].  Be sure to build the svn trunk to get the latest features.  The examples here were made using the 4.0.1 version (January 2012), so things may have improved by the time you try it.  This tutorial was created with revision 19037.
 Developing an Editor Effect requires familiarity with [http://python.org python].

@@ Line 110: / Line 110: @@
 Skipping several hundred steps, we get to a working version of the WandTool that you can look at in this repository: https://github.com/pieper/WandEffect
 Note that if you want to use this as the starting point for your work, you can still use the ModuleWizard.  For example, to make your own special HarryPotterWandEffect, you could do this:
   python ModuleWizard.py --template ./WandEffect --templateKey WandEffect --target ./HarryPotterWandEffect HarryPotterWandEffect

@@ Line 67: / Line 67: @@
 Inside the WandEffect.py file you'll find the following classes:
-*'''WandEffectOptions''' which defines the python qt GUI for your effect
+*'''WandEffectOptions''' which defines the python qt GUI for your effect - one of these will be instanced by the Editor module with the parent argument being the QFrame in which to create your GUI when your tool is selected.
-*'''WandEffect''' which is the 'hook' by which Slicer's extension loading mechanism recognizes the code as something that should be brought into the slicer runtime.
+*'''WandEffectTool''' defines the interactive behavior of a mouse tool.  One of these will be instanced for each of the slice views.  The processEvent method gets called when something interesting happens.  In general, this class can create vtk actors that provide visual feedback.
 *'''WandEffectWidget''' which is a dummy class that would be used if this were a regular slicer module instead of an Editor Effect.
-In practice, the last two of these can be left as-is (no modification required).  The first place to play is in the WandEffectOptions class.
+In practice, the last three of these can be left as-is (no modification required).  The first place to play is in the WandEffectOptions class.
 == Adding Custom Behavior ==

@@ Line 43: / Line 43: @@
   ccmake ../WandEffect
   make
 == Configuring Slicer ==

@@ Line 35: / Line 35: @@
-  slicer4=/home/pieper/slicer4/latest/Slicer4
+  $ slicer4=/home/pieper/slicer4/latest/Slicer4
-  pieper@flint:/tmp$ python ${slicer4}/Utilities/Scripts/ModuleWizard.py --template ${slicer4}/Extensions/Testing/EditorExtensionTemplate --templateKey EditorExtensionTemplate --target ./WandEffect WandEffect
+  $ python ${slicer4}/Utilities/Scripts/ModuleWizard.py --template ${slicer4}/Extensions/Testing/EditorExtensionTemplate --templateKey EditorExtensionTemplate --target ./WandEffect WandEffect
 Now create a build directory and make the tool:

@@ Line 34: / Line 34: @@
 Now, we use the ModuleWizard tool from slicer to create a scaffold for us to add our own code.  In this example, replace occurrences of "/home/pieper/slicer4/latest/Slicer4" with the path to your slicer4 checkout and replace 'WandEffect' with the name of your effect.
-  python /home/pieper/slicer4/latest/Slicer4/Utilities/Scripts/ModuleWizard.py --template /home/pieper/slicer4/latest/Slicer4/Extensions/Testing/EditorExtensionTemplate --templateKey EditorExtensionTemplate --target ./WandEffect WandEffect
 Now create a build directory and make the tool:
@@ Line 41: / Line 43: @@
   ccmake ../WandEffect
   make
 == Configuring Slicer ==

← Older revision		Revision as of 21:19, 7 January 2012
Line 103:		Line 103:

	Skipping several hundred steps, we get to a working version of the WandTool that you can look at in this repository: https://github.com/pieper/WandEffect		Skipping several hundred steps, we get to a working version of the WandTool that you can look at in this repository: https://github.com/pieper/WandEffect
		+
		+	Note that if you want to use this as the starting point for your work, you can still use the ModuleWizard. For example, to make your own special HarryPotterWandEffect, you could do this:
		+
		+	python ModuleWizard.py --template ./WandEffect --templateKey WandEffect --target ./HarryPotterWandEffect HarryPotterWandEffect

← Older revision		Revision as of 21:14, 7 January 2012
Line 99:		Line 99:

	Stay tuned for more details on how to make use of this interface as the project evolves. For now, follow up with the slicer-devel mailing list if you want to get more hints on how to write implement your interactive editing plans.		Stay tuned for more details on how to make use of this interface as the project evolves. For now, follow up with the slicer-devel mailing list if you want to get more hints on how to write implement your interactive editing plans.
		+
		+	== A More Complete Example ==
		+
		+	Skipping several hundred steps, we get to a working version of the WandTool that you can look at in this repository: https://github.com/pieper/WandEffect