Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
vtkMRMLNode Class Referenceabstract

Abstract Superclass for all specific types of MRML nodes. More...

#include <Libs/MRML/Core/vtkMRMLNode.h>

Inheritance diagram for vtkMRMLNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLNode:
Collaboration graph
[legend]

Classes

class  vtkMRMLNodeReference
 Class to hold information about a node reference. More...
 

Public Types

enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void Copy (vtkMRMLNode *node)
 Copy parameters (not including ID and Scene) from another node of the same type. More...
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
virtual vtkMRMLNodeCreateNodeInstance ()=0
 Create instance of the default node. Like New only virtual. More...
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual const char * GetClassName ()
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
virtual const char * GetNodeTagName ()=0
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
virtual int IsA (const char *type)
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml. More...
 
virtual void ReadXMLAttributes (const char **atts)
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
virtual void UpdateScene (vtkMRMLScene *)
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
virtual void WriteXML (ostream &of, int indent)
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Types

typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 

Protected Member Functions

virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Static Protected Member Functions

static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Protected Attributes

int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Friends

class vtkMRMLScene
 
class vtkMRMLSceneViewNode
 

Detailed Description

Abstract Superclass for all specific types of MRML nodes.

This node encapsulates the functionality common to all types of MRML nodes. This includes member variables for ID, Description, and Options, as well as member functions to Copy() and Write().

Definition at line 138 of file vtkMRMLNode.h.

Member Typedef Documentation

◆ AttributesType

typedef std::map< std::string, std::string > vtkMRMLNode::AttributesType
protected

Definition at line 924 of file vtkMRMLNode.h.

◆ NodeReferenceEventsType

typedef std::map< std::string, vtkSmartPointer<vtkIntArray> > vtkMRMLNode::NodeReferenceEventsType
protected

Definition at line 937 of file vtkMRMLNode.h.

◆ NodeReferenceListType

typedef std::vector< vtkSmartPointer<vtkMRMLNodeReference> > vtkMRMLNode::NodeReferenceListType
protected

NodeReferences is a map that stores vector of references for each referenceRole, the referenceRole can be any unique string, for example "display", "transform" etc.

Definition at line 931 of file vtkMRMLNode.h.

◆ NodeReferencesType

typedef std::map< std::string, NodeReferenceListType > vtkMRMLNode::NodeReferencesType
protected

Definition at line 932 of file vtkMRMLNode.h.

◆ Superclass

typedef vtkObject vtkMRMLNode::Superclass

Definition at line 146 of file vtkMRMLNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

HierarchyModifiedEvent is generated when the hierarchy node with which this node is associated changes

Enumerator
HierarchyModifiedEvent 
IDChangedEvent 
ReferenceAddedEvent 
ReferenceModifiedEvent 
ReferenceRemovedEvent 
ReferencedNodeModifiedEvent 

Definition at line 742 of file vtkMRMLNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLNode() [1/2]

vtkMRMLNode::vtkMRMLNode ( )
protected

◆ ~vtkMRMLNode()

vtkMRMLNode::~vtkMRMLNode ( )
overrideprotected

critical to have a virtual destructor!

◆ vtkMRMLNode() [2/2]

vtkMRMLNode::vtkMRMLNode ( const vtkMRMLNode )
protected

Member Function Documentation

◆ AddAndObserveNodeReferenceID()

vtkMRMLNode* vtkMRMLNode::AddAndObserveNodeReferenceID ( const char *  referenceRole,
const char *  referencedNodeID,
vtkIntArray *  events = nullptr 
)

Add and observe a reference node from this node for a specific referenceRole.

Observe Modified event by default, optionally takes array of events.

◆ AddNodeReferenceID()

vtkMRMLNode* vtkMRMLNode::AddNodeReferenceID ( const char *  referenceRole,
const char *  referencedNodeID 
)

Convenience method that adds a referencedNodeID at the end of the list.

◆ AddNodeReferenceRole()

void vtkMRMLNode::AddNodeReferenceRole ( const char *  referenceRole,
const char *  mrmlAttributeName = nullptr,
vtkIntArray *  events = nullptr 
)

Add a referenceRole.

The referenceRole can be any unique string, for example "display", "transform" etc. Optionally a MRML attribute name for storing the reference in the mrml scene file can be specified. For example "displayNodeRef". If omitted the MRML attribute name will be the same as the role. If referenceRole ends with '/', it is considered as a "template" reference role that can be used to generate attribute names dynamically by concatenation: If referenceRole is "unit/" and mrmlAttributeName is "UnitRef", then the generated MRML attribute names for a node reference role of "unit/length" will be "lengthUnitRef". Use this method to add new reference types to a node. This method is typically called in the constructors of each subclass. The optional events argument specifies what events should be observed by default (e.g., when loading the scene from file).

See also
GetReferenceNodeFromMRMLAttributeName()

◆ AddToSceneOff()

virtual void vtkMRMLNode::AddToSceneOff ( )
virtual

◆ AddToSceneOn()

virtual void vtkMRMLNode::AddToSceneOn ( )
virtual

◆ Copy()

virtual void vtkMRMLNode::Copy ( vtkMRMLNode node)
virtual

Copy parameters (not including ID and Scene) from another node of the same type.

Note
Subclasses should implement this method. Call this method in the subclass implementation. Node name is only updated if a non-empty node name is specified in the source node.

Reimplemented in vtkMRMLPlotSeriesNode, vtkMRMLMarkupsNode, vtkMRMLVolumePropertyNode, vtkMRMLSegmentationStorageNode, vtkMRMLDisplayNode, vtkMRMLAnnotationDisplayNode, vtkMRMLSegmentEditorNode, vtkMRMLSubjectHierarchyNode, vtkMRMLSegmentationDisplayNode, vtkMRMLTransformDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLDisplayableNode, vtkMRMLFolderDisplayNode, vtkMRMLSegmentationNode, vtkMRMLStorageNode, vtkMRMLTableNode, vtkMRMLColorNode, vtkMRMLFiducialListNode, vtkMRMLShaderPropertyNode, vtkMRMLMarkupsCurveNode, vtkMRMLStreamingVolumeNode, vtkMRMLMarkupsFiducialNode, vtkMRMLPlotViewNode, vtkMRMLStorableNode, vtkMRMLModelDisplayNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsLineNode, vtkMRMLModelNode, vtkMRMLAnnotationNode, vtkMRMLMarkupsDisplayNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLChartNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDoubleArrayNode, vtkMRMLVolumeNode, vtkMRMLPlotChartNode, vtkMRMLSliceNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLTableViewNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAbstractViewNode, vtkMRMLMarkupsStorageNode, vtkMRMLUnitNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLCameraNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLTransformNode, vtkMRMLCropVolumeParametersNode, vtkMRMLCrosshairNode, vtkMRMLClipModelsNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLLinearTransformNode, vtkMRMLProceduralColorNode, vtkMRMLSelectionNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLColorTableNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLSceneViewNode, vtkMRMLTransformStorageNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLSnapshotClipNode, vtkMRMLTextNode, vtkMRMLAnnotationLinesNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLVolumeRenderingDisplayNode, vtkMRMLChartViewNode, vtkMRMLHierarchyNode, vtkMRMLModelHierarchyNode, vtkMRMLVolumeDisplayNode, vtkMRMLAbstractLayoutNode, vtkMRMLBSplineTransformNode, vtkMRMLNRRDStorageNode, vtkMRMLViewNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLAnnotationROINode, vtkMRMLVectorVolumeNode, vtkMRMLGridTransformNode, vtkMRMLScriptedModuleNode, vtkMRMLSliceCompositeNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLCommandLineModuleNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationSplineNode, vtkMRMLROINode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLLayoutNode, vtkMRMLROIListNode, vtkMRMLPETProceduralColorNode, and vtkMRMLInteractionNode.

