vtkMRMLAnnotationNode Class Reference

#include <vtkMRMLAnnotationNode.h>

Inheritance diagram for vtkMRMLAnnotationNode:

List of all members.

Public Types
enum	{ TEXT_SELECTED = 0, TEXT_VISIBLE, NUM_TEXT_ATTRIBUTE_TYPES }
Public Member Functions
int	AddText (const char *newText, int selectedFlag, int visibleFlag)
virtual void	Copy (vtkMRMLNode *node)
	Copy the node's attributes to this object.
void	CreateAnnotationTextDisplayNode ()
virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()
virtual vtkMRMLNode *	CreateNodeInstance ()
	MRMLNode methods.
int	DeleteAttribute (vtkIdType idAttEntry, vtkIdType idAttType)
int	DeleteText (int id)
int	GetAnnotationAttribute (vtkIdType id, int att)
vtkDataArray *	GetAnnotationAttributes (int att)
vtkMRMLAnnotationTextDisplayNode *	GetAnnotationTextDisplayNode ()
virtual const char *	GetAttributeTypesEnumAsString (int val)
virtual const char *	GetNodeTagName ()
int	GetNumberOfTexts ()
vtkStdString	GetText (int id)
virtual void	PrintAnnotationInfo (ostream &os, vtkIndent indent, int titleFlag=1)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessMRMLEvents (vtkObject *, unsigned long, void *)
virtual void	ReadXMLAttributes (const char **atts)
virtual void	ResetAnnotations ()
void	SetAnnotationAttribute (vtkIdType id, int att, double value)
void	SetLocked (int init)
void	SetText (int id, const char *newText, int selectedFlag, int visibleFlag)
void	UpdateScene (vtkMRMLScene *scene)
	vtkBooleanMacro (Visible, int)
	vtkGetMacro (Locked, int)
	vtkGetMacro (Visible, int)
	vtkGetStringMacro (ReferenceNodeID)
	vtkSetMacro (Visible, int)
	vtkSetStringMacro (ReferenceNodeID)
	vtkTypeMacro (vtkMRMLAnnotationNode, vtkMRMLModelNode)
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static vtkMRMLAnnotationNode *	New ()
Protected Member Functions
void	CreatePolyData ()
void	operator= (const vtkMRMLAnnotationNode &)
void	ResetAttributes (int id)
void	ResetTextAttributesAll ()
void	SetAttributeSize (vtkIdType id, vtkIdType n)
	vtkMRMLAnnotationNode (const vtkMRMLAnnotationNode &)
	vtkMRMLAnnotationNode ()
	~vtkMRMLAnnotationNode ()
Protected Attributes
int	Locked
char *	ReferenceNodeID
vtkStringArray *	TextList
int	Visible

---

Member Enumeration Documentation

anonymous enum

Enumerator:

TEXT_SELECTED
TEXT_VISIBLE
NUM_TEXT_ATTRIBUTE_TYPES

---

Constructor & Destructor Documentation

vtkMRMLAnnotationNode::vtkMRMLAnnotationNode

(

)

[protected]

References Locked, New(), ReferenceNodeID, TextList, and Visible.

vtkMRMLAnnotationNode::~vtkMRMLAnnotationNode

(

)

[protected]

References ReferenceNodeID, and TextList.

vtkMRMLAnnotationNode::vtkMRMLAnnotationNode

(

const vtkMRMLAnnotationNode &

)

[protected]

---

Member Function Documentation

int vtkMRMLAnnotationNode::AddText	(	const char *	newText,
		int	selectedFlag,
		int	visibleFlag
	)

References GetNumberOfTexts(), mathExample::n, SetText(), and TextList.

Referenced by vtkSlicermiAnnotationModuleLogic::AddFiducial(), vtkMRMLAnnotationStickyNode::Initialize(), vtkMRMLAnnotationRulerNode::Initialize(), vtkMRMLAnnotationAngleNode::Initialize(), vtkMRMLAnnotationStorageNode::ReadAnnotationTextData(), ReadXMLAttributes(), and SetControlPointsAndText().

