Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vtkMRMLHierarchyNode Class Reference

Abstract class representing a hierarchy member. More...

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

Inheritance diagram for vtkMRMLHierarchyNode:
Collaboration diagram for vtkMRMLHierarchyNode:

Public Types

enum  { ChildNodeAddedEvent = 15550 , ChildNodeRemovedEvent = 15551 }
 ChildNodeAddedEvent is send when a child node added to this parent. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent ,
  ReferenceRemovedEvent , ReferencedNodeModifiedEvent
}
 
enum  ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }
 
typedef std::map< std::string, std::string > ReferencePropertiesType
 Get the node reference properties for a specific referenceRole.
 
typedef vtkObject Superclass
 

Public Member Functions

virtual void AllowMultipleChildrenOff ()
 
virtual void AllowMultipleChildrenOn ()
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object.
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual.
 
void GetAllChildrenNodes (std::vector< vtkMRMLHierarchyNode * > &childrenNodes)
 Given this hierarchy node returns all it's children recursively.
 
virtual int GetAllowMultipleChildren ()
 
virtual void GetAssociatedChildrenNodes (vtkCollection *children, const char *childClass=nullptr)
 
virtual vtkMRMLNodeGetAssociatedNode ()
 Get node associated with this hierarchy node.
 
virtual char * GetAssociatedNodeID ()
 String ID of the corresponding displayable MRML node.
 
std::vector< vtkMRMLHierarchyNode * > GetChildrenNodes ()
 
virtual const char * GetClassName ()
 
int GetIndexInParent ()
 Get index of this node in it's parent based on the value of their SortingValue.
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model)
 
vtkMRMLHierarchyNodeGetNthChildNode (int index)
 Get n-th child node sorted in the order of their SortingValue.
 
int GetNumberOfChildrenNodes ()
 Returns the number of immediate children in the hierarchy.
 
vtkMRMLHierarchyNodeGetParentNode ()
 Associated parent MRML node.
 
virtual char * GetParentNodeID ()
 String ID of the parent hierarchy MRML node.
 
virtual double GetSortingValue ()
 
vtkMRMLHierarchyNodeGetTopParentNode ()
 Get the top parent node in the hierarchy.
 
virtual int IsA (const char *type)
 
void MoveInParent (int increment)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML file.
 
void RemoveAllHierarchyChildrenNodes ()
 Removes all children hierarchy nodes including children of children, etc.
 
void RemoveHierarchyChildrenNodes ()
 Removes immediate children nodes, their children are reparented to this parent node.
 
virtual void SetAllowMultipleChildren (int)
 
virtual void SetAssociatedNodeID (const char *ref)
 
void SetIndexInParent (int index)
 Set index of this node in it's parent based on the value of their SortingValue.
 
virtual void SetParentNodeID (const char *ref)
 
void SetSceneReferences () override
 Set the reference node to current scene.
 
void SetSortingValue (double value)
 Node's Sorting Value.
 
void UpdateReferenceID (const char *oldID, const char *newID) override
 Update the stored reference to another node in the scene.
 
void UpdateReferences () override
 
void UpdateScene (vtkMRMLScene *scene) override
 Observe the reference transform node.
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format.
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (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.
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list.
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
 Add a referenceRole.
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
void ClearNodeReferenceProperties (const std::string &referenceRole)
 Remove all node reference properties for a specific referenceRole.
 
void ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)
 
virtual void CopyContent (vtkMRMLNode *node, bool deepCopy=true)
 Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy.
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this.
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type.
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node.
 
virtual int GetAddToScene ()
 node added to MRML scene.
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute.
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names.
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version.
 
virtual vtkIntArray * GetContentModifiedEvents ()
 
int GetCustomModifiedEventPending (int eventId)
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros.
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden.
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML.
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops.
 
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.
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char * > &referencedNodeIDs)
 Return a list of the referenced node IDs.
 
const ReferencePropertiesTypeGetNodeReferenceProperties (const char *referenceRole)
 
std::string GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
 Get the node reference property for a specific referenceRole.
 
std::string GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
 Get the name of the Nth node reference property for a specific referenceRole.
 
std::vector< std::string > GetNodeReferencePropertyNames (const std::string &referenceRole)
 Get the names of all node reference properties for a specific referenceRole.
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode * > &nodes)
 Return a list of the referenced nodes.
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole.
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role.
 
