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

Inheritance diagram for vtkMRMLDisplayableNode:

Collaboration diagram for vtkMRMLDisplayableNode:

Public Types
enum	{ DisplayModifiedEvent = 17000 }
typedef vtkMRMLStorableNode	Superclass
Public Member Functions
void	AddAndObserveDisplayNodeID (const char *displayNodeID)
virtual void	Copy (vtkMRMLNode *node)
virtual void	CreateDefaultDisplayNodes ()
virtual vtkMRMLNode *	CreateNodeInstance ()=0
	MRMLNode methods.
virtual const char *	GetClassName ()
vtkMRMLDisplayNode *	GetDisplayNode ()
const char *	GetDisplayNodeID ()
virtual int	GetDisplayVisibility ()
virtual const char *	GetNodeTagName ()=0
vtkMRMLDisplayNode *	GetNthDisplayNode (int n)
const char *	GetNthDisplayNodeID (int n)
int	GetNumberOfDisplayNodes ()
virtual void	GetRASBounds (double bounds[6])
	Get bounding box in global RAS the form (xmin,xmax, ymin,ymax, zmin,zmax).
bool	HasDisplayNodeID (const char *displayNodeID)
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessMRMLEvents (vtkObject , unsigned long, void )
virtual void	ReadXMLAttributes (const char **atts)
void	RemoveAllDisplayNodeIDs ()
void	RemoveNthDisplayNodeID (int n)
void	SetAndObserveDisplayNodeID (const char *displayNodeID)
void	SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)
virtual void	SetDisplayVisibility (int visible)
virtual void	WriteCLI (std::ostringstream &vtkNotUsed(ss), std::string vtkNotUsed(prefix))
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLDisplayableNode *	SafeDownCast (vtkObject *o)
Protected Member Functions
virtual char *	GetDisplayNodeReferenceRererenceMRMLAttributeName ()
virtual char *	GetDisplayNodeReferenceRole ()
virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference)
virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
void	operator= (const vtkMRMLDisplayableNode &)
virtual void	SetDisplayNodeReferenceRererenceMRMLAttributeName (const char *)
virtual void	SetDisplayNodeReferenceRole (const char *)
	vtkMRMLDisplayableNode ()
	vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)
	~vtkMRMLDisplayableNode ()
Protected Attributes
char *	DisplayNodeReferenceRererenceMRMLAttributeName
char *	DisplayNodeReferenceRole

Detailed Description

Definition at line 43 of file vtkMRMLDisplayableNode.h.

Member Typedef Documentation

typedef vtkMRMLStorableNode vtkMRMLDisplayableNode::Superclass

Member Enumeration Documentation

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 197 of file vtkMRMLDisplayableNode.h.

Constructor & Destructor Documentation

vtkMRMLDisplayableNode::vtkMRMLDisplayableNode ( ) [protected]

vtkMRMLDisplayableNode::~vtkMRMLDisplayableNode ( ) [protected]

vtkMRMLDisplayableNode::vtkMRMLDisplayableNode ( const vtkMRMLDisplayableNode & ) [protected]

Member Function Documentation

void vtkMRMLDisplayableNode::AddAndObserveDisplayNodeID ( const char * displayNodeID ) [inline]

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

See also:: SetAndObserverNthDisplayNodeID(int, const char*)

Definition at line 84 of file vtkMRMLDisplayableNode.h.

virtual void vtkMRMLDisplayableNode::Copy ( vtkMRMLNode * node ) [virtual]

Copy the node's attributes to this object

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionImageVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLModelNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLUnstructuredGridNode, vtkMRMLVectorVolumeNode, vtkMRMLVolumeNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationSplineNode, and vtkMRMLFiberBundleNode.

virtual void vtkMRMLDisplayableNode::CreateDefaultDisplayNodes ( ) [virtual]

Create and observe default display node(s) Does nothing by default, must be reimplemented by subclasses that have display nodes.

Reimplemented in vtkMRMLFiberBundleNode.

virtual vtkMRMLNode* vtkMRMLDisplayableNode::CreateNodeInstance ( ) [pure virtual]

virtual const char* vtkMRMLDisplayableNode::GetClassName ( ) [virtual]

vtkMRMLDisplayNode* vtkMRMLDisplayableNode::GetDisplayNode ( ) [inline]

Utility function that returns the first display node.

See also:: GetNthDisplayNode(int), GetDisplayNodeID()

Definition at line 171 of file vtkMRMLDisplayableNode.h.

const char* vtkMRMLDisplayableNode::GetDisplayNodeID ( ) [inline]

Utility function that returns the first display node id.

See also:: GetNthDisplayNodeID(int), GetDisplayNode()

Definition at line 151 of file vtkMRMLDisplayableNode.h.

virtual char* vtkMRMLDisplayableNode::GetDisplayNodeReferenceRererenceMRMLAttributeName ( ) [protected, virtual]

virtual char* vtkMRMLDisplayableNode::GetDisplayNodeReferenceRole ( ) [protected, virtual]

virtual int vtkMRMLDisplayableNode::GetDisplayVisibility ( ) [virtual]

