Python bridge for vtkMRMLLayerDMPipeline. Delegates calls to the pipeline to its underlying python object. More...

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

Inheritance diagram for vtkMRMLLayerDMScriptedPipelineBridge:

[legend]

Collaboration diagram for vtkMRMLLayerDMScriptedPipelineBridge:

[legend]

Public Types
typedef vtkMRMLLayerDMPipeline	Superclass

Public Types inherited from vtkMRMLLayerDMPipeline
enum	Events { RenderGroupingModified = vtkCommand::UserEvent + 1 }

typedef vtkObject	Superclass

Public Member Functions
bool	CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2) override

virtual const char *	GetClassName ()

vtkCamera *	GetCustomCamera (unsigned int renderOrder) const override

int	GetMouseCursor () const override

unsigned int	GetRenderOrder () const override

std::vector< unsigned int >	GetRenderOrders () const override

int	GetWidgetState () const override

virtual int	IsA (const char *type)

void	LoseFocus (vtkMRMLInteractionEventData *eventData) override

void	OnDefaultCameraModified (vtkCamera *camera) override

void	OnReferenceToDisplayNodeAdded (vtkMRMLNode *fromNode, const std::string &role) override

void	OnReferenceToDisplayNodeRemoved (vtkMRMLNode *fromNode, const std::string &role) override

void	OnRendererAdded (vtkRenderer *renderer) override

void	OnRendererRemoved (vtkRenderer *renderer) override

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override

void	SetDisplayNode (vtkMRMLNode *displayNode) override

void	SetPipelineManager (vtkMRMLLayerDMPipelineManager *pipelineManager) override

void	SetPythonObject (PyObject *object)

void	SetScene (vtkMRMLScene *scene) override

void	SetViewNode (vtkMRMLAbstractViewNode *viewNode) override

void	UpdateFromMRML () override

Public Member Functions inherited from vtkMRMLLayerDMPipeline
bool	BlockUpdateDisplay (bool isBlocked)
	If.

virtual vtkCamera *	GetCustomCamera () const

vtkMRMLNode *	GetDisplayNode () const
	Returns the current display node.

unsigned int	GetMaxRenderOrder () const
	Maximum render order handled by the DM.

vtkMRMLLayerDMPipeline *	GetNodePipeline (vtkMRMLNode *node) const

vtkMRMLLayerDMPipelineManager *	GetPipelineManager () const
	Returns the instance of pipeline manager which created the pipeline.

vtkRenderer *	GetRenderer () const

vtkRenderer *	GetRenderer (unsigned int renderOrder) const

std::vector< vtkRenderer * >	GetRenderers () const
	Returns the current renderers attached to the pipeline in increasing order of GetRenderOrders.

vtkMRMLScene *	GetScene () const
	Returns the current scene.

vtkMRMLAbstractViewNode *	GetViewNode () const
	Returns the current view node.

unsigned int	GetVtkRendererOrder (const vtkRenderer *renderer) const

void	PrintSelf (ostream &os, vtkIndent indent) override

void	RemoveObservations (vtkObject *prevObj) const

void	RequestRender () const

void	SetRenderer (vtkRenderer *renderer)

void	SetRenderers (const std::vector< vtkRenderer * > &renderers, const std::vector< unsigned int > &renderOrders)

void	UpdateDisplay ()

bool	BlockInteractionProcessing (bool isBlocked)

bool	IsInteractionProcessingBlocked () const

bool	BlockUpdateObserver (bool isBlocked) const

bool	IsUpdateObserverBlocked () const

void	SetFrozen (bool isFrozen)

bool	IsFrozen () const

bool	UpdateObservation (vtkObject prevObj, vtkObject obj, const std::vector< unsigned long > &events) const

bool	UpdateObservation (vtkObject prevObj, vtkObject obj, unsigned long event=vtkCommand::ModifiedEvent) const

Static Public Member Functions
static PyObject *	CastCallData (PyObject *object, int vtkType)

static int	IsTypeOf (const char *type)

static vtkMRMLLayerDMScriptedPipelineBridge *	New ()

static vtkMRMLLayerDMScriptedPipelineBridge *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLLayerDMPipeline
static int	IsTypeOf (const char *type)

static vtkMRMLLayerDMPipeline *	New ()

static vtkMRMLLayerDMPipeline *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	OnUpdate (vtkObject obj, unsigned long eventId, void callData) override

	vtkMRMLLayerDMScriptedPipelineBridge ()

	~vtkMRMLLayerDMScriptedPipelineBridge () override

Protected Member Functions inherited from vtkMRMLLayerDMPipeline
	vtkMRMLLayerDMPipeline ()

	~vtkMRMLLayerDMPipeline () override=default

