Abstract class representing a hierarchy member. More...

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

Inheritance diagram for vtkMRMLHierarchyNode:

[legend]

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 }

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 More...

vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual. More...

void	GetAllChildrenNodes (std::vector< vtkMRMLHierarchyNode *> &childrenNodes)
	Given this hierarchy node returns all it's children recursively. More...

virtual int	GetAllowMultipleChildren ()

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

virtual vtkMRMLNode *	GetAssociatedNode ()
	Get node associated with this hierarchy node. More...

virtual char *	GetAssociatedNodeID ()
	String ID of the corresponding displayable MRML node More...

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. More...

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model) More...

vtkMRMLHierarchyNode *	GetNthChildNode (int index)
	Get n-th child node sorted in the order of their SortingValue. More...

int	GetNumberOfChildrenNodes ()
	Returns the number of immediate children in the hierarchy. More...

vtkMRMLHierarchyNode *	GetParentNode ()
	Associated prent MRML node More...

virtual char *	GetParentNodeID ()
	String ID of the parent hierarchy MRML node More...

virtual double	GetSortingValue ()

vtkMRMLHierarchyNode *	GetTopParentNode ()
	Get the top parent node in the hierarchy More...

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 More...

void	RemoveAllHierarchyChildrenNodes ()
	Removes all children hierarchy nodes including children of children, etc. More...

void	RemoveHierarchyChildrenNodes ()
	Removes immediate children nodes, their children are reparented to this parent node. More...

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. More...

virtual void	SetParentNodeID (const char *ref)

void	SetSceneReferences () override
	Set the reference node to current scene. More...

void	SetSortingValue (double value)
	Node's Sorting Value More...

void	UpdateReferenceID (const char oldID, const char newID) override
	Update the stored reference to another node in the scene More...

void	UpdateReferences () override

void	UpdateScene (vtkMRMLScene *scene) override
	Observe the reference transform node More...

void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format. More...

Public Member Functions inherited from 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. More...

vtkMRMLNode *	AddNodeReferenceID (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	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. More...

virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this. More...

void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type. 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 vtkIntArray *	GetContentModifiedEvents ()

int	GetCustomModifiedEventPending (int eventId)

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 ()

vtkMRMLNode *	GetNodeReference (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...

vtkMRMLNode *	GetNthNodeReference (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 vtkMRMLScene *	GetScene ()
	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 const char *	GetTypeDisplayName ()

virtual bool	GetUndoEnabled ()

virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content. More...

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...

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...

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)

vtkMRMLNode *	SetAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr)
	Set and observe a reference node from this node for a specific referenceRole. More...

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. 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...

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...

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. 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	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 ()

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...

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 vtkMRMLHierarchyNode *	GetAssociatedHierarchyNode (vtkMRMLScene scene, const char associatedNodeID)
	Get Hierarchy node for a given associated node More...

static int	IsTypeOf (const char *type)

static vtkMRMLHierarchyNode *	New ()

static vtkMRMLHierarchyNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)

