MRML node to represent a list of points in 3D. More...

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

Inheritance diagram for vtkMRMLFiducialListNode:

Collaboration diagram for vtkMRMLFiducialListNode:

Public Types
enum	{ DisplayModifiedEvent = 19000, PolyDataModifiedEvent = 19001, FiducialModifiedEvent = 19002, FiducialIndexModifiedEvent = 19003 }
enum	GlyphShapes { GlyphMin = 1, Vertex2D = GlyphMin, Dash2D, Cross2D, ThickCross2D, Triangle2D, Square2D, Circle2D, Diamond2D, Arrow2D, ThickArrow2D, HookedArrow2D, StarBurst2D, Sphere3D, Diamond3D, GlyphMax = Diamond3D }
enum	NumberingSchemes { SchemeMin = 0, UseID = SchemeMin, UseIndex, UsePrevious, SchemeMax = UsePrevious }
	Flags to determine how the next fiducial added to the list is labelled. More...
typedef vtkMRMLStorableNode	Superclass
Public Member Functions
int	AddFiducial ()
	Add a fiducial point to the list with default values.
int	AddFiducialWithLabelXYZSelectedVisibility (const char *label, float x, float y, float z, int selected, int visibility)
	Add a fiducial point to the list with a label, x,y,z, selected flag, visibility.
int	AddFiducialWithXYZ (float x, float y, float z, int selected)
	Add a fiducial point to the list x, y, z.
virtual void	ApplyTransform (vtkAbstractTransform *transform)
virtual void	ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
virtual bool	CanApplyNonLinearTransforms () const
	transform utility functions
virtual void	Copy (vtkMRMLNode *node)
	Copy the node's attributes to this object.
virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()
	Create default storage node or NULL if does not have one.
virtual vtkMRMLNode *	CreateNodeInstance ()
virtual double	GetAmbient ()
virtual const char *	GetClassName ()
virtual double *	GetColor ()
virtual void	GetColor (double data[3])
virtual double	GetDiffuse ()
int	GetFiducialIndex (std::string fiducialID)
virtual int	GetGlyphType ()
const char *	GetGlyphTypeAsString (int g)
const char *	GetGlyphTypeAsString ()
	Return a string representing the glyph type, set it from a string.
virtual int	GetLocked ()
int	GetMaximumGlyphType ()
int	GetMinimumGlyphType ()
	Return the min/max glyph types, for iterating over them in tcl.
virtual const char *	GetNodeTagName ()
	Get node XML tag name (like Volume, Model)
const char *	GetNthFiducialID (int n)
	get the id of the nth fiducial
const char *	GetNthFiducialLabelText (int n)
	get the label text of the nth fiducial
float *	GetNthFiducialOrientation (int n)
	get the orientation of the nth fiducial
int	GetNthFiducialSelected (int n)
	get the selected state on the nth fiducial
int	GetNthFiducialVisibility (int n)
	get the visible state on the nth fiducial
float *	GetNthFiducialXYZ (int n)
int	GetNthFiducialXYZWorld (int n, double *worldxyz)
virtual int	GetNumberingScheme ()
const char *	GetNumberingSchemeAsString (int g)
const char *	GetNumberingSchemeAsString ()
	Return a string representing the numbering scheme, set it from a string.
int	GetNumberOfFiducials ()
	Get the number of fiducials in the list.
virtual double	GetOpacity ()
virtual double	GetPower ()
virtual double *	GetSelectedColor ()
virtual void	GetSelectedColor (double data[3])
virtual double	GetSpecular ()
virtual double	GetSymbolScale ()
virtual double	GetTextScale ()
virtual int	GetVisibility ()
int	GlyphTypeIs3D ()
int	GlyphTypeIs3D (int glyphType)
	Returns 1 if the type is a 3d one, 0 else.
virtual int	IsA (const char *type)
int	IsFiducialPresent (vtkMRMLFiducial *o)
	is this fiducial on the list?
int	MoveFiducialDown (int fidIndex)
int	MoveFiducialUp (int fidIndex)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData)
	Process events from the MRML scene.
virtual void	ReadXMLAttributes (const char **atts)
	Set node attributes.
void	RemoveAllFiducials ()
	remove all fiducials from the list
void	RemoveFiducial (vtkMRMLFiducial *o)
	remove the passed in fiducial from the list