void vtkMRMLAnnotationNode::Copy

(

vtkMRMLNode *

node

)

[virtual]

Copy the node's attributes to this object.

Description:

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

References SetLocked(), and TextList.

void vtkMRMLAnnotationNode::CreateAnnotationTextDisplayNode

(

)

References vtkMRMLDisplayableNode::AddAndObserveDisplayNodeID(), vtkMRMLScene::AddNode(), GetAnnotationTextDisplayNode(), vtkMRMLNode::GetScene(), and New().

Referenced by vtkSlicermiAnnotationModuleLogic::AddRulerNodeObserver(), vtkSlicerAnnotationRulerManager::AddTextDiaplayNodeID(), vtkSlicerAnnotationAngleManager::AddTextDiaplayNodeID(), vtkSlicermiAnnotationModuleLogic::GetAnnotationPropertiesColor(), vtkSlicermiAnnotationModuleLogic::GetAnnotationPropertiesDouble(), vtkMRMLAnnotationStickyNode::Initialize(), vtkMRMLAnnotationRulerNode::Initialize(), vtkMRMLAnnotationAngleNode::Initialize(), SaveAnnotationNode(), qSlicermiAnnotationModuleAnnotationPropertyDialog::SaveAnnotationNode(), qSlicermiAnnotationModuleAnnotationPropertyDialog::SaveStateForUndo(), vtkSlicermiAnnotationModuleLogic::SetAnnotationProperties(), UndoAnnotationNode(), and qSlicermiAnnotationModuleAnnotationPropertyDialog::UndoAnnotationNode().

vtkMRMLStorageNode * vtkMRMLAnnotationNode::CreateDefaultStorageNode

(

)

[virtual]

Create default storage node or NULL if does not have one

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

References vtkMRMLAnnotationStorageNode::New().

vtkMRMLNode * vtkMRMLAnnotationNode::CreateNodeInstance

(

void

)

[virtual]

MRMLNode methods.

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationStickyNode.

References autoSlicerTracto2regions::ret.

void vtkMRMLAnnotationNode::CreatePolyData

(

)

[protected]

Reimplemented in vtkMRMLAnnotationControlPointsNode, and vtkMRMLAnnotationLinesNode.

References New(), vtkMRMLDisplayableNode::PolyData, and vtkMRMLModelNode::SetAndObservePolyData().

Referenced by ResetTextAttributesAll().

int vtkMRMLAnnotationNode::DeleteAttribute	(	vtkIdType	idAttEntry,
		vtkIdType	idAttType
	)

References GetAnnotationAttributes(), and mathExample::n.

Referenced by vtkMRMLAnnotationControlPointsNode::DeleteControlPoint(), vtkMRMLAnnotationLinesNode::DeleteLine(), and DeleteText().

int vtkMRMLAnnotationNode::DeleteText

(

int

id

)

References DeleteAttribute(), GetAnnotationAttributes(), GetNumberOfTexts(), GetText(), j, mathExample::n, NUM_TEXT_ATTRIBUTE_TYPES, vtkMRMLDisplayableNode::PolyData, ResetAttributes(), ResetTextAttributesAll(), and TextList.

int vtkMRMLAnnotationNode::GetAnnotationAttribute	(	vtkIdType	id,
		int	att
	)

References GetAnnotationAttributes().

Referenced by vtkMRMLAnnotationRulerNode::GetDistanceAnnotationVisibility(), vtkMRMLAnnotationAngleNode::GetLabelVisibility(), vtkMRMLAnnotationAngleNode::GetRay1Visibility(), vtkMRMLAnnotationAngleNode::GetRay2Visibility(), PrintAnnotationInfo(), vtkMRMLAnnotationLinesNode::PrintAnnotationInfo(), vtkMRMLAnnotationControlPointsNode::PrintAnnotationInfo(), vtkMRMLAnnotationControlPointsStorageNode::WriteAnnotationControlPointsData(), vtkMRMLAnnotationStorageNode::WriteAnnotationData(), vtkMRMLAnnotationLinesStorageNode::WriteAnnotationLinesData(), WriteXML(), vtkMRMLAnnotationLinesNode::WriteXML(), and vtkMRMLAnnotationControlPointsNode::WriteXML().