◆ CopyReferences()

virtual void vtkMRMLNode::CopyReferences ( vtkMRMLNode node)
virtual

Copy the references of the node into this.

Existing references will be replaced if found in node, or removed if not in node.

◆ CopyWithoutModifiedEvent()

void vtkMRMLNode::CopyWithoutModifiedEvent ( vtkMRMLNode node)
inline

Definition at line 532 of file vtkMRMLNode.h.

◆ CopyWithScene()

void vtkMRMLNode::CopyWithScene ( vtkMRMLNode node)

Copy everything (including Scene and ID) from another node of the same type.

Note
The node is not added into the scene of node. You must do it manually after calling CopyWithScene(vtkMRMLNode*) using vtkMRMLScene::AddNode(vtkMRMLNode*).
Bug:
Calling vtkMRMLScene::AddNode(vtkMRMLNode*) before CopyWithScene(vtkMRMLNode*) is NOT supported, it will unsynchronize the node internal caches. See #4078
See also
vtkMRMLScene::AddNode(vtkMRMLNode*)

◆ CopyWithSceneWithSingleModifiedEvent()

void vtkMRMLNode::CopyWithSceneWithSingleModifiedEvent ( vtkMRMLNode node)
inline

Copy everything (including Scene and ID) from another node of the same type.

This function is a wrapper around CopyWithScene(vtkMRMLNode *) ensuring that only one vtkCommand::ModifiedEvent is invoked. It internally uses the function StartModify() and EndModify(int).

See also
CopyWithScene(vtkMRMLNode *)
StartModify() EndModify(int)

Definition at line 548 of file vtkMRMLNode.h.

◆ CopyWithSingleModifiedEvent()

void vtkMRMLNode::CopyWithSingleModifiedEvent ( vtkMRMLNode node)
inline

Definition at line 523 of file vtkMRMLNode.h.

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLNode::CreateNodeInstance ( )
pure virtual

Create instance of the default node. Like New only virtual.

Note
Subclasses should implement this method

Implemented in vtkMRMLVolumePropertyNode, vtkMRMLSegmentationStorageNode, vtkMRMLMarkupsNode, vtkMRMLSegmentEditorNode, vtkMRMLSubjectHierarchyNode, vtkMRMLAnnotationDisplayNode, vtkMRMLPlotSeriesNode, vtkMRMLSegmentationDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLTransformDisplayNode, vtkMRMLModelDisplayNode, vtkMRMLSegmentationNode, vtkMRMLFolderDisplayNode, vtkMRMLShaderPropertyNode, vtkMRMLFiducialListNode, vtkMRMLTableNode, vtkMRMLColorNode, vtkMRMLMarkupsCurveNode, vtkMRMLDisplayableNode, vtkMRMLModelNode, vtkMRMLStreamingVolumeNode, vtkMRMLMarkupsFiducialNode, vtkMRMLPlotViewNode, vtkMRMLTableStorageNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsDisplayNode, vtkMRMLMarkupsLineNode, vtkMRMLStorableNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLChartNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDoubleArrayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLVolumeNode, vtkMRMLPlotChartNode, vtkMRMLSliceNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableViewNode, vtkMRMLAnnotationNode, vtkMRMLMarkupsFiducialDisplayNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLUnitNode, vtkMRMLCropVolumeParametersNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLLabelMapVolumeNode, vtkMRMLMarkupsStorageNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLSelectionNode, vtkMRMLTensorVolumeNode, vtkMRMLCameraNode, vtkMRMLTransformNode, vtkMRMLCrosshairNode, vtkMRMLStorageNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLLinearTransformNode, vtkMRMLProceduralColorNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLClipModelsNode, vtkMRMLColorTableNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLTransformableNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLSnapshotClipNode, vtkMRMLTextNode, vtkMRMLViewNode, vtkMRMLHierarchyNode, vtkMRMLTextStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLBSplineTransformNode, vtkMRMLChartViewNode, vtkMRMLModelHierarchyNode, vtkMRMLScriptedModuleNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLCommandLineModuleNode, vtkMRMLLabelMapVolumeDisplayNode, vtkMRMLNRRDStorageNode, vtkMRMLSceneViewNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLModelStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLVectorVolumeNode, vtkMRMLAnnotationLinesNode, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLGridTransformNode, vtkMRMLSliceCompositeNode, vtkMRMLAnnotationStickyNode, vtkMRMLSceneViewStorageNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationTextNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLROINode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationHierarchyNode, vtkMRMLAnnotationSplineNode, vtkMRMLROIListNode, vtkMRMLLayoutNode, vtkMRMLPETProceduralColorNode, and vtkMRMLInteractionNode.

◆ DisableModifiedEventOff()

void vtkMRMLNode::DisableModifiedEventOff ( )
inline

Definition at line 421 of file vtkMRMLNode.h.

◆ DisableModifiedEventOn()

void vtkMRMLNode::DisableModifiedEventOn ( )
inline

Definition at line 417 of file vtkMRMLNode.h.

◆ EndModify()

virtual int vtkMRMLNode::EndModify ( int  previousDisableModifiedEventState)
inlinevirtual

End modifying the node.

Enable Modify events if the previous state of DisableModifiedEvent flag is 0.

Return the number of pending events (even if InvokePendingModifiedEvent() is not called).

Definition at line 269 of file vtkMRMLNode.h.

◆ GetAddToScene()

virtual int vtkMRMLNode::GetAddToScene ( )
virtual

node added to MRML scene.

◆ GetAttribute()

const char* vtkMRMLNode::GetAttribute ( const char *  name)

Get value of a name value pair attribute.

Return nullptr if the name does not exists.

◆ GetAttributeNames() [1/2]

std::vector< std::string > vtkMRMLNode::GetAttributeNames ( )

Get all attribute names.

◆ GetAttributeNames() [2/2]

void vtkMRMLNode::GetAttributeNames ( vtkStringArray *  attributeNames)

Get all attribute names. Python-wrappable version.

◆ GetClassName()

virtual const char* vtkMRMLNode::GetClassName ( )
virtual