void	RemoveFiducial (int i)
	remove the fiducial at index i
void	RenameFiducials (const char *newName)
void	RenumberFiducials (int startFrom=0)
int	SetAllFiducialsSelected (int flag)
	Set all fiducials selected state to flag.
int	SetAllFiducialsVisibility (int flag)
	Set all fiducials visible state to flag.
void	SetAmbient (double val)
	Ambient of the fiducial surface expressed as a number from 0 to 1.
void	SetColor (double r, double g, double b)
void	SetColor (double c[3])
void	SetDiffuse (double val)
	Diffuse of the fiducial surface expressed as a number from 0 to 1.
void	SetFiducialLabelTextFromID (vtkMRMLFiducial *fid)
int	SetFiducialXYZ (std::string fiducialID, float x, float y, float z)
void	SetGlyphType (int type)
	The glyph type used to display this fiducial.
void	SetGlyphTypeFromString (const char *glyphString)
void	SetLocked (int locked)
	When fiducial lists are locked, they cannot be manipulated using the interactive widgets.
int	SetNthFiducialID (int n, const char *id)
int	SetNthFiducialLabelText (int n, const char *text)
int	SetNthFiducialOrientation (int n, float w, float x, float y, float z)
int	SetNthFiducialSelected (int n, int flag)
int	SetNthFiducialSelectedNoModified (int n, int flag)
int	SetNthFiducialVisibility (int n, int flag)
int	SetNthFiducialVisibilityNoModified (int n, int flag)
int	SetNthFiducialXYZ (int n, float x, float y, float z)
int	SetNthFiducialXYZWorld (int n, float x, float y, float z)
virtual void	SetNumberingScheme (int)
	Flag determining how to number the next added fiducial.
void	SetNumberingSchemeFromString (const char *schemeString)
void	SetOpacity (double opacity)
	Opacity of the fiducial surface expressed as a number from 0 to 1.
void	SetPower (double val)
	Power of the fiducial surface expressed as a number from 0 to 1.
void	SetSelectedColor (double r, double g, double b)
	Get/Set for colour for when a fiducial is selected.
void	SetSelectedColor (double c[3])
void	SetSpecular (double val)
	Specular of the fiducial surface expressed as a number from 0 to 1.
void	SetSymbolScale (double scale)
	vtkSetMacro(SymbolScale,double);
void	SetTextScale (double scale)
void	SetVisibility (int visible)
void	UpdateReferences ()
	update display node ids
virtual void	UpdateScene (vtkMRMLScene *scene)
virtual void	WriteXML (ostream &of, int indent)
	Write this node's information to a MRML file in XML format.
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLFiducialListNode *	New ()
static vtkMRMLFiducialListNode *	SafeDownCast (vtkObject *o)
Protected Member Functions
vtkMRMLFiducial *	GetNthFiducial (int n)
void	operator= (const vtkMRMLFiducialListNode &)
	vtkMRMLFiducialListNode ()
	vtkMRMLFiducialListNode (const vtkMRMLFiducialListNode &)
	~vtkMRMLFiducialListNode ()
Protected Attributes
double	Ambient
double	Color [3]
double	Diffuse
vtkCollection *	FiducialList
	The collection of fiducial points that make up this list.
int	GlyphType
int	Locked
int	NumberingScheme
	How the next added fiducial will be numbered in it's LabelText field.
double	Opacity
	Numbers relating to the display of the fiducials.
double	Power
double	SelectedColor [3]
double	Specular
double	SymbolScale
double	TextScale
int	Visibility

Detailed Description

MRML node to represent a list of points in 3D.

Deprecated:: Used for backward compatibility for Slicer3 fiducial lists, please use the Annotation Module MRML nodes

See also:: vtkMRMLAnnotationNode, vtkMRMLAnnotationFiducialNode

Fiducial list nodes describe a list of points in 3d space. They indicate how to render it (color, opacity, etc).

Definition at line 46 of file vtkMRMLFiducialListNode.h.

Member Typedef Documentation

typedef vtkMRMLStorableNode vtkMRMLFiducialListNode::Superclass

Reimplemented from vtkMRMLStorableNode.

Definition at line 53 of file vtkMRMLFiducialListNode.h.

Member Enumeration Documentation

anonymous enum

DisplayModifiedEvent is generated when display node parameters is changed PolyDataModifiedEvent is generated when something else is changed

