vtkMRMLModelHierarchyLogic.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: vtkMRMLModelHierarchyLogic.h,v $
  Date:      $Date: 2010-02-15 16:35:35 -0500 (Mon, 15 Feb 2010) $
  Version:   $Revision: 12142 $

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

#ifndef __vtkMRMLModelHierarchyLogic_h
#define __vtkMRMLModelHierarchyLogic_h

// MRML includes
#include <vtkMRMLAbstractLogic.h>
//#include <vtkMRML.h>
//#include <vtkMRMLModelNode.h>
class vtkMRMLModelHierarchyNode;
class vtkMRMLDisplayableHierarchyNode;
//#include <vtkMRMLModelHierarchyNode.h>

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

typedef std::vector< vtkMRMLModelHierarchyNode *> vtkMRMLModelHierarchyNodeList;

class VTK_MRML_LOGIC_EXPORT vtkMRMLModelHierarchyLogic : public vtkMRMLAbstractLogic
{
public:
  static vtkMRMLModelHierarchyLogic *New();
  vtkTypeMacro(vtkMRMLModelHierarchyLogic,vtkMRMLAbstractLogic);

  vtkMRMLModelHierarchyNode* GetModelHierarchyNode(const char *modelNodeID);

  int GetNumberOfModelsInHierarchy()
    {
    this->UpdateModelToHierarchyMap();
    return (int)this->ModelHierarchyNodes.size();
    };

  void GetHierarchyChildrenNodes(vtkMRMLModelHierarchyNode *parentNode,
                                 vtkMRMLModelHierarchyNodeList &childrenNodes);
  vtkMRMLModelHierarchyNodeList GetHierarchyChildrenNodes(vtkMRMLModelHierarchyNode *parentNode);

  void HierarchyIsModified()
    {
    ModelHierarchyNodesMTime = 0;
    HierarchyChildrenNodesMTime = 0;
    }

  static void SetChildrenVisibility(vtkMRMLDisplayableHierarchyNode *displayableHierarchyNode,
                                   const char *displayableNodeClass, const char *displayNodeClass,
                                   int visibility);

  vtkSetMacro(ChildrenVisibilitySetBatchUpdateThreshold, int);
  vtkGetMacro(ChildrenVisibilitySetBatchUpdateThreshold, int);

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

  virtual void SetMRMLSceneInternal(vtkMRMLScene* newScene) VTK_OVERRIDE;

  virtual void OnMRMLSceneNodeRemoved(vtkMRMLNode* removedNode) VTK_OVERRIDE;

  int UpdateModelToHierarchyMap();

  void UpdateHierarchyChildrenMap();

  std::map<std::string, vtkMRMLModelHierarchyNode *> ModelHierarchyNodes;
  typedef std::map<std::string, std::vector< vtkMRMLModelHierarchyNode *> > HierarchyChildrenNodesType;
  HierarchyChildrenNodesType HierarchyChildrenNodes;

  vtkMTimeType ModelHierarchyNodesMTime;
  vtkMTimeType HierarchyChildrenNodesMTime;

  static int ChildrenVisibilitySetBatchUpdateThreshold;
};

#endif