Class vtkMRMLLayerDMPipelineFactory

• Defined in File vtkMRMLLayerDMPipelineFactory.h

Inheritance Relationships

Base Type

• public vtkObject

Class Documentation

class vtkMRMLLayerDMPipelineFactory : public vtkObject

Inheritance diagram for vtkMRMLLayerDMPipelineFactory:

Collaboration diagram for vtkMRMLLayerDMPipelineFactory:

Class responsible for creating new pipelines given input viewNode and Node pairs.

Delegates creation to its list of

See also

vtkMRMLLayerDMPipelineCreatorI. Early returns when a first creator capable of handling the input is found.

Unnamed Group

vtkMRMLAbstractViewNode *GetLastViewNode() const

Get the last pipeline created by the factory. Values are valid when the PipelineAboutToBeCreatedEvent event is triggered.

vtkMRMLNode *GetLastNode() const

vtkMRMLLayerDMPipelineI *GetLastPipeline() const

Public Types

enum Events

Values:

enumerator PipelineAboutToBeCreatedEvent

Public Functions

vtkTypeMacro(vtkMRMLLayerDMPipelineFactory, vtkObject)

void AddPipelineCreator(const vtkSmartPointer<vtkMRMLLayerDMPipelineCreatorI> &creator)

Add the input creator to the list of creators. If the factory already contains the creator, does nothing. Invokes vtkCommand::ModifiedEvent if the factory is modified.

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

Convenience method to add creator callback Delegates to

See also

vtkMRMLLayerDMPipelineCallbackCreator and returns the creator instance.

Parameters:

priority – Creator priority value (default=0) higher indicates priority on handling the creation call

void RemovePipelineCreator(const vtkSmartPointer<vtkMRMLLayerDMPipelineCreatorI> &creator)

Remove the input creator from the list of creators. If the factory doesn’t contain the creator, does nothing. Invokes vtkCommand::ModifiedEvent if the factory is modified.

bool ContainsPipelineCreator(const vtkSmartPointer<vtkMRMLLayerDMPipelineCreatorI> &creator) const

true if the given creator is contained in the factory, false otherwise.

vtkSmartPointer<vtkMRMLLayerDMPipelineI> CreatePipeline(vtkMRMLAbstractViewNode *viewNode, vtkMRMLNode *node)

Tries to create a new pipeline given input viewNode and node by iterating on its creators. Returns nullptr if no creator was able to create a pipeline. Invokes PipelineAboutToBeCreatedEvent before returning the newly created pipeline instance.

See also

GetLastViewNode

See also

GetLastNode

See also

GetLastPipeline

Public Static Functions

static vtkMRMLLayerDMPipelineFactory *New()

static vtkSmartPointer<vtkMRMLLayerDMPipelineFactory> GetInstance()

Singleton instance of the factory used by the displayable manager.

Protected Functions

vtkMRMLLayerDMPipelineFactory()

~vtkMRMLLayerDMPipelineFactory() override = default