Reimplemented in vtkMRMLSegmentationStorageNode, vtkMRMLMarkupsNode, vtkMRMLSegmentEditorNode, vtkMRMLSubjectHierarchyNode, vtkMRMLSegmentationDisplayNode, vtkMRMLAnnotationDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLSegmentationNode, vtkMRMLFolderDisplayNode, vtkMRMLFiducialListNode, vtkMRMLColorNode, vtkMRMLTableNode, vtkMRMLStreamingVolumeNode, vtkMRMLTableStorageNode, vtkMRMLDisplayableNode, vtkMRMLModelNode, vtkMRMLPlotSeriesNode, vtkMRMLMarkupsCurveNode, vtkMRMLShaderPropertyNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLTransformDisplayNode, vtkMRMLVolumeNode, vtkMRMLMarkupsDisplayNode, vtkMRMLChartNode, vtkMRMLDoubleArrayNode, vtkMRMLSliceNode, vtkMRMLMarkupsFiducialNode, vtkMRMLAbstractViewNode, vtkMRMLPlotChartNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLDisplayNode, vtkMRMLLabelMapVolumeNode, vtkMRMLModelDisplayNode, vtkMRMLCropVolumeParametersNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsLineNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLMarkupsStorageNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLVolumePropertyNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLSelectionNode, vtkMRMLTensorVolumeNode, vtkMRMLMarkupsFiducialDisplayNode, vtkMRMLVolumeRenderingDisplayNode, vtkMRMLTableViewNode, vtkMRMLTransformNode, vtkMRMLUnitNode, vtkMRMLAbstractLayoutNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLStorableNode, vtkMRMLStorageNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLFiducialListStorageNode, vtkMRMLLinearTransformNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLPlotViewNode, vtkMRMLTransformableNode, vtkMRMLVolumeDisplayNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLCameraNode, vtkMRMLSnapshotClipNode, vtkMRMLTextStorageNode, vtkMRMLHierarchyNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLAnnotationNode, vtkMRMLBSplineTransformNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLScriptedModuleNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLCommandLineModuleNode, vtkMRMLClipModelsNode, vtkMRMLColorTableNode, vtkMRMLLabelMapVolumeDisplayNode, vtkMRMLNRRDStorageNode, vtkMRMLSceneViewNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLCrosshairNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLModelStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLVectorVolumeNode, vtkMRMLViewNode, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLGridTransformNode, vtkMRMLSliceCompositeNode, vtkMRMLChartViewNode, vtkMRMLModelHierarchyNode, vtkMRMLSceneViewStorageNode, vtkMRMLTextNode, vtkMRMLAnnotationStickyNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationTextNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationStorageNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationHierarchyNode, vtkMRMLAnnotationROINode, vtkMRMLLayoutNode, vtkMRMLROINode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLROIListNode, vtkMRMLAnnotationSplineNode, vtkMRMLInteractionNode, and vtkMRMLPETProceduralColorNode.

◆ GetDescription()

virtual char* vtkMRMLNode::GetDescription ( )
virtual

◆ GetDisableModifiedEvent()

virtual int vtkMRMLNode::GetDisableModifiedEvent ( )
virtual

Turn on/off generating InvokeEvent for set macros.

◆ GetHideFromEditors()

virtual int vtkMRMLNode::GetHideFromEditors ( )
virtual

Describes if the node is hidden.

◆ GetID()

virtual char* vtkMRMLNode::GetID ( )
virtual

ID use by other nodes to reference this node in XML.

◆ GetInMRMLCallbackFlag()

virtual int vtkMRMLNode::GetInMRMLCallbackFlag ( )
virtual

Flags to avoid event loops.

Warning
Do NOT use the SetMacro or it call modified on itself and generate even more events!

◆ GetModifiedEventPending()

virtual int vtkMRMLNode::GetModifiedEventPending ( )
virtual

Number of pending modified events.

See also
InvokePendingModifiedEvent()
Modified()
GetDisableModifiedEvent()

◆ GetMRMLAttributeNameFromReferenceRole()

virtual const char* vtkMRMLNode::GetMRMLAttributeNameFromReferenceRole ( const char *  refRole)
protectedvirtual

Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.

Note
AddNodeReference() must be called prior.
See also
GetReferenceRoleFromMRMLAttributeName(), AddNodeReference(), ReadXMLAttributes(), WriteXML()

◆ GetName()

virtual char* vtkMRMLNode::GetName ( )
virtual

◆ GetNodeReference()

vtkMRMLNode* vtkMRMLNode::GetNodeReference ( const char *  referenceRole)

Utility function that returns the first referenced node.

See also
GetNthNodeReference(int), GetNodeReferenceID()

◆ GetNodeReferenceID()

const char* vtkMRMLNode::GetNodeReferenceID ( const char *  referenceRole)

Utility function that returns the first node id for a specific referenceRole.

See also
GetNthNodeReferenceID(int), GetNodeReference()

◆ GetNodeReferenceIDs()

void vtkMRMLNode::GetNodeReferenceIDs ( const char *  referenceRole,
std::vector< const char *> &  referencedNodeIDs 
)

Return a list of the referenced node IDs.

Some IDs may be null and nodes for valid IDs may not yet be in the scene.

See also
GetNodeReferences(), GetNodeReferenceID()

◆ GetNodeReferenceRoles()

void vtkMRMLNode::GetNodeReferenceRoles ( std::vector< std::string > &  roles)

Get reference roles of the present node references.

See also
GetNodeReferenceRoles(), GetNodeReferenceRoles(), GetNthNodeReferenceRole()

◆ GetNodeReferences()

void vtkMRMLNode::GetNodeReferences ( const char *  referenceRole,
std::vector< vtkMRMLNode *> &  nodes 
)

Return a list of the referenced nodes.

Warning
Some nodes can be 0 when the scene is in a temporary state.
Note
The list of nodes is browsed (slow) to make sure the pointers are up-to-date.
See also
GetNthNodeReference

◆ GetNodeTagName()

virtual const char* vtkMRMLNode::GetNodeTagName ( )
pure virtual

Get node XML tag name (like Volume, Model).

Note
Subclasses should implement this method.

Implemented in vtkMRMLVolumePropertyNode, vtkMRMLSegmentationStorageNode, vtkMRMLMarkupsNode, vtkMRMLAnnotationDisplayNode, vtkMRMLSegmentEditorNode, vtkMRMLSubjectHierarchyNode, vtkMRMLPlotSeriesNode, vtkMRMLSegmentationDisplayNode, vtkMRMLTransformDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLSegmentationNode, vtkMRMLLayoutNode, vtkMRMLStorageNode, vtkMRMLTableNode, vtkMRMLColorNode, vtkMRMLFiducialListNode, vtkMRMLShaderPropertyNode, vtkMRMLVolumeNode, vtkMRMLModelDisplayNode, vtkMRMLPlotViewNode, vtkMRMLSliceNode, vtkMRMLStreamingVolumeNode, vtkMRMLFolderDisplayNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLMarkupsDisplayNode, vtkMRMLChartNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDoubleArrayNode, vtkMRMLPlotChartNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLTableViewNode, vtkMRMLUnitNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLMarkupsCurveNode, vtkMRMLCameraNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLModelNode, vtkMRMLTransformNode, vtkMRMLCrosshairNode, vtkMRMLDisplayableNode, vtkMRMLCropVolumeParametersNode, vtkMRMLClipModelsNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLLinearTransformNode, vtkMRMLProceduralColorNode, vtkMRMLMarkupsFiducialNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLColorTableNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLSceneViewNode, vtkMRMLSelectionNode, vtkMRMLTableStorageNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLSnapshotClipNode, vtkMRMLTextNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsLineNode, vtkMRMLChartViewNode, vtkMRMLHierarchyNode, vtkMRMLModelHierarchyNode, vtkMRMLVolumeDisplayNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLBSplineTransformNode, vtkMRMLStorableNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformableNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVectorVolumeNode, vtkMRMLViewNode, vtkMRMLGridTransformNode, vtkMRMLSliceCompositeNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLAnnotationNode, vtkMRMLMarkupsFiducialDisplayNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLLabelMapVolumeNode, vtkMRMLMarkupsStorageNode, vtkMRMLScriptedModuleNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLCommandLineModuleNode, vtkMRMLTransformStorageNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLFiducialListStorageNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLROINode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLTextStorageNode, vtkMRMLLabelMapVolumeDisplayNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLModelStorageNode, vtkMRMLROIListNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationHierarchyNode, vtkMRMLProceduralColorStorageNode, vtkMRMLAnnotationLinesNode, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLAnnotationStickyNode, vtkMRMLPETProceduralColorNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationTextNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLInteractionNode, and vtkMRMLAnnotationSplineNode.

