Slicer3:Loadable Modules:HOWTO - Revision history

Pieper: /* Examples */

2010-04-15T21:25:45Z

Examples

2009-05-18T22:11:41Z

2009-05-08T20:44:46Z

Slicer3 Extension Description

2009-05-08T20:38:41Z

Slicer3 Extension Description

2009-05-08T20:38:25Z

2009-02-28T22:22:30Z

Example

2009-02-28T22:22:01Z

2009-02-27T22:15:08Z

ModuleName.xml

2009-02-27T22:14:39Z

2009-02-27T22:14:07Z

vtkModuleNameGUI

← Older revision		Revision as of 21:25, 15 April 2010
Line 155:		Line 155:

	[http://tinyurl.com/c6e7ab Loadable GUI-less Module]		[http://tinyurl.com/c6e7ab Loadable GUI-less Module]
		+
		+
		+	== Building and testing a loadable module locally ==
		+
		+
		+	1) check out the example and make a build directory
		+
		+	svn checkout https://www.nitrc.org/svn/slicer3examples/trunk/Slicer3ExampleModules/Loadable
		+	mkdir Loadable-build
		+	cd Loadable-build/
		+
		+	2) run the version of cmake that you built with slicer (it's the latest version and may not be installed on your machine)
		+
		+	/csail/vision-polina2/pieper/slicer3/latest/Slicer3-lib/CMake-build/bin/ccmake ../Loadable
		+
		+	(in cmake, confirm that Slicer3_DIR points to your build of slicer's Slicer3-build directory. Press 'c' twice then 'g').
		+
		+	3) make the module
		+
		+	make
		+
		+	4) run your locally built version of slicer
		+
		+	/csail/vision-polina2/pieper/slicer3/latest/Slicer3-build/Slicer3
		+
		+	in the View->Application Settings->Module Settings add the path to the built loadable module (it will be something like /csail/vision-polina2/pieper/slicer3/latest/examples/Loadable-build/lib/Slicer3/Modules)
		+
		+	5) restart slicer and you should see "ExampleLM" in the modules menu.
		+
		+
		+	From here you can edit/modify the example loadable module to make it do what you need to do.

← Older revision		Revision as of 22:11, 18 May 2009
Line 116:		Line 116:

	description An example of a loadable module using Slicer3 GUI and Logic classes, plus a MRML node.		description An example of a loadable module using Slicer3 GUI and Logic classes, plus a MRML node.
		+
		+	== Adding logo to your module ==
		+
		+	To add logo to a C++ loadable module, you can use ''KWConvertImageToHeader'' tool, which is compiled in Slicer3-lib/KWWidgets-build/bin to convert an image to C++ header file. Once you include this file, you can initialize the logo vtkKWIcon as follows:
		+
		+	<pre>
		+	// Logo setup. To prepare the header file with the logo information, use
		+	// KWConvertImageToHeader tool supplied with KWWidgets, with --zlib option.
		+	vtkKWIcon* logo = vtkKWIcon::New();
		+	logo->SetImage(image_bsf_logo,
		+	image_bsf_logo_width, image_bsf_logo_height,
		+	image_bsf_logo_pixel_size, image_bsf_logo_length,
		+	0);
		+	this->Logo = logo;
		+	logo->Delete();
		+	</pre>
		+
		+	Next, you can insert logo into the logo frame in the BuildGUI() method:
		+
		+	<pre>
		+	this->BuildHelpAndAboutFrame(module_page, help_text, ack_text);
		+
		+	// Show the logo
		+	if (this->GetLogo())
		+	{
		+	vtkKWLabel *logoLabel = vtkKWLabel::New();
		+	logoLabel->SetParent( this->GetLogoFrame() );
		+	logoLabel->Create();
		+	logoLabel->SetImageToIcon( this->GetLogo() );
		+	app->Script("pack %s", logoLabel->GetWidgetName() );
		+	logoLabel->Delete();
		+	}
		+	</pre>

	== Examples ==		== Examples ==

@@ Line 100: / Line 100: @@
 == Slicer3 Extension Description ==
-In order to add the module to the extension server, and Slicer3 Extension file needs to be added to /Slicer3/Extensions:
+In order to add the module to the extension server, a Slicer3 Extension file needs to be added to /Slicer3/Extensions:
    scm       svn

@@ Line 106: / Line 106: @@
    svnusername slicerbot
    svnpassword slicer
-−
    depends
-−
    homepage  http://www.nitrc.org/projects/slicer3examples/
-−
    category  Examples
-−
    status    Beta
-−
    description An example of a loadable module using Slicer3 GUI and Logic classes, plus a MRML node.

@@ Line 97: / Line 97: @@
      ARCHIVE DESTINATION ${Slicer3_INSTALL_MODULES_LIB_DIR} COMPONENT Development
+     )
 == Examples ==

@@ Line 98: / Line 98: @@
+     )
-== Example ==
+== Examples ==
-[http://tinyurl.com/53jqbp "Loadable Module"]
+[http://tinyurl.com/53jqbp Loadable Module]
-[http://tinyurl.com/c6e7ab "Loadable GUI-less Module"]
+[http://tinyurl.com/c6e7ab Loadable GUI-less Module]

← Older revision		Revision as of 22:22, 28 February 2009
Line 97:		Line 97:
	ARCHIVE DESTINATION ${Slicer3_INSTALL_MODULES_LIB_DIR} COMPONENT Development		ARCHIVE DESTINATION ${Slicer3_INSTALL_MODULES_LIB_DIR} COMPONENT Development
	)		)
		+
		+	== Example ==
		+
		+	[http://tinyurl.com/53jqbp "Loadable Module"]
		+
		+	[http://tinyurl.com/c6e7ab "Loadable GUI-less Module"]

@@ Line 57: / Line 57: @@
    <GUIName>OpenIGT</GUIName>
-''When creating a GUI-less module, omit the GUIName directive''
+'''When creating a GUI-less module, omit the GUIName directive.'''
 Optionally, other attributes may be listed:
@@ Line 63: / Line 63: @@
    <Description>This is a description of my module.</Description>
    <SourceLocation>https://use/the/source/luke</SourceLocation>
- <HomePage>http://my/module/homepage</HomePage>
+  <HomePage>http://my/module/homepage</HomePage>
    <Version>1.0</Version>
    <Dependency>Module One</Dependency>

@@ Line 34: / Line 34: @@
 == vtkModuleNameLogic ==
 === Optional ===
@@ Line 42: / Line 44: @@
 == ModuleName.xml ==
 Create ModuleName.xml in the module's directory.  ModuleName should follow the naming convention for the *GUI and *Logic classes.
@@ Line 67: / Line 71: @@
 == CMakeLists.txt ==
 Most modules will be defined outside of the main Slicer3 build tree.  To enable your module to be loaded dynamically, a couple entries in CMakeLists.txt are required.

← Older revision		Revision as of 22:14, 27 February 2009
Line 8:		Line 8:

	== vtkModuleNameGUI ==		== vtkModuleNameGUI ==
		+
		+	vtkModuleNameGUI.h/cxx

	'''Do not create this class if you want your module to be GUI-less'''		'''Do not create this class if you want your module to be GUI-less'''