Documentation/Nightly/Developers/Layouts - Revision history

Davide: /* Example */

2016-06-08T20:12:35Z

Example

Davide: /* View XML elements */

2016-06-08T20:06:56Z

View XML elements

Davide: /* View XML elements */

2016-06-08T20:06:34Z

View XML elements

Davide: /* Example */

2016-06-08T20:02:08Z

Example

Davide: /* Example */

2016-06-08T20:01:17Z

Example

Davide: /* How to register a new layout ? */

2016-06-08T19:58:05Z

How to register a new layout ?

JChris.FillionR at 15:57, 8 June 2016

2016-06-08T15:57:26Z

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

2013-06-14T07:56:13Z

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

Finetjul: /* Main classes */

2013-02-28T19:30:18Z

Main classes

Finetjul: Structure of the documentation

2013-02-28T18:56:07Z

Structure of the documentation

New page

=Layout=
== Main classes ==
* <code>vtkMRMLLayoutNode</code>
* <code>vtkMRMLLayoutLogic</code>
* <code>vtkMRMLAbstractViewNode</code>
* <code>ctkLayoutManager</code>
* <code>qMRMLLayoutManager</code>
* <code>qSlicerLayoutManager</code>

==Layout mechanism==

==How to change the layout ?==

==How to register a new layout ?==

== View XML elements ==

== Example ==

@@ Line 41: / Line 41: @@
 == Example ==
-Example of CustomLayout
+Example of qSlicerCustomLayoutSliceViewFactory:
 <pre>

@@ Line 37: / Line 37: @@
 </pre>
-Layout Description can be modified using the SetLayoutDescription method
+Layout descriptions can be modified using the SetLayoutDescription method
 == Example ==

← Older revision		Revision as of 20:06, 8 June 2016
Line 30:		Line 30:

	== View XML elements ==		== View XML elements ==
		+
		+	<pre>
		+	vtkMRMLLayoutNode* layoutNode = vtkMRMLLayoutNode::SafeDownCast(
		+	this->mrmlScene()->GetSingletonNode("vtkMRMLLayoutNode","vtkMRMLLayoutNode"));
		+	std::string layoutDescription = layoutNode->GetLayoutDescription(index);
		+	</pre>
		+
		+	Layout Description can be modified using the SetLayoutDescription method

	== Example ==		== Example ==

@@ Line 75: / Line 75: @@
 </pre>
 //-----------------------------------------------------------------------------
 qSlicerAstroVolumeLayoutSliceViewFactory::qSlicerAstroVolumeLayoutSliceViewFactory(QObject* _parent)
@@ Line 134: / Line 136: @@
    return "vtkMRMLSliceNode";
+}
 </pre>

← Older revision		Revision as of 20:01, 8 June 2016
Line 32:		Line 32:

	== Example ==		== Example ==
		+
		+	Example of CustomLayout
		+
		+	<pre>
		+	#ifndef __qSlicerAstroVolumeLayoutSliceViewFactory_h
		+	#define __qSlicerAstroVolumeLayoutSliceViewFactory_h
		+
		+	// SlicerQt includes
		+	#include "qMRMLLayoutManager.h"
		+	#include "qMRMLLayoutManager_p.h"
		+
		+	// VTK includes
		+	#include <vtkWeakPointer.h>
		+
		+	#include "qSlicerAstroVolumeModuleExport.h"
		+
		+	class qSlicerAstroVolumeLayoutSliceViewFactoryPrivate;
		+
		+	/// \ingroup Slicer_QtModules_AstroVolume
		+	class Q_SLICER_QTMODULES_ASTROVOLUME_EXPORT qSlicerAstroVolumeLayoutSliceViewFactory
		+	: public qMRMLLayoutSliceViewFactory
		+	{
		+	Q_OBJECT
		+	public:
		+	typedef qMRMLLayoutSliceViewFactory Superclass;
		+	qSlicerAstroVolumeLayoutSliceViewFactory(QObject* parent);
		+	virtual ~qSlicerAstroVolumeLayoutSliceViewFactory();
		+
		+	virtual QString viewClassName()const;
		+
		+	protected:
		+
		+	virtual QWidget* createViewFromNode(vtkMRMLAbstractViewNode* viewNode);
		+	virtual void deleteView(vtkMRMLAbstractViewNode* viewNode);
		+
		+	private:
		+	Q_DECLARE_PRIVATE(qSlicerAstroVolumeLayoutSliceViewFactory);
		+	Q_DISABLE_COPY(qSlicerAstroVolumeLayoutSliceViewFactory);
		+	};
		+
		+	#endif
		+	</pre>
		+
		+	//-----------------------------------------------------------------------------
		+	qSlicerAstroVolumeLayoutSliceViewFactory::qSlicerAstroVolumeLayoutSliceViewFactory(QObject* _parent)
		+	: Superclass(_parent)
		+	{
		+	}
		+
		+	//-----------------------------------------------------------------------------
		+	qSlicerAstroVolumeLayoutSliceViewFactory::~qSlicerAstroVolumeLayoutSliceViewFactory()
		+	{
		+	}
		+
		+	//-----------------------------------------------------------------------------
		+	QWidget* qSlicerAstroVolumeLayoutSliceViewFactory::createViewFromNode(vtkMRMLAbstractViewNode* viewNode)
		+	{
		+	if (!this->layoutManager() \|\| !viewNode)
		+	{// can't create a slice widget if there is no parent widget
		+	Q_ASSERT(viewNode);
		+	return 0;
		+	}
		+
		+	// there is a unique slice widget per node
		+	Q_ASSERT(!this->viewWidget(viewNode));
		+
		+	qMRMLSliceAstroWidget * sliceWidget = new qMRMLSliceAstroWidget(this->layoutManager()->viewport());
		+	sliceWidget->sliceController()->setControllerButtonGroup(this->SliceControllerButtonGroup);
		+	QString sliceLayoutName(viewNode->GetLayoutName());
		+	QString sliceViewLabel(viewNode->GetLayoutLabel());
		+	vtkMRMLSliceNode* sliceNode = vtkMRMLSliceNode::SafeDownCast(viewNode);
		+	QColor sliceLayoutColor = QColor::fromRgbF(sliceNode->GetLayoutColor()[0],
		+	sliceNode->GetLayoutColor()[1],
		+	sliceNode->GetLayoutColor()[2]);
		+	sliceWidget->setSliceViewName(sliceLayoutName);
		+	sliceWidget->setObjectName(QString("qMRMLSliceWidget" + sliceLayoutName));
		+	sliceWidget->setSliceViewLabel(sliceViewLabel);
		+	sliceWidget->setSliceViewColor(sliceLayoutColor);
		+	sliceWidget->setMRMLScene(this->mrmlScene());
		+	sliceWidget->setMRMLSliceNode(sliceNode);
		+	sliceWidget->setSliceLogics(this->sliceLogics());
		+
		+	this->sliceLogics()->AddItem(sliceWidget->sliceLogic());
		+
		+	return sliceWidget;
		+	}
		+
		+	void qSlicerAstroVolumeLayoutSliceViewFactory::deleteView(vtkMRMLAbstractViewNode *viewNode)
		+	{
		+	qMRMLSliceAstroWidget* sliceWidget =
		+	qobject_cast<qMRMLSliceAstroWidget*>(this->viewWidget(viewNode));
		+	if (sliceWidget)
		+	{
		+	this->sliceLogics()->RemoveItem(sliceWidget->sliceLogic());
		+	}
		+	this->Superclass::deleteView(viewNode);
		+	}
		+
		+	QString qSlicerAstroVolumeLayoutSliceViewFactory::viewClassName() const
		+	{
		+	return "vtkMRMLSliceNode";
		+	}
		+
		+	<pre>
		+
		+	</pre>