◆ GetNthNodeReference()

vtkMRMLNode* vtkMRMLNode::GetNthNodeReference ( const char *  referenceRole,
int  n 
)

Get referenced MRML node for a specific referenceRole.

Can be 0 in temporary states; e.g. if the referenced node has no scene, or if the referenced is not yet into the scene. If not cached, it tnternally scans (slow) the scene to search for the associated referenced node ID. If the referencing node is no longer in the scene (GetScene() == 0), it happens after the node is removed from the scene (scene->RemoveNode(dn), the returned referenced node is 0.

◆ GetNthNodeReferenceID()

const char* vtkMRMLNode::GetNthNodeReferenceID ( const char *  referenceRole,
int  n 
)

Return the string of the Nth node ID for a specific reference role.

Return 0 if no such node exist.

Warning
A temporary char generated from a std::string::c_str() is returned.

◆ GetNthNodeReferenceRole()

const char* vtkMRMLNode::GetNthNodeReferenceRole ( int  n)

Get a specific node reference role name.

See also
GetNodeReferenceRoles(), GetNodeReferenceRoles(), GetNthNodeReferenceRole()

◆ GetNumberOfNodeReferenceRoles()

int vtkMRMLNode::GetNumberOfNodeReferenceRoles ( )

Get number of node reference role names.

See also
GetNodeReferenceRoles(), GetNodeReferenceRoles(), GetNthNodeReferenceRole()

◆ GetNumberOfNodeReferences()

int vtkMRMLNode::GetNumberOfNodeReferences ( const char *  referenceRole)

Return the number of node IDs for a specific reference role (and nodes as they always have the same size).

◆ GetReferenceRoleFromMRMLAttributeName()

virtual const char* vtkMRMLNode::GetReferenceRoleFromMRMLAttributeName ( const char *  attName)
protectedvirtual

Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise.

Note
AddNodeReference() must be called prior.
See also
GetMRMLAttributeNameFromReferenceRole(), AddNodeReference(), ReadXMLAttributes(), WriteXML()

◆ GetSaveWithScene()

virtual int vtkMRMLNode::GetSaveWithScene ( )
virtual

Save node with MRML scene.

◆ GetScene()

virtual vtkMRMLScene* vtkMRMLNode::GetScene ( )
virtual

Get the scene this node has been added to.

◆ GetSelectable()

virtual int vtkMRMLNode::GetSelectable ( )
virtual

Describes if the node is selectable.

◆ GetSelected()

virtual int vtkMRMLNode::GetSelected ( )
virtual

Get/Set for Selected.

◆ GetSingletonTag()

virtual char* vtkMRMLNode::GetSingletonTag ( )
virtual

◆ GetTempURLString()

virtual char* vtkMRMLNode::GetTempURLString ( )
protectedvirtual

◆ GetUndoEnabled()

virtual bool vtkMRMLNode::GetUndoEnabled ( )
virtual

Specifies if the state of this node is stored in the scene's undo buffer. False by default to make sure that undo can be enabled selectively, only for nodes that are prepared to work correctly when saved/restored. Nodes with different UndoEnabled value must not reference to each other, because restoring states could lead to unresolved node references. Therefore, when undo is enabled for a certain node, it must be enabled for nodes that it references (for example, if undo is enabled for vtkMRMLModelNode then it must be enabled for vtkMRMLModelDisplayNode and vtkMRMLModelStorageNode as well).

◆ GetUpdatedReferencedNodeEventList()

void vtkMRMLNode::GetUpdatedReferencedNodeEventList ( int &  oldReferencedNodeUseCount,
int &  newReferencedNodeUseCount,
vtkIntArray *  oldConsolidatedEventList,
vtkIntArray *  newConsolidatedEventList,
vtkMRMLNode oldReferencedNode,
vtkMRMLNode newReferencedNode,
vtkMRMLNodeReference referenceToIgnore,
vtkIntArray *  newEvents 
)
protected

Helper function for SetAndObserveNthNodeReferenceID (through UpdateNodeReferenceEventObserver). Counts how many times the old and new node is used and what events are observed. referenceToIgnore specifies a reference (the reference that is currently being processed) that is ignored. oldReferencedNodeUseCount and oldConsolidatedEventList are only computed if oldReferencedNode!=newReferencedNode.

◆ HasNodeReferenceID()

bool vtkMRMLNode::HasNodeReferenceID ( const char *  referenceRole,
const char *  referencedNodeID 
)

Return true if referencedNodeID is in the node ID list for a specific referenceRole.

If nullptr is specified as role then all roles are checked.

◆ HideFromEditorsOff()

virtual void vtkMRMLNode::HideFromEditorsOff ( )
virtual

◆ HideFromEditorsOn()

virtual void vtkMRMLNode::HideFromEditorsOn ( )
virtual

◆ InvalidateNodeReferences()

virtual void vtkMRMLNode::InvalidateNodeReferences ( )
protectedvirtual

Remove all references and event observers to referenced nodes but leave ID's and events. References and event observers can be re-added by calling UpdateNodeReferences().

◆ InvokeCustomModifiedEvent()

virtual void vtkMRMLNode::InvokeCustomModifiedEvent ( int  eventId,
void *  callData = nullptr 
)
inlinevirtual

This method allows the node to compress events.

Instead of invoking a certain event several times, the event is called only once, for all the invocations that are made between StartModify() and EndModify().

Typical usage is to group several ...Added, ...Removed, ...Modified events into one, to improve performance.

callData is passed to InvokeEvent() if the event is invoked immediately.

If the event is not invoked immediately then it will be sent with callData=nullptr.

Definition at line 508 of file vtkMRMLNode.h.

◆ InvokePendingModifiedEvent()

virtual int vtkMRMLNode::InvokePendingModifiedEvent ( )
inlinevirtual

Invokes any modified events that are pending.

Pending modified events were generated while the DisableModifiedEvent flag was nonzero.

Returns the total number of pending modified events that have been replaced by the just invoked modified event(s).

Reimplemented in vtkMRMLAnnotationControlPointsNode.

Definition at line 465 of file vtkMRMLNode.h.

◆ IsA()

virtual int vtkMRMLNode::IsA ( const char *  type)
virtual

Reimplemented in vtkMRMLSegmentationStorageNode, vtkMRMLMarkupsNode, vtkMRMLSegmentEditorNode, vtkMRMLSubjectHierarchyNode, vtkMRMLSegmentationDisplayNode, vtkMRMLAnnotationDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLSegmentationNode, vtkMRMLFolderDisplayNode, vtkMRMLFiducialListNode, vtkMRMLColorNode, vtkMRMLTableNode, vtkMRMLStreamingVolumeNode, vtkMRMLTableStorageNode, vtkMRMLDisplayableNode, vtkMRMLModelNode, vtkMRMLPlotSeriesNode, vtkMRMLMarkupsCurveNode, vtkMRMLShaderPropertyNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLTransformDisplayNode, vtkMRMLVolumeNode, vtkMRMLMarkupsDisplayNode, vtkMRMLChartNode, vtkMRMLDoubleArrayNode, vtkMRMLSliceNode, vtkMRMLMarkupsFiducialNode, vtkMRMLAbstractViewNode, vtkMRMLPlotChartNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLDisplayNode, vtkMRMLLabelMapVolumeNode, vtkMRMLModelDisplayNode, vtkMRMLCropVolumeParametersNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsLineNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLMarkupsStorageNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLVolumePropertyNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLSelectionNode, vtkMRMLTensorVolumeNode, vtkMRMLMarkupsFiducialDisplayNode, vtkMRMLVolumeRenderingDisplayNode, vtkMRMLTableViewNode, vtkMRMLTransformNode, vtkMRMLUnitNode, vtkMRMLAbstractLayoutNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLStorableNode, vtkMRMLStorageNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLFiducialListStorageNode, vtkMRMLLinearTransformNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLPlotViewNode, vtkMRMLTransformableNode, vtkMRMLVolumeDisplayNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLCameraNode, vtkMRMLSnapshotClipNode, vtkMRMLTextStorageNode, vtkMRMLHierarchyNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLAnnotationNode, vtkMRMLBSplineTransformNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLScriptedModuleNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLCommandLineModuleNode, vtkMRMLClipModelsNode, vtkMRMLColorTableNode, vtkMRMLLabelMapVolumeDisplayNode, vtkMRMLNRRDStorageNode, vtkMRMLSceneViewNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLCrosshairNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLModelStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLVectorVolumeNode, vtkMRMLViewNode, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLGridTransformNode, vtkMRMLSliceCompositeNode, vtkMRMLChartViewNode, vtkMRMLModelHierarchyNode, vtkMRMLSceneViewStorageNode, vtkMRMLTextNode, vtkMRMLAnnotationStickyNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationTextNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationStorageNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationHierarchyNode, vtkMRMLAnnotationROINode, vtkMRMLLayoutNode, vtkMRMLROINode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLROIListNode, vtkMRMLAnnotationSplineNode, vtkMRMLInteractionNode, and vtkMRMLPETProceduralColorNode.

◆ IsReferenceRoleGeneric()

virtual bool vtkMRMLNode::IsReferenceRoleGeneric ( const char *  refRole)
protectedvirtual

Return true if the reference role is generic (ends with '/') or false otherwise.

See also
AddNodeReference()

◆ IsSingleton()

bool vtkMRMLNode::IsSingleton ( )
inline

Definition at line 395 of file vtkMRMLNode.h.

◆ IsTypeOf()

static int vtkMRMLNode::IsTypeOf ( const char *  type)
static

◆ Modified()

void vtkMRMLNode::Modified ( )
inlineoverride

Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.

It overrides the vtkObject method so that all changes to the node which would normally generate a vtkCommand::ModifiedEvent can be grouped into an atomic operation.

Typical usage would be to disable modified events, call a series of Set* operations, and then re-enable modified events and call InvokePendingModifiedEvent() to invoke the event (if any of the Set* calls actually changed the values of the instance variables).

See also
GetDisableModifiedEvent()

Definition at line 446 of file vtkMRMLNode.h.

◆ MRMLCallback()

static void vtkMRMLNode::MRMLCallback ( vtkObject *  caller,
unsigned long  eid,
void *  clientData,
void *  callData 
)
staticprotected

a shared set of functions that call the virtual ProcessMRMLEvents

◆ OnNodeAddedToScene()

virtual void vtkMRMLNode::OnNodeAddedToScene ( )
inlinevirtual

Updates this node if it depends on other nodes when the scene is read in This method is called by scene when a node added to a scene.

Definition at line 181 of file vtkMRMLNode.h.

◆ OnNodeReferenceAdded()

virtual void vtkMRMLNode::OnNodeReferenceAdded ( vtkMRMLNodeReference reference)
inlineprotectedvirtual

Called when a valid node reference is added. The event is not invoked when the referenced node ID is specified, but only when a valid node pointer is obtained.

Reimplemented in vtkMRMLPlotChartNode, vtkMRMLModelNode, vtkMRMLPlotSeriesNode, vtkMRMLVolumeNode, vtkMRMLDisplayableNode, vtkMRMLPlotViewNode, and vtkMRMLTransformableNode.

Definition at line 880 of file vtkMRMLNode.h.

◆ OnNodeReferenceModified()

virtual void vtkMRMLNode::OnNodeReferenceModified ( vtkMRMLNodeReference reference)
inlineprotectedvirtual

Called when a referenced node pointer is modified.

Reimplemented in vtkMRMLPlotChartNode, vtkMRMLModelNode, vtkMRMLPlotSeriesNode, vtkMRMLVolumeNode, vtkMRMLDisplayableNode, vtkMRMLPlotViewNode, and vtkMRMLTransformableNode.

Definition at line 886 of file vtkMRMLNode.h.

◆ OnNodeReferenceRemoved()

virtual void vtkMRMLNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference reference)
inlineprotectedvirtual

