vtkMRMLLayerDMPipelineManager Class Reference

Class responsible for handling adding / updating / removing pipelines depending on nodes added / removed / updated in the 3D Slicer Scene. More...

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

Inheritance diagram for vtkMRMLLayerDMPipelineManager:

Collaboration diagram for vtkMRMLLayerDMPipelineManager:

Public Types
typedef vtkObject	Superclass

Public Member Functions
bool	AddNode (vtkMRMLNode *node)
bool	BlockRequestRender (bool isBlocked)
bool	CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2) const
	Delegates can process interaction event to.
void	ClearDisplayableNodes ()
bool	CreatePipelineForNode (vtkMRMLNode *displayNode)
virtual const char *	GetClassName ()
vtkCamera *	GetDefaultCamera () const
int	GetMouseCursor () const
	Returns the mouse cursor from the latest pipeline having handled the latest interaction.
vtkSmartPointer< vtkMRMLLayerDMPipeline >	GetNodePipeline (vtkMRMLNode *node) const
	Returns the pipeline associated with the input display node if any.
vtkMRMLLayerDMPipeline *	GetNthPipeline (int iPipeline) const
int	GetNumberOfPipelines () const
	Returns the number of pipelines currently managed by the pipeline manager.
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
bool	ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) const
	Delegates process interaction event to.
void	RequestRender ()
	Reset camera clipping range and call display manager request render.
void	ResetCameraClippingRange () const
void	SetFactory (const vtkSmartPointer< vtkMRMLLayerDMPipelineFactory > &factory)
void	SetRenderer (vtkRenderer *renderer) const
	Set the default renderer used by the display manager (initialization).
void	SetRenderWindow (vtkRenderWindow *renderWindow)
	Set the render window on which the pipeline manager is attached (initialization).
void	SetRequestRender (const std::function< void()> &requestRender)
	Set the request render callback used during.
void	SetScene (vtkMRMLScene *scene)
	Set the scene (initialization).
void	SetViewNode (vtkMRMLAbstractViewNode *viewNode)
	Set the view node (initialization).
void	UpdateAllPipelines ()
void	UpdateFromScene ()
void	LoseFocus () const
void	LoseFocus (vtkMRMLInteractionEventData *eventData) const
bool	RemoveNode (vtkMRMLNode *node)
bool	RemovePipeline (vtkMRMLNode *displayNode)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLLayerDMPipelineManager *	New ()
static vtkMRMLLayerDMPipelineManager *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkMRMLLayerDMPipelineManager ()
	~vtkMRMLLayerDMPipelineManager () override

Detailed Description

Class responsible for handling adding / updating / removing pipelines depending on nodes added / removed / updated in the 3D Slicer Scene.

The display manager handles connections to the scene's events.

Definition at line 56 of file vtkMRMLLayerDMPipelineManager.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMRMLLayerDMPipelineManager::Superclass

Definition at line 60 of file vtkMRMLLayerDMPipelineManager.h.

Constructor & Destructor Documentation

vtkMRMLLayerDMPipelineManager()

vtkMRMLLayerDMPipelineManager::vtkMRMLLayerDMPipelineManager ( )

protected

~vtkMRMLLayerDMPipelineManager()

vtkMRMLLayerDMPipelineManager::~vtkMRMLLayerDMPipelineManager ( )

overrideprotected

Member Function Documentation

AddNode()

bool vtkMRMLLayerDMPipelineManager::AddNode

(

vtkMRMLNode *

node

)

Add a new node to the pipeline manager. If no pipeline exist for the input display node and the

See also

vtkMRMLLayerDMPipelineFactory can create a pipeline, creates and stores the pipeline in the manager.

BlockRequestRender()

bool vtkMRMLLayerDMPipelineManager::BlockRequestRender

(

bool

isBlocked

)

Block the request render Returns the previous blocked value.

Allows to avoid requesting a render while a render is already being processed or when updating multiple pipelines at a time (for instance updating from scene or synchronizing with the default camera)

CanProcessInteractionEvent()

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

Delegates can process interaction event to.

See also

vtkMRMLLayerDMInteractionLogic

ClearDisplayableNodes()

void vtkMRMLLayerDMPipelineManager::ClearDisplayableNodes

(

)

Clear all pipelines from the pipeline manager. Should be called at delete.

CreatePipelineForNode()

bool vtkMRMLLayerDMPipelineManager::CreatePipelineForNode

(

vtkMRMLNode *

displayNode

)

Create a new pipeline associated with the input display node. Delegates to

See also

vtkMRMLLayerDMPipelineFactory::CreatePipeline.

