vtkMRMLLayoutLogic.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __vtkMRMLLayoutLogic_h
#define __vtkMRMLLayoutLogic_h

// MRMLLogic includes
#include "vtkMRMLAbstractLogic.h"
#include "vtkMRMLLogicExport.h"

// MRML includes
class vtkMRMLAbstractViewNode;
class vtkMRMLLayoutNode;

// VTK includes
class vtkCollection;
class vtkXMLDataElement;

// STD includes
#include <cstdlib>
#include <vector>

class VTK_MRML_LOGIC_EXPORT vtkMRMLLayoutLogic : public vtkMRMLAbstractLogic
{
public:
  static vtkMRMLLayoutLogic *New();
  vtkTypeMacro(vtkMRMLLayoutLogic,vtkMRMLAbstractLogic);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  typedef std::map<std::string, std::string> ViewAttributes;
  typedef ViewAttributes ViewProperty;
  typedef std::vector<ViewProperty> ViewProperties;

  virtual void   AddDefaultLayouts();

  vtkMRMLNode*   GetViewFromElement(vtkXMLDataElement* element);
  vtkMRMLNode*   GetViewFromAttributes(const ViewAttributes& attributes);

  vtkCollection* GetViewsFromAttributes(const ViewAttributes& attributes);

  vtkMRMLNode*   CreateViewFromAttributes(const ViewAttributes& attributes);

  void ApplyProperties(const ViewProperties& properties, vtkMRMLNode* view, const std::string& action);
  void ApplyProperty(const ViewProperty& property, vtkMRMLNode* view);

  vtkGetObjectMacro(ViewNodes, vtkCollection);

  vtkGetObjectMacro(LayoutNode, vtkMRMLLayoutNode);

  void MaximizeView(vtkMRMLAbstractViewNode* viewToMaximize);

  void CreateMaximizedViewLayoutDescription(int layout,
                                            vtkMRMLAbstractViewNode* viewToMaximize);

  std::string GetMaximizedViewLayoutDescription(vtkMRMLAbstractViewNode* viewToMaximize);

protected:
  vtkMRMLLayoutLogic();
  ~vtkMRMLLayoutLogic() override;
  // disable copy constructor and operator
  vtkMRMLLayoutLogic(const vtkMRMLLayoutLogic&);
  void operator=(const vtkMRMLLayoutLogic&);

  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;

  void OnMRMLNodeModified(vtkMRMLNode* node) override;
  void OnMRMLSceneStartRestore() override;
  void OnMRMLSceneEndRestore() override;

  void UnobserveMRMLScene() override;
  void UpdateFromMRMLScene() override;

  void UpdateViewNodes();

  void UpdateLayoutNode();

  void SetLayoutNode(vtkMRMLLayoutNode* layoutNode);

  void UpdateFromLayoutNode();
  void UpdateViewCollectionsFromLayout();
  void CreateMissingViews();
  void CreateMissingViews(vtkXMLDataElement* layoutRootElement);

  vtkCollection*     GetViewsFromLayout(vtkXMLDataElement* root);

  void UpdateCompareViewLayoutDefinitions();

  vtkXMLDataElement* GetNextViewElement(vtkXMLDataElement* viewElement);
  vtkXMLDataElement* GetNextElement(vtkXMLDataElement* element);
  ViewAttributes     GetViewElementAttributes(vtkXMLDataElement* viewElement)const;
  ViewProperties     GetViewElementProperties(vtkXMLDataElement* viewElement)const;
  ViewProperty       GetViewElementProperty(vtkXMLDataElement* viewProperty)const;

  vtkMRMLLayoutNode* LayoutNode;
  int                LastValidViewArrangement;
  vtkCollection*     ViewNodes;
  vtkXMLDataElement* ConventionalLayoutRootElement;
};

#endif