Called when a referenced node pointer is removed (set to nullptr).

Reimplemented in vtkMRMLPlotChartNode, vtkMRMLPlotSeriesNode, vtkMRMLDisplayableNode, vtkMRMLPlotViewNode, and vtkMRMLTransformableNode.

Definition at line 892 of file vtkMRMLNode.h.

◆ operator=()

void vtkMRMLNode::operator= ( const vtkMRMLNode )
protected

◆ ParseReferencesAttribute()

void vtkMRMLNode::ParseReferencesAttribute ( const char *  attValue,
std::map< std::string, std::string > &  references 
)
protected

Parse references in the form "role1:id1 id2;role2:id3;" map contains existing role-id pairs, so we don't repeat them

◆ PrintSelf()

void vtkMRMLNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessChildNode()

virtual void vtkMRMLNode::ProcessChildNode ( vtkMRMLNode )
inlinevirtual

Set dependencies between this node and a child node when parsing XML file.

Reimplemented in vtkMRMLSceneViewNode.

Definition at line 169 of file vtkMRMLNode.h.

◆ ProcessMRMLEvents()

virtual void vtkMRMLNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
virtual

Propagate events generated in mrml.

Reimplemented in vtkMRMLTransformNode, vtkMRMLCommandLineModuleNode, vtkMRMLSelectionNode, vtkMRMLVolumeNode, vtkMRMLFiducialListNode, vtkMRMLModelDisplayNode, vtkMRMLDisplayableNode, vtkMRMLVolumePropertyNode, vtkMRMLMarkupsNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLCameraNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLPlotSeriesNode, vtkMRMLAnnotationDisplayNode, vtkMRMLPlotViewNode, vtkMRMLColorTableNode, vtkMRMLDisplayNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLStorageNode, vtkMRMLVolumeDisplayNode, vtkMRMLModelHierarchyNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLROINode, vtkMRMLColorNode, vtkMRMLROIListNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLVolumeRenderingDisplayNode, vtkMRMLTransformDisplayNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLFolderDisplayNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLTableNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLShaderPropertyNode, vtkMRMLStorableNode, vtkMRMLMarkupsDisplayNode, vtkMRMLChartNode, vtkMRMLDoubleArrayNode, vtkMRMLTransformableNode, vtkMRMLAnnotationNode, vtkMRMLPlotChartNode, vtkMRMLProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLModelNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLStreamingVolumeNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationAngleNode, vtkMRMLPETProceduralColorNode, vtkMRMLAnnotationSplineNode, and vtkMRMLLabelMapVolumeDisplayNode.

