vtkMRMLAnnotationRulerNode Class Reference

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

Inheritance diagram for vtkMRMLAnnotationRulerNode:

Collaboration diagram for vtkMRMLAnnotationRulerNode:

List of all members.

Public Types
enum	{ RulerNodeAddedEvent = 20010, ValueModifiedEvent }
typedef vtkMRMLAnnotationLinesNode	Superclass
Public Member Functions
virtual void	ApplyTransform (vtkAbstractTransform *transform)
virtual void	ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
virtual void	Copy (vtkMRMLNode *node)
	Copy the node's attributes to this object.
virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()
virtual vtkMRMLNode *	CreateNodeInstance ()
	MRMLNode methods.
virtual const char *	GetClassName ()
virtual char *	GetDistanceAnnotationFormat ()
double	GetDistanceAnnotationScale ()
double *	GetDistanceAnnotationTextColour ()
int	GetDistanceAnnotationVisibility ()
double	GetDistanceMeasurement ()
	Calculate the distance between world coordinates of the two end points.
virtual const char *	GetIcon ()
double *	GetLineColour ()
virtual char *	GetModelID1 ()
	get/set the id of the model the first and second end of the ruler is constrained upon
virtual char *	GetModelID2 ()
virtual const char *	GetNodeTagName ()
	Get node XML tag name (like Volume, Model)
double *	GetPointColour ()
void	GetPosition1 (double position[3])
double *	GetPosition1 ()
void	GetPosition2 (double position[3])
double *	GetPosition2 ()
void	GetPositionWorldCoordinates1 (double position[4])
void	GetPositionWorldCoordinates2 (double position[4])
virtual int	GetResolution ()
virtual int	IsA (const char *type)
void	PrintAnnotationInfo (ostream &os, vtkIndent indent, int titleFlag=1)
virtual void	ProcessMRMLEvents (vtkObject *, unsigned long, void *)
	alternative method to propagate events generated in Display nodes
virtual void	ReadXMLAttributes (const char **atts)
virtual void	SetDistanceAnnotationFormat (const char *)
void	SetDistanceAnnotationScale (double init)
void	SetDistanceAnnotationTextColour (double initColor[3])
void	SetDistanceAnnotationVisibility (int flag)
void	SetLineColour (double newColor[3])
virtual void	SetModelID1 (const char *)
virtual void	SetModelID2 (const char *)
void	SetPointColour (double initColor[3])
int	SetPosition1 (double nC1, double nC2, double nC3)
int	SetPosition1 (double newControl[3])
int	SetPosition2 (double nC1, double nC2, double nC3)
int	SetPosition2 (double newControl[3])
int	SetPositionWorldCoordinates1 (double newControl[4])
int	SetPositionWorldCoordinates2 (double newControl[4])
virtual void	SetResolution (int)
int	SetRuler (vtkIdType line1Id, int sel, int vis)
void	UpdateScene (vtkMRMLScene *scene)
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLAnnotationRulerNode *	New ()
static vtkMRMLAnnotationRulerNode *	SafeDownCast (vtkObject *o)
Protected Member Functions
int	AddControlPoint (double newControl[3], int selectedFlag, int visibleFlag)
void	operator= (const vtkMRMLAnnotationRulerNode &)
int	SetControlPoint (int id, double newControl[3])
	vtkMRMLAnnotationRulerNode ()
	vtkMRMLAnnotationRulerNode (const vtkMRMLAnnotationRulerNode &)
	~vtkMRMLAnnotationRulerNode ()
Protected Attributes
char *	DistanceAnnotationFormat
char *	ModelID1
char *	ModelID2
int	Resolution

---

Detailed Description

Definition at line 12 of file vtkMRMLAnnotationRulerNode.h.

---

Member Typedef Documentation

typedef vtkMRMLAnnotationLinesNode vtkMRMLAnnotationRulerNode::Superclass

Reimplemented from vtkMRMLAnnotationLinesNode.

Definition at line 16 of file vtkMRMLAnnotationRulerNode.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

RulerNodeAddedEvent
ValueModifiedEvent

Definition at line 185 of file vtkMRMLAnnotationRulerNode.h.

---

Constructor & Destructor Documentation

vtkMRMLAnnotationRulerNode::vtkMRMLAnnotationRulerNode

(

)

[protected]

vtkMRMLAnnotationRulerNode::~vtkMRMLAnnotationRulerNode

