vtkMRMLLayoutNode.h

Go to the documentation of this file.

#ifndef __vtkMRMLLayoutNode_h
#define __vtkMRMLLayoutNode_h

// MRML includes
#include "vtkMRMLNode.h"

class vtkXMLDataElement;

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

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

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

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

  virtual void Copy(vtkMRMLNode *node) VTK_OVERRIDE;

  vtkGetMacro (ViewArrangement, int );
  virtual void SetViewArrangement ( int );

  vtkGetMacro (GUIPanelVisibility, int);
  vtkSetMacro (GUIPanelVisibility, int);

  vtkGetMacro ( BottomPanelVisibility, int );
  vtkSetMacro (BottomPanelVisibility, int );

  vtkGetMacro (GUIPanelLR, int );
  vtkSetMacro (GUIPanelLR, int );

  vtkGetMacro (CollapseSliceControllers, int);
  vtkSetMacro (CollapseSliceControllers, int);

  vtkGetMacro ( NumberOfCompareViewRows, int );
  vtkSetClampMacro ( NumberOfCompareViewRows, int, 1, 50);
  vtkGetMacro ( NumberOfCompareViewColumns, int );
  vtkSetClampMacro ( NumberOfCompareViewColumns, int, 1, 50 );

  vtkGetMacro ( NumberOfCompareViewLightboxRows, int );
  vtkSetClampMacro ( NumberOfCompareViewLightboxRows, int, 1, 50 );
  vtkGetMacro ( NumberOfCompareViewLightboxColumns, int );
  vtkSetClampMacro ( NumberOfCompareViewLightboxColumns, int, 1, 50 );

  vtkGetMacro( MainPanelSize, int);
  vtkSetMacro( MainPanelSize, int);
  vtkGetMacro( SecondaryPanelSize, int);
  vtkSetMacro( SecondaryPanelSize, int);

  vtkGetStringMacro( SelectedModule);
  vtkSetStringMacro( SelectedModule);

  virtual const char* GetNodeTagName() VTK_OVERRIDE {return "Layout";}

  enum SlicerLayout
    {
      SlicerLayoutInitialView = 0,
      SlicerLayoutDefaultView = 1,
      SlicerLayoutConventionalView = 2,
      SlicerLayoutFourUpView = 3,
      SlicerLayoutOneUp3DView = 4,
      SlicerLayoutOneUpSliceView = 5, // XXX Slicer 4.5 - Remove this value. Here only for backward compatibility.
      SlicerLayoutOneUpRedSliceView = 6,
      SlicerLayoutOneUpYellowSliceView = 7,
      SlicerLayoutOneUpGreenSliceView = 8,
      SlicerLayoutTabbed3DView = 9,
      SlicerLayoutTabbedSliceView = 10,
      SlicerLayoutLightboxView = 11, // XXX Slicer 4.5 - Remove this value. Here only for backward compatibility.
      SlicerLayoutCompareView = 12,
      SlicerLayoutSideBySideLightboxView = 13, // XXX Slicer 4.5 - Remove this value. Here only for backward compatibility.
      SlicerLayoutNone = 14,
      SlicerLayoutDual3DView = 15,
      SlicerLayoutConventionalWidescreenView = 16,
      SlicerLayoutCompareWidescreenView = 17,
      SlicerLayoutSingleLightboxView = 18, // XXX Slicer 4.5 - Remove this value. Here only for backward compatibility.
      SlicerLayoutTriple3DEndoscopyView = 19, // Up to here, all layouts are Slicer 3 compatible
      SlicerLayout3DPlusLightboxView = 20, // XXX Slicer 4.5 - Remove this value. Here only for backward compatibility.
      SlicerLayoutThreeOverThreeView = 21,
      SlicerLayoutFourOverFourView = 22,
      SlicerLayoutCompareGridView = 23,
      SlicerLayoutConventionalQuantitativeView = 24,
      SlicerLayoutFourUpQuantitativeView = 25,
      SlicerLayoutOneUpQuantitativeView = 26,
      SlicerLayoutTwoOverTwoView = 27,
      SlicerLayoutThreeOverThreeQuantitativeView = 28,
      SlicerLayoutSideBySideView = 29,
      SlicerLayoutFourByThreeSliceView = 30,
      SlicerLayoutFourByTwoSliceView = 31,
      SlicerLayoutFiveByTwoSliceView = 32,
      SlicerLayoutThreeByThreeSliceView = 33,
      SlicerLayoutFourUpTableView = 34,
      SlicerLayout3DTableView = 35,
      SlicerLayoutConventionalPlotView = 36,
      SlicerLayoutFourUpPlotView = 37,
      SlicerLayoutFourUpPlotTableView = 38,
      SlicerLayoutOneUpPlotView = 39,
      SlicerLayoutThreeOverThreePlotView = 40,
      SlicerLayoutFinalView, // special value, must be placed after the last standard view (used for iterating through all the views)

      SlicerLayoutMaximizedView = 98,
      SlicerLayoutCustomView = 99,
      SlicerLayoutUserView = 100
    };

  bool AddLayoutDescription(int layout, const char* layoutDescription);

  bool SetLayoutDescription(int layout, const char* layoutDescription);

  bool IsLayoutDescription(int layout);

  std::string GetLayoutDescription(int layout);

  // Get the layout description currently displayed. Used
  // internally. This is XML description corresponding to the ivar
  // ViewArrangement which is the integer identifier for the
  // layout. ViewArrangement and CurrentViewDescription may not
  // correspond while a view is being switched.
  vtkGetStringMacro(CurrentLayoutDescription);

  // Get the XML data model of the CurrentViewDescription
  vtkGetObjectMacro(LayoutRootElement, vtkXMLDataElement);

  // You are responsible to delete the returned dataElement.
  static vtkXMLDataElement* ParseLayout(const char* description);

protected:
  void UpdateCurrentLayoutDescription();
  void SetAndParseCurrentLayoutDescription(const char* description);
  vtkSetStringMacro(CurrentLayoutDescription);

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

  int GUIPanelVisibility;
  int BottomPanelVisibility;
  int GUIPanelLR;
  int CollapseSliceControllers;
  int ViewArrangement;
  int NumberOfCompareViewRows;
  int NumberOfCompareViewColumns;
  int NumberOfCompareViewLightboxRows;
  int NumberOfCompareViewLightboxColumns;

  char *SelectedModule;

  int MainPanelSize;
  int SecondaryPanelSize;

  std::map<int, std::string> Layouts;
  char*                      CurrentLayoutDescription;
  vtkXMLDataElement*         LayoutRootElement;
};

#endif