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

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

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

Public Types

enum  { DisplayModifiedEvent = 17000 }
 
typedef vtkMRMLTransformableNode Superclass
 
- Public Types inherited from vtkMRMLTransformableNode
enum  { TransformModifiedEvent = 15000 }
 TransformModifiedEvent is send when the parent transform is modidied. More...
 
typedef vtkMRMLStorableNode Superclass
 
- Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void AddAndObserveDisplayNodeID (const char *displayNodeID)
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
virtual void CreateDefaultDisplayNodes ()
 
virtual void CreateDefaultSequenceDisplayNodes ()
 
vtkMRMLNodeCreateNodeInstance () override=0
 MRMLNode methods. More...
 
virtual void GetBounds (double bounds[6])
 
virtual const char * GetClassName ()
 
virtual int GetDisplayClassVisibility (const char *nodeClass)
 
vtkMRMLDisplayNodeGetDisplayNode ()
 
const char * GetDisplayNodeID ()
 
virtual const char * GetDisplayNodeReferenceRole ()
 
virtual int GetDisplayVisibility ()
 
const char * GetNodeTagName () override=0
 
Get node XML tag name (like Volume, Model) More...
 
vtkMRMLDisplayNodeGetNthDisplayNode (int n)
 
const char * GetNthDisplayNodeID (int n)
 
int GetNumberOfDisplayNodes ()
 
virtual void GetRASBounds (double bounds[6])
 
bool HasDisplayNodeID (const char *displayNodeID)
 
Return true if displayNodeID is in the display node ID list. 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 RemoveAllDisplayNodeIDs ()
 
Remove all display node IDs and associated display nodes. More...
 
void RemoveNthDisplayNodeID (int n)
 
void SetAndObserveDisplayNodeID (const char *displayNodeID)
 
void SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)
 
virtual void SetDisplayClassVisibility (const char *nodeClass, int visible)
 
virtual void SetDisplayVisibility (int visible)
 
void SetSelectable (int) override
 
virtual void WriteCLI (std::vector< std::string > &vtkNotUsed(commandLine), std::string vtkNotUsed(prefix), int vtkNotUsed(coordinateSystemFlag)=vtkMRMLStorageNode::CoordinateSystemRAS, int vtkNotUsed(multipleFlag)=1)
 
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 vtkMRMLTransformableNode
virtual void ApplyTransform (vtkAbstractTransform *transform)
 
virtual void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
 
virtual bool CanApplyNonLinearTransforms () const
 
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Transform nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
bool SetAndObserveTransformNodeID (const char *transformNodeID)
 
virtual void TransformPointFromWorld (const double inWorld[3], double outLocal[3])
 
virtual void TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)
 
virtual void TransformPointToWorld (const double inLocal[3], double outWorld[3])
 
virtual void TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)
 
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 vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class. More...
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual vtkMRMLStorageNodeCreateDefaultStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
virtual bool GetModifiedSinceRead ()
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void 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 ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual 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)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
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 vtkMRMLDisplayableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTransformableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual const char * GetDisplayNodeReferenceMRMLAttributeName ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLDisplayableNode &)
 
 vtkMRMLDisplayableNode ()
 
 vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)
 
 ~vtkMRMLDisplayableNode () override
 
- Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char * GetTransformNodeReferenceMRMLAttributeName ()
 
virtual const char * GetTransformNodeReferenceRole ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
virtual void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode)
 Called when transform node reference added/modified/removed. More...
 
void operator= (const vtkMRMLTransformableNode &)
 
 vtkMRMLTransformableNode ()
 
 vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)
 
 ~vtkMRMLTransformableNode () override
 
- Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char * GetStorageNodeReferenceMRMLAttributeName ()
 
virtual const char * GetStorageNodeReferenceRole ()
 
virtual vtkTimeStamp GetStoredTime ()
 
void operator= (const vtkMRMLStorableNode &)
 
 vtkMRMLStorableNode ()
 
 vtkMRMLStorableNode (const vtkMRMLStorableNode &)
 
 ~vtkMRMLStorableNode () 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...
 
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...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Static Protected Attributes

static const char * DisplayNodeReferenceMRMLAttributeName
 
static const char * DisplayNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char * TransformNodeReferenceMRMLAttributeName
 
static const char * TransformNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Additional Inherited Members

- 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, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- 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...
 
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}
 

Detailed Description

Definition at line 44 of file vtkMRMLDisplayableNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkMRMLDisplayableNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

DisplayModifiedEvent is fired when:

  • a new display node is observed
  • a display node is not longer observed
  • an associated display node is modified Note that when SetAndObserve(Nth)NodeID() is called with an ID that has not yet any associated display node in the scene, then DisplayModifiedEvent is not fired until found for the first time in the scene, e.g. Get(Nth)DisplayNode(), UpdateScene()...
Enumerator
DisplayModifiedEvent 

Definition at line 174 of file vtkMRMLDisplayableNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLDisplayableNode() [1/2]

vtkMRMLDisplayableNode::vtkMRMLDisplayableNode ( )
protected