Detailed Description

Python bridge for vtkMRMLLayerDMPipeline. Delegates calls to the pipeline to its underlying python object.

See also: vtkMRMLLayerDMPipeline; vtkMRMLLayerDMScriptedPipeline

Definition at line 38 of file vtkMRMLLayerDMScriptedPipelineBridge.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLLayerDMPipeline vtkMRMLLayerDMScriptedPipelineBridge::Superclass

Definition at line 42 of file vtkMRMLLayerDMScriptedPipelineBridge.h.

Constructor & Destructor Documentation

◆ vtkMRMLLayerDMScriptedPipelineBridge()

vtkMRMLLayerDMScriptedPipelineBridge::vtkMRMLLayerDMScriptedPipelineBridge ( )

protected

◆ ~vtkMRMLLayerDMScriptedPipelineBridge()

vtkMRMLLayerDMScriptedPipelineBridge::~vtkMRMLLayerDMScriptedPipelineBridge ( )

overrideprotected

Member Function Documentation

◆ CanProcessInteractionEvent()

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

overridevirtual

true if the pipeline can process the input event data

Parameters

eventData	The MRML event needing to be processed
distance2	Return value for the distance to the interaction (preferably actual RAS distance)

Returns: true if the pipeline can process the input event data. Default = false;

Reimplemented from vtkMRMLLayerDMPipeline.

◆ CastCallData()

static PyObject * vtkMRMLLayerDMScriptedPipelineBridge::CastCallData	(	PyObject *	object,
		int	vtkType )

static

◆ GetClassName()

virtual const char * vtkMRMLLayerDMScriptedPipelineBridge::GetClassName ( )

virtual

Reimplemented from vtkMRMLLayerDMPipeline.

◆ GetCustomCamera()

vtkCamera * vtkMRMLLayerDMScriptedPipelineBridge::GetCustomCamera ( unsigned int renderOrder ) const

overridevirtual

Reimplemented from vtkMRMLLayerDMPipeline.

◆ GetMouseCursor()

int vtkMRMLLayerDMScriptedPipelineBridge::GetMouseCursor ( ) const

overridevirtual

Custom mouse cursor from VTK mouse cursor enum. This value is only used if the pipeline actually processes an event and is ignore otherwise.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ GetRenderOrder()

unsigned int vtkMRMLLayerDMScriptedPipelineBridge::GetRenderOrder ( ) const

overridevirtual

Arbitrary render order number where the pipeline wants to be displayed. Return 0 to be at the default order (main 3D Slicer pipelines) Return larger values to be rendered on top of pipelines with lower render orders. Order number is read-only during update and is expected to be static per pipeline.

See also: vtkMRMLLayerDMLayerManager

Returns: default = 0

Reimplemented from vtkMRMLLayerDMPipeline.

◆ GetRenderOrders()

std::vector< unsigned int > vtkMRMLLayerDMScriptedPipelineBridge::GetRenderOrders ( ) const

overridevirtual

Pipeline render orders.

See also: GetRenderOrder

Reimplemented from vtkMRMLLayerDMPipeline.

◆ GetWidgetState()

int vtkMRMLLayerDMScriptedPipelineBridge::GetWidgetState ( ) const

overridevirtual

Current widget state of the pipeline.

Returns: default = WidgetStateIdle

Reimplemented from vtkMRMLLayerDMPipeline.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLLayerDMPipeline.

◆ IsTypeOf()

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

static

◆ LoseFocus()

void vtkMRMLLayerDMScriptedPipelineBridge::LoseFocus ( vtkMRMLInteractionEventData * eventData )

overridevirtual

Triggered when the pipeline had focus (processed an interaction) and loses the focus (other pipeline handled the new interaction or window leave event). default behavior: does nothing.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ New()

static vtkMRMLLayerDMScriptedPipelineBridge * vtkMRMLLayerDMScriptedPipelineBridge::New ( )

static

◆ OnDefaultCameraModified()

void vtkMRMLLayerDMScriptedPipelineBridge::OnDefaultCameraModified ( vtkCamera * camera )

overridevirtual

Triggered when the default camera is modified. default behavior: does nothing.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ OnReferenceToDisplayNodeAdded()

void vtkMRMLLayerDMScriptedPipelineBridge::OnReferenceToDisplayNodeAdded	(	vtkMRMLNode *	fromNode,
		const std::string &	role )

overridevirtual

Triggered when a reference to the display node is added / removed default behavior: Triggers onUpdate with the display node as argument and ReferenceAdded / Removed eventId.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ OnReferenceToDisplayNodeRemoved()

void vtkMRMLLayerDMScriptedPipelineBridge::OnReferenceToDisplayNodeRemoved	(	vtkMRMLNode *	fromNode,
		const std::string &	role )

