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 "vtkMRMLStorageNode.h"
#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) override;

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

  vtkMRMLNode* CreateNodeInstance() override = 0;

  const char* GetNodeTagName() override = 0;

  void ReadXMLAttributes( const char** atts) override;

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

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

  void Copy(vtkMRMLNode *node) 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();


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

  enum
    {
    DisplayModifiedEvent = 17000,
    };

  virtual void CreateDefaultDisplayNodes();

  virtual void CreateDefaultSequenceDisplayNodes();

  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();

  void SetSelectable(int) override;

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

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

  virtual const char* GetDisplayNodeReferenceMRMLAttributeName();

  void OnNodeReferenceAdded(vtkMRMLNodeReference *reference) override;

  void OnNodeReferenceModified(vtkMRMLNodeReference *reference) override;

  void OnNodeReferenceRemoved(vtkMRMLNodeReference *reference) override;

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

#endif