◆ ~vtkMRMLDisplayableNode()

vtkMRMLDisplayableNode::~vtkMRMLDisplayableNode ( )
overrideprotected

◆ vtkMRMLDisplayableNode() [2/2]

vtkMRMLDisplayableNode::vtkMRMLDisplayableNode ( const vtkMRMLDisplayableNode )
protected

Member Function Documentation

◆ AddAndObserveDisplayNodeID()

void vtkMRMLDisplayableNode::AddAndObserveDisplayNodeID ( const char *  displayNodeID)

Convenience method that adds a display node ID at the end of the list.

See also
SetAndObserverNthDisplayNodeID(int, const char*)

◆ Copy()

void vtkMRMLDisplayableNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLVectorVolumeNode, and vtkMRMLAnnotationRulerNode.

◆ CreateDefaultDisplayNodes()

virtual void vtkMRMLDisplayableNode::CreateDefaultDisplayNodes ( )
virtual

◆ CreateDefaultSequenceDisplayNodes()

virtual void vtkMRMLDisplayableNode::CreateDefaultSequenceDisplayNodes ( )
virtual

Creates the most appropriate display node class for storing a sequence of these nodes. If the method is not overwritten by subclass then it creates display node by calling, CreateDefaultDisplayNodes method.

Reimplemented in vtkMRMLTransformNode, and vtkMRMLVolumeNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLDisplayableNode::CreateNodeInstance ( )
overridepure virtual

◆ GetBounds()

virtual void vtkMRMLDisplayableNode::GetBounds ( double  bounds[6])
virtual

Get bounding box in global RAS form (xmin,xmax, ymin,ymax, zmin,zmax). This method always returns the bounds of the untransformed object.

See also
GetRASBounds()

Reimplemented in vtkMRMLMarkupsNode, vtkMRMLMarkupsPlaneNode, vtkMRMLModelNode, vtkMRMLMarkupsROINode, vtkMRMLAnnotationROINode, vtkMRMLVolumeNode, and vtkMRMLSegmentationNode.

◆ GetClassName()

virtual const char* vtkMRMLDisplayableNode::GetClassName ( )
virtual

◆ GetDisplayClassVisibility()

virtual int vtkMRMLDisplayableNode::GetDisplayClassVisibility ( const char *  nodeClass)
virtual

Get/Set visibility of display nodes of certain class if nodeClass is 0, get/set visibility of all display nodes It ignores display nodes that have ShowMode other than vtkMRMLDisplayNode::ShowDefault.

◆ GetDisplayNode()

vtkMRMLDisplayNode* vtkMRMLDisplayableNode::GetDisplayNode ( )

Utility function that returns the first display node.

See also
GetNthDisplayNode(int), GetDisplayNodeID()

◆ GetDisplayNodeID()

const char* vtkMRMLDisplayableNode::GetDisplayNodeID ( )

Utility function that returns the first display node id.

See also
GetNthDisplayNodeID(int), GetDisplayNode()

◆ GetDisplayNodeReferenceMRMLAttributeName()

virtual const char* vtkMRMLDisplayableNode::GetDisplayNodeReferenceMRMLAttributeName ( )
protectedvirtual

◆ GetDisplayNodeReferenceRole()

virtual const char* vtkMRMLDisplayableNode::GetDisplayNodeReferenceRole ( )
virtual

◆ GetDisplayVisibility()

virtual int vtkMRMLDisplayableNode::GetDisplayVisibility ( )
virtual

TODO: Remove these functions when removing the Annotations module Utility to return the visibility of all the display nodes. Return 0 if they are all hidden, 1 if all are visible and 2 if some are visible and some are hidden. It ignores display nodes that have ShowMode other than vtkMRMLDisplayNode::ShowDefault.

◆ GetNodeTagName()

const char* vtkMRMLDisplayableNode::GetNodeTagName ( )
overridepure virtual

◆ GetNthDisplayNode()

vtkMRMLDisplayNode* vtkMRMLDisplayableNode::GetNthDisplayNode ( int  n)

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

See also
GetNthDisplayNodeByClass()

◆ GetNthDisplayNodeID()

const char* vtkMRMLDisplayableNode::GetNthDisplayNodeID ( int  n)

Return the string of the Nth display node ID. Or 0 if no such node exist. Warning, a temporary char generated from a std::string::c_str() is returned.

◆ GetNumberOfDisplayNodes()

int vtkMRMLDisplayableNode::GetNumberOfDisplayNodes ( )

Return the number of display node IDs (and display nodes as they always have the same size).

◆ GetRASBounds()

virtual void vtkMRMLDisplayableNode::GetRASBounds ( double  bounds[6])
virtual

Get bounding box in global RAS form (xmin,xmax, ymin,ymax, zmin,zmax). This method returns the bounds of the object with any transforms that may be applied to it.

See also
GetBounds()

Reimplemented in vtkMRMLMarkupsNode, vtkMRMLMarkupsPlaneNode, vtkMRMLModelNode, vtkMRMLMarkupsROINode, vtkMRMLAnnotationROINode, vtkMRMLVolumeNode, and vtkMRMLSegmentationNode.