overridevirtual

Reimplemented from vtkMRMLLayerDMPipeline.

◆ OnRendererAdded()

void vtkMRMLLayerDMScriptedPipelineBridge::OnRendererAdded ( vtkRenderer * renderer )

overridevirtual

Triggered when the pipeline is displayed on a new renderer. default behavior: does nothing.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ OnRendererRemoved()

void vtkMRMLLayerDMScriptedPipelineBridge::OnRendererRemoved ( vtkRenderer * renderer )

overridevirtual

Triggered when the pipeline is removed from its previous renderer. default behavior: does nothing.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ OnUpdate()

void vtkMRMLLayerDMScriptedPipelineBridge::OnUpdate	(	vtkObject *	obj,
		unsigned long	eventId,
		void *	callData )

overrideprotectedvirtual

Observer update callback. Triggered when any object & events observed using UpdateObservation is triggered.

Reimplemented from vtkMRMLLayerDMPipeline.

◆ PrintSelf()

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

override

◆ ProcessInteractionEvent()

bool vtkMRMLLayerDMScriptedPipelineBridge::ProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData )

overridevirtual

Triggered when the pipeline can process the interaction and is at the top of the priority list. default behavior: does nothing and returns false.

Parameters

eventData The MRML event needing to be processed

Returns: True if event was processed. False otherwise (default = false)

Reimplemented from vtkMRMLLayerDMPipeline.

◆ SafeDownCast()

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

static

◆ SetDisplayNode()

void vtkMRMLLayerDMScriptedPipelineBridge::SetDisplayNode ( vtkMRMLNode * displayNode )

overridevirtual

Set the display node for the pipeline has changed (initialization). default behavior: Stored and display node is observed for vtkCommand::ModifiedEvent.

See also: UpdateObservation; OnUpdate

Reimplemented from vtkMRMLLayerDMPipeline.

◆ SetPipelineManager()

void vtkMRMLLayerDMScriptedPipelineBridge::SetPipelineManager ( vtkMRMLLayerDMPipelineManager * pipelineManager )

overridevirtual

Set the pipeline manager (initialization). default behavior: Stores the pipeline manager to delegate request render calls (no active observer).

Parameters

pipelineManager The instance of pipeline manager managing the current pipeline

Reimplemented from vtkMRMLLayerDMPipeline.

◆ SetPythonObject()

void vtkMRMLLayerDMScriptedPipelineBridge::SetPythonObject ( PyObject * object )

◆ SetScene()

void vtkMRMLLayerDMScriptedPipelineBridge::SetScene ( vtkMRMLScene * scene )

overridevirtual

Set the pipeline scene (initialization). default behavior: Stores the scene for access (no active observer).

Reimplemented from vtkMRMLLayerDMPipeline.

◆ SetViewNode()

void vtkMRMLLayerDMScriptedPipelineBridge::SetViewNode ( vtkMRMLAbstractViewNode * viewNode )

overridevirtual

Set the pipeline view node (initialization). default behavior: Stored and view node is observed for vtkCommand::ModifiedEvent.

Parameters

viewNode The instance of viewNode the pipeline is attached to

Reimplemented from vtkMRMLLayerDMPipeline.

◆ UpdateFromMRML()

void vtkMRMLLayerDMScriptedPipelineBridge::UpdateFromMRML ( )

overridevirtual

Triggered on

See also: UpdateDisplay calls default behavior: does nothing.

Reimplemented from vtkMRMLLayerDMPipeline.

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

Modules/Loadable/LayerDM/MRMLDM/vtkMRMLLayerDMScriptedPipelineBridge.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLLayerDMScriptedPipelineBridge()

◆ ~vtkMRMLLayerDMScriptedPipelineBridge()

Member Function Documentation

◆ CanProcessInteractionEvent()

◆ CastCallData()

◆ GetClassName()

◆ GetCustomCamera()

◆ GetMouseCursor()

◆ GetRenderOrder()

◆ GetRenderOrders()

◆ GetWidgetState()

◆ IsA()

◆ IsTypeOf()

◆ LoseFocus()

◆ New()

◆ OnDefaultCameraModified()

◆ OnReferenceToDisplayNodeAdded()

◆ OnReferenceToDisplayNodeRemoved()

◆ OnRendererAdded()

◆ OnRendererRemoved()

◆ OnUpdate()

◆ PrintSelf()

◆ ProcessInteractionEvent()

◆ SafeDownCast()

◆ SetDisplayNode()

◆ SetPipelineManager()

◆ SetPythonObject()

◆ SetScene()

◆ SetViewNode()

◆ UpdateFromMRML()