const ReferencePropertiesTypeGetNthNodeReferenceProperties (const char *referenceRole, int n)
 
std::string GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
 
std::string GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)
 
std::vector< std::string > GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
 Get the number of node reference properties for a specific referenceRole.
 
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).
 
int GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)
 
virtual int GetSaveWithScene ()
 Save node with MRML scene.
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to.
 
virtual int GetSelectable ()
 Describes if the node is selectable.
 
virtual int GetSelected ()
 Get/Set for Selected.
 
virtual char * GetSingletonTag ()
 
virtual const char * GetTypeDisplayName ()
 
virtual bool GetUndoEnabled ()
 
virtual bool HasCopyContent () const
 Returns true if the class supports deep and shallow copying node content.
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole.
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events.
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending.
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.
 
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.
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml.
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name.
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole.
 
void RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
 Remove a node reference property for a specific referenceRole.
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list.
 
void RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node.
 
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, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
 Set and observe a reference node from this node for a specific referenceRole.
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (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.
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute.
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user.
 
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.
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole.
 
void SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
 Set the node reference property for a specific referenceRole.
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.
 
void SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)
 
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.
 
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.
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events.
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
const char * URLDecodeString (const char *inString)
 Decode a URL string.
 
const char * URLEncodeString (const char *inString)
 Encode a URL string.
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format.
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string.
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences)
 

Static Public Member Functions

static vtkMRMLHierarchyNodeGetAssociatedHierarchyNode (vtkMRMLScene *scene, const char *associatedNodeID)
 Get Hierarchy node for a given associated node.
 
static int IsTypeOf (const char *type)
 
static vtkMRMLHierarchyNodeNew ()
 
static vtkMRMLHierarchyNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Types

typedef std::map< std::string, vtkMRMLHierarchyNode * > AssociatedHierarchyNodesType
 
typedef std::map< std::string, std::vector< vtkMRMLHierarchyNode * > > HierarchyChildrenNodesType
 
- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, NodeReferenceEventListNodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 

Protected Member Functions

virtual char * GetAssociatedNodeIDReference ()
 
virtual char * GetParentNodeIDReference ()
 
void InvokeHierarchyModifiedEvent (vtkMRMLNode *node=nullptr)
 
void operator= (const vtkMRMLHierarchyNode &)
 
void SetAssociatedNodeIDReference (const char *)
 
void SetParentNodeIDReference (const char *id)
 String ID of the parent hierarchy MRML node.
 
void UpdateChildrenMap ()
 
 vtkMRMLHierarchyNode ()
 
 vtkMRMLHierarchyNode (const vtkMRMLHierarchyNode &)
 
 ~vtkMRMLHierarchyNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.
 
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.
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents, bool newObserveContentModifiedEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise.
 
std::string NodeReferencePropertyDecodeString (const std::string &inString)
 Decode a node reference property string.
 
std::string NodeReferencePropertyEncodeString (const std::string &inString)
 Encode a node reference property string (replaces special characters by code sequences)
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified.
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr).
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)
 
void RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters.
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, bool newObserveContentModifiedEvents, 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!
 

Static Protected Member Functions

static void AssociatedHierarchyIsModified (vtkMRMLScene *scene)
 Mark hierarchy as modified.
 
static void HierarchyIsModified (vtkMRMLScene *scene)
 Mark hierarchy as modified when you.
 
static int UpdateAssociatedToHierarchyMap (vtkMRMLScene *scene)
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Protected Attributes

int AllowMultipleChildren
 is this a node that's only supposed to have one child?
 
char * AssociatedNodeIDReference
 String ID of the associated MRML node.
 
char * ParentNodeIDReference
 
double SortingValue
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene {1}
 
AttributesType Attributes
 
vtkIntArray * ContentModifiedEvents
 
char * Description {nullptr}
 
int HideFromEditors {0}
 
char * ID {nullptr}
 
int InMRMLCallbackFlag {0}
 Flag to avoid event loops.
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks.
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable {1}
 
int Selected {0}
 
bool UndoEnabled {false}
 

Static Protected Attributes

static double MaximumSortingValue
 
static std::map< vtkMRMLScene *, AssociatedHierarchyNodesTypeSceneAssociatedHierarchyNodes
 
