vtkMRMLLayerDMPipelineFactory Class Reference

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

#include <Modules/Loadable/LayerDM/MRMLDM/vtkMRMLLayerDMPipelineFactory.h>

Inheritance diagram for vtkMRMLLayerDMPipelineFactory:

Collaboration diagram for vtkMRMLLayerDMPipelineFactory:

Public Types
enum	Events { PipelineAboutToBeCreatedEvent = vtkCommand::UserEvent + 1 }
typedef vtkObject	Superclass

Public Member Functions
vtkSmartPointer< vtkMRMLLayerDMPipelineCreator >	AddPipelineCreator (const std::function< vtkSmartPointer< vtkMRMLLayerDMPipeline >(vtkMRMLAbstractViewNode *, vtkMRMLNode *)> &creatorCallBack, int priority=0)
void	AddPipelineCreator (const vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > &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.
bool	ContainsPipelineCreator (const vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > &creator) const
	true if the given creator is contained in the factory, false otherwise.
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	RemovePipelineCreator (const vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > &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.
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

Static Public Member Functions
static vtkSmartPointer< vtkMRMLLayerDMPipelineFactory >	GetInstance ()
	Singleton instance of the factory used by the displayable manager.
static int	IsTypeOf (const char *type)
static vtkMRMLLayerDMPipelineFactory *	New ()
static vtkMRMLLayerDMPipelineFactory *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkMRMLLayerDMPipelineFactory ()
	~vtkMRMLLayerDMPipelineFactory () override=default

Detailed Description

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

Delegates creation to its list of

See also

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

Definition at line 46 of file vtkMRMLLayerDMPipelineFactory.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMRMLLayerDMPipelineFactory::Superclass

Definition at line 56 of file vtkMRMLLayerDMPipelineFactory.h.

Member Enumeration Documentation

Events

enum vtkMRMLLayerDMPipelineFactory::Events

Enumerator
PipelineAboutToBeCreatedEvent

Definition at line 49 of file vtkMRMLLayerDMPipelineFactory.h.

Constructor & Destructor Documentation

vtkMRMLLayerDMPipelineFactory()

vtkMRMLLayerDMPipelineFactory::vtkMRMLLayerDMPipelineFactory ( )

protected

~vtkMRMLLayerDMPipelineFactory()

vtkMRMLLayerDMPipelineFactory::~vtkMRMLLayerDMPipelineFactory ( )

overrideprotecteddefault

Member Function Documentation

AddPipelineCreator() [1/2]

vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > vtkMRMLLayerDMPipelineFactory::AddPipelineCreator	(	const std::function< vtkSmartPointer< vtkMRMLLayerDMPipeline >(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

AddPipelineCreator() [2/2]

void vtkMRMLLayerDMPipelineFactory::AddPipelineCreator

(

const vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > &

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.

ContainsPipelineCreator()

bool vtkMRMLLayerDMPipelineFactory::ContainsPipelineCreator

(

const vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > &

creator

)

const

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

CreatePipeline() [1/2]

vtkSmartPointer< vtkMRMLLayerDMPipeline > vtkMRMLLayerDMPipelineFactory::CreatePipeline	(	vtkMRMLAbstractViewNode *	viewNode,
		vtkMRMLNode *	node )

CreatePipeline() [2/2]

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

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. If creator is not nullptr, it is set to the creator that created the pipeline. Invokes PipelineAboutToBeCreatedEvent before returning the newly created pipeline instance.

See also

GetLastViewNode

GetLastNode

GetLastPipeline

GetClassName()

virtual const char * vtkMRMLLayerDMPipelineFactory::GetClassName ( )

virtual

GetInstance()

static vtkSmartPointer< vtkMRMLLayerDMPipelineFactory > vtkMRMLLayerDMPipelineFactory::GetInstance ( )

static

Singleton instance of the factory used by the displayable manager.

GetLastNode()

vtkMRMLNode * vtkMRMLLayerDMPipelineFactory::GetLastNode

(

)

const

GetLastPipeline()

vtkMRMLLayerDMPipeline * vtkMRMLLayerDMPipelineFactory::GetLastPipeline

(

)

const

GetLastViewNode()

vtkMRMLAbstractViewNode * vtkMRMLLayerDMPipelineFactory::GetLastViewNode

(

)

const

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

IsA()

virtual int vtkMRMLLayerDMPipelineFactory::IsA ( const char * type )

virtual

IsTypeOf()

static int vtkMRMLLayerDMPipelineFactory::IsTypeOf ( const char * type )

static

New()

static vtkMRMLLayerDMPipelineFactory * vtkMRMLLayerDMPipelineFactory::New ( )

static

PrintSelf()

void vtkMRMLLayerDMPipelineFactory::PrintSelf ( ostream & os, vtkIndent indent )

override

RemovePipelineCreator()

void vtkMRMLLayerDMPipelineFactory::RemovePipelineCreator

(

const vtkSmartPointer< vtkMRMLLayerDMPipelineCreator > &

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.

SafeDownCast()

static vtkMRMLLayerDMPipelineFactory * vtkMRMLLayerDMPipelineFactory::SafeDownCast ( vtkObject * o )

static

---

The documentation for this class was generated from the following file:

• Modules/Loadable/LayerDM/MRMLDM/vtkMRMLLayerDMPipelineFactory.h