static vtkMRMLNode *	SafeDownCast (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, vtkSmartPointer< vtkIntArray > >	NodeReferenceEventsType

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

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

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 More...

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. 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::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. More...

vtkMRMLNode *	UpdateNodeReferenceEventObserver (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	AssociatedHierarchyIsModified (vtkMRMLScene *scene)
	Mark hierarchy as modified. More...

static void	HierarchyIsModified (vtkMRMLScene *scene)
	Mark hierarchy as modified when you. More...

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? More...

char *	AssociatedNodeIDReference
	String ID of the associated MRML node More...

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 More...

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks. More...

vtkObserverManager *	MRMLObserverManager

char *	Name {nullptr}

NodeReferenceEventsType	NodeReferenceEvents

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

NodeReferencesType	NodeReferences

int	SaveWithScene {true}

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable {1}

int	Selected {0}

bool	UndoEnabled {false}

Static Protected Attributes
static double	MaximumSortingValue

static std::map< vtkMRMLScene *, AssociatedHierarchyNodesType >	SceneAssociatedHierarchyNodes

static std::map< vtkMRMLScene *, vtkMTimeType >	SceneAssociatedHierarchyNodesMTime

static std::map< vtkMRMLScene *, HierarchyChildrenNodesType >	SceneHierarchyChildrenNodes

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

typedef std::map<std::string, vtkMRMLHierarchyNode *> vtkMRMLHierarchyNode::AssociatedHierarchyNodesType

protected

Definition at line 208 of file vtkMRMLHierarchyNode.h.

◆ HierarchyChildrenNodesType

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

protected

Definition at line 195 of file vtkMRMLHierarchyNode.h.

◆ Superclass

typedef vtkMRMLNode vtkMRMLHierarchyNode::Superclass

Definition at line 32 of file vtkMRMLHierarchyNode.h.

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 vtkMRMLSubjectHierarchyLegacyNode, and vtkMRMLModelHierarchyNode.

◆ 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 vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLModelHierarchyNode, and vtkMRMLAnnotationHierarchyNode.

◆ 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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLModelHierarchyNode, and vtkMRMLAnnotationHierarchyNode.

◆ 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 vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLModelHierarchyNode, and vtkMRMLAnnotationHierarchyNode.

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 prent 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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLDisplayableHierarchyNode, vtkMRMLModelHierarchyNode, and vtkMRMLAnnotationHierarchyNode.

◆ 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 vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLModelHierarchyNode, and vtkMRMLAnnotationHierarchyNode.

◆ 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 vtkMRMLSubjectHierarchyLegacyNode, vtkMRMLModelHierarchyNode, and vtkMRMLAnnotationHierarchyNode.

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 178 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:

Libs/MRML/Core/vtkMRMLHierarchyNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ AssociatedHierarchyNodesType

◆ HierarchyChildrenNodesType

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLHierarchyNode() [1/2]

◆ ~vtkMRMLHierarchyNode()

◆ vtkMRMLHierarchyNode() [2/2]

Member Function Documentation

◆ AllowMultipleChildrenOff()

◆ AllowMultipleChildrenOn()

◆ AssociatedHierarchyIsModified()

◆ Copy()

◆ CreateNodeInstance()

◆ GetAllChildrenNodes()

◆ GetAllowMultipleChildren()

◆ GetAssociatedChildrenNodes()

◆ GetAssociatedHierarchyNode()

◆ GetAssociatedNode()

◆ GetAssociatedNodeID()

◆ GetAssociatedNodeIDReference()

◆ GetChildrenNodes()

◆ GetClassName()

◆ GetIndexInParent()

◆ GetNodeTagName()

◆ GetNthChildNode()

◆ GetNumberOfChildrenNodes()

◆ GetParentNode()

◆ GetParentNodeID()

◆ GetParentNodeIDReference()

◆ GetSortingValue()

◆ GetTopParentNode()

◆ HierarchyIsModified()

◆ InvokeHierarchyModifiedEvent()

◆ IsA()

◆ IsTypeOf()

◆ MoveInParent()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ReadXMLAttributes()

◆ RemoveAllHierarchyChildrenNodes()

◆ RemoveHierarchyChildrenNodes()

◆ SafeDownCast()

◆ SetAllowMultipleChildren()

◆ SetAssociatedNodeID()

◆ SetAssociatedNodeIDReference()

◆ SetIndexInParent()

◆ SetParentNodeID()

◆ SetParentNodeIDReference()

◆ SetSceneReferences()

◆ SetSortingValue()

◆ UpdateAssociatedToHierarchyMap()

◆ UpdateChildrenMap()

◆ UpdateReferenceID()

◆ UpdateReferences()

◆ UpdateScene()

◆ WriteXML()

Member Data Documentation

◆ AllowMultipleChildren

◆ AssociatedNodeIDReference

◆ MaximumSortingValue

◆ ParentNodeIDReference

◆ SceneAssociatedHierarchyNodes

◆ SceneAssociatedHierarchyNodesMTime

◆ SceneHierarchyChildrenNodes

◆ SceneHierarchyChildrenNodesMTime

◆ SortingValue