vtkDataArray * vtkMRMLAnnotationNode::GetAnnotationAttributes

(

int

att

)

References GetAttributeTypesEnumAsString(), and vtkMRMLDisplayableNode::PolyData.

Referenced by DeleteAttribute(), vtkMRMLAnnotationControlPointsNode::DeleteControlPoint(), vtkMRMLAnnotationLinesNode::DeleteLine(), DeleteText(), GetAnnotationAttribute(), ResetAttributes(), SetAnnotationAttribute(), and SetAttributeSize().

vtkMRMLAnnotationTextDisplayNode * vtkMRMLAnnotationNode::GetAnnotationTextDisplayNode

(

)

References vtkMRMLDisplayableNode::GetNthDisplayNode(), vtkMRMLDisplayableNode::GetNumberOfDisplayNodes(), and mathExample::n.

Referenced by vtkSlicermiAnnotationModuleLogic::AddRulerNodeObserver(), vtkSlicerAnnotationRulerManager::AddTextDiaplayNodeID(), vtkSlicerAnnotationAngleManager::AddTextDiaplayNodeID(), CheckTextColor(), CreateAnnotationTextDisplayNode(), vtkSlicermiAnnotationModuleLogic::GetAnnotationPropertiesColor(), vtkSlicermiAnnotationModuleLogic::GetAnnotationPropertiesDouble(), vtkMRMLAnnotationRulerNode::GetDistanceAnnotationScale(), vtkMRMLAnnotationRulerNode::GetDistanceAnnotationTextColour(), vtkMRMLAnnotationAngleNode::GetLabelScale(), vtkMRMLAnnotationAngleNode::GetLabelTextColour(), vtkMRMLAnnotationFiducialsStorageNode::ReadAnnotationFiducialsData(), vtkMRMLAnnotationStorageNode::ReadAnnotationTextProperties(), SaveAnnotationNode(), qSlicermiAnnotationModuleAnnotationPropertyDialog::SaveAnnotationNode(), qSlicermiAnnotationModuleAnnotationPropertyDialog::SaveStateForUndo(), vtkSlicermiAnnotationModuleLogic::SetAnnotationProperties(), vtkMRMLAnnotationLinesNode::SetControlPoint(), vtkMRMLAnnotationRulerNode::SetDistanceAnnotationScale(), vtkMRMLAnnotationRulerNode::SetDistanceAnnotationTextColour(), vtkMRMLAnnotationAngleNode::SetLabelScale(), vtkMRMLAnnotationAngleNode::SetLabelTextColour(), UndoAnnotationNode(), qSlicermiAnnotationModuleAnnotationPropertyDialog::UndoAnnotationNode(), vtkSlicerAnnotationRulerManager::Update3DWidget(), vtkSlicerAnnotationAngleManager::Update3DWidget(), vtkSlicermiAnnotationModuleLogicTest1(), and vtkMRMLAnnotationStorageNode::WriteAnnotationTextProperties().

const char * vtkMRMLAnnotationNode::GetAttributeTypesEnumAsString

(

int

val

)

[virtual]

Reimplemented in vtkMRMLAnnotationControlPointsNode, and vtkMRMLAnnotationLinesNode.

References TEXT_SELECTED, and TEXT_VISIBLE.

Referenced by GetAnnotationAttributes(), PrintAnnotationInfo(), ReadXMLAttributes(), ResetAttributes(), and WriteXML().

virtual const char* vtkMRMLAnnotationNode::GetNodeTagName

(

)

[inline, virtual]

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationStickyNode.

int vtkMRMLAnnotationNode::GetNumberOfTexts

(

)

References TextList.