static std::map< vtkMRMLScene *, vtkMTimeType > SceneAssociatedHierarchyNodesMTime
 
static std::map< vtkMRMLScene *, HierarchyChildrenNodesTypeSceneHierarchyChildrenNodes
 
static std::map< vtkMRMLScene *, vtkMTimeType > SceneHierarchyChildrenNodesMTime
 

Detailed Description

Abstract class representing a hierarchy member.

Definition at line 28 of file vtkMRMLHierarchyNode.h.

Member Typedef Documentation

◆ AssociatedHierarchyNodesType

Definition at line 208 of file vtkMRMLHierarchyNode.h.

◆ HierarchyChildrenNodesType

typedef std::map<std::string, std::vector< vtkMRMLHierarchyNode *> > vtkMRMLHierarchyNode::HierarchyChildrenNodesType
protected

Definition at line 197 of file vtkMRMLHierarchyNode.h.

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

ChildNodeAddedEvent is send when a child node added to this parent.

Enumerator
ChildNodeAddedEvent 
ChildNodeRemovedEvent 

Definition at line 122 of file vtkMRMLHierarchyNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLHierarchyNode() [1/2]

vtkMRMLHierarchyNode::vtkMRMLHierarchyNode ( )
protected

◆ ~vtkMRMLHierarchyNode()

vtkMRMLHierarchyNode::~vtkMRMLHierarchyNode ( )
overrideprotected

◆ vtkMRMLHierarchyNode() [2/2]

vtkMRMLHierarchyNode::vtkMRMLHierarchyNode ( const vtkMRMLHierarchyNode & )
protected

Member Function Documentation

◆ AllowMultipleChildrenOff()

virtual void vtkMRMLHierarchyNode::AllowMultipleChildrenOff ( )
virtual

◆ AllowMultipleChildrenOn()

virtual void vtkMRMLHierarchyNode::AllowMultipleChildrenOn ( )
virtual

◆ AssociatedHierarchyIsModified()

static void vtkMRMLHierarchyNode::AssociatedHierarchyIsModified ( vtkMRMLScene * scene)
staticprotected

Mark hierarchy as modified.

◆ Copy()

