vtkMRMLLayerDMPipelineFactory.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 __vtkMRMLLayerDMPipelineFactory_h
#define __vtkMRMLLayerDMPipelineFactory_h
 
#include "vtkSlicerLayerDMModuleMRMLDisplayableManagerExport.h"
 
// VTK includes
#include <vtkCommand.h>
#include <vtkObject.h>
#include <vtkSmartPointer.h>
#include <vtkWeakPointer.h>
 
// STL includes
#include <functional>
#include <vector>
 
class vtkMRMLAbstractViewNode;
class vtkMRMLLayerDMObjectEventObserver;
class vtkMRMLLayerDMPipelineCreator;
class vtkMRMLLayerDMPipeline;
class vtkMRMLNode;

class VTK_SLICER_LAYERDM_MODULE_MRMLDISPLAYABLEMANAGER_EXPORT vtkMRMLLayerDMPipelineFactory : public vtkObject
{
public:
  enum Events
  {
    // Triggered when the factory creates a non-empty pipeline
    PipelineAboutToBeCreatedEvent = vtkCommand::UserEvent + 1
  };
 
  static vtkMRMLLayerDMPipelineFactory* New();
  vtkTypeMacro(vtkMRMLLayerDMPipelineFactory, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkSmartPointer<vtkMRMLLayerDMPipelineFactory> GetInstance();

  void AddPipelineCreator(const vtkSmartPointer<vtkMRMLLayerDMPipelineCreator>& creator);

  vtkSmartPointer<vtkMRMLLayerDMPipelineCreator> AddPipelineCreator(
    const std::function<vtkSmartPointer<vtkMRMLLayerDMPipeline>(vtkMRMLAbstractViewNode*, vtkMRMLNode*)>& creatorCallBack,
    int priority = 0);

  void RemovePipelineCreator(const vtkSmartPointer<vtkMRMLLayerDMPipelineCreator>& creator);

  bool ContainsPipelineCreator(const vtkSmartPointer<vtkMRMLLayerDMPipelineCreator>& creator) const;

  vtkSmartPointer<vtkMRMLLayerDMPipeline> CreatePipeline(vtkMRMLAbstractViewNode* viewNode, vtkMRMLNode* node, vtkSmartPointer<vtkMRMLLayerDMPipelineCreator>* creator);
  vtkSmartPointer<vtkMRMLLayerDMPipeline> CreatePipeline(vtkMRMLAbstractViewNode* viewNode, vtkMRMLNode* node);

  vtkMRMLAbstractViewNode* GetLastViewNode() const;
  vtkMRMLNode* GetLastNode() const;
  vtkMRMLLayerDMPipeline* GetLastPipeline() const;
 
protected:
  vtkMRMLLayerDMPipelineFactory();
  ~vtkMRMLLayerDMPipelineFactory() override = default;
 
private:
  void SortPipelineCreators();
 
  std::vector<vtkSmartPointer<vtkMRMLLayerDMPipelineCreator>> PipelineCreators;
  vtkSmartPointer<vtkMRMLLayerDMObjectEventObserver> Observer;
  vtkWeakPointer<vtkMRMLAbstractViewNode> LastView;
  vtkWeakPointer<vtkMRMLNode> LastNode;
  vtkWeakPointer<vtkMRMLLayerDMPipeline> LastPipeline;
};
 
#endif