Enumerator:

DisplayModifiedEvent
PolyDataModifiedEvent
FiducialModifiedEvent
FiducialIndexModifiedEvent

Definition at line 184 of file vtkMRMLFiducialListNode.h.

enum vtkMRMLFiducialListNode::GlyphShapes

Which kind of glyph should be used to display this fiducial? Vertex2D is supposed to start at 1

Enumerator:

GlyphMin
Vertex2D
Dash2D
Cross2D
ThickCross2D
Triangle2D
Square2D
Circle2D
Diamond2D
Arrow2D
ThickArrow2D
HookedArrow2D
StarBurst2D
Sphere3D
Diamond3D
GlyphMax

Definition at line 218 of file vtkMRMLFiducialListNode.h.

enum vtkMRMLFiducialListNode::NumberingSchemes

Flags to determine how the next fiducial added to the list is labelled.

Enumerator:

SchemeMin
UseID
UseIndex
UsePrevious
SchemeMax

Definition at line 278 of file vtkMRMLFiducialListNode.h.

Constructor & Destructor Documentation

vtkMRMLFiducialListNode::vtkMRMLFiducialListNode ( ) [protected]

vtkMRMLFiducialListNode::~vtkMRMLFiducialListNode ( ) [protected]

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

Member Function Documentation

int vtkMRMLFiducialListNode::AddFiducial ( )

Add a fiducial point to the list with default values.

int vtkMRMLFiducialListNode::AddFiducialWithLabelXYZSelectedVisibility	(	const char *	label,
		float	x,
		float	y,
		float	z,
		int	selected,
		int	visibility
	)

Add a fiducial point to the list with a label, x,y,z, selected flag, visibility.

int vtkMRMLFiducialListNode::AddFiducialWithXYZ	(	float	x,
		float	y,
		float	z,
		int	selected
	)

Add a fiducial point to the list x, y, z.

virtual void vtkMRMLFiducialListNode::ApplyTransform ( vtkAbstractTransform * transform ) [virtual]

Concatenate a transform to the current transform matrix.

See also:: SetAndObserveTransformNodeID, ApplyMatrix, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

virtual void vtkMRMLFiducialListNode::ApplyTransformMatrix ( vtkMatrix4x4 * transformMatrix ) [virtual]

Concatenate a matrix to the current transform matrix.

See also:: SetAndObserveTransformNodeID, ApplyTransform, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

virtual bool vtkMRMLFiducialListNode::CanApplyNonLinearTransforms ( ) const [virtual]

transform utility functions

Reimplemented from vtkMRMLTransformableNode.

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

Copy the node's attributes to this object.

Reimplemented from vtkMRMLStorableNode.

virtual vtkMRMLStorageNode* vtkMRMLFiducialListNode::CreateDefaultStorageNode ( ) [virtual]

Create default storage node or NULL if does not have one.

Reimplemented from vtkMRMLStorableNode.

virtual vtkMRMLNode* vtkMRMLFiducialListNode::CreateNodeInstance ( ) [virtual]

-------------------------------------------------------------------------- MRMLNode methods --------------------------------------------------------------------------

Implements vtkMRMLStorableNode.

virtual double vtkMRMLFiducialListNode::GetAmbient ( ) [virtual]

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

Reimplemented from vtkMRMLStorableNode.

virtual double* vtkMRMLFiducialListNode::GetColor ( ) [virtual]

virtual void vtkMRMLFiducialListNode::GetColor ( double data[3] ) [virtual]

virtual double vtkMRMLFiducialListNode::GetDiffuse ( ) [virtual]

int vtkMRMLFiducialListNode::GetFiducialIndex ( std::string fiducialID )

Look through the list of fiducials for fiducialID and return the current zero based index. Useful when delete fiducials from the list, as the index will change. Returns -1 if none found.

virtual int vtkMRMLFiducialListNode::GetGlyphType ( ) [virtual]

const char* vtkMRMLFiducialListNode::GetGlyphTypeAsString ( )

Return a string representing the glyph type, set it from a string.

const char* vtkMRMLFiducialListNode::GetGlyphTypeAsString ( int g )

virtual int vtkMRMLFiducialListNode::GetLocked ( ) [virtual]

int vtkMRMLFiducialListNode::GetMaximumGlyphType ( ) [inline]

Definition at line 240 of file vtkMRMLFiducialListNode.h.