TODO: Change it to Get/SetVisibility() for consistency with vtkMRMLDisplayNode. 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.

virtual const char* vtkMRMLDisplayableNode::GetNodeTagName ( ) [pure virtual]

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

const char* vtkMRMLDisplayableNode::GetNthDisplayNodeID ( int n ) [inline]

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.

Definition at line 143 of file vtkMRMLDisplayableNode.h.

int vtkMRMLDisplayableNode::GetNumberOfDisplayNodes ( ) [inline]

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

Definition at line 133 of file vtkMRMLDisplayableNode.h.

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

Get bounding box in global RAS the form (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented in vtkMRMLModelNode, and vtkMRMLVolumeNode.

bool vtkMRMLDisplayableNode::HasDisplayNodeID ( const char * displayNodeID ) [inline]

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

Definition at line 125 of file vtkMRMLDisplayableNode.h.

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

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

virtual void vtkMRMLDisplayableNode::OnNodeReferenceAdded ( vtkMRMLNodeReference * reference ) [inline, protected, virtual]

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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelNode, and vtkMRMLVolumeNode.

Definition at line 235 of file vtkMRMLDisplayableNode.h.

virtual void vtkMRMLDisplayableNode::OnNodeReferenceModified ( vtkMRMLNodeReference * reference ) [inline, protected, virtual]

Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLModelNode, and vtkMRMLVolumeNode.

Definition at line 246 of file vtkMRMLDisplayableNode.h.

virtual void vtkMRMLDisplayableNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference * reference ) [inline, protected, virtual]

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

Reimplemented from vtkMRMLNode.

Definition at line 254 of file vtkMRMLDisplayableNode.h.

void vtkMRMLDisplayableNode::operator= ( const vtkMRMLDisplayableNode & ) [protected]

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

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionImageVolumeNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLModelNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLUnstructuredGridNode, vtkMRMLVectorVolumeNode, vtkMRMLVolumeNode, vtkMRMLAnnotationNode, and vtkMRMLFiberBundleNode.

virtual void vtkMRMLDisplayableNode::ProcessMRMLEvents	(	vtkObject *	,
		unsigned	long,
		void *
	)		`[virtual]`

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 alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionImageVolumeNode, vtkMRMLModelNode, vtkMRMLUnstructuredGridNode, vtkMRMLVolumeNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationSplineNode, and vtkMRMLFiberBundleNode.

virtual void vtkMRMLDisplayableNode::ReadXMLAttributes ( const char ** atts ) [virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionImageVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLVectorVolumeNode, vtkMRMLVolumeNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationSplineNode, and vtkMRMLFiberBundleNode.

void vtkMRMLDisplayableNode::RemoveAllDisplayNodeIDs ( ) [inline]

Remove all display node IDs and associated display nodes.

Definition at line 99 of file vtkMRMLDisplayableNode.h.

void vtkMRMLDisplayableNode::RemoveNthDisplayNodeID ( int n ) [inline]

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

See also:: SetAndObserverNthDisplayNodeID(int, const char*)

Definition at line 92 of file vtkMRMLDisplayableNode.h.

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

void vtkMRMLDisplayableNode::SetAndObserveDisplayNodeID ( const char * displayNodeID ) [inline]

Convenience method that sets the first display node ID.

See also:: SetAndObserverNthDisplayNodeID(int, const char*)

Reimplemented in vtkMRMLDiffusionTensorVolumeNode.

Definition at line 76 of file vtkMRMLDisplayableNode.h.

void vtkMRMLDisplayableNode::SetAndObserveNthDisplayNodeID	(	int	n,
		const char *	displayNodeID
	)		`[inline]`

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)

Definition at line 118 of file vtkMRMLDisplayableNode.h.

virtual void vtkMRMLDisplayableNode::SetDisplayNodeReferenceRererenceMRMLAttributeName ( const char * ) [protected, virtual]

virtual void vtkMRMLDisplayableNode::SetDisplayNodeReferenceRole ( const char * ) [protected, virtual]

virtual void vtkMRMLDisplayableNode::SetDisplayVisibility ( int visible ) [virtual]

virtual void vtkMRMLDisplayableNode::WriteCLI	(	std::ostringstream &	vtkNotUsedss,
		std::string	vtkNotUsedprefix
	)		`[inline, virtual]`

Write this node's information to a string for passing to a CLI, precede each datum with the prefix if not an empty string

Definition at line 67 of file vtkMRMLDisplayableNode.h.

virtual void vtkMRMLDisplayableNode::WriteXML	(	ostream &	of,
		int	indent
	)		`[virtual]`

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

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionImageVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLVectorVolumeNode, vtkMRMLVolumeNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationBidimensionalNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationSplineNode, and vtkMRMLFiberBundleNode.

Member Data Documentation

char* vtkMRMLDisplayableNode::DisplayNodeReferenceRererenceMRMLAttributeName [protected]

Definition at line 225 of file vtkMRMLDisplayableNode.h.

char* vtkMRMLDisplayableNode::DisplayNodeReferenceRole [protected]

Definition at line 224 of file vtkMRMLDisplayableNode.h.

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

Libs/MRML/Core/vtkMRMLDisplayableNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation