Documentation/Nightly/Developers/MRML/NodeReferences - Revision history

JChris.FillionR at 22:20, 3 April 2015

2015-04-03T22:20:37Z

JChris.FillionR at 22:10, 3 April 2015

2015-04-03T22:10:25Z

JChris.FillionR at 22:05, 3 April 2015

2015-04-03T22:05:14Z

JChris.FillionR: /* Overview */

2015-04-03T22:02:55Z

Overview

JChris.FillionR at 22:02, 3 April 2015

2015-04-03T22:02:45Z

JChris.FillionR: moved Documentation/Nightly/Developers/MRMLNodeReferences to Documentation/Nightly/Developers/MRML/NodeReferences

2014-05-19T16:51:07Z

moved Documentation/Nightly/Developers/MRMLNodeReferences to Documentation/Nightly/Developers/MRML/NodeReferences

JChris.FillionR at 15:30, 19 May 2014

2014-05-19T15:30:27Z

JChris.FillionR: /* API Description */

2014-01-30T23:07:06Z

API Description

JChris.FillionR: /* API Description */

2014-01-30T23:03:53Z

API Description

JChris.FillionR at 23:01, 30 January 2014

2014-01-30T23:01:51Z

@@ Line 55: / Line 55: @@
 * etc.
-For full API see: http://slicer.org/doc/html/classvtkMRMLNode-members.html
+For full API see [{{doxygen-class-url|vtkMRMLNode|members}} here]
 Currently the following MRML nodes are implemented using MRML Node Reference API:

@@ Line 9: / Line 9: @@
 == API Description ==
-The node reference API automatically takes care of (1) read/write/copy of
+The node reference API automatically takes care of
-node references, (2) updating references on scene import, (3) adding and deleting
+(1) read/write/copy of node references,
-nodes. All that functionality is implemented in the <code>vtkMRMLNode</code> base
+(2) updating references on scene import,
-class. The only thing that needs to happen in the derived MRML node class
+(3) adding and deleting nodes.
 (usually in the constructor of the class)
-is a call to <code>vtkMRMLNode::AddNodeReferenceRole(const char *referenceRole,
+All that functionality is implemented in the [{{doxygen-class-url|vtkMRMLNode}} vtkMRMLNode] base class.
 const char *mrmlAttributeName)</code>
-that takes a unique string defining the reference role between this node
+The only thing that needs to happen in the derived MRML node class (usually in the constructor of the class)
 and the referenced node, and a MRML attribute name for storing the
 reference in the .mrml file.
@@ Line 28: / Line 30: @@
 vtkMRMLNode* AddAndObserveNodeReferenceID(const char* referenceRole , const char* referencedNodeID, vtkIntArray *events=0);
 </pre>
-if the multiple instances of this reference are allowed.
+if multiple instances of this reference are allowed.
-vtkMRMLNode also provides virtual callbacks that can be extended in the
+[{{doxygen-class-url|vtkMRMLNode}} vtkMRMLNode] also provides virtual callbacks that can be extended in the
 derived classes:
-* OnNodeReferenceAdded(vtkMRMLNodeReference *reference)
+<pre>
-* OnNodeReferenceRemoved(vtkMRMLNodeReference *reference)
+OnNodeReferenceAdded(vtkMRMLNodeReference *reference)
-* OnNodeReferenceModified(vtkMRMLNodeReference *reference)
+OnNodeReferenceRemoved(vtkMRMLNodeReference *reference)
 By default those methods generate the following events:
-* vtkMRMLNode::ReferenceAddedEvent
+<pre>
-* vtkMRMLNode::ReferenceRemovedEvent
+vtkMRMLNode::ReferenceAddedEvent
-* vtkMRMLNode::ReferenceModifiedEvent
+vtkMRMLNode::ReferenceRemovedEvent
 In the derived classes those methods could be extended using <code>vtkMRMLNode</code>

@@ Line 52: / Line 52: @@
 Currently the following MRML nodes are implemented using MRML Node Reference API:
-* vtkMRMLStorableNode
+* [{{doxygen-class-url|vtkMRMLStorableNode}} vtkMRMLStorableNode]
-* vtkMRMLTransformableNode
+* [{{doxygen-class-url|vtkMRMLTransformableNode}} vtkMRMLTransformableNode]
-* vtkMRMLDisplayableNode
+* [{{doxygen-class-url|vtkMRMLDisplayableNode}} vtkMRMLDisplayableNode]
-Other references to MRML nodes such as to vtkMRMLColorTableNode, vtkMRMLDiffusionTensorDisplayPropertiesNode are currently not using this API.
+Other references to MRML nodes such as to [{{doxygen-class-url|vtkMRMLColorTableNode}} vtkMRMLColorTableNode], [{{doxygen-class-url|vtkMRMLDiffusionTensorDisplayPropertiesNode}} vtkMRMLDiffusionTensorDisplayPropertiesNode] are currently not using this API.
 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.

← Older revision		Revision as of 22:02, 3 April 2015
Line 6:		Line 6:

	As describe in the [[Documentation/{{documentation/version}}/Developers/MRML#MRML_Nodes\|MRML Nodes]] section, node references allow to associate data node implementing interfaces (like [{{doxygen-class-url\|vtkMRMLDisplayableNode}} Displayable], [{{doxygen-class-url\|vtkMRMLStorableNode}} Storable] and [{{doxygen-class-url\|vtkMRMLTransformableNode}} Transformable]) with a representation node (like [{{doxygen-class-url\|vtkMRMLStorageNode}} Storage] or [{{doxygen-class-url\|vtkMRMLDisplayNode}} Display] node) or other data node (like [{{doxygen-class-url\|vtkMRMLTransformNode}} Transform] node).		As describe in the [[Documentation/{{documentation/version}}/Developers/MRML#MRML_Nodes\|MRML Nodes]] section, node references allow to associate data node implementing interfaces (like [{{doxygen-class-url\|vtkMRMLDisplayableNode}} Displayable], [{{doxygen-class-url\|vtkMRMLStorableNode}} Storable] and [{{doxygen-class-url\|vtkMRMLTransformableNode}} Transformable]) with a representation node (like [{{doxygen-class-url\|vtkMRMLStorageNode}} Storage] or [{{doxygen-class-url\|vtkMRMLDisplayNode}} Display] node) or other data node (like [{{doxygen-class-url\|vtkMRMLTransformNode}} Transform] node).
−
−	~~Before delving into the details of the node references API, let's~~

	== API Description ==		== API Description ==

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
-== Goal ==
+== Overview ==
-This page explains how to create a MRML node that reference and observes
+This page explains how to create a MRML node that reference and observes other MRML nodes.
 other MRML nodes.
 == API Description ==

← Older revision	Revision as of 16:51, 19 May 2014
(No difference)

@@ Line 6: / Line 6: @@
 other MRML nodes.
-== New API ==
+== API Description ==
-The new node reference API automatically takes care of read/write/copy of
+The node reference API automatically takes care of read/write/copy of
 node references, updating references on scene import, adding and deleting
-nodes. All that functionality in implemented the vtkMRMLNode base
+nodes. All that functionality is implemented in the vtkMRMLNode base
 class. The only thing that needs to happen in the derived MRML node class
 (usually in the constructor of the class)