qMRMLNodeFactory.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 Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1
 
==============================================================================*/
 
#ifndef __qMRMLNodeFactory_h
#define __qMRMLNodeFactory_h
 
// Qt includes
#include <QObject>
#include <QHash>
 
// CTK includes
#include <ctkPimpl.h>
 
#include "qMRMLWidgetsExport.h"
 
class vtkMRMLNode;
class vtkMRMLScene;
class qMRMLNodeFactoryPrivate;

class QMRML_WIDGETS_EXPORT qMRMLNodeFactory : public QObject
{
  Q_OBJECT
public:
  typedef QHash<QString, QString> AttributeType;

  typedef QObject Superclass;
  explicit qMRMLNodeFactory(QObject* parent = nullptr);
  ~qMRMLNodeFactory() override;

  vtkMRMLScene* mrmlScene() const;

  Q_INVOKABLE vtkMRMLNode* createNode(const QString& className);

  static vtkMRMLNode* createNode(vtkMRMLScene* scene, const QString& className, const AttributeType& attributes = AttributeType());

  Q_INVOKABLE void addAttribute(const QString& attributeName, const QString& attributeValue);
  Q_INVOKABLE void removeAttribute(const QString& attributeName);
  Q_INVOKABLE QString attribute(const QString& attributeName) const;

  Q_INVOKABLE void setBaseName(const QString& className, const QString& baseName);
  Q_INVOKABLE QString baseName(const QString& className) const;
 
public slots:
  void setMRMLScene(vtkMRMLScene* mrmlScene);
 
signals:
  void nodeInstantiated(vtkMRMLNode* node);
  void nodeInitialized(vtkMRMLNode* node);
  void nodeAdded(vtkMRMLNode* node);
 
protected:
  QScopedPointer<qMRMLNodeFactoryPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qMRMLNodeFactory);
  Q_DISABLE_COPY(qMRMLNodeFactory);
};
 
#endif