int vtkMRMLFiducialListNode::GetMinimumGlyphType ( ) [inline]

Return the min/max glyph types, for iterating over them in tcl.

Definition at line 239 of file vtkMRMLFiducialListNode.h.

virtual const char* vtkMRMLFiducialListNode::GetNodeTagName ( ) [inline, virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Definition at line 73 of file vtkMRMLFiducialListNode.h.

vtkMRMLFiducial* vtkMRMLFiducialListNode::GetNthFiducial ( int n ) [protected]

disallow access to the fiducial points by outside classes, have them use SetNthFiducial

const char* vtkMRMLFiducialListNode::GetNthFiducialID ( int n )

get the id of the nth fiducial

const char* vtkMRMLFiducialListNode::GetNthFiducialLabelText ( int n )

get the label text of the nth fiducial

float* vtkMRMLFiducialListNode::GetNthFiducialOrientation ( int n )

get the orientation of the nth fiducial

int vtkMRMLFiducialListNode::GetNthFiducialSelected ( int n )

get the selected state on the nth fiducial

int vtkMRMLFiducialListNode::GetNthFiducialVisibility ( int n )

get the visible state on the nth fiducial

float* vtkMRMLFiducialListNode::GetNthFiducialXYZ ( int n )

Get the elements of the fiducial points Return a three element float holding the position

int vtkMRMLFiducialListNode::GetNthFiducialXYZWorld	(	int	n,
		double *	worldxyz
	)

Return a three element double giving the world position (any parent transform on the list applied to the return of GetNthFiducialXYZ. worldxyz is a 4 item array, xyzw returns 0 on failure, 1 on success.

virtual int vtkMRMLFiducialListNode::GetNumberingScheme ( ) [virtual]

const char* vtkMRMLFiducialListNode::GetNumberingSchemeAsString ( int g )

const char* vtkMRMLFiducialListNode::GetNumberingSchemeAsString ( )

Return a string representing the numbering scheme, set it from a string.

int vtkMRMLFiducialListNode::GetNumberOfFiducials ( )

Get the number of fiducials in the list.

virtual double vtkMRMLFiducialListNode::GetOpacity ( ) [virtual]

virtual double vtkMRMLFiducialListNode::GetPower ( ) [virtual]

virtual double* vtkMRMLFiducialListNode::GetSelectedColor ( ) [virtual]

virtual void vtkMRMLFiducialListNode::GetSelectedColor ( double data[3] ) [virtual]

virtual double vtkMRMLFiducialListNode::GetSpecular ( ) [virtual]

virtual double vtkMRMLFiducialListNode::GetSymbolScale ( ) [virtual]

virtual double vtkMRMLFiducialListNode::GetTextScale ( ) [virtual]

virtual int vtkMRMLFiducialListNode::GetVisibility ( ) [virtual]

int vtkMRMLFiducialListNode::GlyphTypeIs3D ( int glyphType )

Returns 1 if the type is a 3d one, 0 else.

int vtkMRMLFiducialListNode::GlyphTypeIs3D ( ) [inline]

Definition at line 247 of file vtkMRMLFiducialListNode.h.

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

Reimplemented from vtkMRMLStorableNode.

int vtkMRMLFiducialListNode::IsFiducialPresent ( vtkMRMLFiducial * o )

is this fiducial on the list?

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

Reimplemented from vtkMRMLStorableNode.

int vtkMRMLFiducialListNode::MoveFiducialDown ( int fidIndex )

int vtkMRMLFiducialListNode::MoveFiducialUp ( int fidIndex )

move a fiducial point in the collection, one up/down returns -1 on failure (current index is out of bounds, the fid is already at the top or bottom of the list), the new fiducial index on success

static vtkMRMLFiducialListNode* vtkMRMLFiducialListNode::New ( ) [static]

Deprecated:: Used for backward compatibility for Slicer3 fiducial lists, please use the Annotation Module MRML nodes

See also:: vtkMRMLAnnotationNode, vtkMRMLAnnotationFiducialNode

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

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

Reimplemented from vtkMRMLStorableNode.

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

Process events from the MRML scene.

Reimplemented from vtkMRMLStorableNode.

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

Set node attributes.

Reimplemented from vtkMRMLStorableNode.

void vtkMRMLFiducialListNode::RemoveAllFiducials ( )

remove all fiducials from the list

void vtkMRMLFiducialListNode::RemoveFiducial ( int i )

remove the fiducial at index i

void vtkMRMLFiducialListNode::RemoveFiducial ( vtkMRMLFiducial * o )

remove the passed in fiducial from the list

void vtkMRMLFiducialListNode::RenameFiducials ( const char * newName )

Reanme all the fiducials in the active list. It preserves any numbers already on the ends of the labels.

void vtkMRMLFiducialListNode::RenumberFiducials ( int startFrom = 0 )

Renumber all the fiducials in the active list. It first removes any numbers from the ends of the label texts and then appends numbers starting from 0 by default.

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

Reimplemented from vtkMRMLStorableNode.

int vtkMRMLFiducialListNode::SetAllFiducialsSelected ( int flag )

Set all fiducials selected state to flag.

int vtkMRMLFiducialListNode::SetAllFiducialsVisibility ( int flag )

Set all fiducials visible state to flag.

void vtkMRMLFiducialListNode::SetAmbient ( double val )

Ambient of the fiducial surface expressed as a number from 0 to 1.

void vtkMRMLFiducialListNode::SetColor	(	double	r,
		double	g,
		double	b
	)

Get/Set for Glyph and Text color vtkSetVector3Macro(Color,double);

void vtkMRMLFiducialListNode::SetColor ( double c[3] )

void vtkMRMLFiducialListNode::SetDiffuse ( double val )

Diffuse of the fiducial surface expressed as a number from 0 to 1.

void vtkMRMLFiducialListNode::SetFiducialLabelTextFromID ( vtkMRMLFiducial * fid )

Generate the label text for a fiducial from it's id. If NumberingScheme is UseID, uses the ID (default). If NumberingScheme is UseIndex, strips the ID of any trailing numbers and appends the fiducial's index to it. If NumberingScheme is UsePrevious, checks the previous fiducial in the list for a trailing number and increments it by 1, and appends the new number. If it's the first fiducial, uses 0. If the previous fiducial has no trailing number in it's label text, will use 1.

int vtkMRMLFiducialListNode::SetFiducialXYZ	(	std::string	fiducialID,
		float	x,
		float	y,
		float	z
	)

Restrict access to the fiducial points, access the fiducial by id (used by the vtkSlicerFiducialListWidget). Returns 0 on success.

void vtkMRMLFiducialListNode::SetGlyphType ( int type )

The glyph type used to display this fiducial.

void vtkMRMLFiducialListNode::SetGlyphTypeFromString ( const char * glyphString )

void vtkMRMLFiducialListNode::SetLocked ( int locked )

When fiducial lists are locked, they cannot be manipulated using the interactive widgets.

int vtkMRMLFiducialListNode::SetNthFiducialID	(	int	n,
		const char *	id
	)

int vtkMRMLFiducialListNode::SetNthFiducialLabelText	(	int	n,
		const char *	text
	)

int vtkMRMLFiducialListNode::SetNthFiducialOrientation	(	int	n,
		float	w,
		float	x,
		float	y,
		float	z
	)

int vtkMRMLFiducialListNode::SetNthFiducialSelected	(	int	n,
		int	flag
	)

int vtkMRMLFiducialListNode::SetNthFiducialSelectedNoModified	(	int	n,
		int	flag
	)

int vtkMRMLFiducialListNode::SetNthFiducialVisibility	(	int	n,
		int	flag
	)

int vtkMRMLFiducialListNode::SetNthFiducialVisibilityNoModified	(	int	n,
		int	flag
	)

int vtkMRMLFiducialListNode::SetNthFiducialXYZ	(	int	n,
		float	x,
		float	y,
		float	z
	)

Restrict access to the fiducial points, pass in a value via the list so that the appropriate events can be invoked. Returns 0 on success

int vtkMRMLFiducialListNode::SetNthFiducialXYZWorld	(	int	n,
		float	x,
		float	y,
		float	z
	)

Set the nth fiducial to xyz transformed by the inverse of the transform to world for the list. Calls SetNthFiducialXYZ after transforming the passed in coordinates and returns the result of that call.

virtual void vtkMRMLFiducialListNode::SetNumberingScheme ( int ) [virtual]

Flag determining how to number the next added fiducial.

void vtkMRMLFiducialListNode::SetNumberingSchemeFromString ( const char * schemeString )