GetClassName()

virtual const char * vtkMRMLLayerDMPipelineManager::GetClassName ( )

virtual

GetDefaultCamera()

vtkCamera * vtkMRMLLayerDMPipelineManager::GetDefaultCamera

(

)

const

Returns the default camera for the pipeline. The camera synchronization is handled by

See also

vtkMRMLLayerDMCameraSynchronizer.

GetMouseCursor()

int vtkMRMLLayerDMPipelineManager::GetMouseCursor

(

)

const

Returns the mouse cursor from the latest pipeline having handled the latest interaction.

GetNodePipeline()

vtkSmartPointer< vtkMRMLLayerDMPipeline > vtkMRMLLayerDMPipelineManager::GetNodePipeline

(

vtkMRMLNode *

node

)

const

Returns the pipeline associated with the input display node if any.

GetNthPipeline()

vtkMRMLLayerDMPipeline * vtkMRMLLayerDMPipelineManager::GetNthPipeline

(

int

iPipeline

)

const

Returns the nth pipeline managed by the pipeline manager, nullptr if the index is out of range.

See also

GetNodePipeline

GetNumberOfPipelines

GetNumberOfPipelines()

int vtkMRMLLayerDMPipelineManager::GetNumberOfPipelines

(

)

const

Returns the number of pipelines currently managed by the pipeline manager.

IsA()

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

virtual

IsTypeOf()

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

static

LoseFocus() [1/2]

void vtkMRMLLayerDMPipelineManager::LoseFocus

(

)

const

Makes the latest pipeline lose focus

LoseFocus() [2/2]

void vtkMRMLLayerDMPipelineManager::LoseFocus

(

vtkMRMLInteractionEventData *

eventData

)

const

New()

static vtkMRMLLayerDMPipelineManager * vtkMRMLLayerDMPipelineManager::New ( )

static

PrintSelf()

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

override

ProcessInteractionEvent()

bool vtkMRMLLayerDMPipelineManager::ProcessInteractionEvent

(

vtkMRMLInteractionEventData *

eventData

)

const

Delegates process interaction event to.

See also

vtkMRMLLayerDMInteractionLogic

RemoveNode()

bool vtkMRMLLayerDMPipelineManager::RemoveNode

(

vtkMRMLNode *

node

)

Remove node from the pipeline manager if any pipeline is associated to the input node.

RemovePipeline()

bool vtkMRMLLayerDMPipelineManager::RemovePipeline

(

vtkMRMLNode *

displayNode

)

RequestRender()

void vtkMRMLLayerDMPipelineManager::RequestRender

(

)

Reset camera clipping range and call display manager request render.

ResetCameraClippingRange()

void vtkMRMLLayerDMPipelineManager::ResetCameraClippingRange

(

)

const

Resets the clipping range for all cameras managed by the LayerDM and renderer 0's camera

SafeDownCast()

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

static

SetFactory()

void vtkMRMLLayerDMPipelineManager::SetFactory

(

const vtkSmartPointer< vtkMRMLLayerDMPipelineFactory > &

factory

)

Set the Pipeline factory to use by the pipeline manager (initialization). On factory-modified event, will trigger a

See also

UpdateFromScene.

SetRenderer()

void vtkMRMLLayerDMPipelineManager::SetRenderer

(

vtkRenderer *

renderer

)

const

Set the default renderer used by the display manager (initialization).

SetRenderWindow()

void vtkMRMLLayerDMPipelineManager::SetRenderWindow

(

vtkRenderWindow *

renderWindow

)

Set the render window on which the pipeline manager is attached (initialization).

SetRequestRender()

void vtkMRMLLayerDMPipelineManager::SetRequestRender

(

const std::function< void()> &

requestRender

)

Set the request render callback used during.

See also

RequestRender.

SetScene()

void vtkMRMLLayerDMPipelineManager::SetScene

(

vtkMRMLScene *

scene

)

Set the scene (initialization).

SetViewNode()

void vtkMRMLLayerDMPipelineManager::SetViewNode

(

vtkMRMLAbstractViewNode *

viewNode

)

Set the view node (initialization).

UpdateAllPipelines()

void vtkMRMLLayerDMPipelineManager::UpdateAllPipelines

(

)

Update all pipelines managed by the pipeline manager. Requests render at the end of the update

UpdateFromScene()

void vtkMRMLLayerDMPipelineManager::UpdateFromScene

(

)

Update the pipeline manager from the current MRML scene state. Will automatically remove or create pipelines depending on the scene state. Requests render at the end of the update

---

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

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