qSlicerMarkupsModule.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Portions (c) Copyright Brigham and Women's Hospital (BWH) All Rights Reserved.

  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.

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

#ifndef __qSlicerMarkupsModule_h
#define __qSlicerMarkupsModule_h

// Slicer includes
#include "qSlicerLoadableModule.h"

#include "qSlicerMarkupsModuleExport.h"

class qSlicerMarkupsModulePrivate;
class vtkMRMLMarkupsDisplayNode;

class Q_SLICER_QTMODULES_MARKUPS_EXPORT qSlicerMarkupsModule :
  public qSlicerLoadableModule
{
  Q_OBJECT
  Q_PLUGIN_METADATA(IID "org.slicer.modules.loadable.qSlicerLoadableModule/1.0");
  Q_INTERFACES(qSlicerLoadableModule);

public:

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

  qSlicerGetTitleMacro(QTMODULE_TITLE);

  QString helpText()const override;

  QString acknowledgementText()const override;

  QStringList  contributors()const override;

  QIcon icon()const override;

  QStringList categories()const override;

  QStringList associatedNodeTypes()const override;

  void setMRMLScene(vtkMRMLScene* scene) override;

  static void readDefaultMarkupsDisplaySettings(vtkMRMLMarkupsDisplayNode* markupsDisplayNode);
  static void writeDefaultMarkupsDisplaySettings(vtkMRMLMarkupsDisplayNode* markupsDisplayNode);

protected:

  void setup() override;

  qSlicerAbstractModuleRepresentation * createWidgetRepresentation() override;

  vtkMRMLAbstractLogic* createLogic() override;

  QScopedPointer<qSlicerMarkupsModulePrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerMarkupsModule);
  Q_DISABLE_COPY(qSlicerMarkupsModule);

};

#endif