qSlicerSubjectHierarchyVolumesPlugin.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. 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.

  This file was originally developed by Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care

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

#ifndef __qSlicerSubjectHierarchyVolumesPlugin_h
#define __qSlicerSubjectHierarchyVolumesPlugin_h

// SubjectHierarchy includes
#include "qSlicerSubjectHierarchyAbstractPlugin.h"

#include "qSlicerVolumesSubjectHierarchyPluginsExport.h"

// Slicer includes
#include "vtkMRMLApplicationLogic.h"

// CTK includes
#include <ctkVTKObject.h>

class qSlicerSubjectHierarchyVolumesPluginPrivate;
class vtkMRMLScalarVolumeNode;

// Due to some reason the Python wrapping of this class fails, therefore
// put everything between BTX/ETX to exclude from wrapping.
// TODO investigate why the wrapping fails:
//   https://www.assembla.com/spaces/slicerrt/tickets/210-python-wrapping-error-when-starting-up-slicer-with-slicerrt
//BTX

class Q_SLICER_VOLUMES_SUBJECT_HIERARCHY_PLUGINS_EXPORT qSlicerSubjectHierarchyVolumesPlugin : public qSlicerSubjectHierarchyAbstractPlugin
{
public:
  Q_OBJECT
  QVTK_OBJECT

public:
  typedef qSlicerSubjectHierarchyAbstractPlugin Superclass;
  qSlicerSubjectHierarchyVolumesPlugin(QObject* parent = NULL);
  virtual ~qSlicerSubjectHierarchyVolumesPlugin();

public:
  virtual double canAddNodeToSubjectHierarchy(
    vtkMRMLNode* node,
    vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID )const;

  virtual double canOwnSubjectHierarchyItem(vtkIdType itemID)const;

  Q_INVOKABLE virtual const QString roleForPlugin()const;

  virtual QIcon icon(vtkIdType itemID);

  virtual QIcon visibilityIcon(int visible);

  virtual QString tooltip(vtkIdType itemID)const;

  virtual void setDisplayVisibility(vtkIdType itemID, int visible);

  virtual int getDisplayVisibility(vtkIdType itemID)const;

  virtual QList<QAction*> itemContextMenuActions()const;

  virtual void showContextMenuActionsForItem(vtkIdType itemID);

public:
  void showVolumeInAllViews(vtkMRMLScalarVolumeNode* node, int layer=vtkMRMLApplicationLogic::BackgroundLayer);

  void hideVolumeFromAllViews(vtkMRMLScalarVolumeNode* node);

  void collectShownVolumes( QSet<vtkIdType>& shownVolumeItemIDs,
    int layer=vtkMRMLApplicationLogic::BackgroundLayer | vtkMRMLApplicationLogic::ForegroundLayer | vtkMRMLApplicationLogic::LabelLayer )const;

protected slots:
  void showVolumesInBranch();

  void onLayoutChanged();
  void onLayoutChanged(int layout);

  void onSliceCompositeNodeModified();

protected:
  QScopedPointer<qSlicerSubjectHierarchyVolumesPluginPrivate> d_ptr;

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

//ETX

#endif