vtkMRMLSliceCompositeNode.h

Go to the documentation of this file.

/*=auto=========================================================================
 
  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Program:   3D Slicer
  Module:    $RCSfile: vtkMRMLSliceCompositeNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.3 $
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLSliceCompositeNode_h
#define __vtkMRMLSliceCompositeNode_h
 
#include "vtkMRMLNode.h"
 
class vtkMRMLModelNode;
class vtkMRMLSliceDisplayNode;
class vtkMRMLVolumeNode;

class VTK_MRML_EXPORT vtkMRMLSliceCompositeNode : public vtkMRMLNode
{
public:
  static vtkMRMLSliceCompositeNode* New();
  vtkTypeMacro(vtkMRMLSliceCompositeNode, vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes(const char** atts) override;

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

  vtkMRMLCopyContentMacro(vtkMRMLSliceCompositeNode);

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

  const char* GetBackgroundVolumeID();
  void SetBackgroundVolumeID(const char* id);
  void SetReferenceBackgroundVolumeID(const char* id) { this->SetBackgroundVolumeID(id); }

  const char* GetForegroundVolumeID();
  void SetForegroundVolumeID(const char* id);
  void SetReferenceForegroundVolumeID(const char* id) { this->SetForegroundVolumeID(id); }

  const char* GetLabelVolumeID();
  void SetLabelVolumeID(const char* id);
  void SetReferenceLabelVolumeID(const char* id) { this->SetLabelVolumeID(id); }
 
  enum
  {
    LayerNone = -1,
    LayerBackground = 0,
    LayerForeground = 1,
    LayerLabel = 2,
    Layer_Last // must be last
  };
 
  int GetNumberOfAdditionalLayers();

  vtkMRMLVolumeNode* GetNthLayerVolume(int layerIndex);
  void SetNthLayerVolume(int layerIndex, vtkMRMLVolumeNode* volumeNode);

  const char* GetNthLayerVolumeID(int layerIndex);
  void SetNthLayerVolumeID(int layerIndex, const char* volumeNodeID);

  vtkGetMacro(Compositing, int);
  vtkSetMacro(Compositing, int);

  vtkGetMacro(ClipToBackgroundVolume, bool);
  vtkSetMacro(ClipToBackgroundVolume, bool);

  double GetNthLayerOpacity(int layerIndex);
  void SetNthLayerOpacity(int layerIndex, double value);

  double GetForegroundOpacity();
  void SetForegroundOpacity(double value);

  double GetLabelOpacity();
  void SetLabelOpacity(double value);

  vtkGetMacro(LinkedControl, int);
  vtkSetMacro(LinkedControl, int);
  vtkBooleanMacro(LinkedControl, int);

  vtkGetMacro(HotLinkedControl, int);
  vtkSetMacro(HotLinkedControl, int);
  vtkBooleanMacro(HotLinkedControl, int);

  vtkGetMacro(FiducialVisibility, int);
  vtkSetMacro(FiducialVisibility, int);
  vtkGetMacro(FiducialLabelVisibility, int);
  vtkSetMacro(FiducialLabelVisibility, int);

  int GetSliceIntersectionVisibility();
  void SetSliceIntersectionVisibility(int visibility);

  vtkSetMacro(DoPropagateVolumeSelection, bool);
  vtkGetMacro(DoPropagateVolumeSelection, bool);

  void SetLayoutName(const char* layoutName) { this->SetSingletonTag(layoutName); }
  char* GetLayoutName() { return this->GetSingletonTag(); }

  enum
  {
    Alpha = 0,
    ReverseAlpha,
    Add,
    Subtract
  };

  void SetInteracting(int);
  vtkGetMacro(Interacting, int);
  vtkBooleanMacro(Interacting, int);

  enum InteractionFlagType
  {
    None = 0,
    ForegroundVolumeFlag = 1,
    BackgroundVolumeFlag = 2,
    LabelVolumeFlag = 4,
    LabelOpacityFlag = 8,
    ForegroundOpacityFlag = 16
    // Next one needs to be 32
  };

  void SetInteractionFlags(unsigned int);
  vtkGetMacro(InteractionFlags, unsigned int);

  void SetInteractionFlagsModifier(unsigned int);
  vtkGetMacro(InteractionFlagsModifier, unsigned int);

  void ResetInteractionFlagsModifier();
 
protected:
  vtkMRMLSliceCompositeNode();
  ~vtkMRMLSliceCompositeNode() override;
  vtkMRMLSliceCompositeNode(const vtkMRMLSliceCompositeNode&);
  void operator=(const vtkMRMLSliceCompositeNode&);
 
  // Helper functions for deprecated SetSliceIntersectionVisibility/GetSliceIntersectionVisibility methods.
  vtkMRMLSliceDisplayNode* GetSliceDisplayNode();
  std::string GetCompositeNodeIDFromSliceModelNode(vtkMRMLModelNode* sliceModelNode);
 
  // Cached value of last found displayable node (it is expensive to determine it)
  vtkWeakPointer<vtkMRMLSliceDisplayNode> LastFoundSliceDisplayNode;
 
  std::vector<double> LayerOpacities = {
    1.0, // Layer N (Background)
    0.0, // Layer N (Foreground) over layer N-1 (Background): Start by showing only the background volume
    1.0, // Layer N (Label) over layer N-1 (Foreground): Show the label if there is one
  };
 
  int Compositing{ Alpha };
 
  bool ClipToBackgroundVolume{ true };
 
  int LinkedControl{ 0 };
  int HotLinkedControl{ 0 };
 
  int FiducialVisibility{ 1 };
  int FiducialLabelVisibility{ 1 };
 
  bool DoPropagateVolumeSelection{ true };
 
  int Interacting{ 0 };
  unsigned int InteractionFlags{ 0 };
  unsigned int InteractionFlagsModifier{ (unsigned int)-1 };
};
 
#endif