vtkMRMLSceneViewNode.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: vtkMRMLSceneViewNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.13 $
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLSceneViewNode_h
#define __vtkMRMLSceneViewNode_h
 
#include "vtkMRMLStorableNode.h"
 
// VTK includes
class vtkCollection;
class vtkImageData;
 
// STD includes
#include <string>
 
class vtkMRMLStorageNode;
class VTK_MRML_EXPORT vtkMRMLSceneViewNode : public vtkMRMLStorableNode
{
public:
  static vtkMRMLSceneViewNode* New();
  vtkTypeMacro(vtkMRMLSceneViewNode, vtkMRMLStorableNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkMRMLNode* CreateNodeInstance() override;
 
  void SetScene(vtkMRMLScene* scene) override;

  void ReadXMLAttributes(const char** atts) override;

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

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

  void Copy(vtkMRMLNode* node) override;

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

  void UpdateScene(vtkMRMLScene* scene) override;

  virtual void UpdateStoredScene();

  void ProcessChildNode(vtkMRMLNode* node) override;

  vtkMRMLScene* GetStoredScene();

  void StoreScene();

  void AddMissingNodes();

  bool RestoreScene(bool removeNodes = true);
 
  void SetAbsentStorageFileNames();

  void SetSceneViewDescription(const std::string& newDescription);
  vtkGetMacro(SceneViewDescription, std::string);

  virtual void SetScreenShot(vtkImageData* newScreenShot);
  vtkGetObjectMacro(ScreenShot, vtkImageData);

  // TODO use an enum for the types
  virtual void SetScreenShotType(int type);
  vtkGetMacro(ScreenShotType, int);

  vtkMRMLStorageNode* CreateDefaultStorageNode() override;

  int GetNodesByClass(const char* className, std::vector<vtkMRMLNode*>& nodes);
  vtkCollection* GetNodesByClass(const char* className);

  bool IncludeNodeInSceneView(vtkMRMLNode* node);
 
  void SetSceneViewRootDir(const char* name);
 
protected:
  vtkMRMLSceneViewNode();
  ~vtkMRMLSceneViewNode() override;
  vtkMRMLSceneViewNode(const vtkMRMLSceneViewNode&);
  void operator=(const vtkMRMLSceneViewNode&);
 
  vtkMRMLScene* SnapshotScene;

  std::string SceneViewDescription;

  vtkImageData* ScreenShot;

  int ScreenShotType;
};
 
#endif