vtkMRMLSegmentEditorNode.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 __vtkMRMLSegmentEditorNode_h
#define __vtkMRMLSegmentEditorNode_h

// MRML includes
#include <vtkMRMLNode.h>

// Segmentations includes
#include "vtkSlicerSegmentationsModuleMRMLExport.h"

#include "vtkOrientedImageData.h"

class vtkMRMLScene;
class vtkMRMLScalarVolumeNode;
class vtkMRMLSegmentationNode;

class VTK_SLICER_SEGMENTATIONS_MODULE_MRML_EXPORT vtkMRMLSegmentEditorNode : public vtkMRMLNode
{
public:
  enum
    {
    EffectParameterModified = 62200
    };

  enum
    {
    PaintAllowedEverywhere=0,
    PaintAllowedInsideAllSegments,
    PaintAllowedInsideVisibleSegments,
    PaintAllowedOutsideAllSegments,
    PaintAllowedOutsideVisibleSegments,
    PaintAllowedInsideSingleSegment,
    // Insert valid types above this line
    PaintAllowed_Last
    };

  enum
    {
    OverwriteAllSegments=0,
    OverwriteVisibleSegments,
    OverwriteNone,
    // Insert valid types above this line
    Overwrite_Last
    };

public:
  static vtkMRMLSegmentEditorNode *New();
  vtkTypeMacro(vtkMRMLSegmentEditorNode, vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes( const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  void Copy(vtkMRMLNode *node) override;

  const char* GetNodeTagName() override { return "SegmentEditor"; }

  static int ConvertOverwriteModeFromString(const char* modeStr);
  static const char* ConvertOverwriteModeToString(int mode);
  static const char* ConvertMaskModeToString(int mode);
  static int ConvertMaskModeFromString(const char* modeStr);

public:

  vtkMRMLScalarVolumeNode* GetMasterVolumeNode();
  void SetAndObserveMasterVolumeNode(vtkMRMLScalarVolumeNode* node);

  vtkMRMLSegmentationNode* GetSegmentationNode();
  void SetAndObserveSegmentationNode(vtkMRMLSegmentationNode* node);

  vtkGetStringMacro(SelectedSegmentID);
  vtkSetStringMacro(SelectedSegmentID);

  vtkGetStringMacro(ActiveEffectName);
  vtkSetStringMacro(ActiveEffectName);

  vtkSetMacro(MaskMode, int);
  vtkGetMacro(MaskMode, int);

  vtkGetStringMacro(MaskSegmentID);
  vtkSetStringMacro(MaskSegmentID);

  vtkBooleanMacro(MasterVolumeIntensityMask, bool);
  vtkGetMacro(MasterVolumeIntensityMask, bool);
  vtkSetMacro(MasterVolumeIntensityMask, bool);

  vtkSetVector2Macro(MasterVolumeIntensityMaskRange, double);
  vtkGetVector2Macro(MasterVolumeIntensityMaskRange, double);

  vtkSetMacro(OverwriteMode, int);
  vtkGetMacro(OverwriteMode, int);

protected:
  vtkMRMLSegmentEditorNode();
  ~vtkMRMLSegmentEditorNode() override;
  vtkMRMLSegmentEditorNode(const vtkMRMLSegmentEditorNode&);
  void operator=(const vtkMRMLSegmentEditorNode&);

  char* SelectedSegmentID{nullptr};

  char* ActiveEffectName{nullptr};

  int MaskMode{PaintAllowedEverywhere};
  char* MaskSegmentID{nullptr};

  int OverwriteMode{OverwriteAllSegments};

  bool MasterVolumeIntensityMask{false};
  double MasterVolumeIntensityMaskRange[2];
};

#endif // __vtkMRMLSegmentEditorNode_h