https://www.slicer.org/w/index.php?action=history&feed=atom&title=Documentation%2F4.3%2FDevelopers%2FMRML%2FNodeReferences 2026-05-08T01:35:50Z Revision history for this page on the wiki MediaWiki 1.33.0 https://www.slicer.org/w/index.php?title=Documentation/4.3/Developers/MRML/NodeReferences&diff=37991&oldid=prev 2014-05-19T16:51:42Z

<p>moved <a href="/wiki/Documentation/4.3/Developers/MRMLNodeReferences" class="mw-redirect" title="Documentation/4.3/Developers/MRMLNodeReferences">Documentation/4.3/Developers/MRMLNodeReferences</a> to <a href="/wiki/Documentation/4.3/Developers/MRML/NodeReferences" title="Documentation/4.3/Developers/MRML/NodeReferences">Documentation/4.3/Developers/MRML/NodeReferences</a></p> <table class="diff diff-contentalign-left" data-mw="interface"> <tr class="diff-title" lang="en"> <td colspan="1" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td> <td colspan="1" style="background-color: #fff; color: #222; text-align: center;">Revision as of 16:51, 19 May 2014</td> </tr><tr><td colspan="2" class="diff-notice" lang="en"><div class="mw-diff-empty">(No difference)</div> </td></tr></table>

JChris.FillionR https://www.slicer.org/w/index.php?title=Documentation/4.3/Developers/MRML/NodeReferences&diff=35065&oldid=prev 2013-09-05T03:26:57Z

<p>Nightly -&gt; 4.3</p> <p><b>New page</b></p><div>&lt;noinclude&gt;{{documentation/versioncheck}}&lt;/noinclude&gt;<br /> == Goal ==<br /> This page explains how to create a MRML node that reference and observes<br /> other MRML nodes.<br /> <br /> == History ==<br /> In Slicer4.2 prior to March of 2013 each MRML node that contained<br /> references to other MRML nodes (for example each vtkMRMLDispalyableNode contained<br /> a reference to an instance vtkMRMLDisplayNode) was responsible for<br /> managing the references internally. This involved complicated logic and<br /> bookkeeping to maintain the references in sync when importing scenes,<br /> adding/deleting nodes, modifying referenced nodes, etc.<br /> <br /> When creating a new node with the reference to another node the following<br /> methods needed to be created/updated to handle the references:<br /> <br /> <br /> * Copy<br /> * PrintSelf<br /> * ReadXMLAttributes<br /> * WriteXML<br /> * ProcessMRMLEvents<br /> * UpdateReferenceIS<br /> * SetSceneRefeecnes<br /> * UpdateScene<br /> * UpdateReferences<br /> * SetAndObserveReferenedNode<br /> <br /> == New API ==<br /> The new node reference API automatically takes care of read/write/copy of<br /> node references, updating references on scene import, adding and deleting<br /> nodes. All that functionality in implemented the vtkMRMLNode base<br /> class. The only thing that needs to happen in the derived MRML node class<br /> (usually in the constructor of the class)<br /> is a call to vtkMRMLNode::AddNodeReferenceRole(const char *referenceRole,<br /> const char *mrmlAttributeName)<br /> that takes a unique string defining the reference role between this node<br /> and the referenced node, and a MRML attribute name for storing the<br /> reference in the .mrml file.<br /> <br /> The only other call that is needed is either:<br /> vtkMRMLNode* SetAndObserveNodeReferenceID(const char* referenceRole , const<br /> char* referencedNodeID, vtkIntArray *events=0);<br /> or <br /> vtkMRMLNode* AddAndObserveNodeReferenceID(const char* referenceRole , const<br /> char* referencedNodeID, vtkIntArray *events=0);<br /> if the multiple instances of this reference are allowed.<br /> <br /> vtkMRMLNode also provides virtual callbacks that can be extended in the<br /> derived calsses:<br /> * OnNodeReferenceAdded(vtkMRMLNodeReference *reference)<br /> * OnNodeReferenceRemoved(vtkMRMLNodeReference *reference)<br /> * OnNodeReferenceModified(vtkMRMLNodeReference *reference)<br /> <br /> By default those methods generate the following events:<br /> * vtkMRMLNode::ReferenceAddedEvent<br /> * vtkMRMLNode::ReferenceRemovedEvent<br /> * vtkMRMLNode::ReferenceModifiedEvent<br /> <br /> In the derived classes those methods could be extended using vtkMRMLNode<br /> API that allows querying of node's references:<br /> <br /> * char *GetNthNodeReferenceID(const char* referenceRole, int n);<br /> * vtkMRMLNode* GetNthNodeReference(const char* referenceRole, int n);<br /> * int GetNumberOfNodeReferences(const char* referenceRole);<br /> * etc.<br /> <br /> For full API see:<br /> <br /> http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLNode.h?view=log<br /> <br /> Currently the following MRML nodes are implemented using new API:<br /> * vtkMRMLStorableNode<br /> * vtkMRMLTransformableNode<br /> * vtkMRMLDisplayableNode<br /> <br /> Other references to MRML nodes such as to vtkMRMLColorTableNode, vtkMRMLDiffusionTensorDisplayPropertiesNode are currently not using new API.<br /> <br /> Module parameter nodes that contain references to input/output Volume/Model, etc. nodes may or may not require a new API since not all of them contain logic to deal with reference changes.<br /> <br /> == Examples ==<br /> * vtkMRMLTransformableNode implementation:<br /> http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLTransformableNode.h?view=log<br /> * vtkMRMLDisplayableNodeimplementation:<br /> http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLDisplayableNode.h?view=log<br /> * vtkMRMLStorableNodeimplementation:<br /> http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=log</div>

UpdateBot