Slicer
5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
MRML node to represent a hierarchyu of models. More...
#include <Libs/MRML/Core/vtkMRMLModelHierarchyNode.h>
Public Types | |
typedef vtkMRMLDisplayableHierarchyNode | Superclass |
Public Types inherited from vtkMRMLDisplayableHierarchyNode | |
enum | { DisplayModifiedEvent = 17000 } |
DisplayModifiedEvent is generated when display node parameters is changed. More... | |
typedef vtkMRMLHierarchyNode | Superclass |
Public Types inherited from vtkMRMLHierarchyNode | |
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 | |
void | Copy (vtkMRMLNode *node) override |
Copy the node's attributes to this object More... | |
vtkMRMLNode * | CreateNodeInstance () override |
MRMLNode methods. More... | |
void | GetChildrenModelNodes (vtkCollection *models) |
Find all child model nodes in the hierarchy More... | |
virtual const char * | GetClassName () |
vtkMRMLModelHierarchyNode * | GetCollapsedParentNode () |
Get the first parent node in hierarchy which is not expanded More... | |
vtkMRMLModelDisplayNode * | GetModelDisplayNode () |
Get associated display MRML node More... | |
vtkMRMLModelNode * | GetModelNode () |
Get associated model MRML node More... | |
char * | GetModelNodeID () |
const char * | GetNodeTagName () override |
Get node XML tag name (like Volume, ModelHierarchy) More... | |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) override |
void | ProcessMRMLEvents (vtkObject *, unsigned long, void *) override |
alternative method to propagate events generated in Display nodes More... | |
void | ReadXMLAttributes (const char **atts) override |
Read node attributes from XML file More... | |
void | SetModelNodeID (const char *id) |
String ID of the model MRML node More... | |
void | SetModelNodeIDReference (const char *ref) |
Need this for tcl wrapping to call ReferenceStringMacro methods. 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 |
Finds the model node and read the data 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 vtkMRMLDisplayableHierarchyNode | |
virtual void | ExpandedOff () |
virtual void | ExpandedOn () |
Indicates if the node is expanded More... | |
void | GetChildrenDisplayableNodes (vtkCollection *children) |
Find all child displayable nodes in the hierarchy More... | |
vtkMRMLDisplayableHierarchyNode * | GetCollapsedParentNode () |
Get the top parent node in the hierarchy which is not expanded More... | |
vtkMRMLDisplayableNode * | GetDisplayableNode () |
Get associated displayable MRML node More... | |
virtual char * | GetDisplayableNodeID () |
String ID of the corresponding displayable MRML node More... | |
vtkMRMLDisplayNode * | GetDisplayNode () |
Get associated display MRML node More... | |
virtual char * | GetDisplayNodeID () |
virtual int | GetExpanded () |
void | PrintSelf (ostream &os, vtkIndent indent) override |
void | RemoveAllChildrenNodes () |
void | RemoveChildrenNodes () |
void | SetAndObserveDisplayNodeID (const char *DisplayNodeID) |
virtual void | SetDisplayableNodeID (const char *ref) |
virtual void | SetExpanded (int) |
void | SetSceneReferences () override |
Set the display node as reference into the scene. More... | |
Public Member Functions inherited from vtkMRMLHierarchyNode | |
virtual void | AllowMultipleChildrenOff () |
virtual void | AllowMultipleChildrenOn () |
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 () |
int | GetIndexInParent () |
Get index of this node in it's parent based on the value of their SortingValue. 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... | |
void | MoveInParent (int increment) |
void | PrintSelf (ostream &os, vtkIndent indent) override |
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... | |
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... | |
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 int | IsTypeOf (const char *type) |
static vtkMRMLModelHierarchyNode * | New () |
static vtkMRMLModelHierarchyNode * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkMRMLDisplayableHierarchyNode | |
static vtkMRMLDisplayableHierarchyNode * | GetDisplayableHierarchyNode (vtkMRMLScene *scene, const char *displayableNodeID) |
Get Hierarchy node for a given displayable node More... | |
static int | IsTypeOf (const char *type) |
static vtkMRMLDisplayableHierarchyNode * | New () |
static vtkMRMLDisplayableHierarchyNode * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkMRMLHierarchyNode | |
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 Member Functions | |
void | operator= (const vtkMRMLModelHierarchyNode &) |
vtkMRMLModelHierarchyNode () | |
vtkMRMLModelHierarchyNode (const vtkMRMLModelHierarchyNode &) | |
~vtkMRMLModelHierarchyNode () override | |
Protected Member Functions inherited from vtkMRMLDisplayableHierarchyNode | |
void | operator= (const vtkMRMLDisplayableHierarchyNode &) |
void | SetDisplayNodeID (const char *) |
vtkMRMLDisplayableHierarchyNode () | |
vtkMRMLDisplayableHierarchyNode (const vtkMRMLDisplayableHierarchyNode &) | |
~vtkMRMLDisplayableHierarchyNode () override | |
Protected Member Functions inherited from vtkMRMLHierarchyNode | |
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... | |
Additional Inherited Members | |
Protected Types inherited from vtkMRMLHierarchyNode | |
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 |
Static Protected Member Functions inherited from vtkMRMLHierarchyNode | |
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) |
Static Protected Attributes inherited from vtkMRMLHierarchyNode | |
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 |
MRML node to represent a hierarchyu of models.
Definition at line 23 of file vtkMRMLModelHierarchyNode.h.
Definition at line 27 of file vtkMRMLModelHierarchyNode.h.
|
protected |
|
overrideprotected |
|
protected |
|
overridevirtual |
Copy the node's attributes to this object
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
overridevirtual |
MRMLNode methods.
Reimplemented from vtkMRMLDisplayableHierarchyNode.
void vtkMRMLModelHierarchyNode::GetChildrenModelNodes | ( | vtkCollection * | models | ) |
Find all child model nodes in the hierarchy
|
virtual |
Reimplemented from vtkMRMLDisplayableHierarchyNode.
vtkMRMLModelHierarchyNode* vtkMRMLModelHierarchyNode::GetCollapsedParentNode | ( | ) |
Get the first parent node in hierarchy which is not expanded
vtkMRMLModelDisplayNode* vtkMRMLModelHierarchyNode::GetModelDisplayNode | ( | ) |
Get associated display MRML node
vtkMRMLModelNode* vtkMRMLModelHierarchyNode::GetModelNode | ( | ) |
Get associated model MRML node
|
inline |
Definition at line 73 of file vtkMRMLModelHierarchyNode.h.
|
inlineoverridevirtual |
Get node XML tag name (like Volume, ModelHierarchy)
Reimplemented from vtkMRMLDisplayableHierarchyNode.
Definition at line 51 of file vtkMRMLModelHierarchyNode.h.
|
virtual |
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
static |
|
static |
|
protected |
|
override |
|
overridevirtual |
alternative method to propagate events generated in Display nodes
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
overridevirtual |
Read node attributes from XML file
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
static |
|
inline |
String ID of the model MRML node
Definition at line 68 of file vtkMRMLModelHierarchyNode.h.
|
inline |
Need this for tcl wrapping to call ReferenceStringMacro methods.
Definition at line 79 of file vtkMRMLModelHierarchyNode.h.
|
overridevirtual |
Update the stored reference to another node in the scene
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
overridevirtual |
Updates this node if it depends on other nodes when the node is deleted in the scene
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
overridevirtual |
Finds the model node and read the data
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
overridevirtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLDisplayableHierarchyNode.
|
protected |
Data.
Definition at line 117 of file vtkMRMLModelHierarchyNode.h.