Referenced by AddText(), DeleteText(), PrintAnnotationInfo(), SetText(), and vtkMRMLAnnotationStorageNode::WriteAnnotationData().

vtkStdString vtkMRMLAnnotationNode::GetText

(

int

id

)

References TextList.

Referenced by DeleteText(), vtkSlicermiAnnotationModuleLogic::GetAnnotationTextProperty(), vtkMRMLAnnotationFiducialNode::GetFiducialLabel(), vtkMRMLAnnotationStickyNode::GetStickyText(), qSlicermiAnnotationModuleWidget::updateAnnotationTable(), and vtkMRMLAnnotationStorageNode::WriteAnnotationData().

vtkMRMLAnnotationNode * vtkMRMLAnnotationNode::New

(

)

[static]

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationStickyNode.

References autoSlicerTracto2regions::ret.

Referenced by CreateAnnotationTextDisplayNode(), CreatePolyData(), ResetAnnotations(), ResetAttributes(), and vtkMRMLAnnotationNode().

void vtkMRMLAnnotationNode::operator=

(

const vtkMRMLAnnotationNode &

)

[protected]

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationStickyNode.

void vtkMRMLAnnotationNode::PrintAnnotationInfo	(	ostream &	os,
		vtkIndent	indent,
		int	titleFlag = 1
	)			[virtual]

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

References GetAnnotationAttribute(), GetAttributeTypesEnumAsString(), GetNumberOfTexts(), j, Locked, NUM_TEXT_ATTRIBUTE_TYPES, vtkMRMLDisplayableNode::PolyData, ReferenceNodeID, vtkMRMLNode::Selected, TextList, and Visible.

Referenced by PrintSelf(), and vtkMRMLAnnotationNodeTest1().

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

Reimplemented from vtkMRMLModelNode.

References PrintAnnotationInfo().

void vtkMRMLAnnotationNode::ProcessMRMLEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)			[virtual]

alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

void vtkMRMLAnnotationNode::ReadXMLAttributes

(

const char **

atts

)

[virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

References AddText(), vtkMRMLNode::EndModify(), GetAttributeTypesEnumAsString(), j, NUM_TEXT_ATTRIBUTE_TYPES, ResetAnnotations(), SetAnnotationAttribute(), SetLocked(), and vtkMRMLNode::StartModify().

void vtkMRMLAnnotationNode::ResetAnnotations

(

)

[virtual]

Reimplemented in vtkMRMLAnnotationControlPointsNode, and vtkMRMLAnnotationLinesNode.

References New(), ResetTextAttributesAll(), and TextList.

Referenced by vtkMRMLAnnotationStorageNode::ReadData(), and ReadXMLAttributes().

void vtkMRMLAnnotationNode::ResetAttributes

(

int

id

)

[protected]

References GetAnnotationAttributes(), GetAttributeTypesEnumAsString(), New(), and vtkMRMLDisplayableNode::PolyData.

Referenced by DeleteText(), vtkMRMLAnnotationControlPointsNode::ResetControlPointsAttributesAll(), vtkMRMLAnnotationLinesNode::ResetLinesAttributesAll(), ResetTextAttributesAll(), and SetAttributeSize().

void vtkMRMLAnnotationNode::ResetTextAttributesAll

(

)

[protected]

References CreatePolyData(), j, NUM_TEXT_ATTRIBUTE_TYPES, and ResetAttributes().

Referenced by DeleteText(), ResetAnnotations(), and SetText().

void vtkMRMLAnnotationNode::SetAnnotationAttribute	(	vtkIdType	id,
		int	att,
		double	value
	)

References GetAnnotationAttributes().

Referenced by ReadXMLAttributes(), vtkMRMLAnnotationLinesNode::ReadXMLAttributes(), vtkMRMLAnnotationControlPointsNode::ReadXMLAttributes(), vtkMRMLAnnotationControlPointsNode::SetControlPoint(), vtkMRMLAnnotationRulerNode::SetDistanceAnnotationVisibility(), vtkMRMLAnnotationAngleNode::SetLabelVisibility(), vtkMRMLAnnotationLinesNode::SetLine(), vtkMRMLAnnotationAngleNode::SetRay1Visibility(), vtkMRMLAnnotationAngleNode::SetRay2Visibility(), and SetText().

void vtkMRMLAnnotationNode::SetAttributeSize	(	vtkIdType	id,
		vtkIdType	n
	)			[protected]

References GetAnnotationAttributes(), and ResetAttributes().

Referenced by vtkMRMLAnnotationControlPointsNode::SetControlPoint(), vtkMRMLAnnotationLinesNode::SetLine(), and SetText().

void vtkMRMLAnnotationNode::SetLocked

(

int

init

)

References Locked.

Referenced by Copy(), qSlicermiAnnotationModuleWidget::lockSelectedButtonClicked(), and ReadXMLAttributes().

void vtkMRMLAnnotationNode::SetText	(	int	id,
		const char *	newText,
		int	selectedFlag,
		int	visibleFlag
	)

References GetNumberOfTexts(), j, NUM_TEXT_ATTRIBUTE_TYPES, vtkMRMLDisplayableNode::PolyData, ResetTextAttributesAll(), SetAnnotationAttribute(), SetAttributeSize(), TEXT_SELECTED, TEXT_VISIBLE, and TextList.

Referenced by AddText(), vtkSlicermiAnnotationModuleLogic::SetAnnotationProperties(), vtkMRMLAnnotationFiducialNode::SetFiducialLabel(), vtkMRMLAnnotationFiducialNode::SetFiducialValue(), and vtkMRMLAnnotationStickyNode::SetStickyText().

void vtkMRMLAnnotationNode::UpdateScene

(

vtkMRMLScene *

scene

)

[virtual]

Clears out the list of display nodes, and updates them from teh lsit of display node ids

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

vtkMRMLAnnotationNode::vtkBooleanMacro	(	Visible	,
		int
	)

vtkMRMLAnnotationNode::vtkGetMacro	(	Locked	,
		int
	)

vtkMRMLAnnotationNode::vtkGetMacro	(	Visible	,
		int
	)

vtkMRMLAnnotationNode::vtkGetStringMacro

(

ReferenceNodeID

)

vtkMRMLAnnotationNode::vtkSetMacro	(	Visible	,
		int
	)

vtkMRMLAnnotationNode::vtkSetStringMacro

(

ReferenceNodeID

)

vtkMRMLAnnotationNode::vtkTypeMacro	(	vtkMRMLAnnotationNode	,
		vtkMRMLModelNode
	)

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

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

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationRulerNode.

References GetAnnotationAttribute(), GetAttributeTypesEnumAsString(), j, Locked, NUM_TEXT_ATTRIBUTE_TYPES, vtkMRMLDisplayableNode::PolyData, ReferenceNodeID, TextList, and Visible.

---

Member Data Documentation

int vtkMRMLAnnotationNode::Locked [protected]

Referenced by PrintAnnotationInfo(), SetLocked(), vtkMRMLAnnotationNode(), and WriteXML().

char* vtkMRMLAnnotationNode::ReferenceNodeID [protected]

Referenced by PrintAnnotationInfo(), vtkMRMLAnnotationNode(), WriteXML(), and ~vtkMRMLAnnotationNode().

vtkStringArray* vtkMRMLAnnotationNode::TextList [protected]

Referenced by AddText(), Copy(), DeleteText(), GetNumberOfTexts(), GetText(), PrintAnnotationInfo(), ResetAnnotations(), SetText(), vtkMRMLAnnotationNode(), WriteXML(), and ~vtkMRMLAnnotationNode().

int vtkMRMLAnnotationNode::Visible [protected]

Referenced by PrintAnnotationInfo(), vtkMRMLAnnotationNode(), and WriteXML().

---

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

• QTModules/miAnnotation/MRML/vtkMRMLAnnotationNode.h
• QTModules/miAnnotation/MRML/vtkMRMLAnnotationNode.cxx