Class vtkMRMLLayerDMScriptedPipeline

• Defined in File vtkMRMLLayerDMScriptedPipeline.py

Inheritance Relationships

Base Type

• public vtkMRMLLayerDMScriptedPipelineBridge

Class Documentation

Python.vtkMRMLLayerDMScriptedPipeline.vtkMRMLLayerDMScriptedPipeline : public vtkMRMLLayerDMScriptedPipelineBridge

Inheritance diagram for Python::vtkMRMLLayerDMScriptedPipeline::vtkMRMLLayerDMScriptedPipeline:

Collaboration diagram for Python::vtkMRMLLayerDMScriptedPipeline::vtkMRMLLayerDMScriptedPipeline:

Python base class for all Layer Displayable Manager pipelines.

Public Functions

__init__(self)

viewNode(self)

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

displayNode(self)

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

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

GetCustomCamera(self)

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

:return: None by default

GetMouseCursor(self)

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

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

GetWidgetState(self)

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

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

OnDefaultCameraModified(self, vtkCamera camera)

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

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

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

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.ResetDisplay()
See also: self.RequestRender()

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

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 or renderer from which the pipeline was removed
:return:

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

Observer update callback.
Triggered when any object & events observed using UpdateObserver 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

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)

SetDisplayNode(self, vtkMRMLNode displayNode)

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

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

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

SetScene(self, vtkMRMLScene scene)

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

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

UpdatePipeline(self)

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

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