vtkMRMLAnnotationTextDisplayNode Class Reference

#include <Modules/Loadable/Annotations/MRML/vtkMRMLAnnotationTextDisplayNode.h>

Inheritance diagram for vtkMRMLAnnotationTextDisplayNode:

Collaboration diagram for vtkMRMLAnnotationTextDisplayNode:

List of all members.

Public Types
typedef vtkMRMLAnnotationDisplayNode	Superclass
Public Member Functions
virtual void	AttachEdgeOnlyOff ()
virtual void	AttachEdgeOnlyOn ()
virtual void	Copy (vtkMRMLNode *node)
	Copy the node's attributes to this object.
void	CreateBackup ()
	Create a backup of this node and attach it.
virtual vtkMRMLNode *	CreateNodeInstance ()
virtual int	GetAttachEdgeOnly ()
virtual const char *	GetClassName ()
virtual double	GetLeaderGlyphSize ()
std::string	GetLineWrappedText (std::string inputText)
virtual unsigned int	GetMaxCharactersPerLine ()
virtual int	GetMaximumLeaderGlyphSize ()
virtual const char *	GetNodeTagName ()
	Get node XML tag name (like Volume, Model)
virtual int	GetPadding ()
virtual int	GetShowArrowHead ()
virtual int	GetShowBorder ()
virtual int	GetShowLeader ()
virtual double	GetTextScale ()
virtual int	GetUseLineWrap ()
virtual int	GetUseThreeDimensionalLeader ()
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	RestoreBackup ()
	Restore an attached backup of this node.
virtual void	SetAttachEdgeOnly (int)
virtual void	SetLeaderGlyphSize (double)
virtual void	SetMaxCharactersPerLine (unsigned int)
	Set teh maximum number of characters in a text line, used if UseLineWrap is true.
virtual void	SetMaximumLeaderGlyphSize (int)
virtual void	SetPadding (int)
virtual void	SetShowArrowHead (int)
	Enable/disable showing the arrow head glyph at the end of the leader. Only used if ShowLeader is true.
virtual void	SetShowBorder (int)
	based on vtkCaptionActor2D.h
virtual void	SetShowLeader (int)
void	SetTextScale (double scale)
virtual void	SetUseLineWrap (int)
	Enable/disable using automatic line wrap on text lines that are longer than MaxCharactersPerLine.
virtual void	SetUseThreeDimensionalLeader (int)
virtual void	ShowArrowHeadOff ()
virtual void	ShowArrowHeadOn ()
virtual void	ShowBorderOff ()
virtual void	ShowBorderOn ()
virtual void	ShowLeaderOff ()
virtual void	ShowLeaderOn ()
virtual void	UpdateScene (vtkMRMLScene *scene)
	Finds the storage node and read the data.
virtual void	UseLineWrapOff ()
virtual void	UseLineWrapOn ()
virtual void	UseThreeDimensionalLeaderOff ()
virtual void	UseThreeDimensionalLeaderOn ()
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLAnnotationTextDisplayNode *	New ()
static vtkMRMLAnnotationTextDisplayNode *	SafeDownCast (vtkObject *o)
Protected Member Functions
void	operator= (const vtkMRMLAnnotationTextDisplayNode &)
	vtkMRMLAnnotationTextDisplayNode ()
	vtkMRMLAnnotationTextDisplayNode (const vtkMRMLAnnotationTextDisplayNode &)
	~vtkMRMLAnnotationTextDisplayNode ()
Protected Attributes
int	AttachEdgeOnly
double	LeaderGlyphSize
unsigned int	MaxCharactersPerLine
int	MaximumLeaderGlyphSize
int	Padding
int	ShowArrowHead
int	ShowBorder
int	ShowLeader
double	TextScale
int	UseLineWrap
int	UseThreeDimensionalLeader

---

Detailed Description

Definition at line 17 of file vtkMRMLAnnotationTextDisplayNode.h.

---

Member Typedef Documentation

typedef vtkMRMLAnnotationDisplayNode vtkMRMLAnnotationTextDisplayNode::Superclass

Reimplemented from vtkMRMLAnnotationDisplayNode.

Definition at line 21 of file vtkMRMLAnnotationTextDisplayNode.h.

---

Constructor & Destructor Documentation