◆ HasDisplayNodeID()

bool vtkMRMLDisplayableNode::HasDisplayNodeID ( const char *  displayNodeID)


Return true if displayNodeID is in the display node ID list.

◆ IsA()

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

◆ IsTypeOf()

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

◆ OnNodeReferenceAdded()

void vtkMRMLDisplayableNode::OnNodeReferenceAdded ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called when a node reference ID is added (list size increased).

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLSegmentationNode, vtkMRMLMarkupsCurveNode, vtkMRMLModelNode, and vtkMRMLVolumeNode.

◆ OnNodeReferenceModified()

void vtkMRMLDisplayableNode::OnNodeReferenceModified ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLSegmentationNode, vtkMRMLMarkupsCurveNode, vtkMRMLModelNode, and vtkMRMLVolumeNode.

◆ OnNodeReferenceRemoved()

void vtkMRMLDisplayableNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called after a node reference ID is removed (list size decreased).

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLSegmentationNode, and vtkMRMLMarkupsCurveNode.

◆ operator=()

void vtkMRMLDisplayableNode::operator= ( const vtkMRMLDisplayableNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

void vtkMRMLDisplayableNode::ProcessMRMLEvents ( vtkObject *  ,
unsigned  long,
void *   
)
overridevirtual


alternative method to propagate events generated in Display nodes

Deprecated:
GetDisplayNodes Obsolete utility function that provides an unsafe API. Please use GetNumberOfDisplayNodes() and GetNthDisplayNode() instead const std::vector<vtkMRMLDisplayNode*>& GetDisplayNodes();
See also
GetNumberOfDisplayNodes, GetNthDisplayNode

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLMarkupsCurveNode, vtkMRMLTransformNode, vtkMRMLMarkupsPlaneNode, vtkMRMLVolumeNode, vtkMRMLMarkupsROINode, vtkMRMLMarkupsNode, vtkMRMLAnnotationNode, vtkMRMLModelNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLStreamingVolumeNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationROINode, and vtkMRMLAnnotationRulerNode.

◆ ReadXMLAttributes()

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

◆ RemoveAllDisplayNodeIDs()

void vtkMRMLDisplayableNode::RemoveAllDisplayNodeIDs ( )


Remove all display node IDs and associated display nodes.

◆ RemoveNthDisplayNodeID()

void vtkMRMLDisplayableNode::RemoveNthDisplayNodeID ( int  n)

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

See also
SetAndObserverNthDisplayNodeID(int, const char*)

◆ SafeDownCast()

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

◆ SetAndObserveDisplayNodeID()

void vtkMRMLDisplayableNode::SetAndObserveDisplayNodeID ( const char *  displayNodeID)

Convenience method that sets the first display node ID.

See also
SetAndObserverNthDisplayNodeID(int, const char*)

◆ SetAndObserveNthDisplayNodeID()

void vtkMRMLDisplayableNode::SetAndObserveNthDisplayNodeID ( int  n,
const char *  displayNodeID 
)

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

See also
SetAndObserveDisplayNodeID(const char*), AddAndObserveDisplayNodeID(const char *), RemoveNthDisplayNodeID(int)

◆ SetDisplayClassVisibility()

virtual void vtkMRMLDisplayableNode::SetDisplayClassVisibility ( const char *  nodeClass,
int  visible 
)
virtual

◆ SetDisplayVisibility()

virtual void vtkMRMLDisplayableNode::SetDisplayVisibility ( int  visible)
virtual

◆ SetSelectable()

void vtkMRMLDisplayableNode::SetSelectable ( int  )
overridevirtual

Override default selectable setting to notify display node about the change.

Reimplemented from vtkMRMLNode.

◆ WriteCLI()

virtual void vtkMRMLDisplayableNode::WriteCLI ( std::vector< std::string > &  vtkNotUsedcommandLine,
std::string   vtkNotUsedprefix,
int   vtkNotUsedcoordinateSystemFlag = vtkMRMLStorageNode::CoordinateSystemRAS,
int   vtkNotUsedmultipleFlag = 1 
)
inlinevirtual

Write this node's information to a vector of strings for passing to a CLI. If the prefix is not an empty string, it gets pushed onto the vector of strings before the information. coordinateSystemFlag = vtkMRMLStorageNode::CoordinateSystemRAS or vtkMRMLStorageNode::CoordinateSystemLPS multipleFlag = 1 for the whole list, 0 for the first in the list

Definition at line 71 of file vtkMRMLDisplayableNode.h.

◆ WriteXML()

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

Member Data Documentation

◆ DisplayNodeReferenceMRMLAttributeName

const char* vtkMRMLDisplayableNode::DisplayNodeReferenceMRMLAttributeName
staticprotected

Definition at line 228 of file vtkMRMLDisplayableNode.h.

◆ DisplayNodeReferenceRole

const char* vtkMRMLDisplayableNode::DisplayNodeReferenceRole
staticprotected

Definition at line 227 of file vtkMRMLDisplayableNode.h.


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