Inheritance diagram for Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline:

[legend]

Collaboration diagram for Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline:

[legend]

Public Member Functions
	__init__ (self)

tuple[bool, float]	CanProcessInteractionEvent (self, vtkMRMLInteractionEventData eventData)

vtkMRMLNode	displayNode (self)

vtkCamera\|None	GetCustomCamera (self, int renderOrder)

int	GetMouseCursor (self)

int	GetRenderOrder (self)

list[int]	GetRenderOrders (self)

int	GetWidgetState (self)

None	LoseFocus (self, vtkMRMLInteractionEventData\|None eventData)

None	OnDefaultCameraModified (self, vtkCamera camera)

None	OnReferenceToDisplayNodeAdded (self, vtkMRMLNode\|None fromNode, str role)

None	OnReferenceToDisplayNodeRemoved (self, vtkMRMLNode\|None fromNode, str role)

None	OnRendererAdded (self, vtkRenderer\|None renderer)

None	OnRendererRemoved (self, vtkRenderer renderer)

None	OnUpdate (self, vtkObject obj, int eventId, Any\|None callData)

bool	ProcessInteractionEvent (self, vtkMRMLInteractionEventData eventData)

None	SetDisplayNode (self, vtkMRMLNode displayNode)

None	SetPipelineManager (self, vtkMRMLLayerDMPipelineManager pipelineManager)

None	SetScene (self, vtkMRMLScene scene)

None	SetViewNode (self, vtkMRMLAbstractViewNode viewNode)

None	UpdateFromMRML (self)

vtkMRMLAbstractViewNode	viewNode (self)

Public Member Functions inherited from vtkMRMLLayerDMScriptedPipelineBridge
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

Additional Inherited Members
Public Types inherited from vtkMRMLLayerDMScriptedPipelineBridge
typedef vtkMRMLLayerDMPipeline	Superclass

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

typedef vtkObject	Superclass

Static Public Member Functions inherited from vtkMRMLLayerDMScriptedPipelineBridge
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 inherited from vtkMRMLLayerDMScriptedPipelineBridge
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 base class for all Layer Displayable Manager pipelines.

Definition at line 16 of file vtkMRMLLayerDMScriptedPipeline.py.

Constructor & Destructor Documentation

◆ init()

Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.__init__ ( self )

Definition at line 19 of file vtkMRMLLayerDMScriptedPipeline.py.

Member Function Documentation

◆ CanProcessInteractionEvent()

tuple[bool, float] Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.CanProcessInteractionEvent	(		self,
		vtkMRMLInteractionEventData	eventData )

Should return true + distance2 to interaction if the pipeline can process the input event data.
:param eventData: The MRML event needing to be processed
:return: (bool, distance2) default = False, float_max

Definition at line 32 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ displayNode()

vtkMRMLNode Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.displayNode ( self )

Property returning the current display node for which the pipeline was created.

Definition at line 28 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ GetCustomCamera()

vtkCamera \| None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.GetCustomCamera	(		self,
		int	renderOrder )

Custom pipeline camera for the input renderOrder.
If the returned value is not None, then the pipeline (or dedicated logic) is expected to handle its own camera
for the given input render order.
Otherwise, the pipeline will be moved in a renderer with a default camera synchronized on its view default camera.

:return: None by default

Definition at line 42 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ GetMouseCursor()

int Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.GetMouseCursor ( self )

Custom mouse cursor from VTK mouse cursor enum.
This value is only used if the pipeline actually processes an event and is ignored otherwise.
:return: 0 by default.

Definition at line 53 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ GetRenderOrder()

int Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.GetRenderOrder ( self )

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.

See also: vtkMRMLLayerDMLayerManager
:return: default = 0

Definition at line 61 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ GetRenderOrders()

list[int] Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.GetRenderOrders ( self )

Arbitrary render orders number where the pipeline wants to be displayed.
Allows the pipeline to be displayed in more than one renderer (for instance in the background / foreground).
Return larger values to be rendered on top of pipelines with lower render orders.

:return: default = [self.GetRenderOrder()]

Definition at line 72 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ GetWidgetState()

int Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.GetWidgetState ( self )

Current widget state of the pipeline.
:return: default = WidgetStateIdle