vtkMRMLAnnotationTextDisplayNode::vtkMRMLAnnotationTextDisplayNode

(

)

[protected]

vtkMRMLAnnotationTextDisplayNode::~vtkMRMLAnnotationTextDisplayNode

(

)

[inline, protected]

Definition at line 132 of file vtkMRMLAnnotationTextDisplayNode.h.

vtkMRMLAnnotationTextDisplayNode::vtkMRMLAnnotationTextDisplayNode

(

const vtkMRMLAnnotationTextDisplayNode &

)

[protected]

---

Member Function Documentation

virtual void vtkMRMLAnnotationTextDisplayNode::AttachEdgeOnlyOff

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::AttachEdgeOnlyOn

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::Copy

(

vtkMRMLNode *

node

)

[virtual]

Copy the node's attributes to this object.

Reimplemented from vtkMRMLAnnotationDisplayNode.

void vtkMRMLAnnotationTextDisplayNode::CreateBackup

(

)

[virtual]

Create a backup of this node and attach it.

Reimplemented from vtkMRMLAnnotationDisplayNode.

virtual vtkMRMLNode* vtkMRMLAnnotationTextDisplayNode::CreateNodeInstance

(

)

[virtual]

Create instance of the default node. Like New only virtual NOTE: Subclasses should implement this method

Reimplemented from vtkMRMLAnnotationDisplayNode.

virtual int vtkMRMLAnnotationTextDisplayNode::GetAttachEdgeOnly

(

)

[virtual]

virtual const char* vtkMRMLAnnotationTextDisplayNode::GetClassName

(

)

[virtual]

Reimplemented from vtkMRMLAnnotationDisplayNode.

virtual double vtkMRMLAnnotationTextDisplayNode::GetLeaderGlyphSize

(

)

[virtual]

std::string vtkMRMLAnnotationTextDisplayNode::GetLineWrappedText

(

std::string

inputText

)

Utility function to return a new string with
's inserted in the input string to bring each line down below the MaxCharactersPerLine. Tries to insert breaks between words, but will force breaks where there are no spaces if necessary

virtual unsigned int vtkMRMLAnnotationTextDisplayNode::GetMaxCharactersPerLine

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::GetMaximumLeaderGlyphSize

(

)

[virtual]

virtual const char* vtkMRMLAnnotationTextDisplayNode::GetNodeTagName

(

)

[inline, virtual]

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLAnnotationDisplayNode.

Definition at line 45 of file vtkMRMLAnnotationTextDisplayNode.h.

virtual int vtkMRMLAnnotationTextDisplayNode::GetPadding

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::GetShowArrowHead

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::GetShowBorder

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::GetShowLeader

(

)

[virtual]

virtual double vtkMRMLAnnotationTextDisplayNode::GetTextScale

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::GetUseLineWrap

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::GetUseThreeDimensionalLeader

(

)

[virtual]

virtual int vtkMRMLAnnotationTextDisplayNode::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkMRMLAnnotationDisplayNode.

static int vtkMRMLAnnotationTextDisplayNode::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkMRMLAnnotationDisplayNode.

static vtkMRMLAnnotationTextDisplayNode* vtkMRMLAnnotationTextDisplayNode::New

(

)

[static]

Reimplemented from vtkMRMLAnnotationDisplayNode.

void vtkMRMLAnnotationTextDisplayNode::operator=

(

const vtkMRMLAnnotationTextDisplayNode &

)

[protected]

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

Reimplemented from vtkMRMLAnnotationDisplayNode.

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

Propagate ModifiedEvent generated by the texture image data or the color node.

See also:

TextureImageData, ColorNode

Reimplemented from vtkMRMLAnnotationDisplayNode.

virtual void vtkMRMLAnnotationTextDisplayNode::ReadXMLAttributes

(

const char **

atts

)

[virtual]

Read node attributes from XML file.

See also:

vtkMRMLParser

Reimplemented from vtkMRMLAnnotationDisplayNode.

void vtkMRMLAnnotationTextDisplayNode::RestoreBackup

(

)

[virtual]

Restore an attached backup of this node.

Reimplemented from vtkMRMLAnnotationDisplayNode.

static vtkMRMLAnnotationTextDisplayNode* vtkMRMLAnnotationTextDisplayNode::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkMRMLAnnotationDisplayNode.

virtual void vtkMRMLAnnotationTextDisplayNode::SetAttachEdgeOnly

(

int

)

[virtual]

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual void vtkMRMLAnnotationTextDisplayNode::SetLeaderGlyphSize

(

double

)

[virtual]

Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph. Only used if ShowArrow is true.

virtual void vtkMRMLAnnotationTextDisplayNode::SetMaxCharactersPerLine

(

unsigned

int

)

[virtual]

Set teh maximum number of characters in a text line, used if UseLineWrap is true.

virtual void vtkMRMLAnnotationTextDisplayNode::SetMaximumLeaderGlyphSize

(

int

)

[virtual]

Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

virtual void vtkMRMLAnnotationTextDisplayNode::SetPadding

(

int

)

[virtual]

Set/Get the padding between the caption and the border. The value is specified in pixels.

virtual void vtkMRMLAnnotationTextDisplayNode::SetShowArrowHead

(

int

)

[virtual]

Enable/disable showing the arrow head glyph at the end of the leader. Only used if ShowLeader is true.

virtual void vtkMRMLAnnotationTextDisplayNode::SetShowBorder

(

int

)

[virtual]

based on vtkCaptionActor2D.h

Enable/disable the placement of a border around the text.

virtual void vtkMRMLAnnotationTextDisplayNode::SetShowLeader

(

int

)

[virtual]

Enable/disable drawing a "line" from the caption to the attachment point.

void vtkMRMLAnnotationTextDisplayNode::SetTextScale

(

double

scale

)

virtual void vtkMRMLAnnotationTextDisplayNode::SetUseLineWrap

(

int

)

[virtual]

Enable/disable using automatic line wrap on text lines that are longer than MaxCharactersPerLine.

virtual void vtkMRMLAnnotationTextDisplayNode::SetUseThreeDimensionalLeader

(

int

)

[virtual]

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered). Only used in the 3d displayable managers, 2d ones set it off

virtual void vtkMRMLAnnotationTextDisplayNode::ShowArrowHeadOff

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::ShowArrowHeadOn

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::ShowBorderOff

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::ShowBorderOn

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::ShowLeaderOff

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::ShowLeaderOn

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::UpdateScene

(

vtkMRMLScene *

scene

)

[virtual]

Finds the storage node and read the data.

Reimplemented from vtkMRMLAnnotationDisplayNode.

virtual void vtkMRMLAnnotationTextDisplayNode::UseLineWrapOff

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::UseLineWrapOn

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::UseThreeDimensionalLeaderOff

(

)

[virtual]

virtual void vtkMRMLAnnotationTextDisplayNode::UseThreeDimensionalLeaderOn

(

)

[virtual]

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

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

See also:

vtkMRMLScene::Commit()

Reimplemented from vtkMRMLAnnotationDisplayNode.

---

Member Data Documentation

int vtkMRMLAnnotationTextDisplayNode::AttachEdgeOnly [protected]

Definition at line 148 of file vtkMRMLAnnotationTextDisplayNode.h.

double vtkMRMLAnnotationTextDisplayNode::LeaderGlyphSize [protected]

Definition at line 145 of file vtkMRMLAnnotationTextDisplayNode.h.

unsigned int vtkMRMLAnnotationTextDisplayNode::MaxCharactersPerLine [protected]

Definition at line 139 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::MaximumLeaderGlyphSize [protected]

Definition at line 146 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::Padding [protected]

Definition at line 147 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::ShowArrowHead [protected]

Definition at line 143 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::ShowBorder [protected]

Definition at line 141 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::ShowLeader [protected]

Definition at line 142 of file vtkMRMLAnnotationTextDisplayNode.h.

double vtkMRMLAnnotationTextDisplayNode::TextScale [protected]

Definition at line 136 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::UseLineWrap [protected]

Definition at line 138 of file vtkMRMLAnnotationTextDisplayNode.h.

int vtkMRMLAnnotationTextDisplayNode::UseThreeDimensionalLeader [protected]

Definition at line 144 of file vtkMRMLAnnotationTextDisplayNode.h.

---

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

• Modules/Loadable/Annotations/MRML/vtkMRMLAnnotationTextDisplayNode.h