vtkMRMLLayerDMPipelineManager.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware SAS
 
  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 Thibault Pelletier, Kitware SAS,
  and was partially funded by ANR grants ANR-22-CE45-0034 and ANR-18-RHUS-005.
 
==============================================================================*/
 
#ifndef __vtkMRMLLayerDMPipelineManager_h
#define __vtkMRMLLayerDMPipelineManager_h
 
#include "vtkSlicerLayerDMModuleMRMLDisplayableManagerExport.h"
 
// VTK includes
#include <vtkCommand.h>
#include <vtkObject.h>
#include <vtkSmartPointer.h>
#include <vtkWeakPointer.h>
 
// STL includes
#include <functional>
#include <map>
 
class vtkCamera;
class vtkMRMLAbstractViewNode;
class vtkMRMLInteractionEventData;
class vtkMRMLLayerDMCameraSynchronizer;
class vtkMRMLLayerDMInteractionLogic;
class vtkMRMLLayerDMLayerManager;
class vtkMRMLLayerDMNodeReferenceObserver;
class vtkMRMLLayerDMObjectEventObserver;
class vtkMRMLLayerDMPipelineCreator;
class vtkMRMLLayerDMPipelineFactory;
class vtkMRMLLayerDMPipeline;
class vtkMRMLNode;
class vtkMRMLScene;
class vtkRenderWindow;
class vtkRenderer;

class VTK_SLICER_LAYERDM_MODULE_MRMLDISPLAYABLEMANAGER_EXPORT vtkMRMLLayerDMPipelineManager : public vtkObject
{
public:
  static vtkMRMLLayerDMPipelineManager* New();
  vtkTypeMacro(vtkMRMLLayerDMPipelineManager, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  bool AddNode(vtkMRMLNode* node);

  bool CanProcessInteractionEvent(vtkMRMLInteractionEventData* eventData, double& distance2) const;

  bool CreatePipelineForNode(vtkMRMLNode* displayNode);

  vtkCamera* GetDefaultCamera() const;

  void ClearDisplayableNodes();

  int GetMouseCursor() const;

  vtkSmartPointer<vtkMRMLLayerDMPipeline> GetNodePipeline(vtkMRMLNode* node) const;

  int GetNumberOfPipelines() const;

  vtkMRMLLayerDMPipeline* GetNthPipeline(int iPipeline) const;

  void LoseFocus() const;
  void LoseFocus(vtkMRMLInteractionEventData* eventData) const;

  bool ProcessInteractionEvent(vtkMRMLInteractionEventData* eventData) const;

  bool RemoveNode(vtkMRMLNode* node);
  bool RemovePipeline(vtkMRMLNode* displayNode);

  void RequestRender();

  void ResetCameraClippingRange() const;

  void SetFactory(const vtkSmartPointer<vtkMRMLLayerDMPipelineFactory>& factory);

  void SetRenderWindow(vtkRenderWindow* renderWindow);

  void SetRenderer(vtkRenderer* renderer) const;

  void SetRequestRender(const std::function<void()>& requestRender);

  void SetScene(vtkMRMLScene* scene);

  void SetViewNode(vtkMRMLAbstractViewNode* viewNode);

  void UpdateAllPipelines();

  void UpdateFromScene();

  bool BlockRequestRender(bool isBlocked);
 
protected:
  vtkMRMLLayerDMPipelineManager();
  ~vtkMRMLLayerDMPipelineManager() override;
 
private:
  void OnDefaultCameraModified();

  void UpdatePipeline(const vtkSmartPointer<vtkMRMLLayerDMPipeline>& pipeline) const;

  void RemoveOutdatedPipelines();

  void AddMissingPipelines();

  bool IsPipelineCreatorOutdated(vtkMRMLNode* node) const;
 
  vtkSmartPointer<vtkMRMLLayerDMPipelineFactory> Factory;
  vtkSmartPointer<vtkMRMLLayerDMLayerManager> LayerManager;
  vtkSmartPointer<vtkMRMLLayerDMCameraSynchronizer> CameraSynchronizer;
  vtkSmartPointer<vtkMRMLLayerDMInteractionLogic> InteractionLogic;
  vtkSmartPointer<vtkMRMLLayerDMObjectEventObserver> EventObserver;
  vtkSmartPointer<vtkCamera> DefaultCamera;
  vtkSmartPointer<vtkMRMLLayerDMNodeReferenceObserver> NodeReferenceObserver;
 
  vtkWeakPointer<vtkMRMLAbstractViewNode> ViewNode;
  vtkWeakPointer<vtkMRMLScene> Scene;
  vtkWeakPointer<vtkRenderWindow> RenderWindow;
 
  std::map<vtkMRMLNode*, vtkSmartPointer<vtkMRMLLayerDMPipeline>> PipelineMap;
  std::map<vtkMRMLNode*, vtkWeakPointer<vtkMRMLLayerDMPipelineCreator>> PipelineCreatorMap;
  std::function<void()> RequestRenderCallback;
 
  bool IsRequestRenderBlocked{ false };
};
 
#endif