(

)

[protected]

vtkMRMLAnnotationRulerNode::vtkMRMLAnnotationRulerNode

(

const vtkMRMLAnnotationRulerNode &

)

[protected]

---

Member Function Documentation

int vtkMRMLAnnotationRulerNode::AddControlPoint	(	double	newControl[3],
		int	selectedFlag,
		int	visibleFlag
	)		[protected]

Reimplemented from vtkMRMLAnnotationControlPointsNode.

virtual void vtkMRMLAnnotationRulerNode::ApplyTransform

(

vtkAbstractTransform *

transform

)

[virtual]

Concatenate a transform to the current transform matrix.

See also:

SetAndObserveTransformNodeID, ApplyMatrix, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLModelNode.

virtual void vtkMRMLAnnotationRulerNode::ApplyTransformMatrix

(

vtkMatrix4x4 *

transformMatrix

)

[virtual]

Concatenate a matrix to the current transform matrix.

See also:

SetAndObserveTransformNodeID, ApplyTransform, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

virtual void vtkMRMLAnnotationRulerNode::Copy

(

vtkMRMLNode *

node

)

[virtual]

Copy the node's attributes to this object.

Description:

Reimplemented from vtkMRMLAnnotationLinesNode.

virtual vtkMRMLStorageNode* vtkMRMLAnnotationRulerNode::CreateDefaultStorageNode

(

)

[virtual]

Create a storage node for this node type or NULL if it doesn't have one. Null by default. This must be overwritten by subclasses that use storage nodes.

Reimplemented from vtkMRMLAnnotationLinesNode.

virtual vtkMRMLNode* vtkMRMLAnnotationRulerNode::CreateNodeInstance

(

)

[virtual]

MRMLNode methods.

Reimplemented from vtkMRMLAnnotationLinesNode.

virtual const char* vtkMRMLAnnotationRulerNode::GetClassName

(

)

[virtual]

Reimplemented from vtkMRMLAnnotationLinesNode.

virtual char* vtkMRMLAnnotationRulerNode::GetDistanceAnnotationFormat

(

)

[virtual]

double vtkMRMLAnnotationRulerNode::GetDistanceAnnotationScale

(

)

double* vtkMRMLAnnotationRulerNode::GetDistanceAnnotationTextColour

(

)

int vtkMRMLAnnotationRulerNode::GetDistanceAnnotationVisibility

(

)

double vtkMRMLAnnotationRulerNode::GetDistanceMeasurement

(

)

Calculate the distance between world coordinates of the two end points.

virtual const char* vtkMRMLAnnotationRulerNode::GetIcon

(

)

[inline, virtual]

Reimplemented from vtkMRMLAnnotationNode.

Definition at line 30 of file vtkMRMLAnnotationRulerNode.h.

double* vtkMRMLAnnotationRulerNode::GetLineColour

(

)

virtual char* vtkMRMLAnnotationRulerNode::GetModelID1

(

)

[virtual]

get/set the id of the model the first and second end of the ruler is constrained upon

virtual char* vtkMRMLAnnotationRulerNode::GetModelID2

(

)

[virtual]

virtual const char* vtkMRMLAnnotationRulerNode::GetNodeTagName

(

)

[inline, virtual]

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLAnnotationLinesNode.

Definition at line 28 of file vtkMRMLAnnotationRulerNode.h.

double* vtkMRMLAnnotationRulerNode::GetPointColour

(

)

double* vtkMRMLAnnotationRulerNode::GetPosition1

(

)

[inline]

Definition at line 69 of file vtkMRMLAnnotationRulerNode.h.

void vtkMRMLAnnotationRulerNode::GetPosition1

(

double

position[3]

)

void vtkMRMLAnnotationRulerNode::GetPosition2

(

double

position[3]

)

double* vtkMRMLAnnotationRulerNode::GetPosition2

(

)

[inline]

Definition at line 104 of file vtkMRMLAnnotationRulerNode.h.

void vtkMRMLAnnotationRulerNode::GetPositionWorldCoordinates1

(

double

position[4]

)

[inline]

Definition at line 59 of file vtkMRMLAnnotationRulerNode.h.

void vtkMRMLAnnotationRulerNode::GetPositionWorldCoordinates2

(

double

position[4]

)

[inline]

Definition at line 97 of file vtkMRMLAnnotationRulerNode.h.