@@ Line 14: / Line 14: @@
 ==How to register a new layout ?==
 == View XML elements ==
 == Example ==

@@ Line 2: / Line 2: @@
 =Layout=
 == Main classes ==
-* <code>[http://slicer.org/doc/html/classvtkMRMLLayoutNode.html vtkMRMLLayoutNode]</code>: Node that describes the layout of the views. There is only one layout node in the scene (singleton)
+* [{{doxygen-class-url|vtkMRMLLayoutNode}}#details vtkMRMLLayoutNode]: Node that describes the layout of the views. There is only one layout node in the scene (singleton)
-* <code>[http://slicer.org/doc/html/classvtkMRMLLayoutLogic.html vtkMRMLLayoutLogic]</code>: Control/observe the layout node. Automatically create the view nodes if needed (referenced in the layout node description but not in the scene).
+* [{{doxygen-class-url|vtkMRMLLayoutLogic}}#details vtkMRMLLayoutLogic]: Control/observe the layout node. Automatically create the view nodes if needed (referenced in the layout node description but not in the scene).
-* <code>[http://slicer.org/doc/html/classvtkMRMLAbstractViewNode.html vtkMRMLAbstractViewNode]</code>: Abstract class for all the view nodes (such as [http://slicer.org/doc/html/classvtkMRMLSliceNode.html vtkMRMLSliceNode], [http://slicer.org/doc/html/classvtkMRMLViewNode.html vtkMRMLViewNode], [http://slicer.org/doc/html/classvtkMRMLChartViewNode.html vtkMRMLChartViewNode]) that can be into a layout.
+* [{{doxygen-class-url|vtkMRMLAbstractViewNode}}#details vtkMRMLAbstractViewNode]: Abstract class for all the view nodes (such as [{{doxygen-class-url|vtkMRMLSliceNode}}#details vtkMRMLSliceNode], [{{doxygen-class-url|vtkMRMLViewNode}}#details vtkMRMLViewNode], [{{doxygen-class-url|vtkMRMLChartViewNode}}#details vtkMRMLChartViewNode]) that can be into a layout.
 * <code>[http://www.commontk.org/docs/html/classctkLayoutManager.html ctkLayoutManager]</code>: Mechanism to convert the layout description (xml) into a Qt layout with Qt widgets.
-* <code>[http://slicer.org/doc/html/classqMRMLLayoutManager.html qMRMLLayoutManager]</code>: Specialized version of ctkLayoutManager to handle MRML only views and properties.
+* [{{doxygen-class-url|qMRMLLayoutManager}}#details qMRMLLayoutManager]: Specialized version of ctkLayoutManager to handle MRML only views and properties.
-* <code>[http://slicer.org/doc/html/classqSlicerLayoutManager.html qSlicerLayoutManager]</code>: Specialized version of qMRMLLayoutManager to handle Slicer specific behaviors. The Slicer layout manager is accessible from the [http://slicer.org/doc/html/classqSlicerApplication.html qSlicerApplication] singleton.
+* [{{doxygen-class-url|qSlicerLayoutManager}}#details qSlicerLayoutManager]: Specialized version of qMRMLLayoutManager to handle Slicer specific behaviors. The Slicer layout manager is accessible from the [{{doxygen-class-url|qSlicerApplication}}#details qSlicerApplication] singleton.
 ==Layout mechanism==

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