vtkMRMLDisplayableNode.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: vtkMRMLDisplayableNode.h,v $
  Date:      $Date: 2006/03/19 17:12:28 $
  Version:   $Revision: 1.6 $

=========================================================================auto=*/

#ifndef __vtkMRMLDisplayableNode_h
#define __vtkMRMLDisplayableNode_h

// MRML includes
#include "vtkMRMLTransformableNode.h"
class vtkMRMLDisplayNode;

// STD includes
#include <vector>


class vtkMRMLDisplayNode;

class VTK_MRML_EXPORT vtkMRMLDisplayableNode : public vtkMRMLTransformableNode
{
public:
  vtkTypeMacro(vtkMRMLDisplayableNode,vtkMRMLTransformableNode);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------

  virtual vtkMRMLNode* CreateNodeInstance() VTK_OVERRIDE = 0;

  virtual const char* GetNodeTagName() VTK_OVERRIDE = 0;

  virtual void ReadXMLAttributes( const char** atts) VTK_OVERRIDE;

  virtual void WriteXML(ostream& of, int indent) VTK_OVERRIDE;

  virtual void WriteCLI(std::vector<std::string>& vtkNotUsed(commandLine),
                        std::string vtkNotUsed(prefix),
                        int vtkNotUsed(coordinateSystemFlag) = 0,
                        int vtkNotUsed(multipleFlag) = 1) {};

  virtual void Copy(vtkMRMLNode *node) VTK_OVERRIDE;

  void SetAndObserveDisplayNodeID(const char *displayNodeID);

  void AddAndObserveDisplayNodeID(const char *displayNodeID);

  void RemoveNthDisplayNodeID(int n);

  void RemoveAllDisplayNodeIDs();

  void SetAndObserveNthDisplayNodeID(int n, const char *displayNodeID);

  bool HasDisplayNodeID(const char* displayNodeID);

  int GetNumberOfDisplayNodes();

  const char *GetNthDisplayNodeID(int n);

  const char *GetDisplayNodeID();

  vtkMRMLDisplayNode* GetNthDisplayNode(int n);

  vtkMRMLDisplayNode* GetDisplayNode();


  virtual void ProcessMRMLEvents ( vtkObject * /*caller*/,
                                   unsigned long /*event*/,
                                   void * /*callData*/ ) VTK_OVERRIDE;

  enum
    {
    DisplayModifiedEvent = 17000,
    };

  virtual void CreateDefaultDisplayNodes();

  virtual int GetDisplayVisibility();
  virtual void SetDisplayVisibility(int visible);

  virtual int GetDisplayClassVisibility(const char* nodeClass);
  virtual void SetDisplayClassVisibility(const char* nodeClass, int visible);

  virtual void GetRASBounds(double bounds[6]);

  virtual void GetBounds(double bounds[6]);

  virtual const char* GetDisplayNodeReferenceRole();

 protected:
  vtkMRMLDisplayableNode();
  ~vtkMRMLDisplayableNode();
  vtkMRMLDisplayableNode(const vtkMRMLDisplayableNode&);
  void operator=(const vtkMRMLDisplayableNode&);

  static const char* DisplayNodeReferenceRole;
  static const char* DisplayNodeReferenceMRMLAttributeName;

  virtual const char* GetDisplayNodeReferenceMRMLAttributeName();

  virtual void OnNodeReferenceAdded(vtkMRMLNodeReference *reference) VTK_OVERRIDE;

  virtual void OnNodeReferenceModified(vtkMRMLNodeReference *reference) VTK_OVERRIDE;

  virtual void OnNodeReferenceRemoved(vtkMRMLNodeReference *reference) VTK_OVERRIDE;

 private:

  std::vector<vtkMRMLDisplayNode *> DisplayNodes;
};

#endif