vtkMRMLVolumeRenderingDisplayNode.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: vtkMRMLVolumeRenderingDisplayNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.3 $
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLVolumeRenderingDisplayNode_h
#define __vtkMRMLVolumeRenderingDisplayNode_h
 
// Volume Rendering includes
#include "vtkSlicerVolumeRenderingModuleMRMLExport.h"
 
// MRML includes
#include "vtkMRMLDisplayNode.h"
class vtkIntArray;
class vtkMRMLAnnotationROINode;
class vtkMRMLMarkupsROINode;
class vtkMRMLMessageCollection;
class vtkMRMLShaderPropertyNode;
class vtkMRMLViewNode;
class vtkMRMLVolumeNode;
class vtkMRMLVolumePropertyNode;

class VTK_SLICER_VOLUMERENDERING_MODULE_MRML_EXPORT vtkMRMLVolumeRenderingDisplayNode : public vtkMRMLDisplayNode
{
public:
  vtkTypeMacro(vtkMRMLVolumeRenderingDisplayNode, vtkMRMLDisplayNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ReadXMLAttributes(const char** atts) override;

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

  void Copy(vtkMRMLNode* node) override;
 
  const char* GetVolumeNodeID();
  vtkMRMLVolumeNode* GetVolumeNode();
 
  const char* GetVolumePropertyNodeID();
  void SetAndObserveVolumePropertyNodeID(const char* volumePropertyNodeID);
  vtkMRMLVolumePropertyNode* GetVolumePropertyNode();
 
  const char* GetShaderPropertyNodeID();
  void SetAndObserveShaderPropertyNodeID(const char* shaderPropertyNodeID);
  vtkMRMLShaderPropertyNode* GetShaderPropertyNode();
  vtkMRMLShaderPropertyNode* GetOrCreateShaderPropertyNode(vtkMRMLScene* mrmlScene);
 
  const char* GetROINodeID();
  void SetAndObserveROINodeID(const char* roiNodeID);
  vtkMRMLDisplayableNode* GetROINode();
  vtkMRMLAnnotationROINode* GetAnnotationROINode() { return nullptr; };
  vtkMRMLMarkupsROINode* GetMarkupsROINode();
 
  vtkMRMLViewNode* GetFirstViewNode();
 
  double GetSampleDistance();
 
  vtkSetMacro(CroppingEnabled, int);
  vtkGetMacro(CroppingEnabled, int);
  vtkBooleanMacro(CroppingEnabled, int);
 
  vtkSetVector2Macro(Threshold, double);
  vtkGetVectorMacro(Threshold, double, 2);
 
  vtkGetMacro(FollowVolumeDisplayNode, int);
  vtkSetMacro(FollowVolumeDisplayNode, int);
 
  vtkGetMacro(IgnoreVolumeDisplayNodeThreshold, int);
  vtkSetMacro(IgnoreVolumeDisplayNodeThreshold, int);
 
  vtkGetMacro(UseSingleVolumeProperty, int);
  vtkSetMacro(UseSingleVolumeProperty, int);
 
  vtkSetVector2Macro(WindowLevel, double);
  vtkGetVectorMacro(WindowLevel, double, 2);


  vtkSetClampMacro(ClippingSoftEdgeVoxels, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(ClippingSoftEdgeVoxels, double);


  vtkSetMacro(ClippingBlankVoxelValue, double);
  vtkGetMacro(ClippingBlankVoxelValue, double);


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


  bool IsFastClippingAvailable(vtkMRMLMessageCollection* userMessages = nullptr);
 
protected:
  vtkMRMLVolumeRenderingDisplayNode();
  ~vtkMRMLVolumeRenderingDisplayNode() override;
  vtkMRMLVolumeRenderingDisplayNode(const vtkMRMLVolumeRenderingDisplayNode&);
  void operator=(const vtkMRMLVolumeRenderingDisplayNode&);
 
  void ProcessMRMLEvents(vtkObject* caller, unsigned long event, void* callData) override;

  static bool IsFastClippingAvailable(vtkMRMLClipNode* clipNode, vtkMRMLMessageCollection* userMessages = nullptr);
 
  static const char* VolumePropertyNodeReferenceRole;
  static const char* VolumePropertyNodeReferenceMRMLAttributeName;
  static const char* ROINodeReferenceRole;
  static const char* ROINodeReferenceMRMLAttributeName;
  static const char* ShaderPropertyNodeReferenceRole;
  static const char* ShaderPropertyNodeReferenceMRMLAttributeName;
 
protected:
  int CroppingEnabled;
 
  double Threshold[2];

  int FollowVolumeDisplayNode;
  int IgnoreVolumeDisplayNodeThreshold;
 
  int UseSingleVolumeProperty;

  double WindowLevel[2];
 
  double ClippingSoftEdgeVoxels{ 0.0 };
 
  double ClippingBlankVoxelValue{ 0.0 };
  bool AutoClippingBlankVoxelValue{ true };
};
 
#endif