virtual int vtkMRMLAnnotationRulerNode::GetResolution

(

)

[virtual]

virtual int vtkMRMLAnnotationRulerNode::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkMRMLAnnotationLinesNode.

static int vtkMRMLAnnotationRulerNode::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkMRMLAnnotationLinesNode.

static vtkMRMLAnnotationRulerNode* vtkMRMLAnnotationRulerNode::New

(

)

[static]

Reimplemented from vtkMRMLAnnotationLinesNode.

void vtkMRMLAnnotationRulerNode::operator=

(

const vtkMRMLAnnotationRulerNode &

)

[protected]

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

Reimplemented from vtkMRMLAnnotationLinesNode.

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

alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLAnnotationLinesNode.

virtual void vtkMRMLAnnotationRulerNode::ReadXMLAttributes

(

const char **

atts

)

[virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLAnnotationLinesNode.

static vtkMRMLAnnotationRulerNode* vtkMRMLAnnotationRulerNode::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkMRMLAnnotationLinesNode.

int vtkMRMLAnnotationRulerNode::SetControlPoint	(	int	id,
		double	newControl[3]
	)		[protected]

Reimplemented from vtkMRMLAnnotationControlPointsNode.

virtual void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationFormat

(

const char *

)

[virtual]

void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationScale

(

double

init

)

void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationTextColour

(

double

initColor[3]

)

void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationVisibility

(

int

flag

)

void vtkMRMLAnnotationRulerNode::SetLineColour

(

double

newColor[3]

)

virtual void vtkMRMLAnnotationRulerNode::SetModelID1

(

const char *

)

[virtual]

virtual void vtkMRMLAnnotationRulerNode::SetModelID2

(

const char *

)

[virtual]

void vtkMRMLAnnotationRulerNode::SetPointColour

(

double

initColor[3]

)

int vtkMRMLAnnotationRulerNode::SetPosition1

(

double

newControl[3]

)

[inline]

Definition at line 74 of file vtkMRMLAnnotationRulerNode.h.

int vtkMRMLAnnotationRulerNode::SetPosition1	(	double	nC1,
		double	nC2,
		double	nC3
	)		[inline]

Definition at line 86 of file vtkMRMLAnnotationRulerNode.h.

int vtkMRMLAnnotationRulerNode::SetPosition2	(	double	nC1,
		double	nC2,
		double	nC3
	)		[inline]

Definition at line 121 of file vtkMRMLAnnotationRulerNode.h.

int vtkMRMLAnnotationRulerNode::SetPosition2

(

double

newControl[3]

)

[inline]

Definition at line 109 of file vtkMRMLAnnotationRulerNode.h.

int vtkMRMLAnnotationRulerNode::SetPositionWorldCoordinates1

(

double

newControl[4]

)

[inline]

Definition at line 79 of file vtkMRMLAnnotationRulerNode.h.

int vtkMRMLAnnotationRulerNode::SetPositionWorldCoordinates2

(

double

newControl[4]

)

[inline]

Definition at line 114 of file vtkMRMLAnnotationRulerNode.h.

virtual void vtkMRMLAnnotationRulerNode::SetResolution

(

int

)

[virtual]

int vtkMRMLAnnotationRulerNode::SetRuler	(	vtkIdType	line1Id,
		int	sel,
		int	vis
	)

void vtkMRMLAnnotationRulerNode::UpdateScene

(

vtkMRMLScene *

scene

)

[virtual]

Finds the storage node and read the data

Reimplemented from vtkMRMLAnnotationLinesNode.

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

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

Reimplemented from vtkMRMLAnnotationLinesNode.

---

Member Data Documentation

char* vtkMRMLAnnotationRulerNode::DistanceAnnotationFormat [protected]

Definition at line 201 of file vtkMRMLAnnotationRulerNode.h.

char* vtkMRMLAnnotationRulerNode::ModelID1 [protected]

the model ids for the models that the ends of the ruler are constrained to

Definition at line 209 of file vtkMRMLAnnotationRulerNode.h.

char* vtkMRMLAnnotationRulerNode::ModelID2 [protected]

Definition at line 210 of file vtkMRMLAnnotationRulerNode.h.

int vtkMRMLAnnotationRulerNode::Resolution [protected]

Definition at line 200 of file vtkMRMLAnnotationRulerNode.h.

---

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

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