void vtkMRMLHierarchyNode::Copy ( vtkMRMLNode * node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode, and vtkMRMLSubjectHierarchyLegacyNode.

◆ CreateNodeInstance()

vtkMRMLNode * vtkMRMLHierarchyNode::CreateNodeInstance ( )
overridevirtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode, and vtkMRMLSubjectHierarchyLegacyNode.

◆ GetAllChildrenNodes()

void vtkMRMLHierarchyNode::GetAllChildrenNodes ( std::vector< vtkMRMLHierarchyNode * > & childrenNodes)

Given this hierarchy node returns all it's children recursively.

◆ GetAllowMultipleChildren()

virtual int vtkMRMLHierarchyNode::GetAllowMultipleChildren ( )
virtual

turn off if only want to have one child associated with this hierarchy node, as with the leaf type nodes that are pointing to a single mrml node. Used first in checking drag and drop targets. Default to true.

◆ GetAssociatedChildrenNodes()

virtual void vtkMRMLHierarchyNode::GetAssociatedChildrenNodes ( vtkCollection * children,
const char * childClass = nullptr )
virtual

Find all associated children nodes of a specified class in the hierarchy if childClass is nullptr returns all associated children nodes.

◆ GetAssociatedHierarchyNode()

static vtkMRMLHierarchyNode * vtkMRMLHierarchyNode::GetAssociatedHierarchyNode ( vtkMRMLScene * scene,
const char * associatedNodeID )
static

Get Hierarchy node for a given associated node.

◆ GetAssociatedNode()

virtual vtkMRMLNode * vtkMRMLHierarchyNode::GetAssociatedNode ( )
virtual

Get node associated with this hierarchy node.

◆ GetAssociatedNodeID()

virtual char * vtkMRMLHierarchyNode::GetAssociatedNodeID ( )
inlinevirtual

String ID of the corresponding displayable MRML node.

Definition at line 132 of file vtkMRMLHierarchyNode.h.

◆ GetAssociatedNodeIDReference()

virtual char * vtkMRMLHierarchyNode::GetAssociatedNodeIDReference ( )
protectedvirtual

◆ GetChildrenNodes()

std::vector< vtkMRMLHierarchyNode * > vtkMRMLHierarchyNode::GetChildrenNodes ( )

Given this hierarchy node returns all it's 1st level children (not recursive). Note: Most compilers don't make a copy of the list if you call the function like that: std::vector< vtkMRMLHierarchyNode* > children = this->GetChildrenNodes();

◆ GetClassName()

virtual const char * vtkMRMLHierarchyNode::GetClassName ( )
virtual

◆ GetIndexInParent()

int vtkMRMLHierarchyNode::GetIndexInParent ( )

Get index of this node in it's parent based on the value of their SortingValue.

◆ GetNodeTagName()

const char * vtkMRMLHierarchyNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode, and vtkMRMLSubjectHierarchyLegacyNode.

Definition at line 51 of file vtkMRMLHierarchyNode.h.

◆ GetNthChildNode()

vtkMRMLHierarchyNode * vtkMRMLHierarchyNode::GetNthChildNode ( int index)

Get n-th child node sorted in the order of their SortingValue.

◆ GetNumberOfChildrenNodes()

int vtkMRMLHierarchyNode::GetNumberOfChildrenNodes ( )
inline

Returns the number of immediate children in the hierarchy.

Definition at line 97 of file vtkMRMLHierarchyNode.h.

◆ GetParentNode()

vtkMRMLHierarchyNode * vtkMRMLHierarchyNode::GetParentNode ( )

Associated parent MRML node.

◆ GetParentNodeID()

virtual char * vtkMRMLHierarchyNode::GetParentNodeID ( )
inlinevirtual

String ID of the parent hierarchy MRML node.

Definition at line 79 of file vtkMRMLHierarchyNode.h.

◆ GetParentNodeIDReference()

virtual char * vtkMRMLHierarchyNode::GetParentNodeIDReference ( )
protectedvirtual

◆ GetSortingValue()

virtual double vtkMRMLHierarchyNode::GetSortingValue ( )
virtual

◆ GetTopParentNode()

vtkMRMLHierarchyNode * vtkMRMLHierarchyNode::GetTopParentNode ( )

Get the top parent node in the hierarchy.

◆ HierarchyIsModified()

static void vtkMRMLHierarchyNode::HierarchyIsModified ( vtkMRMLScene * scene)
staticprotected

Mark hierarchy as modified when you.

◆ InvokeHierarchyModifiedEvent()

void vtkMRMLHierarchyNode::InvokeHierarchyModifiedEvent ( vtkMRMLNode * node = nullptr)
protected

Invoke hierarchy modified event(s) It should be fired on any node that see its location changed relative to it parent, and also on a parent that add/remove/move a child Invoke the event on the passed node if not null, otherwise on the associated node if not null.

◆ IsA()

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

◆ IsTypeOf()

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

◆ MoveInParent()

void vtkMRMLHierarchyNode::MoveInParent ( int increment)

Move this node in it's parent up (positive increment) or down (negative increment) by 'increment' number of places

◆ New()

static vtkMRMLHierarchyNode * vtkMRMLHierarchyNode::New ( )
static

◆ operator=()

void vtkMRMLHierarchyNode::operator= ( const vtkMRMLHierarchyNode & )
protected

◆ PrintSelf()

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

◆ ReadXMLAttributes()

void vtkMRMLHierarchyNode::ReadXMLAttributes ( const char ** atts)
overridevirtual

Read node attributes from XML file.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode, and vtkMRMLSubjectHierarchyLegacyNode.

◆ RemoveAllHierarchyChildrenNodes()

void vtkMRMLHierarchyNode::RemoveAllHierarchyChildrenNodes ( )

Removes all children hierarchy nodes including children of children, etc.

◆ RemoveHierarchyChildrenNodes()

void vtkMRMLHierarchyNode::RemoveHierarchyChildrenNodes ( )

Removes immediate children nodes, their children are reparented to this parent node.

◆ SafeDownCast()

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

◆ SetAllowMultipleChildren()

virtual void vtkMRMLHierarchyNode::SetAllowMultipleChildren ( int )
virtual

◆ SetAssociatedNodeID()

virtual void vtkMRMLHierarchyNode::SetAssociatedNodeID ( const char * ref)
virtual

◆ SetAssociatedNodeIDReference()

void vtkMRMLHierarchyNode::SetAssociatedNodeIDReference ( const char * )
protected

◆ SetIndexInParent()

void vtkMRMLHierarchyNode::SetIndexInParent ( int index)

Set index of this node in it's parent based on the value of their SortingValue.

◆ SetParentNodeID()

virtual void vtkMRMLHierarchyNode::SetParentNodeID ( const char * ref)
virtual

◆ SetParentNodeIDReference()

void vtkMRMLHierarchyNode::SetParentNodeIDReference ( const char * id)
protected

String ID of the parent hierarchy MRML node.

◆ SetSceneReferences()

void vtkMRMLHierarchyNode::SetSceneReferences ( )
overridevirtual

Set the reference node to current scene.

Reimplemented from vtkMRMLNode.

◆ SetSortingValue()

void vtkMRMLHierarchyNode::SetSortingValue ( double value)

Node's Sorting Value.

Use a method for Set because it needs to call modified on any associated

◆ UpdateAssociatedToHierarchyMap()

static int vtkMRMLHierarchyNode::UpdateAssociatedToHierarchyMap ( vtkMRMLScene * scene)
staticprotected

Create Associated to hierarchy map, return number of Associated hierarchy nodes

◆ UpdateChildrenMap()

void vtkMRMLHierarchyNode::UpdateChildrenMap ( )
protected

◆ UpdateReferenceID()

void vtkMRMLHierarchyNode::UpdateReferenceID ( const char * oldID,
const char * newID )
overridevirtual

Update the stored reference to another node in the scene.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode.

◆ UpdateReferences()

void vtkMRMLHierarchyNode::UpdateReferences ( )
overridevirtual

Updates this node if it depends on other nodes when the node is deleted in the scene

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode.

◆ UpdateScene()

void vtkMRMLHierarchyNode::UpdateScene ( vtkMRMLScene * scene)
overridevirtual

Observe the reference transform node.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode.

◆ WriteXML()

void vtkMRMLHierarchyNode::WriteXML ( ostream & of,
int indent )
overridevirtual

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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelHierarchyNode, and vtkMRMLSubjectHierarchyLegacyNode.

Member Data Documentation

◆ AllowMultipleChildren

int vtkMRMLHierarchyNode::AllowMultipleChildren
protected

is this a node that's only supposed to have one child?

Definition at line 221 of file vtkMRMLHierarchyNode.h.

◆ AssociatedNodeIDReference

char* vtkMRMLHierarchyNode::AssociatedNodeIDReference
protected

String ID of the associated MRML node.

Definition at line 192 of file vtkMRMLHierarchyNode.h.

◆ MaximumSortingValue

double vtkMRMLHierarchyNode::MaximumSortingValue
staticprotected

Definition at line 216 of file vtkMRMLHierarchyNode.h.

◆ ParentNodeIDReference

char* vtkMRMLHierarchyNode::ParentNodeIDReference
protected

Definition at line 180 of file vtkMRMLHierarchyNode.h.

◆ SceneAssociatedHierarchyNodes

std::map< vtkMRMLScene*, AssociatedHierarchyNodesType> vtkMRMLHierarchyNode::SceneAssociatedHierarchyNodes
staticprotected

Definition at line 210 of file vtkMRMLHierarchyNode.h.

◆ SceneAssociatedHierarchyNodesMTime

std::map< vtkMRMLScene*, vtkMTimeType> vtkMRMLHierarchyNode::SceneAssociatedHierarchyNodesMTime
staticprotected

Definition at line 212 of file vtkMRMLHierarchyNode.h.

◆ SceneHierarchyChildrenNodes

std::map< vtkMRMLScene*, HierarchyChildrenNodesType> vtkMRMLHierarchyNode::SceneHierarchyChildrenNodes
staticprotected

Definition at line 199 of file vtkMRMLHierarchyNode.h.

◆ SceneHierarchyChildrenNodesMTime

std::map< vtkMRMLScene*, vtkMTimeType> vtkMRMLHierarchyNode::SceneHierarchyChildrenNodesMTime
staticprotected

Definition at line 200 of file vtkMRMLHierarchyNode.h.

◆ SortingValue

double vtkMRMLHierarchyNode::SortingValue
protected

Definition at line 214 of file vtkMRMLHierarchyNode.h.


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