Class vtkMRMLLayerDMNodeReferenceObserver

Inheritance Relationships

Base Type

  • public vtkObject

Class Documentation

class vtkMRMLLayerDMNodeReferenceObserver : public vtkObject

Inheritance diagram for vtkMRMLLayerDMNodeReferenceObserver:

digraph { graph [bgcolor="#00000000"] node [shape=rectangle style=filled fillcolor="#FFFFFF" font=Helvetica padding=2] edge [color="#1414CE"] "2" [label="vtkObject" tooltip="vtkObject"] "1" [label="vtkMRMLLayerDMNodeReferenceObserver" tooltip="vtkMRMLLayerDMNodeReferenceObserver" fillcolor="#BFBFBF"] "1" -> "2" [dir=forward tooltip="public-inheritance"] }

Collaboration diagram for vtkMRMLLayerDMNodeReferenceObserver:

digraph { graph [bgcolor="#00000000"] node [shape=rectangle style=filled fillcolor="#FFFFFF" font=Helvetica padding=2] edge [color="#1414CE"] "2" [label="vtkObject" tooltip="vtkObject"] "1" [label="vtkMRMLLayerDMNodeReferenceObserver" tooltip="vtkMRMLLayerDMNodeReferenceObserver" fillcolor="#BFBFBF"] "1" -> "2" [dir=forward tooltip="public-inheritance"] }

Reference node observer. Triggers node ref added / removed when references change in the scene. Allows to appropriately update pipelines when references to a given display node are added / removed.

Unnamed Group

using CallBackT = std::function<void(vtkMRMLNode*, vtkMRMLNode*, const std::string&, int eventType)>

Set the callback triggerred when a reference from a node to another node with a given role is added / removed. If the callbacks are defined before the scene is set to the object, the callbacks will be triggerred for existing nodes in the scene.

void SetReferenceModifiedCallBack(const CallBackT &modifiedCallback)

Unnamed Group

std::set<RefT> GetNodeToReferences(vtkMRMLNode *node) const

Get references to / from node

std::set<RefT> GetNodeFromReferences(vtkMRMLNode *node) const

Unnamed Group

int GetReferenceToSize() const

Returns the number of nodes currently stored in the observer. Used for testing / debugging purposes. Usage in normal context should be unnecessary.

int GetReferenceFromSize() const
int GetNumberOfNodes() const

Public Types

enum Event

Values:

enumerator ReferenceAddedEvent
enumerator ReferenceRemovedEvent
using RefT = std::tuple<vtkWeakPointer<vtkMRMLNode>, std::string>

Public Functions

void SetScene(vtkMRMLScene *scene)

Setting the MRML scene will trigger node added / removed callbacks if they are set.

Public Static Functions

static vtkMRMLLayerDMNodeReferenceObserver *New()

Protected Functions

vtkMRMLLayerDMNodeReferenceObserver()
~vtkMRMLLayerDMNodeReferenceObserver() override = default