15#ifndef __vtkMRMLNode_h
16#define __vtkMRMLNode_h
21#include "vtkIdTypeArray.h"
22#include "vtkIntArray.h"
30#include <vtkSmartPointer.h>
31#include <vtkWeakPointer.h>
32class vtkCallbackCommand;
35#include <vtkLoggingMacros.h>
46#ifndef vtkSetMRMLObjectMacro
47# define vtkSetMRMLObjectMacro(node, value) \
49 this->MRMLObserverManager->SetObject(vtkObjectPointer(&(node)), (value)); \
54#ifndef vtkSetAndObserveMRMLObjectMacro
55# define vtkSetAndObserveMRMLObjectMacro(node, value) \
57 this->MRMLObserverManager->SetAndObserveObject(vtkObjectPointer(&(node)), (value)); \
61#ifndef vtkSetAndObserveMRMLObjectMacroNoWarning
62# define vtkSetAndObserveMRMLObjectMacroNoWarning(node, value) \
64 this->MRMLObserverManager->SetAndObserveObject(vtkObjectPointer(&(node)), (value), 0.0, false ); \
68#ifndef vtkSetAndObserveMRMLObjectEventsMacro
69# define vtkSetAndObserveMRMLObjectEventsMacro(node, value, events) \
71 this->MRMLObserverManager->SetAndObserveObjectEvents(vtkObjectPointer(&(node)), (value), (events)); \
75#ifndef vtkSetAndObserveMRMLObjectEventsMacroNoWarning
76# define vtkSetAndObserveMRMLObjectEventsMacroNoWarning(node, value, events) \
78 this->MRMLObserverManager->SetAndObserveObjectEvents(vtkObjectPointer(&(node)), (value), (events), nullptr , false ); \
82#ifndef vtkObserveMRMLObjectMacro
83# define vtkObserveMRMLObjectMacro(node) \
85 this->MRMLObserverManager->ObserveObject((node)); \
89#ifndef vtkObserveMRMLObjectEventMacro
90# define vtkObserveMRMLObjectEventMacro(node, event) \
92 this->MRMLObserverManager->AddObjectEvent((node), (event)); \
96#ifndef vtkObserveMRMLObjectEventMacroNoWarning
97# define vtkObserveMRMLObjectEventMacroNoWarning(node, event) \
99 this->MRMLObserverManager->AddObjectEvent((node), (event), 0.0, false); \
103#ifndef vtkObserveMRMLObjectEventsMacro
104# define vtkObserveMRMLObjectEventsMacro(node, events) \
106 this->MRMLObserverManager->AddObjectEvents((node), (events)); \
110#ifndef vtkUnObserveMRMLObjectMacro
111# define vtkUnObserveMRMLObjectMacro(node) \
113 this->MRMLObserverManager->RemoveObjectEvents((node)); \
117#ifndef vtkSetReferenceStringBodyMacro
118# define vtkSetReferenceStringBodyMacro(name) \
119 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting " << #name " to " << (_arg ? _arg : "(null)")); \
120 if (this->name == nullptr && _arg == nullptr) \
124 if (this->name && _arg && (!strcmp(this->name, _arg))) \
128 std::string oldValue; \
131 oldValue = this->name; \
132 delete[] this->name; \
136 size_t n = strlen(_arg) + 1; \
137 char* cp1 = new char[n]; \
138 const char* cp2 = (_arg); \
147 this->name = nullptr; \
150 if (this->Scene && this->name) \
152 if (oldValue.size() > 0) \
154 this->Scene->RemoveReferencedNodeID(oldValue.c_str(), this); \
156 this->Scene->AddReferencedNodeID(this->name, this); \
160#ifndef vtkSetReferenceStringMacro
161# define vtkSetReferenceStringMacro(name) \
162 virtual void Set##name(const char* _arg) \
164 vtkSetReferenceStringBodyMacro(name) \
168#ifndef vtkCxxSetReferenceStringMacro
169# define vtkCxxSetReferenceStringMacro(class, name) \
170 void class ::Set##name(const char* _arg) \
172 vtkSetReferenceStringBodyMacro(name); \
176#ifndef vtkMRMLNodeNewMacro
177# define vtkMRMLNodeNewMacro(newClass) \
178 vtkStandardNewMacro(newClass); \
179 vtkMRMLNode* newClass::CreateNodeInstance() \
181 return newClass::New(); \
193#ifndef vtkMRMLCopyContentMacro
194# define vtkMRMLCopyContentMacro(thisClassName) \
195 void CopyContent(vtkMRMLNode* node, bool deepCopy = true) override; \
196 bool HasCopyContent() const override \
198 return strcmp(#thisClassName, this->GetClassNameInternal()) == 0; \
206#ifndef vtkMRMLCopyContentDefaultMacro
207# define vtkMRMLCopyContentDefaultMacro(thisClassName) \
208 bool HasCopyContent() const override \
210 return strcmp(#thisClassName, this->GetClassNameInternal()) == 0; \
216#define DEFAULT_NODE_NAME_PREFIX_IS_STD_STRING 1
361 return disabledModify;
371 virtual int EndModify(
int previousDisableModifiedEventState)
374 if (!previousDisableModifiedEventState)
378 return this->ModifiedEventPending;
480 vtkGetStringMacro(
ID);
508 vtkSetStringMacro(SingletonTag);
509 vtkGetStringMacro(SingletonTag);
526 vtkGetMacro(DisableModifiedEvent,
int);
536 vtkGetMacro(ModifiedEventPending,
int);
545 std::map<int, int>::iterator it = this->CustomModifiedEventPending.find(eventId);
546 if (it == this->CustomModifiedEventPending.end())
573 Superclass::Modified();
577 ++this->ModifiedEventPending;
590 int oldModifiedEventPending = 0;
592 if (this->ModifiedEventPending)
594 oldModifiedEventPending += this->ModifiedEventPending;
595 this->ModifiedEventPending = 0;
596 Superclass::Modified();
599 if (!this->CustomModifiedEventPending.empty())
604 std::vector<int> customEventsToInvoke;
605 for (std::map<int, int>::iterator it = this->CustomModifiedEventPending.begin(); it != this->CustomModifiedEventPending.end(); ++it)
607 oldModifiedEventPending += it->second;
608 customEventsToInvoke.push_back(it->first);
610 this->CustomModifiedEventPending.clear();
611 for (std::vector<int>::iterator it = customEventsToInvoke.begin(); it != customEventsToInvoke.end(); ++it)
613 this->InvokeEvent(*it);
616 return oldModifiedEventPending;
636 this->InvokeEvent(eventId, callData);
642 ++this->CustomModifiedEventPending[eventId];
726 void AddNodeReferenceRole(
const char* referenceRole,
const char* mrmlAttributeName =
nullptr, vtkIntArray* events =
nullptr,
bool observeContentModifiedEvents =
false);
748 const char* referencedNodeID,
749 vtkIntArray* events =
nullptr,
762 const char* referencedNodeID,
763 vtkIntArray* events =
nullptr,
789 const char* referencedNodeID,
790 vtkIntArray* events =
nullptr,
957 void PrintSelf(ostream& vtkNotUsed(os), vtkIndent vtkNotUsed(indent))
override {};
985 bool SetProperty(
const std::string& key,
const std::string& value);
1035 static void MRMLCallback(vtkObject* caller,
unsigned long eid,
void* clientData,
void* callData);
1039 vtkSetStringMacro(TempURLString);
1040 vtkGetStringMacro(TempURLString);
1086 vtkIntArray* newEvents,
1087 bool newObserveContentModifiedEvents,
1096 int& newReferencedNodeUseCount,
1097 vtkIntArray* oldConsolidatedEventList,
1098 vtkIntArray* newConsolidatedEventList,
1102 vtkIntArray* newEvents,
1103 bool newObserveContentModifiedEvents);
1182 void SetID(
const char* newID);
1185 char* TempURLString{
nullptr };
1187 char* SingletonTag{
nullptr };
1189 int DisableModifiedEvent{ 0 };
1190 int ModifiedEventPending{ 0 };
1191 std::map<int, int> CustomModifiedEventPending;
1212 this->WasModifying = this->Node->StartModify();
1219 this->Node->EndModify(this->WasModifying);
MRMLNodeModifyBlocker(vtkMRMLNode *node)
vtkWeakPointer< vtkMRMLNode > Node
Class to hold information about a node reference.
void SetReferencingNode(vtkMRMLNode *node)
vtkIntArray * GetStaticEvents() const
bool SetProperty(const std::string &key, const std::string &value)
Set the properties of the reference.
void PrintSelf(ostream &vtkNotUsed(os), vtkIndent vtkNotUsed(indent)) override
vtkMRMLNodeReference(const vtkMRMLNodeReference &)
ContentModifiedObserveType ObserveContentModifiedEvents
vtkWeakPointer< vtkMRMLNode > ReferencingNode
Points to this MRML node (that added the reference)
void SetProperties(const ReferencePropertiesType &properties)
~vtkMRMLNodeReference() override
vtkSmartPointer< vtkIntArray > StaticEvents
Events that should be observed.
void SetReferencedNode(vtkMRMLNode *node)
static vtkMRMLNodeReference * New()
ReferencePropertiesType Properties
vtkMRMLNode * GetReferencingNode() const
char * ReferenceRole
Name of the reference role.
vtkMRMLNode * GetReferencedNode() const
bool RemoveProperty(const std::string &key)
Remove a property from the reference.
bool ClearProperties()
Remove all properties from the reference.
std::string GetProperty(const std::string &key) const
Get the properties of the reference.
void SetStaticEvents(vtkIntArray *events)
Set the events that will be observed when the referenced node will be available.
vtkSmartPointer< vtkMRMLNode > ReferencedNode
The referenced node that is actually observed now.
void operator=(const vtkMRMLNodeReference &)
const ReferencePropertiesType * GetProperties() const
Abstract Superclass for all specific types of MRML nodes.
virtual void UpdateReferences()
The method should remove all pointers and observations to all nodes that are not in the scene anymore...
void DisableModifiedEventOn()
virtual void SetScene(vtkMRMLScene *scene)
This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene.
virtual int StartModify()
Start modifying the node. Disable Modify events.
vtkMRMLNode * GetNodeReference(const char *referenceRole)
vtkMRMLNode * AddAndObserveNodeReferenceID(const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
Add and observe a reference node from this node for a specific referenceRole.
void DisableModifiedEventOff()
virtual void OnNodeReferenceRemoved(vtkMRMLNodeReference *reference)
Called when a referenced node pointer is removed (set to nullptr).
void ParseReferencesAttribute(const char *attValue, std::set< std::string > &references)
virtual void UpdateNodeReferences(const char *referenceRole=nullptr)
virtual void UpdateNthNodeReference(const char *referenceRole, int n)
int GetNumberOfNodeReferenceRoles()
virtual void OnNodeReferenceModified(vtkMRMLNodeReference *reference)
Called when a referenced node pointer is modified.
virtual const char * GetMRMLAttributeNameFromReferenceRole(const char *refRole)
Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.
virtual void WriteNodeBodyXML(ostream &of, int indent)
Write this node's body to a MRML file in XML format.
NodeReferenceEventsType NodeReferenceEvents
vtkMRMLNode * AddNodeReferenceID(const char *referenceRole, const char *referencedNodeID)
Convenience method that adds a referencedNodeID at the end of the list.
vtkMRMLNode * UpdateNodeReferenceEventObserver(vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, bool newObserveContentModifiedEvents, vtkMRMLNodeReference *referenceToIgnore)
void GetAttributeNames(vtkStringArray *attributeNames)
Get all attribute names. Python-wrappable version.
void ClearNodeReferenceProperties(const std::string &referenceRole)
Remove all node reference properties for a specific referenceRole.
std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
void GetNodeReferenceRoles(std::vector< std::string > &roles)
std::map< std::string, std::string > ReferencePropertiesType
Get the node reference properties for a specific referenceRole.
void SetAddToSceneNoModify(int value)
virtual std::string GetDefaultNodeNamePrefix()
void RemoveNthNodeReferenceID(const char *referenceRole, int n)
Convenience method that removes the Nth node ID from the list.
std::string GetNthNodeReferenceProperty(const std::string &referenceRole, int n, const std::string &propertyName)
virtual int InvokePendingModifiedEvent()
Invokes any modified events that are pending.
virtual void CopyReferences(vtkMRMLNode *node)
Copy the references of the node into this.
std::string NodeReferencePropertyEncodeString(const std::string &inString)
Encode a node reference property string (replaces special characters by code sequences)
friend class vtkMRMLSceneViewNode
virtual void InvalidateNodeReferences()
virtual void Reset(vtkMRMLNode *defaultNode)
Reset node attributes to the initial state as defined in the constructor or the passed default node.
vtkIntArray * ContentModifiedEvents
std::string XMLAttributeEncodeString(const std::string &inString)
Encode an XML attribute string (replaces special characters by code sequences)
virtual int GetDisableModifiedEvent()
Turn on/off generating InvokeEvent for set macros.
AttributesType Attributes
void RemoveNodeReferenceProperty(const std::string &referenceRole, const std::string &propertyName)
Remove a node reference property for a specific referenceRole.
NodeReferencesType NodeReferences
virtual char * GetSingletonTag()
std::map< std::string, NodeReferenceListType > NodeReferencesType
void SetNodeReferenceProperty(const std::string &referenceRole, const std::string &propertyName, const std::string &value)
Set the node reference property for a specific referenceRole.
ContentModifiedObserveType
@ ContentModifiedObserveDisabled
Do not observe content modified events (default)
@ ContentModifiedObserveUndefined
Observe content modified events if it is enabled in the node reference role.
@ ContentModifiedObserveEnabled
Observe content modified events.
virtual vtkMRMLNode * CreateNodeInstance()=0
Create instance of the default node. Like New only virtual.
int GetNumberOfNodeReferenceProperties(const std::string &referenceRole)
Get the number of node reference properties for a specific referenceRole.
void GetNodeReferences(const char *referenceRole, std::vector< vtkMRMLNode * > &nodes)
Return a list of the referenced nodes.
@ ReferencedNodeModifiedEvent
virtual const char * GetNodeTagName()=0
void RemoveNodeReferenceIDs(const char *referenceRole)
Remove all node IDs and associated nodes for a specific referenceRole.
void RemoveInvalidReferences(const std::set< std::string > &validNodeIDs)
bool HasNodeReferenceID(const char *referenceRole, const char *referencedNodeID)
Return true if referencedNodeID is in the node ID list for a specific referenceRole.
virtual void ReadXMLAttributes(const char **atts)
void GetUpdatedReferencedNodeEventList(int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents, bool newObserveContentModifiedEvents)
virtual void OnNodeAddedToScene()
virtual bool HasCopyContent() const
Returns true if the class supports deep and shallow copying node content.
virtual void SetSceneReferences()
Update the references of the node to the scene.
const char * GetNodeReferenceID(const char *referenceRole)
Utility function that returns the first node id for a specific referenceRole.
virtual void OnNodeReferenceAdded(vtkMRMLNodeReference *reference)
virtual bool IsReferenceRoleGeneric(const char *refRole)
Return true if the reference role is generic (ends with '/') or false otherwise.
std::string GetNodeReferencePropertyName(const std::string &referenceRole, int propertyIndex)
Get the name of the Nth node reference property for a specific referenceRole.
void SetAttribute(const char *name, const char *value)
Set a name value pair attribute.
virtual void SetDefaultNodeNamePrefix(const std::string &prefix)
const char * GetNthNodeReferenceRole(int n)
void RemoveAttribute(const char *name)
Remove attribute with the specified name.
std::string NodeReferencePropertyDecodeString(const std::string &inString)
Decode a node reference property string.
virtual void CopyContent(vtkMRMLNode *node, bool deepCopy=true)
Copy node contents from another node of the same type. Does not copy node ID, Scene,...
const char * URLEncodeString(const char *inString)
Encode a URL string.
const char * GetNthNodeReferenceID(const char *referenceRole, int n)
Return the string of the Nth node ID for a specific reference role.
virtual int EndModify(int previousDisableModifiedEventState)
End modifying the node.
void CopyWithScene(vtkMRMLNode *node)
Copy everything (including Scene and ID) from another node of the same type.
std::map< std::string, std::string > AttributesType
void GetNodeReferenceIDs(const char *referenceRole, std::vector< const char * > &referencedNodeIDs)
Return a list of the referenced node IDs.
virtual void SetTypeDisplayName(const std::string &name)
void PrintSelf(ostream &os, vtkIndent indent) override
int GetNumberOfNodeReferences(const char *referenceRole)
Return the number of node IDs for a specific reference role (and nodes as they always have the same s...
vtkMRMLNode * SetAndObserveNthNodeReferenceID(const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
Set and observe the Nth node ID for a specific reference role.
const ReferencePropertiesType * GetNodeReferenceProperties(const char *referenceRole)
virtual vtkMRMLScene * GetScene()
Get the scene this node has been added to.
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
const char * URLDecodeString(const char *inString)
Decode a URL string.
vtkMRMLNode * SetNodeReferenceID(const char *referenceRole, const char *referencedNodeID)
Set a reference to a node with specified nodeID from this node for a specific referenceRole.
vtkObserverManager * MRMLObserverManager
virtual void SetSingletonTag(const char *)
Tag that make this node a singleton in the scene.
virtual void WriteXML(ostream &of, int indent)
vtkCallbackCommand * MRMLCallbackCommand
Holders for MRML callbacks.
int GetNumberOfNthNodeReferenceProperties(const std::string &referenceRole, int n)
vtkWeakPointer< vtkMRMLScene > Scene
std::map< std::string, NodeReferenceEventList > NodeReferenceEventsType
vtkMRMLNode * SetAndObserveNodeReferenceID(const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
Set and observe a reference node from this node for a specific referenceRole.
std::vector< std::string > GetAttributeNames()
Get all attribute names.
const ReferencePropertiesType * GetNthNodeReferenceProperties(const char *referenceRole, int n)
virtual void UpdateReferenceID(const char *oldID, const char *newID)
Update the stored reference to another node in the scene.
void SetDisableModifiedEvent(int onOff)
const char * GetAttribute(const char *name)
Get value of a name value pair attribute.
virtual const char * GetReferenceRoleFromMRMLAttributeName(const char *attName)
Return the reference role (if found) associated with the attribute name found in a MRML scene file....
void Modified() override
Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.
void AddNodeReferenceRole(const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
Add a referenceRole.
friend class vtkMRMLScene
std::string GetNthNodeReferencePropertyName(const std::string &referenceRole, int referenceIndex, int propertyIndex)
void SetNthNodeReferenceProperty(const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)
int GetCustomModifiedEventPending(int eventId)
virtual void ProcessChildNode(vtkMRMLNode *)
Set dependencies between this node and a child node when parsing XML file.
virtual std::string GetTypeDisplayName()
int InMRMLCallbackFlag
Flag to avoid event loops.
std::vector< std::string > GetNthNodeReferencePropertyNames(const std::string &referenceRole, int n)
std::string DefaultNodeNamePrefix
void RemoveNthNodeReferenceProperty(const std::string &referenceRole, int n, const std::string &propertyName)
void operator=(const vtkMRMLNode &)
void ClearNthNodeReferenceProperties(const std::string &referenceRole, int n)
void SetInMRMLCallbackFlag(int flag)
virtual void InvokeCustomModifiedEvent(int eventId, void *callData=nullptr)
This method allows the node to compress events.
std::vector< std::string > GetNodeReferencePropertyNames(const std::string &referenceRole)
Get the names of all node reference properties for a specific referenceRole.
virtual void Copy(vtkMRMLNode *node)
Copy node contents from another node of the same type. Does not copy node ID and Scene....
std::string GetNodeReferenceProperty(const std::string &referenceRole, const std::string &propertyName)
Get the node reference property for a specific referenceRole.
std::string XMLAttributeDecodeString(const std::string &inString)
Decode an XML attribute string.
vtkMRMLNode * GetNthNodeReference(const char *referenceRole, int n)
Get referenced MRML node for a specific referenceRole.
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.
virtual void UpdateScene(vtkMRMLScene *)
~vtkMRMLNode() override
critical to have a virtual destructor!
vtkMRMLNode(const vtkMRMLNode &)
std::string TypeDisplayName
virtual void ProcessMRMLEvents(vtkObject *caller, unsigned long event, void *callData)
Propagate events generated in mrml.
static void MRMLCallback(vtkObject *caller, unsigned long eid, void *clientData, void *callData)
A set of MRML Nodes that supports serialization and undo/redo.
Manages adding and deleting of observers with events.
vtkSmartPointer< vtkIntArray > StaticEvents
ContentModifiedObserveType ObserveContentModifiedEvents