Definition at line 82 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ LoseFocus()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.LoseFocus	(		self,
		vtkMRMLInteractionEventData \| None	eventData )

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.
:param eventData: Optional event data which triggered the lose focus

Definition at line 89 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ OnDefaultCameraModified()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.OnDefaultCameraModified	(		self,
		vtkCamera	camera )

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

Definition at line 98 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ OnReferenceToDisplayNodeAdded()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.OnReferenceToDisplayNodeAdded	(		self,
		vtkMRMLNode \| None	fromNode,
		str	role )

Triggered when a reference to the display node is added
default behavior: does nothing.

See also: self.GetDisplayNode()
:param fromNode: Node which added a reference to the display node
:param role: Role of the added reference

Definition at line 106 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ OnReferenceToDisplayNodeRemoved()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.OnReferenceToDisplayNodeRemoved	(		self,
		vtkMRMLNode \| None	fromNode,
		str	role )

Triggered when a reference to the display node is removed
default behavior: does nothing.

See also: self.GetDisplayNode()
:param fromNode: Node which removed a reference to the display node
:param role: Role of the removed reference

Definition at line 117 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ OnRendererAdded()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.OnRendererAdded	(		self,
		vtkRenderer \| None	renderer )

Triggered when the pipeline is displayed on a new renderer.
default behavior: does nothing.
See also: self.GetRenderer()
See also: self.UpdateDisplay()
See also: self.RequestRender()

:param renderer: Optional instance of renderer on which the pipeline is added

Definition at line 128 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ OnRendererRemoved()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.OnRendererRemoved	(		self,
		vtkRenderer	renderer )

Triggered when the pipeline is removed from its previous renderer.
default behavior: does nothing.
See also: self.GetRenderer()

:param renderer: Optional instance of renderer from which the pipeline was removed

Definition at line 140 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ OnUpdate()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.OnUpdate	(		self,
		vtkObject	obj,
		int	eventId,
		Any \| None	callData )

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

:param obj: vtkObject instance which triggered the callback
:param eventId: Event id which triggered the callback
:param callData: Optional observer call data. Use self.CastCallData(callData, vtkType) to convert to Python

Definition at line 150 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ ProcessInteractionEvent()

bool Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.ProcessInteractionEvent	(		self,
		vtkMRMLInteractionEventData	eventData )

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

:param eventData: The MRML event needing to be processed
:return: True if event was processed. False otherwise (default = false)

Definition at line 161 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ SetDisplayNode()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.SetDisplayNode	(		self,
		vtkMRMLNode	displayNode )

Called when the display node of the pipeline has changed (initialization).
default behavior: Stored and display node is observed for vtkCommand::ModifiedEvent.
See also: self.UpdateObservation(prevObj, newObj, eventIds)
See also: self.OnUpdate(obj, eventId, callData)

:param displayNode: The new instance of display node for the pipeline

Definition at line 171 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ SetPipelineManager()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.SetPipelineManager	(		self,
		vtkMRMLLayerDMPipelineManager	pipelineManager )

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

See also: self.GetPipelineManager()
See also: self.GetNodePipeline(node)
:param pipelineManager: The instance of pipeline manager managing the current pipeline

Definition at line 182 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ SetScene()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.SetScene	(		self,
		vtkMRMLScene	scene )

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

Definition at line 193 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ SetViewNode()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.SetViewNode	(		self,
		vtkMRMLAbstractViewNode	viewNode )

Set the pipeline view node  (initialization).
default behavior: Stored and view node is observed for vtkCommand::ModifiedEvent.
:param viewNode: The instance of viewNode the pipeline is attached to

Definition at line 200 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ UpdateFromMRML()

None Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.UpdateFromMRML ( self )

Triggered by self.UpdateDisplay() calls
Override to update the representation of the pipeline in the different views.

See also: self.RequestRender()
default behavior: does nothing.

Definition at line 208 of file vtkMRMLLayerDMScriptedPipeline.py.

◆ viewNode()

vtkMRMLAbstractViewNode Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline.viewNode ( self )

Property returning the current view node on which the pipeline is attached.

Definition at line 23 of file vtkMRMLLayerDMScriptedPipeline.py.

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

Modules/Loadable/LayerDM/MRMLDM/Python/vtkMRMLLayerDMScriptedPipeline.py

Public Member Functions

Additional Inherited Members