qMRMLLayoutManager.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 __qMRMLLayoutManager_h
#define __qMRMLLayoutManager_h
 
// Qt includes
#include <QStringList>
class QWidget;
 
// CTK includes
#include <ctkLayoutFactory.h>
 
// qMRML includes
#include "qMRMLWidgetsExport.h"
#include "qMRMLLayoutViewFactory.h"
 
class qMRMLPlotWidget;
class qMRMLTableWidget;
class qMRMLThreeDWidget;
class qMRMLSliceWidget;
class qMRMLLayoutManagerPrivate;
class qMRMLLayoutViewFactory;
 
class vtkMRMLAbstractViewNode;
class vtkMRMLColorLogic;
class vtkMRMLLayoutLogic;
class vtkMRMLScene;
class vtkMRMLNode;
class vtkMRMLTableNode;
class vtkMRMLTableViewNode;
class vtkMRMLViewNode;
class vtkMRMLPlotViewNode;
 
class vtkCollection;
class vtkRenderer;

class QMRML_WIDGETS_EXPORT qMRMLLayoutManager : public ctkLayoutFactory
{
  Q_OBJECT

  Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled)
  // The following properties are exposed so that they are available within python
  Q_PROPERTY(int layout READ layout WRITE setLayout NOTIFY layoutChanged DESIGNABLE false)
  Q_PROPERTY(int threeDViewCount READ threeDViewCount DESIGNABLE false)
  Q_PROPERTY(int tableViewCount READ tableViewCount DESIGNABLE false)
  Q_PROPERTY(int plotViewCount READ plotViewCount DESIGNABLE false)
 
public:
  typedef ctkLayoutFactory Superclass;

  explicit qMRMLLayoutManager(QObject* parent = nullptr);
  explicit qMRMLLayoutManager(QWidget* viewport, QObject* parent);
  ~qMRMLLayoutManager() override;

  bool isEnabled() const;

  Q_INVOKABLE virtual void registerViewFactory(ctkLayoutViewFactory* viewFactory);

  Q_INVOKABLE QList<qMRMLLayoutViewFactory*> mrmlViewFactories() const;

  Q_INVOKABLE qMRMLLayoutViewFactory* mrmlViewFactory(const QString& viewClassName) const;

  Q_INVOKABLE vtkMRMLScene* mrmlScene() const;

  Q_INVOKABLE QWidget* viewWidget(vtkMRMLNode* n) const;

  Q_INVOKABLE QList<QWidget*> viewWidgets() const;

  Q_INVOKABLE qMRMLSliceWidget* sliceWidget(const QString& name) const;

  Q_INVOKABLE qMRMLThreeDWidget* threeDWidget(const QString& name) const;

  Q_INVOKABLE QStringList sliceViewNames() const;

  int threeDViewCount() const;
  int tableViewCount() const;
  int plotViewCount() const;
  int viewCount() const;

  Q_INVOKABLE qMRMLThreeDWidget* threeDWidget(int id) const;
  Q_INVOKABLE qMRMLTableWidget* tableWidget(int id) const;
  Q_INVOKABLE qMRMLPlotWidget* plotWidget(int id) const;

  Q_INVOKABLE vtkCollection* mrmlSliceLogics() const;

  Q_INVOKABLE vtkCollection* mrmlViewLogics() const;
 
  Q_INVOKABLE void setMRMLColorLogic(vtkMRMLColorLogic* colorLogic);
  Q_INVOKABLE vtkMRMLColorLogic* mrmlColorLogic() const;

  int layout() const;

  Q_INVOKABLE vtkMRMLLayoutLogic* layoutLogic() const;

  Q_INVOKABLE vtkMRMLViewNode* activeMRMLThreeDViewNode() const;
  Q_INVOKABLE vtkRenderer* activeThreeDRenderer() const;
  Q_INVOKABLE vtkMRMLTableViewNode* activeMRMLTableViewNode() const;
  Q_INVOKABLE vtkRenderer* activeTableRenderer() const;
  Q_INVOKABLE vtkMRMLPlotViewNode* activeMRMLPlotViewNode() const;
  Q_INVOKABLE vtkRenderer* activePlotRenderer() const;

  int allViewsPauseRenderCount();
 
public slots:
  void setEnabled(bool enable);

  void setMRMLScene(vtkMRMLScene* scene);

  void setLayout(int newLayout);

  void addMaximizedViewNode(vtkMRMLAbstractViewNode* viewNode);

  void removeMaximizedViewNode(vtkMRMLAbstractViewNode* viewNode);

  void removeAllMaximizedViewNodes();

  void setLayoutNumberOfCompareViewRows(int num);
  void setLayoutNumberOfCompareViewColumns(int num);

  void resetThreeDViews();

  void resetSliceViews();

  void setRenderPaused(bool pause);

  void pauseRender();

  void resumeRender();
 
signals:
  void activeMRMLThreeDViewNodeChanged(vtkMRMLViewNode* newActiveMRMLThreeDViewNode);
  void activeMRMLTableViewNodeChanged(vtkMRMLTableViewNode* newActiveMRMLTableViewNode);
  void activeMRMLPlotViewNodeChanged(vtkMRMLPlotViewNode* newActiveMRMLPlotViewNode);
  void activeThreeDRendererChanged(vtkRenderer* newRenderer);
  void activeTableRendererChanged(vtkRenderer* newRenderer);
  void activePlotRendererChanged(vtkRenderer* newRenderer);
  void layoutChanged(int);

  void nodeAboutToBeEdited(vtkMRMLNode* node);
 
protected:
  QScopedPointer<qMRMLLayoutManagerPrivate> d_ptr;
  qMRMLLayoutManager(qMRMLLayoutManagerPrivate* obj, QWidget* viewport, QObject* parent);
 
  QWidget* createViewport(const QDomElement& layoutElement, const QString& viewportName) override;
  void onViewportChanged() override;
  void onViewportUsageChanged(const QString& viewportName) override;
 
  using ctkLayoutManager::setLayout;
 
private:
  Q_DECLARE_PRIVATE(qMRMLLayoutManager);
  Q_DISABLE_COPY(qMRMLLayoutManager);
};
 
#endif