vtkMRMLModelDisplayableManager.h

Go to the documentation of this file.

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

  Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.

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

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

#ifndef __vtkMRMLModelDisplayableManager_h
#define __vtkMRMLModelDisplayableManager_h

// MRMLDisplayableManager includes
#include "vtkMRMLAbstractThreeDViewDisplayableManager.h"
#include "vtkMRMLDisplayableManagerExport.h"

// MRML includes
#include <vtkMRMLModelNode.h>
class vtkMRMLClipModelsNode;
class vtkMRMLDisplayNode;
class vtkMRMLDisplayableNode;
class vtkMRMLTransformNode;

// VTK includes
#include "vtkRenderWindow.h"
class vtkActor;
class vtkAlgorithm;
class vtkCellPicker;
class vtkLookupTable;
class vtkMatrix4x4;
class vtkPlane;
class vtkPointPicker;
class vtkProp3D;
class vtkPropPicker;
class vtkWorldPointPicker;

class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLModelDisplayableManager
  : public vtkMRMLAbstractThreeDViewDisplayableManager
{
public:
  static vtkMRMLModelDisplayableManager* New();
  vtkTypeMacro(vtkMRMLModelDisplayableManager,vtkMRMLAbstractThreeDViewDisplayableManager);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLClipModelsNode* GetClipModelsNode();
  void SetClipModelsNode(vtkMRMLClipModelsNode *snode);

  vtkProp3D *GetActorByID(const char *id);

  const char *GetIDByActor(vtkProp3D *actor);

  vtkWorldPointPicker* GetWorldPointPicker();

  vtkPropPicker* GetPropPicker();

  vtkCellPicker* GetCellPicker();

  vtkPointPicker* GetPointPicker();

  int Pick(int x, int y);

  int Pick3D(double ras[3]) override;

  double GetPickTolerance();
  void SetPickTolerance(double tolerance);

  const char* GetPickedNodeID() override;

  double* GetPickedRAS();
  void SetPickedRAS(double* newPickedRAS);

  vtkIdType GetPickedCellID();
  void SetPickedCellID(vtkIdType newCellID);

  vtkIdType GetPickedPointID();
  void SetPickedPointID(vtkIdType newPointID);

  void SetClipPlaneFromMatrix(vtkMatrix4x4 *sliceMatrix,
                             int planeDirection,
                             vtkPlane *plane);

  bool IsModelDisplayable(vtkMRMLDisplayableNode* node)const;
  bool IsModelDisplayable(vtkMRMLDisplayNode* node)const;

  static bool IsCellScalarsActive(vtkMRMLDisplayNode* displayNode, vtkMRMLModelNode* model = nullptr);

protected:
  int ActiveInteractionModes() override;

  void UnobserveMRMLScene() override;

  void OnMRMLSceneStartClose() override;
  void OnMRMLSceneEndClose() override;
  void UpdateFromMRMLScene() override;
  void OnMRMLSceneNodeAdded(vtkMRMLNode* node) override;
  void OnMRMLSceneNodeRemoved(vtkMRMLNode* node) override;

  void OnInteractorStyleEvent(int eventId) override;
  void ProcessMRMLNodesEvents(vtkObject *caller, unsigned long event, void *callData) override;

  bool OnMRMLDisplayableModelNodeModifiedEvent(vtkMRMLDisplayableNode* modelNode);

  void UpdateFromMRML() override;

  void RemoveMRMLObservers() override;

  void RemoveModelProps();
  void RemoveModelObservers(int clearCache);
  void RemoveDisplayable(vtkMRMLDisplayableNode* model);
  void RemoveDisplayableNodeObservers(vtkMRMLDisplayableNode* model);

  void UpdateModelsFromMRML();
  void UpdateModel(vtkMRMLDisplayableNode* model);
  void UpdateModelMesh(vtkMRMLDisplayableNode* model);
  void UpdateModifiedModel(vtkMRMLDisplayableNode* model);

  void SetModelDisplayProperty(vtkMRMLDisplayableNode* model);
  int GetDisplayedModelsVisibility(vtkMRMLDisplayNode* displayNode);

  const char* GetActiveScalarName(vtkMRMLDisplayNode* displayNode,
                                  vtkMRMLModelNode* model = nullptr);

  int UpdateClipSlicesFromMRML();
  vtkAlgorithm *CreateTransformedClipper(vtkMRMLTransformNode *tnode,
                                         vtkMRMLModelNode::MeshTypeHint type);

  void RemoveDisplayedID(std::string &id);

protected:
  vtkMRMLModelDisplayableManager();
  ~vtkMRMLModelDisplayableManager() override;

  friend class vtkMRMLThreeDViewInteractorStyle; // Access to RequestRender();

private:
  vtkMRMLModelDisplayableManager(const vtkMRMLModelDisplayableManager&) = delete;
  void operator=(const vtkMRMLModelDisplayableManager&) = delete;

  class vtkInternal;
  vtkInternal* Internal;
};

#endif