qMRMLLayoutViewFactory.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __qMRMLLayoutViewFactory_h
#define __qMRMLLayoutViewFactory_h

// Qt includes
#include <QStringList>

// CTK includes
#include <ctkLayoutViewFactory.h>
#include <ctkVTKObject.h>

// MRML includes
#include "qMRMLWidgetsExport.h"
class qMRMLLayoutManager;
class qMRMLLayoutViewFactoryPrivate;
class vtkMRMLAbstractViewNode;
class vtkMRMLNode;
class vtkMRMLScene;

// VTK includes
class vtkCollection;
class vtkObject;
class vtkRenderer;

class QMRML_WIDGETS_EXPORT qMRMLLayoutViewFactory : public ctkLayoutViewFactory
{
  Q_OBJECT
  QVTK_OBJECT
  Q_PROPERTY(QString viewClassName READ viewClassName);
public:
  typedef ctkLayoutViewFactory Superclass;

  explicit qMRMLLayoutViewFactory(QObject* parent=nullptr);
  ~qMRMLLayoutViewFactory() override;

  virtual QString viewClassName()const;

  bool isElementSupported(QDomElement layoutElement)const override;

  virtual bool isViewNodeSupported(vtkMRMLAbstractViewNode* viewNode)const;

  Q_INVOKABLE qMRMLLayoutManager* layoutManager()const;

  Q_INVOKABLE void setLayoutManager(qMRMLLayoutManager*);

  Q_INVOKABLE vtkMRMLScene* mrmlScene()const;

  Q_INVOKABLE QWidget* viewWidget(int id)const;
  Q_INVOKABLE QWidget* viewWidget(vtkMRMLAbstractViewNode* node)const;
  Q_INVOKABLE QWidget* viewWidget(const QString& name)const;
  Q_INVOKABLE QWidget* viewWidgetByLayoutLabel(const QString& layoutLabel)const;
  Q_INVOKABLE int viewCount()const;

  void beginSetupLayout() override;

  vtkMRMLAbstractViewNode* viewNode(QWidget* widget)const;

  QStringList viewNodeNames() const;

  void setActiveViewNode(vtkMRMLAbstractViewNode* viewNode);
  vtkMRMLAbstractViewNode* activeViewNode()const;
  virtual vtkRenderer* activeRenderer()const;

public Q_SLOTS:
  virtual void setMRMLScene(vtkMRMLScene* scene);

  virtual void onNodeAdded(vtkObject* scene, vtkObject* node);
  virtual void onNodeRemoved(vtkObject* scene, vtkObject* node);
  virtual void onNodeModified(vtkObject* node);
  virtual void onViewNodeAdded(vtkMRMLAbstractViewNode* node);
  virtual void onViewNodeRemoved(vtkMRMLAbstractViewNode* node);
  virtual void onViewNodeModified(vtkMRMLAbstractViewNode* node);

  virtual void onSceneModified();

Q_SIGNALS:
  void viewCreated(QWidget* createdView);

  void activeViewNodeChanged(vtkMRMLAbstractViewNode*);


protected:
  QScopedPointer<qMRMLLayoutViewFactoryPrivate> d_ptr;

  void setupView(QDomElement viewElement, QWidget* view) override;
  QWidget* createViewFromXML(QDomElement layoutElement) override;
  QList<QWidget*> createViewsFromXML(QDomElement layoutElement) override;

  virtual vtkMRMLAbstractViewNode* viewNodeFromXML(QDomElement viewElement)const;
  virtual QList<vtkMRMLAbstractViewNode*> viewNodesFromXML(QDomElement viewElement)const;

  virtual QWidget* createViewFromNode(vtkMRMLAbstractViewNode* node);
  virtual void deleteView(vtkMRMLAbstractViewNode* node);

private:
  Q_DECLARE_PRIVATE(qMRMLLayoutViewFactory);
  Q_DISABLE_COPY(qMRMLLayoutViewFactory);
};

#endif