◆ ReadXMLAttributes()

virtual void vtkMRMLNode::ReadXMLAttributes ( const char **  atts)
virtual

Set node attributes

Note
Subclasses should implement this method. Call this method in the subclass implementation.

Reimplemented in vtkMRMLVolumePropertyNode, vtkMRMLSegmentationStorageNode, vtkMRMLMarkupsNode, vtkMRMLDisplayNode, vtkMRMLSegmentEditorNode, vtkMRMLAnnotationDisplayNode, vtkMRMLPlotSeriesNode, vtkMRMLSegmentationDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLTransformDisplayNode, vtkMRMLFolderDisplayNode, vtkMRMLSegmentationNode, vtkMRMLShaderPropertyNode, vtkMRMLFiducialListNode, vtkMRMLTableNode, vtkMRMLColorNode, vtkMRMLMarkupsCurveNode, vtkMRMLDisplayableNode, vtkMRMLStreamingVolumeNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsLineNode, vtkMRMLPlotViewNode, vtkMRMLStorableNode, vtkMRMLModelDisplayNode, vtkMRMLMarkupsDisplayNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLAnnotationNode, vtkMRMLChartNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDoubleArrayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLVolumeNode, vtkMRMLAbstractViewNode, vtkMRMLMarkupsStorageNode, vtkMRMLPlotChartNode, vtkMRMLSliceNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLTableViewNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLStorageNode, vtkMRMLUnitNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLCropVolumeParametersNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLCameraNode, vtkMRMLSelectionNode, vtkMRMLTransformNode, vtkMRMLCrosshairNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLLinearTransformNode, vtkMRMLProceduralColorNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLVolumeRenderingDisplayNode, vtkMRMLClipModelsNode, vtkMRMLColorTableNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLTransformableNode, vtkMRMLAbstractLayoutNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLSnapshotClipNode, vtkMRMLTextNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLHierarchyNode, vtkMRMLViewNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeDisplayNode, vtkMRMLAnnotationLinesNode, vtkMRMLBSplineTransformNode, vtkMRMLChartViewNode, vtkMRMLModelHierarchyNode, vtkMRMLNRRDStorageNode, vtkMRMLSceneViewNode, vtkMRMLScriptedModuleNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLCommandLineModuleNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLVectorVolumeNode, vtkMRMLAnnotationROINode, vtkMRMLGridTransformNode, vtkMRMLSliceCompositeNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationSplineNode, vtkMRMLAnnotationHierarchyNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLLayoutNode, vtkMRMLROINode, vtkMRMLROIListNode, vtkMRMLPETProceduralColorNode, and vtkMRMLInteractionNode.

◆ RemoveAttribute()

void vtkMRMLNode::RemoveAttribute ( const char *  name)

Remove attribute with the specified name.

◆ RemoveNodeReferenceIDs()

void vtkMRMLNode::RemoveNodeReferenceIDs ( const char *  referenceRole)

Remove all node IDs and associated nodes for a specific referenceRole.

If referenceRole is 0 remove references for all roles

◆ RemoveNthNodeReferenceID()

void vtkMRMLNode::RemoveNthNodeReferenceID ( const char *  referenceRole,
int  n 
)

Convenience method that removes the Nth node ID from the list.

◆ Reset()

virtual void vtkMRMLNode::Reset ( vtkMRMLNode defaultNode)
virtual

Reset node attributes to the initial state as defined in the constructor or the passed default node.

It preserves values of the following dynamic attributes that may be set by an application:

  • SaveWithScene
  • HideFromEditors
  • Selectable
  • SingletonTag.

If a defaultNode pointer is passed then the values stored in that node will be used to set the node contents. If defaultNode is nullptr then the values set in the constructor of the class will be used to set the node contents.

Note
Other attributes that needs to be preserved should be handled in the subclass.
See also
SetSaveWithScene()
SetHideFromEditors()
SetSelectable()
SetSingletonTag()

Reimplemented in vtkMRMLColorTableNode, vtkMRMLColorNode, vtkMRMLSliceNode, vtkMRMLUnitNode, and vtkMRMLAbstractViewNode.

◆ SafeDownCast()

static vtkMRMLNode* vtkMRMLNode::SafeDownCast ( vtkObject *  o)
static

◆ SaveWithSceneOff()

virtual void vtkMRMLNode::SaveWithSceneOff ( )
virtual

◆ SaveWithSceneOn()

virtual void vtkMRMLNode::SaveWithSceneOn ( )
virtual

◆ SelectableOff()

virtual void vtkMRMLNode::SelectableOff ( )
virtual

◆ SelectableOn()

virtual void vtkMRMLNode::SelectableOn ( )
virtual

◆ SelectedOff()

virtual void vtkMRMLNode::SelectedOff ( )
virtual

◆ SelectedOn()

virtual void vtkMRMLNode::SelectedOn ( )
virtual

◆ SetAddToScene()

virtual void vtkMRMLNode::SetAddToScene ( int  )
virtual

◆ SetAddToSceneNoModify()

void vtkMRMLNode::SetAddToSceneNoModify ( int  value)

◆ SetAndObserveNodeReferenceID()

vtkMRMLNode* vtkMRMLNode::SetAndObserveNodeReferenceID ( const char *  referenceRole,
const char *  referencedNodeID,
vtkIntArray *  events = nullptr 
)

Set and observe a reference node from this node for a specific referenceRole.

Observe Modified event by default, optionally takes array of events

◆ SetAndObserveNthNodeReferenceID()

vtkMRMLNode* vtkMRMLNode::SetAndObserveNthNodeReferenceID ( const char *  referenceRole,
int  n,
const char *  referencedNodeID,
vtkIntArray *  events = nullptr 
)

Set and observe the Nth node ID for a specific reference role.

If n is larger than the number of reference nodes, the node ID is added at the end of the list. If nodeReferenceID is 0, the node ID is removed from the list. When a node ID is set (added or changed), its corresponding node is searched (slow) into the scene and cached for fast future access. It is possible however that the node is not yet into the scene (due to some temporary state (at loading time for example). UpdateScene() can later be called to retrieve the nodes from the scene (automatically done when loading a scene). Get(Nth)NodeReference() also scan the scene if the node was not yet cached.

See also
SetAndObserveNodeReferenceID(const char*)
AddAndObserveNodeReferenceID(const char*)
RemoveNthNodeReferenceID(int)

◆ SetAttribute()

void vtkMRMLNode::SetAttribute ( const char *  name,
const char *  value 
)

Set a name value pair attribute.

Fires a vtkCommand::ModifiedEvent.

Attributes are written in the XML. If value is 0, the attribute name is removed from the pair list.

This function is a no-op if name is null or empty.

See also
WriteXML()

◆ SetDescription()

virtual void vtkMRMLNode::SetDescription ( const char *  )
virtual

Text description of this node, to be set by the user.

◆ SetDisableModifiedEvent()

void vtkMRMLNode::SetDisableModifiedEvent ( int  onOff)
inline

Definition at line 413 of file vtkMRMLNode.h.

◆ SetHideFromEditors()

virtual void vtkMRMLNode::SetHideFromEditors ( int  )
virtual

◆ SetInMRMLCallbackFlag()

void vtkMRMLNode::SetInMRMLCallbackFlag ( int  flag)
inline

Definition at line 343 of file vtkMRMLNode.h.

◆ SetName()

virtual void vtkMRMLNode::SetName ( const char *  )
virtual

Name of this node, to be set by the user.

Reimplemented in vtkMRMLUnitNode.

◆ SetNodeReferenceID()

vtkMRMLNode* vtkMRMLNode::SetNodeReferenceID ( const char *  referenceRole,
const char *  referencedNodeID 
)

Set a reference to a node with specified nodeID from this node for a specific referenceRole.

◆ SetNthNodeReferenceID()

vtkMRMLNode* vtkMRMLNode::SetNthNodeReferenceID ( const char *  referenceRole,
int  n,
const char *  referencedNodeID 
)

Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.

◆ SetSaveWithScene()

virtual void vtkMRMLNode::SetSaveWithScene ( int  )
virtual

◆ SetScene()

virtual void vtkMRMLNode::SetScene ( vtkMRMLScene scene)
virtual

This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene.

Internally calls SetSceneReferences()

See also
SetSceneReferences()

Reimplemented in vtkMRMLFolderDisplayNode.

◆ SetSceneReferences()

virtual void vtkMRMLNode::SetSceneReferences ( )
virtual

Update the references of the node to the scene.

Note
You must unsure that a valid scene is set before calling SetSceneReferences().

Reimplemented in vtkMRMLChartNode, vtkMRMLCameraNode, vtkMRMLDisplayNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLSelectionNode, vtkMRMLHierarchyNode, and vtkMRMLSliceCompositeNode.

◆ SetSelectable()

virtual void vtkMRMLNode::SetSelectable ( int  )
virtual

Reimplemented in vtkMRMLDisplayableNode.

◆ SetSelected()

virtual void vtkMRMLNode::SetSelected ( int  )
virtual

◆ SetSingletonOff()

void vtkMRMLNode::SetSingletonOff ( )
inline

Definition at line 391 of file vtkMRMLNode.h.

◆ SetSingletonOn()

void vtkMRMLNode::SetSingletonOn ( )
inline

Definition at line 387 of file vtkMRMLNode.h.

◆ SetSingletonTag()

virtual void vtkMRMLNode::SetSingletonTag ( const char *  )
virtual

Tag that make this node a singleton in the scene.

If set to nullptr, multiple instances of this node class are allowed.

If set to a non-nullptr string, the node will be a singleton and the scene will replace this node instead of adding new instances.

The SingletonTag is used by the scene to build a unique ID.

If the there can only be one instance of a given node class in the scene, then the singleton tag should be Singleton. For example, the interaction and selection nodes are named Selection and Interaction, with Singleton tags set to Singleton, and with IDs set to vtkMRMLSelectionNodeSingleton and vtkMRMLInteractionNodeSingleton. If the singleton node is associated with a specific module it should use the module name, which already needs to be unique, as the tag. The Editor module uses this naming convention, with a parameter node that has a singleton tag of Editor and a node ID of vtkMRMLScriptedModuleNodeEditor. If the there is more than one instance of the node class then the singleton tag should be Singleton post-pended with a unique identifier for that specific node (e.g. the name). Any new color nodes should use this convention, with a name of NewName, a Singleton tag of SingletonNewName, leading to an ID of vtkMRMLColorTableNodeSingletonNewName. The existing MRML nodes don't always use these conventions but are kept unchanged for backward compatibility.

See also
vtkMRMLScene::BuildID

◆ SetTempURLString()

virtual void vtkMRMLNode::SetTempURLString ( const char *  )
protectedvirtual

Get/Set the string used to manage encoding/decoding of strings/URLs with special characters.

◆ SetUndoEnabled()

virtual void vtkMRMLNode::SetUndoEnabled ( bool  )
virtual

◆ StartModify()

virtual int vtkMRMLNode::StartModify ( )
inlinevirtual

Start modifying the node. Disable Modify events.

Returns the previous state of DisableModifiedEvent flag that should be passed to EndModify() method.

See also
EndModify()

Definition at line 255 of file vtkMRMLNode.h.

◆ UndoEnabledOff()

virtual void vtkMRMLNode::UndoEnabledOff ( )
virtual

◆ UndoEnabledOn()

virtual void vtkMRMLNode::UndoEnabledOn ( )
virtual

◆ UpdateNodeReferenceEventObserver()

vtkMRMLNode* vtkMRMLNode::UpdateNodeReferenceEventObserver ( vtkMRMLNode oldReferencedNode,
vtkMRMLNode newReferencedNode,
vtkIntArray *  newEvents,
vtkMRMLNodeReference referenceToIgnore 
)
protected

Helper function for SetAndObserveNthNodeReferenceID. Updates the event observers on the old and new referenced node. referenceToIgnore should contain the current reference that is being updated.

◆ UpdateNodeReferences()

virtual void vtkMRMLNode::UpdateNodeReferences ( const char *  referenceRole = nullptr)
protectedvirtual

Updates references and event observations on the selected referenced nodes. If referenceRole is nullptr then all the roles will be updated.

See also
UpdateNthNodeReference

◆ UpdateNthNodeReference()

virtual void vtkMRMLNode::UpdateNthNodeReference ( const char *  referenceRole,
int  n 
)
protectedvirtual

Updates references and event observations on the selected referenced node. Update is necessary because at the time the reference was added the referenced node might not have been available in the scene yet. Prerequisites: scene is valid, n >= 0 and n < referenced node IDs list size.

◆ UpdateReferenceID()

virtual void vtkMRMLNode::UpdateReferenceID ( const char *  oldID,
const char *  newID 
)
virtual

◆ UpdateReferences()

virtual void vtkMRMLNode::UpdateReferences ( )
virtual

◆ UpdateScene()

virtual void vtkMRMLNode::UpdateScene ( vtkMRMLScene )
inlinevirtual

◆ URLDecodeString()

const char* vtkMRMLNode::URLDecodeString ( const char *  inString)

Decode a URL string.

Returns the string (null) if the input is null.

Note
Currently only works on %, space, ', ", <, >
See also
URLEncodeString()

◆ URLEncodeString()

const char* vtkMRMLNode::URLEncodeString ( const char *  inString)

Encode a URL string.

Returns the string (null) if the input is null.

Note
Currently only works on %, space, ', ", <, >
See also
URLDecodeString()

◆ WriteNodeBodyXML()

virtual void vtkMRMLNode::WriteNodeBodyXML ( ostream &  of,
int  indent 
)
virtual

Write this node's body to a MRML file in XML format.

Reimplemented in vtkMRMLSubjectHierarchyNode, and vtkMRMLSceneViewNode.

◆ WriteXML()

virtual void vtkMRMLNode::WriteXML ( ostream &  of,
int  indent 
)
virtual

Write this node's information to a MRML file in XML format.

Note
Subclasses should implement this method. Call this method in the subclass implementation.
Parameters
indentDeprecated argument that is kept for API backward-compatibility

Reimplemented in vtkMRMLVolumePropertyNode, vtkMRMLSegmentationStorageNode, vtkMRMLMarkupsNode, vtkMRMLDisplayNode, vtkMRMLSegmentEditorNode, vtkMRMLAnnotationDisplayNode, vtkMRMLPlotSeriesNode, vtkMRMLSubjectHierarchyNode, vtkMRMLSegmentationDisplayNode, vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLTransformDisplayNode, vtkMRMLFolderDisplayNode, vtkMRMLSegmentationNode, vtkMRMLStorageNode, vtkMRMLTableNode, vtkMRMLShaderPropertyNode, vtkMRMLColorNode, vtkMRMLFiducialListNode, vtkMRMLMarkupsCurveNode, vtkMRMLDisplayableNode, vtkMRMLStreamingVolumeNode, vtkMRMLMarkupsFiducialNode, vtkMRMLPlotViewNode, vtkMRMLStorableNode, vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsLineNode, vtkMRMLModelDisplayNode, vtkMRMLMarkupsDisplayNode, vtkMRMLDiffusionTensorVolumeDisplayNode, vtkMRMLScalarVolumeDisplayNode, vtkMRMLAnnotationNode, vtkMRMLChartNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDoubleArrayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, vtkMRMLVolumeNode, vtkMRMLPlotChartNode, vtkMRMLSliceNode, vtkMRMLAbstractViewNode, vtkMRMLMarkupsStorageNode, vtkMRMLTableViewNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLDiffusionTensorVolumeSliceDisplayNode, vtkMRMLUnitNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLDiffusionWeightedVolumeDisplayNode, vtkMRMLVectorVolumeDisplayNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLCropVolumeParametersNode, vtkMRMLCameraNode, vtkMRMLTransformNode, vtkMRMLCrosshairNode, vtkMRMLSelectionNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLLinearTransformNode, vtkMRMLProceduralColorNode, vtkMRMLCPURayCastVolumeRenderingDisplayNode, vtkMRMLGPURayCastVolumeRenderingDisplayNode, vtkMRMLClipModelsNode, vtkMRMLColorTableNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLTransformableNode, vtkMRMLMultiVolumeRenderingDisplayNode, vtkMRMLVolumeRenderingDisplayNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLSnapshotClipNode, vtkMRMLTextNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAbstractLayoutNode, vtkMRMLHierarchyNode, vtkMRMLVolumeDisplayNode, vtkMRMLAnnotationLinesNode, vtkMRMLBSplineTransformNode, vtkMRMLChartViewNode, vtkMRMLModelHierarchyNode, vtkMRMLViewNode, vtkMRMLNRRDStorageNode, vtkMRMLSceneViewNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLScriptedModuleNode, vtkMRMLVectorVolumeNode, vtkMRMLAnnotationROINode, vtkMRMLCommandLineModuleNode, vtkMRMLGridTransformNode, vtkMRMLModelStorageNode, vtkMRMLSliceCompositeNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationLineDisplayNode, vtkMRMLAnnotationPointDisplayNode, vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationSplineNode, vtkMRMLROINode, vtkMRMLAnnotationHierarchyNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLLayoutNode, vtkMRMLROIListNode, vtkMRMLPETProceduralColorNode, and vtkMRMLInteractionNode.

◆ XMLAttributeDecodeString()

std::string vtkMRMLNode::XMLAttributeDecodeString ( const std::string &  inString)

Decode an XML attribute string.

Important: attributes that vtkMRMLNode::ReadXMLAttributes method receives are already decoded, therefore no XML attribute decoding must not be applied to those strings.

See also
XMLAttributeEncodeString()

◆ XMLAttributeEncodeString()

std::string vtkMRMLNode::XMLAttributeEncodeString ( const std::string &  inString)

Encode an XML attribute string (replaces special characters by code sequences)

See also
XMLAttributeDecodeString()

Friends And Related Function Documentation

◆ vtkMRMLScene

friend class vtkMRMLScene
friend

make the vtkMRMLScene a friend so that AddNodeNoNotify can call SetID, but that's the only class that is allowed to do so

Definition at line 142 of file vtkMRMLNode.h.

◆ vtkMRMLSceneViewNode

friend class vtkMRMLSceneViewNode
friend

Definition at line 143 of file vtkMRMLNode.h.

Member Data Documentation

◆ AddToScene

int vtkMRMLNode::AddToScene
protected

Definition at line 910 of file vtkMRMLNode.h.

◆ Attributes

AttributesType vtkMRMLNode::Attributes
protected

Definition at line 925 of file vtkMRMLNode.h.

◆ Description

char* vtkMRMLNode::Description
protected

Definition at line 906 of file vtkMRMLNode.h.

◆ HideFromEditors

int vtkMRMLNode::HideFromEditors
protected

Definition at line 907 of file vtkMRMLNode.h.

◆ ID

char* vtkMRMLNode::ID
protected

Definition at line 904 of file vtkMRMLNode.h.

◆ InMRMLCallbackFlag

int vtkMRMLNode::InMRMLCallbackFlag
protected


Flag to avoid event loops

Definition at line 917 of file vtkMRMLNode.h.

◆ MRMLCallbackCommand

vtkCallbackCommand* vtkMRMLNode::MRMLCallbackCommand
protected

Holders for MRML callbacks.

Definition at line 902 of file vtkMRMLNode.h.

◆ MRMLObserverManager

vtkObserverManager* vtkMRMLNode::MRMLObserverManager
protected

Definition at line 927 of file vtkMRMLNode.h.

◆ Name

char* vtkMRMLNode::Name
protected

Definition at line 905 of file vtkMRMLNode.h.

◆ NodeReferenceEvents

NodeReferenceEventsType vtkMRMLNode::NodeReferenceEvents
protected

Definition at line 938 of file vtkMRMLNode.h.

◆ NodeReferenceMRMLAttributeNames

std::map< std::string, std::string> vtkMRMLNode::NodeReferenceMRMLAttributeNames
protected

Definition at line 935 of file vtkMRMLNode.h.

◆ NodeReferences

NodeReferencesType vtkMRMLNode::NodeReferences
protected

Definition at line 933 of file vtkMRMLNode.h.

◆ SaveWithScene

int vtkMRMLNode::SaveWithScene
protected

Definition at line 913 of file vtkMRMLNode.h.

◆ Scene

vtkWeakPointer<vtkMRMLScene> vtkMRMLNode::Scene
protected

Definition at line 922 of file vtkMRMLNode.h.

◆ Selectable

int vtkMRMLNode::Selectable
protected

Definition at line 908 of file vtkMRMLNode.h.

◆ Selected

int vtkMRMLNode::Selected
protected

Definition at line 909 of file vtkMRMLNode.h.

◆ UndoEnabled

bool vtkMRMLNode::UndoEnabled
protected

Definition at line 911 of file vtkMRMLNode.h.


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